add releaseChannel to deployment template #29726

bjmcabee · 2024-07-08T16:26:16Z

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.

PR review workflow diagram

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

Purpose of this PR

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

New resource provider.
New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
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:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
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.
If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
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 ARM review (PR workflow diagram Step 2), 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.

openapi-pipeline-app · 2024-07-08T16:26:20Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ Your PR has breaking changes in the generated SDK for Python (label: BreakingChange-Python-Sdk). Refer to step 3 in the PR workflow diagram.
❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide. In addition, refer to step 4 in the PR workflow diagram

openapi-pipeline-app · 2024-07-08T16:26:20Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️❌Breaking Change(Cross-Version): 21 Errors, 7 Warnings failed [Detail]

Compared specs (v0.10.12)	new version	base version
apimdeployment.json	2024-06-01-preview(fb5566a)	2022-08-01(main)
apimdeployment.json	2024-06-01-preview(fb5566a)	2023-09-01-preview(main)

The following breaking changes are detected by comparison with the latest stable version:

Rule	Message
`❌` 1023 - TypeFormatChanged	The new version has a different format 'uuid' than the previous one ''. New: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L89:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L89:9
`❌` 1023 - TypeFormatChanged	The new version has a different format 'uuid' than the previous one ''. New: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L134:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L134:9
`❌` 1023 - TypeFormatChanged	The new version has a different format 'uuid' than the previous one ''. New: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L203:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L203:9
`❌` 1023 - TypeFormatChanged	The new version has a different format 'uuid' than the previous one ''. New: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L302:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L293:9
`❌` 1023 - TypeFormatChanged	The new version has a different format 'uuid' than the previous one ''. New: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L364:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L355:9
`❌` 1023 - TypeFormatChanged	The new version has a different format 'uuid' than the previous one ''. New: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L429:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L414:9
`❌` 1023 - TypeFormatChanged	The new version has a different format 'uuid' than the previous one ''. New: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L469:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L454:9
`❌` 1023 - TypeFormatChanged	The new version has a different format 'uuid' than the previous one ''. New: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L524:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L503:9
`❌` 1023 - TypeFormatChanged	The new version has a different format 'uuid' than the previous one ''. New: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L587:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L557:9
`❌` 1023 - TypeFormatChanged	The new version has a different format 'uuid' than the previous one ''. New: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L629:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L599:9
`❌` 1023 - TypeFormatChanged	The new version has a different format 'uuid' than the previous one ''. New: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L668:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L638:9
`❌` 1023 - TypeFormatChanged	The new version has a different format 'uuid' than the previous one ''. New: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L711:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L681:9
`❌` 1023 - TypeFormatChanged	The new version has a different format 'uuid' than the previous one ''. New: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L756:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L726:9
`❌` 1023 - TypeFormatChanged	The new version has a different format 'uuid' than the previous one ''. New: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L792:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L762:9
`❌` 1023 - TypeFormatChanged	The new version has a different format 'uuid' than the previous one ''. New: common-types/resource-management/v5/types.json#L632:5 Old: common-types/resource-management/v3/types.json#L622:5
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L264:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L70:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L269:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L74:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L264:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L41:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L269:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L45:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L274:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L49:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L279:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L78:9
⚠️ 1014 - RemovingHeader	The new version removs a required header 'Location'. Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L236:15
⚠️ 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: common-types/resource-management/v5/types.json#L307:9 Old: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L59:9
⚠️ 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: common-types/resource-management/v5/types.json#L282:11 Old: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L80:11
⚠️ 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'details' in response that was not found in the old version. New: common-types/resource-management/v5/types.json#L263:7 Old: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L40:7
⚠️ 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'additionalInfo' in response that was not found in the old version. New: common-types/resource-management/v5/types.json#L263:7 Old: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L40:7
⚠️ 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'target' in response that was not found in the old version. New: common-types/resource-management/v5/types.json#L263:7 Old: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L69:7
⚠️ 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'additionalInfo' in response that was not found in the old version. New: common-types/resource-management/v5/types.json#L263:7 Old: Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json#L69:7

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

