azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Add stable deployment stacks swagger

Open kalbert312 opened this issue 1 year ago • 9 comments

ARM (Control Plane) API Specification Update Pull Request

[!TIP] Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

[!NOTE] As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

Click here to see the details of Step 1

Breaking changes review (Diagram Step 1)

If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you, you must follow the breaking changes process.
IMPORTANT This applies even if:

  • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
  • You believe there is no need for you to request breaking change approval, for any reason. Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2

ARM API changes review (Diagram Step 2)

  • For help with Step 2 / "ARM review", see https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • [ ] New resource provider.
  • [x] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
  • [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • [ ] Update existing version to fix OpenAPI spec quality issues in S360.
  • [ ] Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood and followed the instructions by checking all the boxes:

  • [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • [x] I have reviewed following Resource Provider guidelines, including ARM resource provider contract and REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
  • For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run. This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

kalbert312 avatar Jan 25 '24 17:01 kalbert312

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Swagger Validation Report

️❌BreakingChange: 12 Errors, 0 Warnings failed [Detail]
Compared specs (v0.10.8) new version base version
deploymentStacks.json 2022-08-01-preview(2d25e88) 2022-08-01-preview(main)
deploymentStacks.json 2024-03-01(2d25e88) 2024-03-01(main)
Rule Message
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Resources/stable/2024-03-01/deploymentStacks.json#L37:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Resources/stable/2024-03-01/deploymentStacks.json#L79:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Resources/stable/2024-03-01/deploymentStacks.json#L118:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Resources/stable/2024-03-01/deploymentStacks.json#L157:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Resources/stable/2024-03-01/deploymentStacks.json#L322:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Resources/stable/2024-03-01/deploymentStacks.json#L478:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Resources/stable/2024-03-01/deploymentStacks.json#L634:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Resources/stable/2024-03-01/deploymentStacks.json#L676:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Resources/stable/2024-03-01/deploymentStacks.json#L715:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Resources/stable/2024-03-01/deploymentStacks.json#L754:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Resources/stable/2024-03-01/deploymentStacks.json#L828:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.Resources/stable/2024-03-01/deploymentStacks.json#L899:5
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 2 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
package-deploymentstacks-2022-08-preview package-deploymentstacks-2022-08-preview(2d25e88) package-deploymentstacks-2022-08-preview(main)
package-deploymentstacks-2024-03 package-deploymentstacks-2024-03(2d25e88) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
:warning: EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Resources/stable/2024-03-01/deploymentStacks.json#L1051
:warning: EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Resources/stable/2024-03-01/deploymentStacks.json#L1646


The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule Message
OperationsAPIImplementation Operations API must be implemented for 'Microsoft.Resources'.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L1
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L67
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L106
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L145
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L209
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L249
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L307
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L365
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L402
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L457
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L515
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L552
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L610
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L652
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L691
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L730
OperationsAPIImplementation Operations API must be implemented for 'Microsoft.Resources'.
Location: Microsoft.Resources/stable/2024-03-01/deploymentStacks.json#L1
:warning: PreviewVersionOverOneYear The API version:2022-08-01-preview having been in a preview state over one year , please move it to GA or retire.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L6
:warning: LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L51
:warning: LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L54
:warning: LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L57
:warning: UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: DeploymentStacksList
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L86
:warning: LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L93
:warning: LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L96
:warning: UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: DeploymentStacksList
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L125
:warning: LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L135
:warning: LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L175
:warning: LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L178
:warning: LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L184
:warning: LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.Resources/preview/2022-08-01-preview/deploymentStacks.json#L230
️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
Rule Message
MULTIPLE_DEFAULT_TAGS The readme file has more than one default tag.
readme: specification/resources/resource-manager/readme.md
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️⚠️ azure-sdk-for-net-track2 warning [Detail]
  • ⚠️Warning in generating from 2dc4ea08c1ab4eb3e3417ec73ee842fb2b7b262e. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    warn	No file changes detected after generation
  • ️✔️Azure.ResourceManager.Resources
    • Azure.ResourceManager.Resources.1.8.0-alpha.20240501.1.nupkg
    info	[Changelog]
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning in generating from 2dc4ea08c1ab4eb3e3417ec73ee842fb2b7b262e. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    cmderr	[automation_init.sh]  notice
    cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
    cmderr	[automation_init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0>
    cmderr	[automation_init.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[automation_init.sh] npm notice
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
  • ️✔️azure-mgmt-resource [Preview SDK Changes]
    • azure_mgmt_resource-23.1.0b2-py3-none-any.whl
    • azure-mgmt-resource-23.1.0b2.zip
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Added operation group DeploymentStacksOperations
    info	[Changelog]   - Added operation group PolicyDefinitionVersionsOperations
    info	[Changelog]   - Added operation group PolicySetDefinitionVersionsOperations
    info	[Changelog]   - Model ContainerConfiguration has a new parameter subnet_ids
    info	[Changelog]   - Model Location has a new parameter availability_zone_mappings
    info	[Changelog]   - Model LocationMetadata has a new parameter geography
    info	[Changelog]   - Model Operation has a new parameter action_type
    info	[Changelog]   - Model Operation has a new parameter is_data_action
    info	[Changelog]   - Model Operation has a new parameter origin
    info	[Changelog]   - Model OperationAutoGenerated has a new parameter action_type
    info	[Changelog]   - Model OperationAutoGenerated has a new parameter is_data_action
    info	[Changelog]   - Model OperationAutoGenerated has a new parameter origin
    info	[Changelog]   - Model OperationDisplayAutoGenerated has a new parameter description
    info	[Changelog]   - Model ParameterDefinitionsValue has a new parameter schema
    info	[Changelog]   - Model PolicyDefinition has a new parameter version
    info	[Changelog]   - Model PolicyDefinition has a new parameter versions
    info	[Changelog]   - Model PolicySetDefinition has a new parameter version
    info	[Changelog]   - Model PolicySetDefinition has a new parameter versions
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 2dc4ea08c1ab4eb3e3417ec73ee842fb2b7b262e. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-resources-generated [Preview SDK Changes]
    • pom.xml
    • azure-resourcemanager-resources-generated-1.0.0-beta.1.jar
    • azure-resourcemanager-resources-generated-1.0.0-beta.1-sources.jar
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 2dc4ea08c1ab4eb3e3417ec73ee842fb2b7b262e. SDK Automation 14.0.0
    command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/resources/armresources [Preview SDK Changes] Breaking Change Detected
    Only showing 11 items here. Refer to log for details.
    info	[Changelog]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New enum type `ExportTemplateOutputFormat` with values `ExportTemplateOutputFormatBicep`, `ExportTemplateOutputFormatJSON`
    info	[Changelog] - New struct `DeploymentParameter`
    info	[Changelog] - New struct `KeyVaultParameterReference`
    info	[Changelog] - New struct `KeyVaultReference`
    info	[Changelog] - New field `OutputFormat` in struct `ExportTemplateRequest`
    info	[Changelog] - New field `Output` in struct `ResourceGroupExportResult`
    info	[Changelog]
    info	[Changelog] Total 5 breaking change(s), 11 additive change(s).
    Present SDK breaking changes suppressions
    Operation `*TagsClient.CreateOrUpdateAtScope` has been changed to LRO, use `*TagsClient.BeginCreateOrUpdateAtScope` instead.
    Operation `*TagsClient.DeleteAtScope` has been changed to LRO, use `*TagsClient.BeginDeleteAtScope` instead.
    Operation `*TagsClient.UpdateAtScope` has been changed to LRO, use `*TagsClient.BeginUpdateAtScope` instead.
    Type of `DeploymentProperties.Parameters` has been changed from `any` to `map[string]*DeploymentParameter`
    Type of `DeploymentWhatIfProperties.Parameters` has been changed from `any` to `map[string]*DeploymentParameter`
    Please refer to https://aka.ms/azsdk/sdk-suppression for more information.
  • ️✔️sdk/resourcemanager/resources/armdeploymentscripts [Preview SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New struct `ContainerGroupSubnetID`
    info	[Changelog] - New field `SubnetIDs` in struct `ContainerConfiguration`
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 3 additive change(s).
  • ️✔️sdk/resourcemanager/resources/armfeatures [Preview SDK Changes]
    info	[Changelog] ### Other Changes
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
  • ️✔️sdk/resourcemanager/resources/armlinks [Preview SDK Changes]
    info	[Changelog] ### Other Changes
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
  • ️✔️sdk/resourcemanager/resources/armlocks [Preview SDK Changes]
    info	[Changelog] ### Other Changes
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
  • ️✔️sdk/resourcemanager/resources/armmanagedapplications [Preview SDK Changes]
    info	[Changelog] ### Other Changes
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
  • ️✔️sdk/resourcemanager/resources/armpolicy [Preview SDK Changes]
    Only showing 11 items here. Refer to log for details.
    info	[Changelog] - New struct `DefinitionVersion`
    info	[Changelog] - New struct `DefinitionVersionListResult`
    info	[Changelog] - New struct `DefinitionVersionProperties`
    info	[Changelog] - New struct `SetDefinitionVersion`
    info	[Changelog] - New struct `SetDefinitionVersionListResult`
    info	[Changelog] - New struct `SetDefinitionVersionProperties`
    info	[Changelog] - New field `Version`, `Versions` in struct `DefinitionProperties`
    info	[Changelog] - New field `Schema` in struct `ParameterDefinitionsValue`
    info	[Changelog] - New field `Version`, `Versions` in struct `SetDefinitionProperties`
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 45 additive change(s).
  • ️✔️sdk/resourcemanager/resources/armsubscriptions [Preview SDK Changes]
    info	[Changelog] ### Other Changes
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
  • ️✔️sdk/resourcemanager/resources/armtemplatespecs [Preview SDK Changes]
    info	[Changelog] ### Other Changes
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
  • ️✔️sdk/resourcemanager/resources/armchanges [Preview SDK Changes]
    info	[Changelog] ### Other Changes
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
  • ️✔️sdk/resourcemanager/resources/armdeploymentstacks [Preview SDK Changes] Breaking Change Detected
    Only showing 11 items here. Refer to log for details.
    info	[Changelog] - New struct `DeploymentParameter`
    info	[Changelog] - New struct `DeploymentStackValidateProperties`
    info	[Changelog] - New struct `DeploymentStackValidateResult`
    info	[Changelog] - New struct `KeyVaultParameterReference`
    info	[Changelog] - New struct `KeyVaultReference`
    info	[Changelog] - New field `BypassStackOutOfSyncError` in struct `ClientBeginDeleteAtManagementGroupOptions`
    info	[Changelog] - New field `BypassStackOutOfSyncError`, `UnmanageActionManagementGroups` in struct `ClientBeginDeleteAtResourceGroupOptions`
    info	[Changelog] - New field `BypassStackOutOfSyncError`, `UnmanageActionManagementGroups` in struct `ClientBeginDeleteAtSubscriptionOptions`
    info	[Changelog] - New field `BypassStackOutOfSyncError`, `CorrelationID` in struct `DeploymentStackProperties`
    info	[Changelog]
    info	[Changelog] Total 8 breaking change(s), 20 additive change(s).
    Present SDK breaking changes suppressions
    Struct `DeploymentStackPropertiesActionOnUnmanage` has been removed
    Struct `ErrorResponse` has been removed
    Type of `DeploymentStackProperties.ActionOnUnmanage` has been changed from `*DeploymentStackPropertiesActionOnUnmanage` to `*ActionOnUnmanage`
    Type of `DeploymentStackProperties.Error` has been changed from `*ErrorResponse` to `*ErrorDetail`
    Type of `DeploymentStackProperties.Parameters` has been changed from `any` to `map[string]*DeploymentParameter`
    Type of `ResourceReferenceExtended.Error` has been changed from `*ErrorResponse` to `*ErrorDetail`
    `DeploymentStackProvisioningStateLocking` from enum `DeploymentStackProvisioningState` has been removed
    `ResourceStatusModeNone` from enum `ResourceStatusMode` has been removed
    Please refer to https://aka.ms/azsdk/sdk-suppression for more information.
️🔄 azure-sdk-for-js inProgress [Detail]
️❌ azure-resource-manager-schemas failed [Detail]
  • Pipeline Framework Failed in generating from 2dc4ea08c1ab4eb3e3417ec73ee842fb2b7b262e. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh]  notice
    cmderr	[initScript.sh] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[initScript.sh] npm notice
    warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    fatal: cannot force update the branch 'sdkAuto/27529/resources_resource-manager' used by worktree at '/mnt/vss/_work/1/s/azure-resource-manager-schemas'
  • resources/resource-manager [Preview Schema Changes]
  • resources/resource-manager
    error	Fatal error: fatal: cannot force update the branch 'sdkAuto/27529/resources_resource-manager' used by worktree at '/mnt/vss/_work/1/s/azure-resource-manager-schemas'
    error	Fatal error: Error: fatal: cannot force update the branch 'sdkAuto/27529/resources_resource-manager' used by worktree at '/mnt/vss/_work/1/s/azure-resource-manager-schemas'    at Object.action (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1332:25)    at PluginStore.exec (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1367:29)    at /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1766:43    at new Promise (<anonymous>)    at GitExecutorChain.handleTaskData (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1764:16)    at GitExecutorChain.<anonymous> (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1748:44)    at Generator.next (<anonymous>)    at fulfilled (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:55:24)    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    error	The following packages are still pending:
    error		resources/resource-manager
    error		resources/resource-manager
    error		resources/resource-manager
    error		resources/resource-manager
    error	ERROR: The 'breakingChangesLabel' configuration is missing or incorrect from the 'swagger_to_sdk_config.json file.
  • resources/resource-manager
  • resources/resource-manager
️⚠️ azure-powershell warning [Detail]
  • ⚠️Warning in generating from 2dc4ea08c1ab4eb3e3417ec73ee842fb2b7b262e. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
  • ⚠️Az.resources.DefaultTag [Preview SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

Generated ApiView

Language Package Name ApiView Link
Java azure-resourcemanager-resources-generated https://apiview.dev/Assemblies/Review/69d90a3c09dd41d388271d10f46fbed8?revisionId=9ded205e50fc4d57847c11c6637bde19
Go sdk/resourcemanager/resources/armchanges There is no API change compared with the previous version
Go sdk/resourcemanager/resources/armdeploymentscripts https://apiview.dev/Assemblies/Review/7baaae1d269a4ed7912f863425ad71a0?revisionId=bd0f3816358b489ab63a7878e4d9e70f
Go sdk/resourcemanager/resources/armdeploymentstacks https://apiview.dev/Assemblies/Review/6313d59674254051ac3edf0447ad74de?revisionId=1100066ffabe401b8a80ab0bb74b8d5a
Go sdk/resourcemanager/resources/armfeatures There is no API change compared with the previous version
Go sdk/resourcemanager/resources/armlinks There is no API change compared with the previous version
Go sdk/resourcemanager/resources/armlocks There is no API change compared with the previous version
Go sdk/resourcemanager/resources/armmanagedapplications There is no API change compared with the previous version
Go sdk/resourcemanager/resources/armpolicy https://apiview.dev/Assemblies/Review/307c195eccc840d1b92e75be6564ba10?revisionId=4d6d0e022a614084951214e6359a02af
Go sdk/resourcemanager/resources/armresources https://apiview.dev/Assemblies/Review/12843540e3a1467ea73d364496b55308?revisionId=0693d776781e4d5786f223fa539b7273
Go sdk/resourcemanager/resources/armsubscriptions There is no API change compared with the previous version
Go sdk/resourcemanager/resources/armtemplatespecs There is no API change compared with the previous version
.Net Azure.ResourceManager.Resources There is no API change compared with the previous version
Swagger Microsoft.Resources https://apiview.dev/Assemblies/Review/c6d5ee6adb604c8d98405cc2ea6c8f31?revisionId=44b1e10506144006839a75cb3be8d8ea

Hi @kalbert312! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.

Swagger Validation Report

️❌LintDiff: 8 Errors, 2 Warnings failed [Detail]

  • OperationsAPIImplementation: Confused on this. Is this related to the current directory structure of Microsoft.Resources?
  • DeleteResponseCodes: The LRO endpoint for deleting a stack will return a 200 if the stack can be synchronously deleted. I realize this is discouraged via the guidelines but not marked with an 'X'. Is this something that can be excepted?

️❌Avocado: 1 Errors, 0 Warnings failed [Detail]

This looks to be related to the directory structure. Can this be excepted?

Swagger Generation Artifacts

️❌SDK Breaking Change Tracking failed [Detail]

Not sure what's going on here. Is it related to a missing base commit? I recently force pushed this branch such that the first commit is the copied 2022-08-01-preview swagger without changes.

️❌ azure-sdk-for-python-track2 failed [Detail]

Not sure what's going on here

️❌ azure-resource-manager-schemas failed [Detail]

Not sure what's going on here

kalbert312 avatar Jan 31 '24 20:01 kalbert312

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

/azp run

msyyc avatar Mar 07 '24 03:03 msyyc

Azure Pipelines successfully started running 4 pipeline(s).

azure-pipelines[bot] avatar Mar 07 '24 03:03 azure-pipelines[bot]

/azp run

kalbert312 avatar Apr 11 '24 20:04 kalbert312

Azure Pipelines successfully started running 4 pipeline(s).

azure-pipelines[bot] avatar Apr 11 '24 20:04 azure-pipelines[bot]

I noticed in recent runs the "azure-for-python-track2" step is skipped. It was running before and I was able to download the python wheel/zip for azure-mgmt-resource. I checked the "azure-sdk-for-python" step but the artifacts listed in the check are not links like the "azure-for-python-track2" check had. I checked the AzDevOps page and didn't see the artifacts I was expecting.

Where can I download this artifact? I'm trying to test the new version of the python sdk in my local AZ CLI branch.

Update: I was able to get the package from the pipeline developers.

kalbert312 avatar Apr 11 '24 21:04 kalbert312

Hello @msyyc, @rkmanda, @visingla-ms - friendly ping on this review. We are shooting for BUILD release and are looking to unblock CLI release as soon as possible. Thanks in advance for the quickness!

azcloudfarmer avatar Apr 16 '24 19:04 azcloudfarmer

No change in api section since last signoff so signing off again

raosuhas avatar Apr 16 '24 21:04 raosuhas

No Python SDK breaking so the PR looks good for python.

msyyc avatar Apr 17 '24 02:04 msyyc

There may be an issue with the ErrorResponse models for Powershell. Looking into it.

Update: Should be resolved by https://github.com/Azure/azure-rest-api-specs/pull/27529/commits/4a89395781c91702612acf02424a53686e7a5cc4 and https://github.com/Azure/azure-rest-api-specs/pull/27529/commits/da335e154924b414e3e223eb34e824df8600f9b1

kalbert312 avatar Apr 17 '24 13:04 kalbert312

Hello @msyyc and @raosuhas - thank you for the signoffs - There was a minor check we reviewed and are now ready for the final sign off. Thanks in advance!

azcloudfarmer avatar Apr 18 '24 00:04 azcloudfarmer

Hello @msyyc and @raosuhas - thank you for the signoffs - There was a minor check we reviewed and are now ready for the final sign off. Thanks in advance!

Why did you need to make the change for the error details ? Seems like you are using a lower version of the errordetails. THe DeploymentStacksError object again seems to be a copy of the ErrorResponse object from common-types.

.. The newer one should be backwards compatible. I would like to know if there is something wrong with the common-types v5 definition of errorresponse that we need to fix.

raosuhas avatar Apr 18 '24 19:04 raosuhas

@raosuhas We made this change for an issue we are facing in azure-powershell with the autorest powershell generated sdk. With the deprecation of the Track 1 .NET sdk, the azure-powershell team has moved forward with a checked-in sdk solution that utilizes the new autorest powershell. We have migrated our module, Az.Resources, to utilize this. Az.Resources contains cmdlets from multiple teams, but they all share a generated sdk directory, meaning that common type generations are shared. Much of the existing checked in code relies on v1 of ErrorResponse, which gets overwritten and becomes a breaking change if used directly here. We don't have the bandwidth currently to upgrade all apis used in Az.Resources to a newer version of ErrorResponse, so this seems like the only option. Let us know if you have any questions.

dantedallag avatar Apr 18 '24 20:04 dantedallag

@raosuhas We made this change for an issue we are facing in azure-powershell with the autorest powershell generated sdk. With the deprecation of the Track 1 .NET sdk, the azure-powershell team has moved forward with a checked-in sdk solution that utilizes the new autorest powershell. We have migrated our module, Az.Resources, to utilize this. Az.Resources contains cmdlets from multiple teams, but they all share a generated sdk directory, meaning that common type generations are shared. Much of the existing checked in code relies on v1 of ErrorResponse, which gets overwritten and becomes a breaking change if used directly here. We don't have the bandwidth currently to upgrade all apis used in Az.Resources to a newer version of ErrorResponse, so this seems like the only option. Let us know if you have any questions.

I see, ok sounds good. Avoiding breaking changes are higher priority than consistency across apis. So this change is fine. You do have a few Lint errors that have come up now. I have marked it in a comment. Could you please fix that one ?

raosuhas avatar Apr 19 '24 22:04 raosuhas

Hello @raosuhas 7 @msyyc - we have checked the lint errors mentioned and are ready for final sign off. Thanks!

azcloudfarmer avatar Apr 23 '24 18:04 azcloudfarmer

I am only Python SDK owner. This PR doesn't have Python SDK breaking so you don't need my approval.

msyyc avatar Apr 24 '24 01:04 msyyc

Thanks for the clarification @msyyc. In that case, we will wait for the final sign-off from @raosuhas. Thanks in advance!

azcloudfarmer avatar Apr 24 '24 21:04 azcloudfarmer

Hello @visingla-ms - friendly ping on a second sign-off here. We appreciate the swiftness as we get closer to GA target. Thanks in advance!

azcloudfarmer avatar Apr 25 '24 00:04 azcloudfarmer

Hello @raosuhas, @visingla-ms, @rkmanda - friendly reminder here on final approvals.

azcloudfarmer avatar Apr 30 '24 18:04 azcloudfarmer

Current breaking changes: The current listing of added paths for /validate are expected. I'm not sure why the other endpoints are listed in this as they are present in the 2022-08-01-preview version. Maybe a bump of the common type version for api version and subscription triggered this?

VersioningReviewRequired: I needed to add an escape pattern to a description to prevent the JS SDK step from crashing. I added it to both the new version and existing version.

kalbert312 avatar Apr 30 '24 20:04 kalbert312

Hi @ramoka178, are you able to do ARM review once more? There was an issue with PR checks that we tried to work around that required commits. No effective changes since sign off except for a couple more suppressions.

kalbert312 avatar May 01 '24 17:05 kalbert312

@raych1 please could you help with the BreakingChange-Go-Sdk-Suppression label?

anthony-c-martin avatar May 01 '24 18:05 anthony-c-martin

/pr RequestMerge

kalbert312 avatar May 02 '24 14:05 kalbert312