-
Notifications
You must be signed in to change notification settings - Fork 4.1k
App Config RP 2024-06-01 #29313
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
App Config RP 2024-06-01 #29313
Changes from all commits
0491e8b
8d1c364
611ddb0
dc6f70f
55405e1
2ffbffe
4d79ab4
a33757a
9294ee3
016e090
27e6f2a
0c29be7
e850c36
e56e736
b4e12bc
2da4999
4f81a9e
725dc08
07e9a84
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -25,15 +25,13 @@ For information on how to develop for `Az.AppConfiguration`, see [how-to.md](how | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Generation Requirements | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Use of the beta version of `autorest.powershell` generator requires the following: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [NodeJS LTS](https://nodejs.org) (10.15.x LTS preferred) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - **Note**: It *will not work* with Node < 10.x. Using 11.x builds may cause issues as they may introduce instability or breaking changes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| > If you want an easy way to install and update Node, [NVS - Node Version Switcher](../nodejs/installing-via-nvs.md) or [NVM - Node Version Manager](../nodejs/installing-via-nvm.md) is recommended. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [AutoRest](https://aka.ms/autorest) v3 beta <br>`npm install -g autorest@beta`<br> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - PowerShell 6.0 or greater | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Use of the `autorest.powershell` generator requires the following: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [NodeJS LTS](https://nodejs.org) (18.x LTS or greater) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [AutoRest](https://aka.ms/autorest) v3 <br>`npm install -g autorest@latest`<br> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - PowerShell 7.0 or greater | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - If you don't have it installed, you can use the cross-platform npm package <br>`npm install -g pwsh`<br> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - .NET Core SDK 2.0 or greater | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - If you don't have it installed, you can use the cross-platform npm package <br>`npm install -g dotnet-sdk-2.2`<br> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - .NET SDK 8.0 or greater | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - If you don't have it installed, download from [https://dotnet.microsoft.com/download](https://dotnet.microsoft.com/download)<br> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Run Generation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| In this directory, run AutoRest: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
@@ -44,17 +42,37 @@ In this directory, run AutoRest: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| > see https://aka.ms/autorest | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` yaml | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| commit: 7d6b4765562b238310ea80d652ac08597fec0476 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| commit: 45cbb1a2b5a68c01b7182dbcaa57c3052f992647 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| require: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - $(this-folder)/../../readme.azure.noprofile.md | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| input-file: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - $(repo)/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - $(repo)/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2024-06-01/appconfiguration.json | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| module-version: 1.0.0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| title: AppConfiguration | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| subject-prefix: $(service-name) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| directive: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Strip x-ms-identifiers extension to avoid schema validation errors | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - from: swagger-document | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| where: $.definitions.OperationDefinitionListResult.properties.value | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transform: delete $['x-ms-identifiers'] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - from: swagger-document | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| where: $.definitions.ServiceSpecification.properties.logSpecifications | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transform: delete $['x-ms-identifiers'] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - from: swagger-document | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| where: $.definitions.ServiceSpecification.properties.metricSpecifications | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transform: delete $['x-ms-identifiers'] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - from: swagger-document | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| where: $.definitions.MetricSpecification.properties.dimensions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transform: delete $['x-ms-identifiers'] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - from: swagger-document | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| where: $.definitions.ErrorDetails.properties.additionalInfo | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transform: delete $['x-ms-identifiers'] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+56
to
+71
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Strip x-ms-identifiers extension to avoid schema validation errors | |
| - from: swagger-document | |
| where: $.definitions.OperationDefinitionListResult.properties.value | |
| transform: delete $['x-ms-identifiers'] | |
| - from: swagger-document | |
| where: $.definitions.ServiceSpecification.properties.logSpecifications | |
| transform: delete $['x-ms-identifiers'] | |
| - from: swagger-document | |
| where: $.definitions.ServiceSpecification.properties.metricSpecifications | |
| transform: delete $['x-ms-identifiers'] | |
| - from: swagger-document | |
| where: $.definitions.MetricSpecification.properties.dimensions | |
| transform: delete $['x-ms-identifiers'] | |
| - from: swagger-document | |
| where: $.definitions.ErrorDetails.properties.additionalInfo | |
| transform: delete $['x-ms-identifiers'] | |
| # Strip x-ms-identifiers extension to avoid schema validation errors | |
| # Remove x-ms-identifiers from operation list items to keep the collection schema compatible with AutoRest/PowerShell generation | |
| - from: swagger-document | |
| where: $.definitions.OperationDefinitionListResult.properties.value | |
| transform: delete $['x-ms-identifiers'] | |
| # Remove x-ms-identifiers from logSpecifications to avoid validation issues on the service diagnostics definition | |
| - from: swagger-document | |
| where: $.definitions.ServiceSpecification.properties.logSpecifications | |
| transform: delete $['x-ms-identifiers'] | |
| # Remove x-ms-identifiers from metricSpecifications to prevent schema extension conflicts in metrics metadata | |
| - from: swagger-document | |
| where: $.definitions.ServiceSpecification.properties.metricSpecifications | |
| transform: delete $['x-ms-identifiers'] | |
| # Remove x-ms-identifiers from metric dimensions so the dimensions array schema passes AutoRest validation | |
| - from: swagger-document | |
| where: $.definitions.MetricSpecification.properties.dimensions | |
| transform: delete $['x-ms-identifiers'] | |
| # Remove x-ms-identifiers from error additionalInfo entries to avoid validation issues on extended error payloads | |
| - from: swagger-document | |
| where: $.definitions.ErrorDetails.properties.additionalInfo | |
| transform: delete $['x-ms-identifiers'] | |
| # Remove x-ms-identifiers from snapshot filters so the filters collection schema is compatible with the generator |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| { | ||
| "resourceType": "configurationStores/replicas", | ||
| "apiVersion": "2024-06-01", | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.appconfiguration" | ||
| }, | ||
| "commands": [ | ||
| { | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we add the |
||
| "name": "Get-AzAppConfigurationReplica", | ||
| "description": "Gets the properties of the specified replica.", | ||
| "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas/{replicaName}", | ||
| "help": { | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.appconfiguration/get-azappconfigurationreplica" | ||
| }, | ||
| "parameterSets": [ | ||
| { | ||
| "parameters": [ | ||
| "-ConfigStoreName <String>", | ||
| "-Name <String>", | ||
| "-ResourceGroupName <String>", | ||
| "[-SubscriptionId <String[]>]" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "examples": [ | ||
| { | ||
| "description": "Gets the properties of the specified replica.", | ||
| "parameters": [ | ||
| { | ||
| "name": "-ConfigStoreName", | ||
| "value": "[Path.configStoreName]" | ||
| }, | ||
| { | ||
| "name": "-Name", | ||
| "value": "[Path.replicaName]" | ||
| }, | ||
| { | ||
| "name": "-ResourceGroupName", | ||
| "value": "[Path.resourceGroupName]" | ||
| }, | ||
| { | ||
| "name": "-SubscriptionId", | ||
| "value": "[Path.subscriptionId]" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "Remove-AzAppConfigurationReplica", | ||
| "description": "Deletes a replica.", | ||
| "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas/{replicaName}", | ||
| "help": { | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.appconfiguration/remove-azappconfigurationreplica" | ||
| }, | ||
| "parameterSets": [ | ||
| { | ||
| "parameters": [ | ||
| "-ConfigStoreName <String>", | ||
| "-Name <String>", | ||
| "-ResourceGroupName <String>", | ||
| "[-SubscriptionId <String>]" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "examples": [ | ||
| { | ||
| "description": "Deletes a replica.", | ||
| "parameters": [ | ||
| { | ||
| "name": "-ConfigStoreName", | ||
| "value": "[Path.configStoreName]" | ||
| }, | ||
| { | ||
| "name": "-Name", | ||
| "value": "[Path.replicaName]" | ||
| }, | ||
| { | ||
| "name": "-ResourceGroupName", | ||
| "value": "[Path.resourceGroupName]" | ||
| }, | ||
| { | ||
| "name": "-SubscriptionId", | ||
| "value": "[Path.subscriptionId]" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,6 +1,6 @@ | ||||||
| --- | ||||||
| Module Name: Az.AppConfiguration | ||||||
| Module Guid: eb7a20d7-4675-4932-b491-c24a29f7519e | ||||||
| Module Guid: 6017deb0-bdea-4770-ab56-df3ec463176b | ||||||
|
||||||
| Module Guid: 6017deb0-bdea-4770-ab56-df3ec463176b | |
| Module Guid: 3ff16738-381e-4d5a-9d90-c7ef6816f78e |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The AutoRest config is updated to the 2024-06-01 spec, but the checked-in generated module outputs under
generated/AppConfiguration/AppConfiguration.Autoreststill appear to target the old API version (no2024-06-01references) and do not include the new Replica cmdlets. Please re-run generation and commit the updated generated outputs (or ensure the build regenerates them) so the actual shipped module matches the updated docs/manifest.