-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New powershell module for Edge Marketplace #29077
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.
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
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
9dff335
New powershell module for Edge Marketplace
aviranjan24 39e9dbe
Updated powershell module to remove publisher Apis
aviranjan24 f56f6bb
Added test recordings and custom cmdlets
aviranjan24 d011239
Merge branch 'main' into edgeMarketplace
aviranjan24 5647f2f
Added download instruction in readme
aviranjan24 9d34a6a
Update custom commands and added recordings
aviranjan24 bc3a3cd
Env file changed
aviranjan24 0d5c299
Update custom cmdlets to only execute in live mode
aviranjan24 180cc23
Updated examples
aviranjan24 7e5cf88
Updated description for cmdlets
aviranjan24 0f383f6
Dummy commit
aviranjan24 54ab897
Changed powershell generator from tsp-client to New-TSPModule
aviranjan24 beb9088
Update command and parameter description
aviranjan24 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| * text=auto |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| bin | ||
| obj | ||
| .vs | ||
| generated | ||
| internal | ||
| exports | ||
| tools | ||
| test/*-TestResults.xml | ||
| license.txt | ||
| /*.ps1 | ||
| /*.psd1 | ||
| /*.ps1xml | ||
| /*.psm1 | ||
| /*.snk | ||
| /*.csproj | ||
| /*.nuspec |
29 changes: 29 additions & 0 deletions
29
src/EdgeMarketplace/EdgeMarketplace.Autorest/Properties/AssemblyInfo.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. See License.txt in the project root for license information. | ||
| // Changes may cause incorrect behavior and will be lost if the code is regenerated. | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the Apache License, Version 2.0 (the ""License""); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an ""AS IS"" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code | ||
| // is regenerated. | ||
|
|
||
| using System; | ||
| using System.Reflection; | ||
| using System.Runtime.CompilerServices; | ||
| using System.Runtime.InteropServices; | ||
|
|
||
| [assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")] | ||
| [assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")] | ||
| [assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")] | ||
| [assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - EdgeMarketplaceClient")] | ||
| [assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.0")] | ||
| [assembly: System.Reflection.AssemblyVersionAttribute("0.1.0")] | ||
| [assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] | ||
| [assembly: System.CLSCompliantAttribute(false)] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| <!-- region Generated --> | ||
| # Az.EdgeMarketplace | ||
| This directory contains the PowerShell module for the EdgeMarketplace service. | ||
|
|
||
| --- | ||
| ## Info | ||
| - Modifiable: yes | ||
| - Generated: all | ||
| - Committed: yes | ||
| - Packaged: yes | ||
|
|
||
| --- | ||
| ## Detail | ||
| This module was primarily generated via [AutoRest](https://github.com/Azure/autorest) using the [PowerShell](https://github.com/Azure/autorest.powershell) extension. | ||
|
|
||
| ## Module Requirements | ||
| - [Az.Accounts module](https://www.powershellgallery.com/packages/Az.Accounts/), version 2.7.5 or greater | ||
|
|
||
| ## Authentication | ||
| AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent. | ||
|
|
||
| ## Development | ||
| For information on how to develop for `Az.EdgeMarketplace`, see [how-to.md](how-to.md). | ||
| <!-- endregion --> | ||
42 changes: 42 additions & 0 deletions
42
src/EdgeMarketplace/EdgeMarketplace.Autorest/UX/Microsoft.EdgeMarketplace/offers.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| { | ||
| "resourceType": "offers", | ||
| "apiVersion": "2025-10-01-preview", | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.edgemarketplace" | ||
| }, | ||
| "commands": [ | ||
| { | ||
| "name": "Get-AzEdgeMarketplaceOffer", | ||
| "description": "Retrieves a list of all available marketplace offers for a given device.", | ||
| "path": "/{resourceUri}/providers/Microsoft.EdgeMarketplace/offers/{offerId}", | ||
| "help": { | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.edgemarketplace/get-azedgemarketplaceoffer" | ||
| }, | ||
| "parameterSets": [ | ||
| { | ||
| "parameters": [ | ||
| "-Id <String>", | ||
| "-ResourceUri <String>" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "examples": [ | ||
| { | ||
| "description": "Retrieves a list of all available marketplace offers for a given device.", | ||
| "parameters": [ | ||
| { | ||
| "name": "-Id", | ||
| "value": "[Path.offerId]" | ||
| }, | ||
| { | ||
| "name": "-ResourceUri", | ||
| "value": "[Path.resourceUri]" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } |
17 changes: 17 additions & 0 deletions
17
src/EdgeMarketplace/EdgeMarketplace.Autorest/custom/Az.EdgeMarketplace.custom.psm1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # region Generated | ||
| # Load the private module dll | ||
| $null = Import-Module -PassThru -Name (Join-Path $PSScriptRoot '../bin/Az.EdgeMarketplace.private.dll') | ||
|
|
||
| # Load the internal module | ||
| $internalModulePath = Join-Path $PSScriptRoot '../internal/Az.EdgeMarketplace.internal.psm1' | ||
| if(Test-Path $internalModulePath) { | ||
| $null = Import-Module -Name $internalModulePath | ||
| } | ||
|
|
||
| # Export nothing to clear implicit exports | ||
| Export-ModuleMember | ||
|
|
||
| # Export script cmdlets | ||
| Get-ChildItem -Path $PSScriptRoot -Recurse -Include '*.ps1' -File | ForEach-Object { . $_.FullName } | ||
| Export-ModuleMember -Function (Get-ScriptCmdlet -ScriptFolder $PSScriptRoot) -Alias (Get-ScriptCmdlet -ScriptFolder $PSScriptRoot -AsAlias) | ||
| # endregion |
41 changes: 41 additions & 0 deletions
41
src/EdgeMarketplace/EdgeMarketplace.Autorest/custom/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Custom | ||
| This directory contains custom implementation for non-generated cmdlets for the `Az.EdgeMarketplace` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `../exports` folder. The only generated file into this folder is the `Az.EdgeMarketplace.custom.psm1`. This file should not be modified. | ||
|
|
||
| ## Info | ||
| - Modifiable: yes | ||
| - Generated: partial | ||
| - Committed: yes | ||
| - Packaged: yes | ||
|
|
||
| ## Details | ||
| For `Az.EdgeMarketplace` to use custom cmdlets, it does this two different ways. We **highly recommend** creating script cmdlets, as they are easier to write and allow access to the other exported cmdlets. C# cmdlets *cannot access exported cmdlets*. | ||
|
|
||
| For C# cmdlets, they are compiled with the rest of the generated low-level cmdlets into the `./bin/Az.EdgeMarketplace.private.dll`. The names of the cmdlets (methods) and files must follow the `[cmdletName]_[variantName]` syntax used for generated cmdlets. The `variantName` is used as the `ParameterSetName`, so use something appropriate that doesn't clash with already created variant or parameter set names. You cannot use the `ParameterSetName` property in the `Parameter` attribute on C# cmdlets. Each cmdlet must be separated into variants using the same pattern as seen in the `generated/cmdlets` folder. | ||
|
|
||
| For script cmdlets, these are loaded via the `Az.EdgeMarketplace.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build. | ||
|
|
||
| ## Purpose | ||
| This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `../exports` folder. | ||
|
|
||
| ## Usage | ||
| The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `../exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters: | ||
| - Break | ||
| - DefaultProfile | ||
| - HttpPipelineAppend | ||
| - HttpPipelinePrepend | ||
| - Proxy | ||
| - ProxyCredential | ||
| - ProxyUseDefaultCredentials | ||
|
|
||
| These provide functionality to our HTTP pipeline and other useful features. In script, you can forward these parameters using `$PSBoundParameters` to the other cmdlets you're calling within `Az.EdgeMarketplace`. For C#, follow the usage seen in the `ProcessRecordAsync` method. | ||
|
|
||
| ### Attributes | ||
| For processing the cmdlets, we've created some additional attributes: | ||
| - `Microsoft.Azure.PowerShell.Cmdlets.EdgeMarketplace.DescriptionAttribute` | ||
| - Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts. | ||
| - `Microsoft.Azure.PowerShell.Cmdlets.EdgeMarketplace.DoNotExportAttribute` | ||
| - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.EdgeMarketplace`. | ||
| - `Microsoft.Azure.PowerShell.Cmdlets.EdgeMarketplace.InternalExportAttribute` | ||
| - Used in C# cmdlets to route exported cmdlets to the `../internal`, which are *not exposed* by `Az.EdgeMarketplace`. For more information, see [README.md](../internal/README.md) in the `../internal` folder. | ||
| - `Microsoft.Azure.PowerShell.Cmdlets.EdgeMarketplace.ProfileAttribute` | ||
| - Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.