Skip to content

Adding PowerShell module for the EdgeZones service #24450

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 10 commits into from
Apr 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions src/EdgeZones/EdgeZones.Autorest/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto
16 changes: 16 additions & 0 deletions src/EdgeZones/EdgeZones.Autorest/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
bin
obj
.vs
generated
internal
exports
tools
custom/*.psm1
custom/autogen-model-cmdlets
test/*-TestResults.xml
/*.ps1
/*.ps1xml
/*.psm1
/*.snk
/*.csproj
/*.nuspec
23 changes: 23 additions & 0 deletions src/EdgeZones/EdgeZones.Autorest/Az.EdgeZones.psd1
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
@{
GUID = '40bf94d1-ec66-4236-9396-2eac6bd6b1fe'
RootModule = './Az.EdgeZones.psm1'
ModuleVersion = '0.1.0'
CompatiblePSEditions = 'Core', 'Desktop'
Author = 'Microsoft Corporation'
CompanyName = 'Microsoft Corporation'
Copyright = 'Microsoft Corporation. All rights reserved.'
Description = 'Microsoft Azure PowerShell: EdgeZones cmdlets'
PowerShellVersion = '5.1'
DotNetFrameworkVersion = '4.7.2'
RequiredAssemblies = './bin/Az.EdgeZones.private.dll'
FormatsToProcess = './Az.EdgeZones.format.ps1xml'
FunctionsToExport = 'Get-AzEdgeZonesExtendedZone', 'Register-AzEdgeZonesExtendedZone', 'Unregister-AzEdgeZonesExtendedZone'
PrivateData = @{
PSData = @{
Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'EdgeZones'
LicenseUri = 'https://aka.ms/azps-license'
ProjectUri = 'https://github.com/Azure/azure-powershell'
ReleaseNotes = ''
}
}
}
80 changes: 80 additions & 0 deletions src/EdgeZones/EdgeZones.Autorest/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<!-- region Generated -->
# Az.EdgeZones
This directory contains the PowerShell module for the EdgeZones 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.EdgeZones`, see [how-to.md](how-to.md).
<!-- endregion -->

### AutoRest Configuration
> see https://aka.ms/autorest

```yaml
# pin the swagger version by using the commit id instead of branch name
commit: 2d973fccf9f28681a481e9760fa12b2334216e21
require:
# readme.azure.noprofile.md is the common configuration file
- $(this-folder)/../../readme.azure.noprofile.md
- $(repo)/specification/edgezones/resource-manager/readme.md
# If the swagger has not been put in the repo, you may uncomment the following line and refer to it locally
# - (this-folder)/relative-path-to-your-local-readme.md

try-require:
- $(repo)/specification/edgezones/resource-manager/readme.powershell.md

# For new RP, the version is 0.1.0
module-version: 0.1.0
# Normally, title is the service name
title: EdgeZones
subject-prefix: $(service-name)

# The next three configurations are exclusive to v3, and in v4, they are activated by default. If you are still using v3, please uncomment them.
# identity-correction-for-post: true
# resourcegroup-append: true
# nested-object-to-string: true

directive:
# Following are common directives which are normally required in all the RPs
# 1. Remove the unexpanded parameter set
# 2. For New-* cmdlets, ViaIdentity is not required
# Following two directives are v4 specific
- where:
variant: ^(Create|Update)(?!.*?(Expanded|JsonFilePath|JsonString))
remove: true
- where:
variant: ^CreateViaIdentity.*$
remove: true
# Follow directive is v3 specific. If you are using v3, uncomment following directive and comments out two directives above
#- where:
# variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$
# remove: true

# Remove the set-* cmdlet
- where:
verb: Set
remove: true

# Add preview announcement
- where:
subject: EdgeZones
set:
preview-announcement:
preview-message: This is a preview version of Azure Extended Zones.
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
{
"resourceType": "extendedZones",
"apiVersion": "2024-04-01-preview",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.edgezones"
},
"commands": [
{
"name": "Get-AzEdgeZonesExtendedZone",
"description": "Gets an Azure Extended Zone for a subscription",
"path": "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeZones/extendedZones/{extendedZoneName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.edgezones/get-azedgezonesextendedzone"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"[-SubscriptionId <String[]>]"
]
}
]
},
"examples": [
{
"description": "Gets an Azure Extended Zone for a subscription",
"parameters": [
{
"name": "-Name",
"value": "[Path.extendedZoneName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
},
{
"name": "Register-AzEdgeZonesExtendedZone",
"description": "Registers a subscription for an Extended Zone",
"path": "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeZones/extendedZones/{extendedZoneName}/register",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.edgezones/register-azedgezonesextendedzone"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"[-SubscriptionId <String>]"
]
}
]
},
"examples": [
{
"description": "Registers a subscription for an Extended Zone",
"parameters": [
{
"name": "-Name",
"value": "[Path.extendedZoneName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
},
{
"name": "Unregister-AzEdgeZonesExtendedZone",
"description": "Unregisters a subscription for an Extended Zone",
"path": "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeZones/extendedZones/{extendedZoneName}/unregister",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.edgezones/unregister-azedgezonesextendedzone"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"[-SubscriptionId <String>]"
]
}
]
},
"examples": [
{
"description": "Unregisters a subscription for an Extended Zone",
"parameters": [
{
"name": "-Name",
"value": "[Path.extendedZoneName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
}
]
}
41 changes: 41 additions & 0 deletions src/EdgeZones/EdgeZones.Autorest/custom/README.md
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.EdgeZones` 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.EdgeZones.custom.psm1`. This file should not be modified.

## Info
- Modifiable: yes
- Generated: partial
- Committed: yes
- Packaged: yes

## Details
For `Az.EdgeZones` 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.EdgeZones.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.EdgeZones.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.EdgeZones`. 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.EdgeZones.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.EdgeZones.DoNotExportAttribute`
- Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.EdgeZones`.
- `Microsoft.Azure.PowerShell.Cmdlets.EdgeZones.InternalExportAttribute`
- Used in C# cmdlets to route exported cmdlets to the `..\internal`, which are *not exposed* by `Az.EdgeZones`. For more information, see [README.md](..\internal/README.md) in the `..\internal` folder.
- `Microsoft.Azure.PowerShell.Cmdlets.EdgeZones.ProfileAttribute`
- Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules.
22 changes: 22 additions & 0 deletions src/EdgeZones/EdgeZones.Autorest/docs/Az.EdgeZones.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
Module Name: Az.EdgeZones
Module Guid: 40bf94d1-ec66-4236-9396-2eac6bd6b1fe
Download Help Link: https://learn.microsoft.com/powershell/module/az.edgezones
Help Version: 1.0.0.0
Locale: en-US
---

# Az.EdgeZones Module
## Description
Microsoft Azure PowerShell: EdgeZones cmdlets

## Az.EdgeZones Cmdlets
### [Get-AzEdgeZonesExtendedZone](Get-AzEdgeZonesExtendedZone.md)
Gets an Azure Extended Zone for a subscription

### [Register-AzEdgeZonesExtendedZone](Register-AzEdgeZonesExtendedZone.md)
Registers a subscription for an Extended Zone

### [Unregister-AzEdgeZonesExtendedZone](Unregister-AzEdgeZonesExtendedZone.md)
Unregisters a subscription for an Extended Zone

Loading