Compared specs (v2.2.2)	new version	base version
package-preview-2024-06	package-preview-2024-06(fb5566a)	package-preview-2024-06(release-apimangement-2024-06-01-preview)

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

Rule	Message	Related RPC [For API reviewers]
`❌` PatchBodyParametersSchema	Properties of a PATCH request body must not have default value, property:releaseChannel. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L375	RPC-Patch-V1-10

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` OperationsApiResponseSchema	The response schema of operations API '/providers/Microsoft.ApiManagement/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L57
`❌` OperationsApiSchemaUsesCommonTypes	Operations API path must follow the schema provided in the common types. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L58
`❌` PatchBodyParametersSchema	Properties of a PATCH request body must not be required, property:type. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L375
`❌` PatchBodyParametersSchema	Properties of a PATCH request body must not have default value, property:legacyApi. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L375
`❌` PatchBodyParametersSchema	Properties of a PATCH request body must not have default value, property:natGatewayState. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L375
`❌` PatchBodyParametersSchema	Properties of a PATCH request body must not have default value, property:virtualNetworkType. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L375
`❌` PatchBodyParametersSchema	Properties of a PATCH request body must not have default value, property:legacyPortalStatus. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L375
`❌` PatchBodyParametersSchema	Properties of a PATCH request body must not have default value, property:developerPortalStatus. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L375
`❌` PatchBodyParametersSchema	Properties of a PATCH request body must not be required, property:name. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L375
`❌` PatchBodyParametersSchema	Properties of a PATCH request body must not be required, property:capacity. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L375
`❌` DeleteResponseCodes	Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L458
`❌` XmsEnumValidation	The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L1069
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L1573
`❌` AllTrackedResourcesMustHaveDelete	The resource ApiManagementServiceResource does not have a corresponding delete operation. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L1871
`❌` TrackedResourcePatchOperation	Tracked resource 'ApiManagementServiceResource' must have patch operation that at least supports the update of tags. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L1871
`❌` GuidUsage	Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L2103
`❌` GuidUsage	Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L2109
`❌` MissingTypeObject	The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L2146
⚠️ 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.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L1126
⚠️ 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.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L1131
⚠️ LocationMustHaveXmsMutability	Property `location` must have `'x-ms-mutability':['read', 'create']` extension defined. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L1227
⚠️ 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.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L1302
⚠️ 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.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L1590
⚠️ 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.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L1626
⚠️ 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.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L1663
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L1888
⚠️ 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.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L2036
⚠️ LocationMustHaveXmsMutability	Property `location` must have `'x-ms-mutability':['read', 'create']` extension defined. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L2076
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L2125
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ApiManagement/preview/2024-06-01-preview/apimdeployment.json#L2146

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️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?}

openapi-pipeline-app · 2024-07-08T16:26:21Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️⚠️ azure-sdk-for-net-track2 warning [Detail]

FAQ

⚠️Warning in generating from 71d83f60f61a63064cca28d957adff0dfca28ad8. 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
cmderr	[Invoke-GenerateAndBuildV2.ps1] Get-ChildItem: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:787
cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
cmderr	[Invoke-GenerateAndBuildV2.ps1]  787 |  … rtifacts += Get-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s …
cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Cannot find path
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | it does not exist.

️✔️Azure.ResourceManager.ApiManagement [Preview SDK Changes]
```
info	[Changelog]
```

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

FAQ

️✔️Succeeded in generating from 71d83f60f61a63064cca28d957adff0dfca28ad8. 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/apimanagement/armapimanagement [Preview SDK Changes]

️⚠️ azure-sdk-for-python warning [Detail]

FAQ

⚠️Warning in generating from 71d83f60f61a63064cca28d957adff0dfca28ad8. 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] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
cmderr	[automation_init.sh] npm notice
cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.2
cmderr	[automation_init.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.2
cmderr	[automation_init.sh] npm notice To update run: npm install -g npm@10.8.2
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-apimanagement [Preview SDK Changes] Breaking Change Detected

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation GatewayOperations.invalidate_debug_credentials
info	[Changelog]   - Added operation GatewayOperations.list_debug_credentials
info	[Changelog]   - Added operation GatewayOperations.list_trace
info	[Changelog]   - Added operation group AllPoliciesOperations
info	[Changelog]   - Added operation group ApiGatewayConfigConnectionOperations
info	[Changelog]   - Added operation group ApiGatewayOperations
info	[Changelog]   - Added operation group ApiManagementGatewaySkusOperations
info	[Changelog]   - Added operation group ApiManagementWorkspaceLinkOperations
info	[Changelog]   - Added operation group ApiManagementWorkspaceLinksOperations
info	[Changelog]   - Added operation group OperationStatusOperations
info	[Changelog]   - Added operation group OperationsResultsOperations
info	[Changelog]   - Added operation group PolicyRestrictionOperations
info	[Changelog]   - Added operation group PolicyRestrictionValidationsOperations
info	[Changelog]   - Added operation group ProductApiLinkOperations
info	[Changelog]   - Added operation group ProductGroupLinkOperations
info	[Changelog]   - Added operation group TagApiLinkOperations
info	[Changelog]   - Added operation group TagOperationLinkOperations
info	[Changelog]   - Added operation group TagProductLinkOperations
info	[Changelog]   - Added operation group WorkspaceApiDiagnosticOperations
info	[Changelog]   - Added operation group WorkspaceApiExportOperations
info	[Changelog]   - Added operation group WorkspaceApiOperationOperations
info	[Changelog]   - Added operation group WorkspaceApiOperationPolicyOperations
info	[Changelog]   - Added operation group WorkspaceApiOperations
info	[Changelog]   - Added operation group WorkspaceApiPolicyOperations
info	[Changelog]   - Added operation group WorkspaceApiReleaseOperations
info	[Changelog]   - Added operation group WorkspaceApiRevisionOperations
info	[Changelog]   - Added operation group WorkspaceApiSchemaOperations
info	[Changelog]   - Added operation group WorkspaceApiVersionSetOperations
info	[Changelog]   - Added operation group WorkspaceBackendOperations
info	[Changelog]   - Added operation group WorkspaceCertificateOperations
info	[Changelog]   - Added operation group WorkspaceDiagnosticOperations
info	[Changelog]   - Added operation group WorkspaceGlobalSchemaOperations
info	[Changelog]   - Added operation group WorkspaceGroupOperations
info	[Changelog]   - Added operation group WorkspaceGroupUserOperations
info	[Changelog]   - Added operation group WorkspaceLoggerOperations
info	[Changelog]   - Added operation group WorkspaceNamedValueOperations
info	[Changelog]   - Added operation group WorkspaceNotificationOperations
info	[Changelog]   - Added operation group WorkspaceNotificationRecipientEmailOperations
info	[Changelog]   - Added operation group WorkspaceNotificationRecipientUserOperations
info	[Changelog]   - Added operation group WorkspaceOperations
info	[Changelog]   - Added operation group WorkspacePolicyFragmentOperations
info	[Changelog]   - Added operation group WorkspacePolicyOperations
info	[Changelog]   - Added operation group WorkspaceProductApiLinkOperations
info	[Changelog]   - Added operation group WorkspaceProductGroupLinkOperations
info	[Changelog]   - Added operation group WorkspaceProductOperations
info	[Changelog]   - Added operation group WorkspaceProductPolicyOperations
info	[Changelog]   - Added operation group WorkspaceSubscriptionOperations
info	[Changelog]   - Added operation group WorkspaceTagApiLinkOperations
info	[Changelog]   - Added operation group WorkspaceTagOperationLinkOperations
info	[Changelog]   - Added operation group WorkspaceTagOperations
info	[Changelog]   - Added operation group WorkspaceTagProductLinkOperations
info	[Changelog]   - Model ApiContract has a new parameter provisioning_state
info	[Changelog]   - Model ApiContractProperties has a new parameter provisioning_state
info	[Changelog]   - Model ApiCreateOrUpdateParameter has a new parameter provisioning_state
info	[Changelog]   - Model ApiCreateOrUpdateProperties has a new parameter provisioning_state
info	[Changelog]   - Model ApiManagementServiceBaseProperties has a new parameter configuration_api
info	[Changelog]   - Model ApiManagementServiceBaseProperties has a new parameter developer_portal_status
info	[Changelog]   - Model ApiManagementServiceBaseProperties has a new parameter legacy_portal_status
info	[Changelog]   - Model ApiManagementServiceBaseProperties has a new parameter release_channel
info	[Changelog]   - Model ApiManagementServiceProperties has a new parameter configuration_api
info	[Changelog]   - Model ApiManagementServiceProperties has a new parameter developer_portal_status
info	[Changelog]   - Model ApiManagementServiceProperties has a new parameter legacy_portal_status
info	[Changelog]   - Model ApiManagementServiceProperties has a new parameter release_channel
info	[Changelog]   - Model ApiManagementServiceResource has a new parameter configuration_api
info	[Changelog]   - Model ApiManagementServiceResource has a new parameter developer_portal_status
info	[Changelog]   - Model ApiManagementServiceResource has a new parameter legacy_portal_status
info	[Changelog]   - Model ApiManagementServiceResource has a new parameter release_channel
info	[Changelog]   - Model ApiManagementServiceUpdateParameters has a new parameter configuration_api
info	[Changelog]   - Model ApiManagementServiceUpdateParameters has a new parameter developer_portal_status
info	[Changelog]   - Model ApiManagementServiceUpdateParameters has a new parameter legacy_portal_status
info	[Changelog]   - Model ApiManagementServiceUpdateParameters has a new parameter release_channel
info	[Changelog]   - Model ApiManagementServiceUpdateProperties has a new parameter configuration_api
info	[Changelog]   - Model ApiManagementServiceUpdateProperties has a new parameter developer_portal_status
info	[Changelog]   - Model ApiManagementServiceUpdateProperties has a new parameter legacy_portal_status
info	[Changelog]   - Model ApiManagementServiceUpdateProperties has a new parameter release_channel
info	[Changelog]   - Model AuthorizationAccessPolicyContract has a new parameter app_ids
info	[Changelog]   - Model BackendBaseParameters has a new parameter circuit_breaker
info	[Changelog]   - Model BackendBaseParameters has a new parameter pool
info	[Changelog]   - Model BackendBaseParameters has a new parameter type
info	[Changelog]   - Model BackendContract has a new parameter circuit_breaker
info	[Changelog]   - Model BackendContract has a new parameter pool
info	[Changelog]   - Model BackendContract has a new parameter type_properties_type
info	[Changelog]   - Model BackendContractProperties has a new parameter circuit_breaker
info	[Changelog]   - Model BackendContractProperties has a new parameter pool
info	[Changelog]   - Model BackendContractProperties has a new parameter type
info	[Changelog]   - Model BackendUpdateParameterProperties has a new parameter circuit_breaker
info	[Changelog]   - Model BackendUpdateParameterProperties has a new parameter pool
info	[Changelog]   - Model BackendUpdateParameterProperties has a new parameter type
info	[Changelog]   - Model BackendUpdateParameters has a new parameter circuit_breaker
info	[Changelog]   - Model BackendUpdateParameters has a new parameter pool
info	[Changelog]   - Model BackendUpdateParameters has a new parameter type
info	[Changelog]   - Model ErrorResponse has a new parameter error
info	[Changelog]   - Model GlobalSchemaContract has a new parameter provisioning_state
info	[Changelog]   - Model NamedValueContract has a new parameter provisioning_state
info	[Changelog]   - Model NamedValueContractProperties has a new parameter provisioning_state
info	[Changelog]   - Model PolicyFragmentContract has a new parameter provisioning_state
info	[Changelog]   - Model PortalRevisionContract has a new parameter provisioning_state
info	[Changelog]   - Model SchemaContract has a new parameter provisioning_state
info	[Changelog]   - Operation ApiManagementServiceOperations.begin_migrate_to_stv2 has a new optional parameter parameters
info	[Changelog]
info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog]   - Model ErrorResponse no longer has parameter code
info	[Changelog]   - Model ErrorResponse no longer has parameter details
info	[Changelog]   - Model ErrorResponse no longer has parameter message
info	[Changelog]   - Renamed operation ApiOperations.delete to ApiOperations.begin_delete
info	[Changelog]   - Renamed operation UserOperations.delete to UserOperations.begin_delete

Present SDK breaking changes suppressions
Model ErrorResponse no longer has parameter code
Model ErrorResponse no longer has parameter details
Model ErrorResponse no longer has parameter message
Renamed operation ApiOperations.delete to ApiOperations.begin_delete
Renamed operation UserOperations.delete to UserOperations.begin_delete

Please refer to the guidance for suppressing SDK breaking changes.

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

FAQ

️✔️Succeeded in generating from 71d83f60f61a63064cca28d957adff0dfca28ad8. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	Warning: File azure-sdk-for-js_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel.
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/arm-apimanagement [Preview SDK Changes]

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

FAQ

❌Code Generator Failed in generating from 71d83f60f61a63064cca28d957adff0dfca28ad8. 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] Submodule 'bicep-types-az' (https://github.com/Azure/bicep-types-az) registered for path 'bicep-types-az'
cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az'...
cmderr	[initScript.sh] Submodule 'bicep-types' (https://github.com/Azure/bicep-types) registered for path 'bicep-types-az/bicep-types'
cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az/bicep-types'...
cmderr	[initScript.sh] npm notice
cmderr	[initScript.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.2
cmderr	[initScript.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.2
cmderr	[initScript.sh] npm notice To update run: npm install -g npm@10.8.2
cmderr	[initScript.sh] npm notice
error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh
warn	Warning: File azure-resource-manager-schemas_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel.
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
cmderr	[generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:500
cmderr	[generateScript.sh]     return new TSError(diagnosticText, diagnosticCodes)
cmderr	[generateScript.sh]            ^
cmderr	[generateScript.sh] TSError: ⨯ Unable to compile TypeScript:
cmderr	[generateScript.sh] cmd/generateall.ts(6,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(10,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(11,18): error TS2307: Cannot find module 'path' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(13,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(14,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations.
cmderr	[generateScript.sh] cmd/generateall.ts(42,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(53,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(69,67): error TS7006: Parameter 'x' implicitly has an 'any' type.
cmderr	[generateScript.sh] cmd/generateall.ts(70,49): error TS7006: Parameter 'f' implicitly has an 'any' type.
cmderr	[generateScript.sh] cmd/generateall.ts(94,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(105,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(106,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
cmderr	[generateScript.sh] cmd/generateall.ts(157,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node` and then add 'node' to the types field in your tsconfig.
cmderr	[generateScript.sh]     at createTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:500:12)
cmderr	[generateScript.sh]     at reportTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:504:19)
cmderr	[generateScript.sh]     at getOutput (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:739:36)
cmderr	[generateScript.sh]     at Object.compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:955:32)
cmderr	[generateScript.sh]     at Module.m._compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:1043:43)
cmderr	[generateScript.sh]     at Module._extensions..js (node:internal/modules/cjs/loader:1422:10)
cmderr	[generateScript.sh]     at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/ts-node@9.0.0_typescript@5.3.3/node_modules/ts-node/src/index.ts:1046:12)
cmderr	[generateScript.sh]     at Module.load (node:internal/modules/cjs/loader:1203:32)
cmderr	[generateScript.sh]     at Function.Module._load (node:internal/modules/cjs/loader:1019:12)
cmderr	[generateScript.sh]     at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:128:12)
error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh
warn	Warning: Package processing is skipped as the SDK generation fails. Please look into the above generation errors or report this issue through https://aka.ms/azsdk/support/specreview-channel.

