Skip to content

Large AAD script fixes #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jamespik merged 3 commits into from
Oct 30, 2021
Merged

Large AAD script fixes #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3db7a86
In progress fixes
jamespik Oct 29, 2021
cbda320
Line endings
jamespik Oct 30, 2021
fac8412
PR comments
jamespik Oct 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions Tools/PowershellModule/doc/PowerShell/Add-WinGetManifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Add-WinGetManifest

## SYNOPSIS
Submits a Manifest file(s) to the Azure rest source
Submits a Manifest file(s) to the Azure REST source

## SYNTAX

Expand All @@ -18,7 +18,7 @@ Add-WinGetManifest [-FunctionName] <String> [-Path] <String> [[-SubscriptionName
```

## DESCRIPTION
By running this function with the required inputs, it will connect to the Azure Tenant that hosts the Windows Package Manager rest source, then collects the required URL for Manifest submission before retrieving the contents of the Manifest JSON to submit.
By running this function with the required inputs, it will connect to the Azure Tenant that hosts the Windows Package Manager REST source, then collects the required URL for Manifest submission before retrieving the contents of the Manifest JSON to submit.

The following Azure Modules are used by this script:
Az.Resources
Expand All @@ -33,26 +33,26 @@ The following Azure Modules are used by this script:
Add-WinGetManifest -FunctionName "PrivateSource" -Path "C:\AppManifests\Microsoft.PowerToys\PowerToys.json"
```

Connects to Azure, then runs the Azure Function "PrivateSource" Rest APIs to add the specified Manifest file (*.json) to the Windows Package Manager rest source
Connects to Azure, then runs the Azure Function "PrivateSource" REST APIs to add the specified Manifest file (*.json) to the Windows Package Manager REST source

### EXAMPLE 2
```
Add-WinGetManifest -FunctionName "PrivateSource" -Path "C:\AppManifests\Microsoft.PowerToys\"
```

Connects to Azure, then runs the Azure Function "PrivateSource" Rest APIs to adds the Manifest file(s) (*.json / *.yaml) found in the specified folder to the Windows Package Manager rest source
Connects to Azure, then runs the Azure Function "PrivateSource" REST APIs to adds the Manifest file(s) (*.json / *.yaml) found in the specified folder to the Windows Package Manager REST source

### EXAMPLE 3
```
Add-WinGetManifest -FunctionName "PrivateSource" -Path "C:\AppManifests\Microsoft.PowerToys\PowerToys.json" -SubscriptionName "Visual Studio Subscription"
```

Connects to Azure and the specified Subscription, then runs the Azure Function "PrivateSource" Rest APIs to add the specified Manifest file (*.json) to the Windows Package Manager rest source
Connects to Azure and the specified Subscription, then runs the Azure Function "PrivateSource" REST APIs to add the specified Manifest file (*.json) to the Windows Package Manager REST source

## PARAMETERS

### -FunctionName
Name of the Azure Function that hosts the rest source.
Name of the Azure Function that hosts the REST source.

```yaml
Type: String
Expand All @@ -67,7 +67,7 @@ Accept wildcard characters: False
```

### -Path
The Path to the JSON manifest file or folder hosting the JSON / YAML files that will be uploaded to the rest source. This path may contain a single JSON / YAML file, or a folder containing multiple JSON / YAML files. Does not support targetting a single folder of multiple different applications in *.yaml format.
The Path to the JSON manifest file or folder hosting the JSON / YAML files that will be uploaded to the REST source. This path may contain a single JSON / YAML file, or a folder containing multiple JSON / YAML files. Does not support targetting a single folder of multiple different applications in *.yaml format.

```yaml
Type: String
Expand All @@ -82,7 +82,7 @@ Accept wildcard characters: False
```

### -SubscriptionName
\[Optional\] The Subscription name contains the Windows Package Manager rest source
\[Optional\] The Subscription name contains the Windows Package Manager REST source

```yaml
Type: String
Expand Down
16 changes: 8 additions & 8 deletions Tools/PowershellModule/doc/PowerShell/Get-WinGetManifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ schema: 2.0.0
# Get-WinGetManifest

## SYNOPSIS
Connects to the specified source Rest API, or local file system path to retrieve the application Manifests, returning an array of all Manifests found.
Allows for filtering results based on the name when targetting the Rest APIs.
Connects to the specified source REST API, or local file system path to retrieve the application Manifests, returning an array of all Manifests found.
Allows for filtering results based on the name when targetting the REST APIs.

## SYNTAX

Expand All @@ -30,7 +30,7 @@ Get-WinGetManifest [-URL] <String> [<CommonParameters>]
```

## DESCRIPTION
Connects to the specified source Rest API, or local file system path to retrieve the application Manifests, returning an array of all Manifests found.
Connects to the specified source REST API, or local file system path to retrieve the application Manifests, returning an array of all Manifests found.
Allows for filtering results based on the name.

The following Azure Modules are used by this script:
Expand Down Expand Up @@ -60,14 +60,14 @@ Returns a Manifest object (*.json) of the specified JSON file.
Get-WinGetManifest -FunctionName "PrivateSource" -ManifestIdentifier "Windows.PowerToys"
```

Returns a Manifest object of the specified Manifest Identifier that is queried against in the Rest APIs.
Returns a Manifest object of the specified Manifest Identifier that is queried against in the REST APIs.

### EXAMPLE 4
```
Get-WinGetManifest -FunctionName "PrivateSource" -ManifestIdentifier "Windows.PowerToys" -SubscriptionName "Visual Studio Subscription"
```

Returns a Manifest object of the specified Manifest Identifier that is queried against in the Rest APIs from the specified Subscription Name.
Returns a Manifest object of the specified Manifest Identifier that is queried against in the REST APIs from the specified Subscription Name.

### EXAMPLE 5
```
Expand All @@ -94,7 +94,7 @@ Accept wildcard characters: False
```

### -URL
Web URL to the host site containing the Rest APIs with access key (if required).
Web URL to the host site containing the REST APIs with access key (if required).

```yaml
Type: String
Expand All @@ -109,7 +109,7 @@ Accept wildcard characters: False
```

### -FunctionName
Name of the Azure Function Name that contains the Windows Package Manager Rest APIs.
Name of the Azure Function Name that contains the Windows Package Manager REST APIs.

```yaml
Type: String
Expand Down Expand Up @@ -139,7 +139,7 @@ Accept wildcard characters: False
```

### -SubscriptionName
\[Optional\] Name of the Azure Subscription that contains the Azure Function which contains the Rest APIs.
\[Optional\] Name of the Azure Subscription that contains the Azure Function which contains the REST APIs.

```yaml
Type: String
Expand Down
30 changes: 15 additions & 15 deletions Tools/PowershellModule/doc/PowerShell/New-WinGetSource.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# New-WinGetSource

## SYNOPSIS
Creates a Windows Package Manager rest source in Azure for private storage of Windows Package Manager application Manifests.
Creates a Windows Package Manager REST source in Azure for private storage of Windows Package Manager application Manifests.

## SYNTAX

Expand All @@ -20,7 +20,7 @@ New-WinGetSource [-Name] <String> [[-Index] <String>] [[-ResourceGroup] <String>
```

## DESCRIPTION
Creates a Windows Package Manager rest source in Azure for private storage of Windows Package Manager application Manifests.
Creates a Windows Package Manager REST source in Azure for private storage of Windows Package Manager application Manifests.

The following Azure Modules are used by this script:
Az.Resources
Expand All @@ -35,15 +35,15 @@ The following Azure Modules are used by this script:
New-WinGetSource -Name "contoso0002"
```

Creates the Windows Package Manager rest source in Azure with resources named "contoso0002" in the westus region of Azure with the basic level performance.
Creates the Windows Package Manager REST source in Azure with resources named "contoso0002" in the westus region of Azure with the basic level performance.

### EXAMPLE 2
```
New-WinGetSource -Name "contoso0002" -ResourceGroup "WinGetSource" -SubscriptionName "Visual Studio Subscription" -Region "westus" -ParameterOutput "C:\WinGet" -ImplementationPerformance "Basic" -ShowConnectionInstructions
```

Creates the Windows Package Manager rest source in Azure with resources named "contoso0002" in the westus region of Azure with the basic level performance in the "Visual Studio Subscription" Subscription.
Displays the required command to connect the WinGet client to the new rest source after the repository has been created.
Creates the Windows Package Manager REST source in Azure with resources named "contoso0002" in the westus region of Azure with the basic level performance in the "Visual Studio Subscription" Subscription.
Displays the required command to connect the WinGet client to the new REST source after the repository has been created.

## PARAMETERS

Expand Down Expand Up @@ -78,7 +78,7 @@ Accept wildcard characters: False
```

### -ResourceGroup
\[Optional\] The Name of the Resource Group that the Windows Package Manager rest source will reside. All Azure resources will be created in in this Resource Group (Default: WinGetRestSource)
\[Optional\] The Name of the Resource Group that the Windows Package Manager REST source will reside. All Azure resources will be created in in this Resource Group (Default: WinGetRESTSource)
(Default: WinGetRestSource)

```yaml
Expand All @@ -94,7 +94,7 @@ Accept wildcard characters: False
```

### -SubscriptionName
\[Optional\] The name of the subscription that will be used to host the Windows Package Manager rest source.
\[Optional\] The name of the subscription that will be used to host the Windows Package Manager REST source.

```yaml
Type: String
Expand Down Expand Up @@ -141,8 +141,8 @@ Accept wildcard characters: False
```

### -RestSourcePath
\[Optional\] Path to the compiled Rest API Zip file.
(Default: .\RestAPI\CompiledFunctions.ps1)
\[Optional\] Path to the compiled REST API Zip file.
(Default: .\Library\RestAPI\WinGet.RestSource.Functions.zip)

```yaml
Type: String
Expand All @@ -151,18 +151,18 @@ Aliases:

Required: False
Position: 7
Default value: "$PSScriptRoot\RestAPI\CompiledFunctions.zip"
Default value: "$PSScriptRoot\Library\RestAPI\WinGet.RestSource.Functions.zip"
Accept pipeline input: False
Accept wildcard characters: False
```

### -ImplementationPerformance
\[Optional\] \["Demo", "Basic", "Enhanced"\] specifies the performance of the resources to be created for the Windows Package Manager rest source.
\[Optional\] \["Demo", "Basic", "Enhanced"\] specifies the performance of the resources to be created for the Windows Package Manager REST source.
| Preference | Description |
|------------|-------------------------------------------------------------------------------------------------------------------------|
| Demo | Specifies lowest cost for demonstrating the Windows Package Manager rest source. Uses free-tier options when available. |
| Basic | Specifies a basic functioning Windows Package Manager rest source. Low cost. |
| Enhanced | Specifies a higher tier functionality with data replication across multiple data centers. High cost. |
| Demo | Specifies lowest cost for demonstrating the Windows Package Manager REST source. Uses free-tier options when available. |
| Basic | Specifies a basic functioning Windows Package Manager REST source. |
| Enhanced | Specifies a higher tier functionality with data replication across multiple data centers. |

(Default: Basic)

Expand All @@ -179,7 +179,7 @@ Accept wildcard characters: False
```

### -ShowConnectionInstructions
\[Optional\] If specified, the instructions for connecting to the Windows Package Manager rest source.
\[Optional\] If specified, the instructions for connecting to the Windows Package Manager REST source.
(Default: False)

```yaml
Expand Down
14 changes: 7 additions & 7 deletions Tools/PowershellModule/doc/PowerShell/Remove-WinGetManifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Remove-WinGetManifest

## SYNOPSIS
Removes a Manifest file from the Azure rest source
Removes a Manifest file from the Azure REST source

## SYNTAX

Expand All @@ -30,7 +30,7 @@ Remove-WinGetManifest [-FunctionName] <String> [[-ManifestIdentifier] <String>]
```

## DESCRIPTION
This function will connect to the Azure Tenant that hosts the Windows Package Manager rest source, removing the specified application Manifest.
This function will connect to the Azure Tenant that hosts the Windows Package Manager REST source, removing the specified application Manifest.

The following Azure Modules are used by this script:
Az.Resources
Expand All @@ -45,19 +45,19 @@ The following Azure Modules are used by this script:
Remove-WinGetManifest -FunctionName "RestSource" -ManifestIdentifier "Windows.PowerToys"
```

Connects to Azure, then runs the Azure Function "RestSource" Rest APIs to remove the specified Manifest file from the Windows Package Manager rest source
Connects to Azure, then runs the Azure Function "RestSource" REST APIs to remove the specified Manifest file from the Windows Package Manager REST source

### EXAMPLE 2
```
Remove-WinGetManifest -URL "https://contoso.azure.web.net/api/packageManifests" -ManifestIdentifier "Windows.PowerToys"
```

Connects to a remote URL Rest APIs to remove the Application Manifest from the Windows Package Manager rest source
Connects to a remote URL REST APIs to remove the Application Manifest from the Windows Package Manager REST source

## PARAMETERS

### -URL
Name of the URL that hosts the rest source.
Name of the URL that hosts the REST source.

```yaml
Type: String
Expand Down Expand Up @@ -87,7 +87,7 @@ Accept wildcard characters: False
```

### -FunctionName
Name of the Azure Function that hosts the rest source.
Name of the Azure Function that hosts the REST source.

```yaml
Type: String
Expand Down Expand Up @@ -117,7 +117,7 @@ Accept wildcard characters: False
```

### -SubscriptionName
\[Optional\] The Subscription name contains the Windows Package Manager rest source
\[Optional\] The Subscription name contains the Windows Package Manager REST source

```yaml
Type: String
Expand Down
Loading