Skip to content

Commit 15805cb

Browse files
authored
Large AAD script fixes (#85)
* In progress fixes * Line endings * PR comments
1 parent bac8169 commit 15805cb

8 files changed

+81
-80
lines changed

Tools/PowershellModule/doc/PowerShell/Add-WinGetManifest.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Add-WinGetManifest
99

1010
## SYNOPSIS
11-
Submits a Manifest file(s) to the Azure rest source
11+
Submits a Manifest file(s) to the Azure REST source
1212

1313
## SYNTAX
1414

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

2020
## DESCRIPTION
21-
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.
21+
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.
2222

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

36-
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
36+
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
3737

3838
### EXAMPLE 2
3939
```
4040
Add-WinGetManifest -FunctionName "PrivateSource" -Path "C:\AppManifests\Microsoft.PowerToys\"
4141
```
4242

43-
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
43+
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
4444

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

50-
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
50+
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
5151

5252
## PARAMETERS
5353

5454
### -FunctionName
55-
Name of the Azure Function that hosts the rest source.
55+
Name of the Azure Function that hosts the REST source.
5656

5757
```yaml
5858
Type: String
@@ -67,7 +67,7 @@ Accept wildcard characters: False
6767
```
6868
6969
### -Path
70-
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.
70+
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.
7171
7272
```yaml
7373
Type: String
@@ -82,7 +82,7 @@ Accept wildcard characters: False
8282
```
8383
8484
### -SubscriptionName
85-
\[Optional\] The Subscription name contains the Windows Package Manager rest source
85+
\[Optional\] The Subscription name contains the Windows Package Manager REST source
8686
8787
```yaml
8888
Type: String

Tools/PowershellModule/doc/PowerShell/Get-WinGetManifest.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ schema: 2.0.0
88
# Get-WinGetManifest
99

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

1414
## SYNTAX
1515

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

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

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

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

6565
### EXAMPLE 4
6666
```
6767
Get-WinGetManifest -FunctionName "PrivateSource" -ManifestIdentifier "Windows.PowerToys" -SubscriptionName "Visual Studio Subscription"
6868
```
6969

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

7272
### EXAMPLE 5
7373
```
@@ -94,7 +94,7 @@ Accept wildcard characters: False
9494
```
9595
9696
### -URL
97-
Web URL to the host site containing the Rest APIs with access key (if required).
97+
Web URL to the host site containing the REST APIs with access key (if required).
9898
9999
```yaml
100100
Type: String
@@ -109,7 +109,7 @@ Accept wildcard characters: False
109109
```
110110
111111
### -FunctionName
112-
Name of the Azure Function Name that contains the Windows Package Manager Rest APIs.
112+
Name of the Azure Function Name that contains the Windows Package Manager REST APIs.
113113
114114
```yaml
115115
Type: String
@@ -139,7 +139,7 @@ Accept wildcard characters: False
139139
```
140140
141141
### -SubscriptionName
142-
\[Optional\] Name of the Azure Subscription that contains the Azure Function which contains the Rest APIs.
142+
\[Optional\] Name of the Azure Subscription that contains the Azure Function which contains the REST APIs.
143143
144144
```yaml
145145
Type: String

Tools/PowershellModule/doc/PowerShell/New-WinGetSource.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-WinGetSource
99

1010
## SYNOPSIS
11-
Creates a Windows Package Manager rest source in Azure for private storage of Windows Package Manager application Manifests.
11+
Creates a Windows Package Manager REST source in Azure for private storage of Windows Package Manager application Manifests.
1212

1313
## SYNTAX
1414

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

2222
## DESCRIPTION
23-
Creates a Windows Package Manager rest source in Azure for private storage of Windows Package Manager application Manifests.
23+
Creates a Windows Package Manager REST source in Azure for private storage of Windows Package Manager application Manifests.
2424

2525
The following Azure Modules are used by this script:
2626
Az.Resources
@@ -35,15 +35,15 @@ The following Azure Modules are used by this script:
3535
New-WinGetSource -Name "contoso0002"
3636
```
3737

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

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

45-
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.
46-
Displays the required command to connect the WinGet client to the new rest source after the repository has been created.
45+
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.
46+
Displays the required command to connect the WinGet client to the new REST source after the repository has been created.
4747

4848
## PARAMETERS
4949

@@ -78,7 +78,7 @@ Accept wildcard characters: False
7878
```
7979
8080
### -ResourceGroup
81-
\[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)
81+
\[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)
8282
(Default: WinGetRestSource)
8383
8484
```yaml
@@ -94,7 +94,7 @@ Accept wildcard characters: False
9494
```
9595
9696
### -SubscriptionName
97-
\[Optional\] The name of the subscription that will be used to host the Windows Package Manager rest source.
97+
\[Optional\] The name of the subscription that will be used to host the Windows Package Manager REST source.
9898
9999
```yaml
100100
Type: String
@@ -141,8 +141,8 @@ Accept wildcard characters: False
141141
```
142142
143143
### -RestSourcePath
144-
\[Optional\] Path to the compiled Rest API Zip file.
145-
(Default: .\RestAPI\CompiledFunctions.ps1)
144+
\[Optional\] Path to the compiled REST API Zip file.
145+
(Default: .\Library\RestAPI\WinGet.RestSource.Functions.zip)
146146
147147
```yaml
148148
Type: String
@@ -151,18 +151,18 @@ Aliases:
151151

152152
Required: False
153153
Position: 7
154-
Default value: "$PSScriptRoot\RestAPI\CompiledFunctions.zip"
154+
Default value: "$PSScriptRoot\Library\RestAPI\WinGet.RestSource.Functions.zip"
155155
Accept pipeline input: False
156156
Accept wildcard characters: False
157157
```
158158
159159
### -ImplementationPerformance
160-
\[Optional\] \["Demo", "Basic", "Enhanced"\] specifies the performance of the resources to be created for the Windows Package Manager rest source.
160+
\[Optional\] \["Demo", "Basic", "Enhanced"\] specifies the performance of the resources to be created for the Windows Package Manager REST source.
161161
| Preference | Description |
162162
|------------|-------------------------------------------------------------------------------------------------------------------------|
163-
| Demo | Specifies lowest cost for demonstrating the Windows Package Manager rest source. Uses free-tier options when available. |
164-
| Basic | Specifies a basic functioning Windows Package Manager rest source. Low cost. |
165-
| Enhanced | Specifies a higher tier functionality with data replication across multiple data centers. High cost. |
163+
| Demo | Specifies lowest cost for demonstrating the Windows Package Manager REST source. Uses free-tier options when available. |
164+
| Basic | Specifies a basic functioning Windows Package Manager REST source. |
165+
| Enhanced | Specifies a higher tier functionality with data replication across multiple data centers. |
166166
167167
(Default: Basic)
168168
@@ -179,7 +179,7 @@ Accept wildcard characters: False
179179
```
180180
181181
### -ShowConnectionInstructions
182-
\[Optional\] If specified, the instructions for connecting to the Windows Package Manager rest source.
182+
\[Optional\] If specified, the instructions for connecting to the Windows Package Manager REST source.
183183
(Default: False)
184184
185185
```yaml

Tools/PowershellModule/doc/PowerShell/Remove-WinGetManifest.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Remove-WinGetManifest
99

1010
## SYNOPSIS
11-
Removes a Manifest file from the Azure rest source
11+
Removes a Manifest file from the Azure REST source
1212

1313
## SYNTAX
1414

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

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

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

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

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

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

5757
## PARAMETERS
5858

5959
### -URL
60-
Name of the URL that hosts the rest source.
60+
Name of the URL that hosts the REST source.
6161

6262
```yaml
6363
Type: String
@@ -87,7 +87,7 @@ Accept wildcard characters: False
8787
```
8888
8989
### -FunctionName
90-
Name of the Azure Function that hosts the rest source.
90+
Name of the Azure Function that hosts the REST source.
9191
9292
```yaml
9393
Type: String
@@ -117,7 +117,7 @@ Accept wildcard characters: False
117117
```
118118
119119
### -SubscriptionName
120-
\[Optional\] The Subscription name contains the Windows Package Manager rest source
120+
\[Optional\] The Subscription name contains the Windows Package Manager REST source
121121
122122
```yaml
123123
Type: String

0 commit comments

Comments
 (0)