️⚠️ azure-powershell warning [Detail]

FAQ

⚠️Warning in generating from 71d83f60f61a63064cca28d957adff0dfca28ad8. 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.apimanagement.DefaultTag [Preview SDK Changes]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-07-08T16:26:21Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/apimanagement/armapimanagement	https://apiview.dev/Assemblies/Review/3f780ded9a334a24ac4c01dbf55c360a?revisionId=189d32d90ee14df981873ec981b90d31
JavaScript	@azure/arm-apimanagement	https://apiview.dev/Assemblies/Review/89ddc593dfab4f6da2ad76a2d356a33e?revisionId=4b1ab9b28e7c45c0becd264fc1caf292
.Net	Azure.ResourceManager.ApiManagement	There is no API change compared with the previous version
Swagger	Microsoft.ApiManagement	https://apiview.dev/Assemblies/Review/5cabe93e09114e71b8ff982e13b6f2ec?revisionId=f30276c7bb2b4f55a73faa5f892ff96c

raosuhas · 2024-07-16T00:11:55Z

Plese check , you have a swagger Lint error being flagged for this : https://github.com/Azure/azure-rest-api-specs/pull/29726/checks?check_run_id=27174353904

rkmanda

bjmcabee · 2024-09-03T16:54:00Z

/azp run

