Skip to content

Commit d80e01d

Browse files
RDMacLachlanroymaclachlanjamespikpalenshusdenelon
authored
Documentation update (#87)
* Automation of new Azure Repo Using PowerShell builds the ARM Parameters files, runs them against the ARM Template files to generate the required objects. Creates new keys in the keyvault. * Updates Updated Function and script parameters for the construction of the private repo. Added a new library that offers a new function allowing for adding new manifests to the repo. * Update PrivateRepoLib.ps1 * Update * Update new-private-repository-azure.md Initial attempt at instructions * Update new-private-repository-azure.md * Update new-private-repository-azure.md * Update new-private-repository-azure.md * Update new-private-repository-azure.md * Update new-private-repository-azure.md * Update new-private-repository-azure.md * Included PowerShell Module Checking Checks for the required Azure Modules before running the script. * Update .gitignore * Update .gitignore * Update .gitignore * Updated Automation Script - Included PowerShell Module Detection - Updated Get-Help Description - Included information on how to connect to your new private repo - Cleaned up code * Update PrivateRepoLib.ps1 Included a Class for use with the Automation script. * Removed ARMObject Class * Update new-private-repository-azure.md - Updated instructions with missing steps - Corrected steps on setting up the Cosmos Account/DB/Container. - Organized the Key Vault steps. * Update automation.ps1 Moved a hardcoded value to variable, and set it in the Begin stage of the function for easy update / reference. * Update new-private-repository-azure.md Updated the Cosmos DB Account instructions to include Firewall exception rule. * Update automation.ps1 Moved the ArchiveFunction path to be a script parameter input. * Moved Scripts to new home * Update .gitignore Updating the Ignore list to include *.zip files in the root of the Infrastructure folder. * Update keyvault.sample.json Removed person object ID * Delete CompiledFunctions.zip Deleted * Update README.md Updated path and included link to automation.ps1 script * Update PrivateRepoLib.ps1 Removed custom class * Update .gitignore Co-authored-by: jamespik <[email protected]> * Update README.md Thank you! Co-authored-by: jamespik <[email protected]> * Update README.md Co-authored-by: jamespik <[email protected]> * Update Tools/PrivateRepoLib.ps1 Co-authored-by: jamespik <[email protected]> * Update Tools/PrivateRepoLib.ps1 Co-authored-by: jamespik <[email protected]> * Update README.md Co-authored-by: jamespik <[email protected]> * Update automation.ps1 Corrected the reporting to show "Install" instead of "Import" * Update PrivateRepoLib.ps1 Expanded the validation and error checking of the PowerShell function library. * Update automation.ps1 Corrected relative path to Archive file and the parameter and template folders. * Update automation.ps1 Corrected the relative path to the Archive files and the template and parameter folders Updated the warning message to read as Install-Module instead of Import-Module * Update PrivateRepoLib.ps1 Import error reporting * Update PrivateRepoLib.ps1 Enhanced error checking * Update new-private-repository-azure.md Updated the name from "private repository" to "private source" Added instructions on how to use the script lib to add manifests to the private source. * Update automation.ps1 Lots of Updates * Update PrivateRepoLib.ps1 Cleaned up comments * Updated Scripts Code Review Updates. * Updated Comments and uncommented build call * Major update Major updates to the PrivateRepoLib.ps1 * Update PrivateRepoLib.ps1 * Imported PowerShell Module Imported the Microsoft.WinGet.Source PowerShell module. Moved old scripts to an "Old" folder (temporarily before deletion.). * Update Add-WinGetManifest.ps1 Bulk Add manifests to WinGet Source * Added Comments and Get-Help information * Removed Old Code * Update Remove-WinGetManifest.ps1 * Updated and new Documetnation * Fixed Demo *.yaml files * Included new Sample app manifests * Included MyEmployees-Finance as a Sample app * Cleaned up Respository * Update solution, remove files that should be sourced from build. * Removing content that doesn't belong in the repo. * Update solution view * Delete extraneous changes from keyvault sample template * Update solution items and remove bogus git ignore items * remove extraneous metadata * update * Documentation update * documentation update * Git Hub corrections. * New Read and Write Keys Updated template AzureFunction.JSON, and Script. Keyvault keys are created and the Function references them. * Pushing changes. * Add details about IP addresses * Trim extra behavior from remove manifest * Adding CosmosDatabase and CosmosContainer to function ARM * Removed reference to $Index * Line Length normalization * Enabled Add-WinGetManifest to add new or update * Removed Debugging * Documentation Update * Update new-private-repository-azure.md * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: jamespik <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update Tools/PowershellModule/doc/new-private-repository-azure.md Co-authored-by: denelon <[email protected]> * Update new-private-repository-azure.md * Update new-private-repository-azure.md * Update new-private-repository-azure.md * Update new-private-repository-azure.md * Update * Updated * Update new-winget-rest-source-azure.md * REST * Private * Manifest to Package ID * Update new-winget-rest-source-azure.md * Update new-winget-rest-source-azure.md * Defaults * Fixed some excess capitalization * Example standardization * Title Changes * Update Add-AzureResourceGroup.ps1 * Update Tools/PowershellModule/doc/new-winget-rest-source-azure.md Co-authored-by: jamespik <[email protected]> * Update new-winget-rest-source-azure.md * Update new-winget-rest-source-azure.md * Update new-winget-rest-source-azure.md * Update new-winget-rest-source-azure.md * Update new-winget-rest-source-azure.md * Update new-winget-rest-source-azure.md * Update new-winget-rest-source-azure.md * Update new-winget-rest-source-azure.md * Relative links * WinGet.RestSource.Functions.zip * Update Tools/PowershellModule/src/Library/New-WinGetSource.ps1 * Update Tools/PowershellModule/doc/PowerShell/Get-WinGetManifest.md * Update Tools/PowershellModule/src/Library/Add-WinGetManifest.ps1 * Apply suggestions from code review * Apply suggestions from code review * Naming and caps Co-authored-by: roymaclachlan <[email protected]> Co-authored-by: jamespik <[email protected]> Co-authored-by: Union Palenshus <[email protected]> Co-authored-by: denelon <[email protected]>
1 parent 15805cb commit d80e01d

16 files changed

+290
-382
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,24 @@ The following Azure Modules are used by this script:
3030

3131
### EXAMPLE 1
3232
```
33-
Add-WinGetManifest -FunctionName "PrivateSource" -Path "C:\AppManifests\Microsoft.PowerToys\PowerToys.json"
33+
Add-WinGetManifest -FunctionName "contosorestsource" -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 "contosorestsource" REST APIs to add the specified Manifest file (*.json) to the Windows Package Manager REST source
3737

3838
### EXAMPLE 2
3939
```
40-
Add-WinGetManifest -FunctionName "PrivateSource" -Path "C:\AppManifests\Microsoft.PowerToys\"
40+
Add-WinGetManifest -FunctionName "contosorestsource" -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 "contosorestsource" 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
```
47-
Add-WinGetManifest -FunctionName "PrivateSource" -Path "C:\AppManifests\Microsoft.PowerToys\PowerToys.json" -SubscriptionName "Visual Studio Subscription"
47+
Add-WinGetManifest -FunctionName "contosorestsource" -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 "contosorestsource" REST APIs to add the specified Manifest file (*.json) to the Windows Package Manager REST source
5151

5252
## PARAMETERS
5353

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

Lines changed: 10 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ 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.
11+
Connects to the specified source REST API, or local file system path to retrieve the package Manifests, returning an array of all Manifests found.
1212
Allows for filtering results based on the name when targetting the REST APIs.
1313

1414
## SYNTAX
@@ -24,13 +24,8 @@ Get-WinGetManifest [-FunctionName] <String> [[-ManifestIdentifier] <String>] [[-
2424
Get-WinGetManifest [-Path] <String> [<CommonParameters>]
2525
```
2626

27-
### Custom
28-
```
29-
Get-WinGetManifest [-URL] <String> [<CommonParameters>]
30-
```
31-
3227
## 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.
28+
Connects to the specified source REST API, or local file system path to retrieve the package Manifests, returning an array of all Manifests found.
3429
Allows for filtering results based on the name.
3530

3631
The following Azure Modules are used by this script:
@@ -46,35 +41,35 @@ The following Azure Modules are used by this script:
4641
Get-WinGetManifest -Path "C:\AppManifests\Microsoft.PowerToys"
4742
```
4843

49-
Returns an array of all Manifest objects based on the files found within the specified Path.
44+
Returns an array of the Package Manifest objects based on the files (*.yaml or *.json) found within the specified Path.
5045

5146
### EXAMPLE 2
5247
```
5348
Get-WinGetManifest -Path "C:\AppManifests\Microsoft.PowerToys\Microsoft.PowerToys.json"
5449
```
5550

56-
Returns a Manifest object (*.json) of the specified JSON file.
51+
Returns a Package Manifest object of the specified JSON file.
5752

5853
### EXAMPLE 3
5954
```
60-
Get-WinGetManifest -FunctionName "PrivateSource" -ManifestIdentifier "Windows.PowerToys"
55+
Get-WinGetManifest -FunctionName "contosorestsource" -ManifestIdentifier "Windows.PowerToys"
6156
```
6257

63-
Returns a Manifest object of the specified Manifest Identifier that is queried against in the REST APIs.
58+
Returns an Manifest object of the specified Application Package Identifier that is queried against in the REST APIs.
6459

6560
### EXAMPLE 4
6661
```
67-
Get-WinGetManifest -FunctionName "PrivateSource" -ManifestIdentifier "Windows.PowerToys" -SubscriptionName "Visual Studio Subscription"
62+
Get-WinGetManifest -FunctionName "contosorestsource" -ManifestIdentifier "Windows.PowerToys" -SubscriptionName "Visual Studio Subscription"
6863
```
6964

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

7267
### EXAMPLE 5
7368
```
74-
Get-WinGetManifest -FunctionName "PrivateSource"
69+
Get-WinGetManifest -FunctionName "contosorestsource"
7570
```
7671

77-
Returns an array of Manifest objects that are found in the specified Azure Function.
72+
Returns an array of Package Manifest objects that are found in the specified Azure Function.
7873

7974
## PARAMETERS
8075

@@ -93,21 +88,6 @@ Accept pipeline input: False
9388
Accept wildcard characters: False
9489
```
9590
96-
### -URL
97-
Web URL to the host site containing the REST APIs with access key (if required).
98-
99-
```yaml
100-
Type: String
101-
Parameter Sets: Custom
102-
Aliases:
103-
104-
Required: True
105-
Position: 1
106-
Default value: None
107-
Accept pipeline input: False
108-
Accept wildcard characters: False
109-
```
110-
11191
### -FunctionName
11292
Name of the Azure Function Name that contains the Windows Package Manager REST APIs.
11393

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

Lines changed: 8 additions & 8 deletions
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 storage of Windows Package Manager package 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 storage of Windows Package Manager package Manifests.
2424

2525
The following Azure Modules are used by this script:
2626
Az.Resources
@@ -32,17 +32,17 @@ The following Azure Modules are used by this script:
3232

3333
### EXAMPLE 1
3434
```
35-
New-WinGetSource -Name "contoso0002"
35+
New-WinGetSource -Name "contosorestsource"
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 "contosorestsource" in the westus region of Azure with the basic level performance.
3939

4040
### EXAMPLE 2
4141
```
42-
New-WinGetSource -Name "contoso0002" -ResourceGroup "WinGetSource" -SubscriptionName "Visual Studio Subscription" -Region "westus" -ParameterOutput "C:\WinGet" -ImplementationPerformance "Basic" -ShowConnectionInstructions
42+
New-WinGetSource -Name "contosorestsource" -ResourceGroup "WinGet" -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.
45+
Creates the Windows Package Manager REST source in Azure with resources named "contosorestsource" in the westus region of Azure with the basic level performance in the "Visual Studio Subscription" Subscription.
4646
Displays the required command to connect the WinGet client to the new REST source after the repository has been created.
4747

4848
## PARAMETERS
@@ -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
@@ -119,7 +119,7 @@ Aliases:
119119

120120
Required: False
121121
Position: 5
122-
Default value: Westus
122+
Default value: westus
123123
Accept pipeline input: False
124124
Accept wildcard characters: False
125125
```

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

Lines changed: 3 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,14 @@ Removes a Manifest file from the Azure REST source
1717
Remove-WinGetManifest [[-ManifestIdentifier] <String>] [[-SubscriptionName] <String>] [<CommonParameters>]
1818
```
1919

20-
### Custom
21-
```
22-
Remove-WinGetManifest [-URL] <String> [-Key] <String> [[-ManifestIdentifier] <String>]
23-
[[-SubscriptionName] <String>] [<CommonParameters>]
24-
```
25-
2620
### Azure
2721
```
2822
Remove-WinGetManifest [-FunctionName] <String> [[-ManifestIdentifier] <String>] [[-SubscriptionName] <String>]
2923
[<CommonParameters>]
3024
```
3125

3226
## DESCRIPTION
33-
This function will connect to the Azure Tenant that hosts the Windows Package Manager REST source, removing the specified application Manifest.
27+
This function will connect to the Azure Tenant that hosts the Windows Package Manager REST source, removing the specified package Manifest.
3428

3529
The following Azure Modules are used by this script:
3630
Az.Resources
@@ -42,50 +36,13 @@ The following Azure Modules are used by this script:
4236

4337
### EXAMPLE 1
4438
```
45-
Remove-WinGetManifest -FunctionName "RestSource" -ManifestIdentifier "Windows.PowerToys"
46-
```
47-
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
49-
50-
### EXAMPLE 2
51-
```
52-
Remove-WinGetManifest -URL "https://contoso.azure.web.net/api/packageManifests" -ManifestIdentifier "Windows.PowerToys"
39+
Remove-WinGetManifest -FunctionName "contosorestsource" -ManifestIdentifier "Windows.PowerToys"
5340
```
5441

55-
Connects to a remote URL REST APIs to remove the Application Manifest from the Windows Package Manager REST source
42+
Connects to Azure, then runs the Azure Function "contosorestsource" REST APIs to remove the specified Manifest file from the Windows Package Manager REST source
5643

5744
## PARAMETERS
5845

59-
### -URL
60-
Name of the URL that hosts the REST source.
61-
62-
```yaml
63-
Type: String
64-
Parameter Sets: Custom
65-
Aliases:
66-
67-
Required: True
68-
Position: 1
69-
Default value: None
70-
Accept pipeline input: False
71-
Accept wildcard characters: False
72-
```
73-
74-
### -Key
75-
{{ Fill Key Description }}
76-
77-
```yaml
78-
Type: String
79-
Parameter Sets: Custom
80-
Aliases:
81-
82-
Required: True
83-
Position: 2
84-
Default value: None
85-
Accept pipeline input: False
86-
Accept wildcard characters: False
87-
```
88-
8946
### -FunctionName
9047
Name of the Azure Function that hosts the REST source.
9148

0 commit comments

Comments
 (0)