azure-pipelines · 2024-09-03T16:54:18Z

Azure Pipelines successfully started running 4 pipeline(s).

* add releaseChannel to deployment template * run prettier on example template * run prettier template * remove default release channel value

add releaseChannel to deployment template

fb5566a

bjmcabee requested a review from solankisamir as a code owner July 8, 2024 16:26

azure-sdk mentioned this pull request Jul 8, 2024

[AutoPR sdk/resourcemanager/apimanagement/armapimanagement] add releaseChannel to deployment template azure-sdk/azure-sdk-for-go#10405

Closed

AzureRestAPISpecReview added ARMReview resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 8, 2024

solankisamir added the 2024-06-01-preview APIM 2024-06-01-preview label Jul 9, 2024

raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jul 16, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 16, 2024

raosuhas added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review and removed ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Jul 16, 2024

bjmcabee added 3 commits July 16, 2024 18:41

run prettier on example template

30eafff

run prettier template

880ef8f

remove default release channel value

74db890

microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Aug 5, 2024

bjmcabee removed the no-recent-activity There has been no recent activity on this issue. label Aug 5, 2024

microsoft-github-policy-service bot added the API Management label Aug 5, 2024

bjmcabee added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Aug 5, 2024

rkmanda approved these changes Aug 9, 2024

View reviewed changes

rkmanda added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Aug 9, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 9, 2024

solankisamir approved these changes Aug 21, 2024

View reviewed changes

solankisamir enabled auto-merge (squash) August 21, 2024 18:16

solankisamir merged commit 12b46f1 into release-apimangement-2024-06-01-preview Sep 3, 2024
21 of 28 checks passed

solankisamir deleted the brianmcabee/release-channel-updates branch September 3, 2024 17:02

azure-sdk added the BreakingChange-Python-Sdk label Sep 3, 2024

solankisamir pushed a commit that referenced this pull request Sep 9, 2024

add releaseChannel to deployment template (#29726)

9b24f2a

* add releaseChannel to deployment template * run prettier on example template * run prettier template * remove default release channel value

solankisamir pushed a commit that referenced this pull request Sep 9, 2024

add releaseChannel to deployment template (#29726)

312f7b5

* add releaseChannel to deployment template * run prettier on example template * run prettier template * remove default release channel value

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add releaseChannel to deployment template #29726

add releaseChannel to deployment template #29726

bjmcabee commented Jul 8, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jul 8, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jul 8, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jul 8, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jul 8, 2024 •

edited

Loading

raosuhas commented Jul 16, 2024

rkmanda left a comment

bjmcabee commented Sep 3, 2024

azure-pipelines bot commented Sep 3, 2024

add releaseChannel to deployment template #29726

add releaseChannel to deployment template #29726

Conversation

bjmcabee commented Jul 8, 2024 • edited Loading

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented Jul 8, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Jul 8, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jul 8, 2024 • edited Loading

Swagger Generation Artifacts

openapi-pipeline-app bot commented Jul 8, 2024 • edited Loading

Generated ApiView

raosuhas commented Jul 16, 2024

rkmanda left a comment

Choose a reason for hiding this comment

bjmcabee commented Sep 3, 2024

azure-pipelines bot commented Sep 3, 2024

bjmcabee commented Jul 8, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jul 8, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jul 8, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jul 8, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jul 8, 2024 •

edited

Loading