Fix missing property in existing APIs #29383

calecarter · 2024-06-10T23:32:40Z

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:
- Missed property with previous PR to add a new API version. This was just discovered and this PR fixes the issue by adding the missing "definitionVersion" property. This updates the spec to match the api.

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-06-10T23:32:44Z

Next Steps to Merge

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

openapi-pipeline-app · 2024-06-10T23:32:44Z

Swagger Validation Report

️❌BreakingChange: 5 Errors, 0 Warnings failed [Detail]

Compared specs (v0.10.9)	new version	base version
policyAssignments.json	2023-04-01(d829f0a)	2023-04-01(main)
policySetDefinitionVersions.json	2023-04-01(d829f0a)	2023-04-01(main)
policySetDefinitions.json	2023-04-01(d829f0a)	2023-04-01(main)
policyAssignments.json	2024-04-01(d829f0a)	2024-04-01(main)

Rule	Message
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'definitionVersion' in response that was not found in the old version. New: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L732:7 Old: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L732:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'definitionVersion' in response that was not found in the old version. New: Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json#L677:7 Old: Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json#L677:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'definitionVersion' in response that was not found in the old version. New: Microsoft.Authorization/stable/2024-04-01/policyAssignments.json#L732:7 Old: Microsoft.Authorization/stable/2024-04-01/policyAssignments.json#L732:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'definitionVersion' that was not found in the old version. New: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L732:7 Old: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L732:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'definitionVersion' that was not found in the old version. New: Microsoft.Authorization/stable/2024-04-01/policyAssignments.json#L732:7 Old: Microsoft.Authorization/stable/2024-04-01/policyAssignments.json#L732:7

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

Compared specs (v2.2.2)	new version	base version
package-2024-04	package-2024-04(d829f0a)	package-2024-04(main)
package-policy-2023-04	package-policy-2023-04(d829f0a)	package-policy-2023-04(main)

The following errors/warnings exist before current PR submission:

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

Rule	Message
`❌` PathForTrackedResourceTypes	The path must be under a subscription and resource group for tracked resource types. Location: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L37
`❌` PutResponseCodes	Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L89
`❌` EvenSegmentedPathForPutOperation	API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments). Location: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L529
`❌` PathForTrackedResourceTypes	The path must be under a subscription and resource group for tracked resource types. Location: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L529
`❌` PutResponseCodes	Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L573
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L839
`❌` TenantLevelAPIsNotAllowed	/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName} is a tenant level api. Tenant level APIs are strongly discouraged and subscription or resource group level APIs are preferred instead. If you cannot model your APIs at these levels, you will need to present your design and get an exception from PAS team. Location: Microsoft.Authorization/stable/2023-04-01/policySetDefinitions.json#L317
`❌` TenantLevelAPIsNotAllowed	/providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/versions/{policyDefinitionVersion} is a tenant level api. Tenant level APIs are strongly discouraged and subscription or resource group level APIs are preferred instead. If you cannot model your APIs at these levels, you will need to present your design and get an exception from PAS team. Location: Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json#L414
`❌` OperationsAPIImplementation	Operations API must be implemented for 'Microsoft.Authorization'. Location: Microsoft.Authorization/stable/2024-04-01/policyAssignments.json#L1
`❌` PathForTrackedResourceTypes	The path must be under a subscription and resource group for tracked resource types. Location: Microsoft.Authorization/stable/2024-04-01/policyAssignments.json#L37
`❌` PutResponseCodes	Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Authorization/stable/2024-04-01/policyAssignments.json#L89
`❌` EvenSegmentedPathForPutOperation	API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments). Location: Microsoft.Authorization/stable/2024-04-01/policyAssignments.json#L529
`❌` PathForTrackedResourceTypes	The path must be under a subscription and resource group for tracked resource types. Location: Microsoft.Authorization/stable/2024-04-01/policyAssignments.json#L529
`❌` PutResponseCodes	Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Authorization/stable/2024-04-01/policyAssignments.json#L573
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Authorization/stable/2024-04-01/policyAssignments.json#L853
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'scope'. Location: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L52
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'scope'. Location: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L121
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'scope'. Location: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L190
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'scope'. Location: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L247
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L309
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L366
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L725
⚠️ LocationMustHaveXmsMutability	Property `location` must have `'x-ms-mutability':['read', 'create']` extension defined. Location: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L879
⚠️ LocationMustHaveXmsMutability	Property `location` must have `'x-ms-mutability':['read', 'create']` extension defined. Location: Microsoft.Authorization/stable/2023-04-01/policyAssignments.json#L1007
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.Authorization/stable/2023-04-01/policySetDefinitions.json#L519
⚠️ PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'listpolicysetdefinitionversions' in:'PolicySetDefinitionVersions_ListAllBuiltins'. Consider updating the operationId Location: Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json#L42
⚠️ PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'listpolicysetdefinitionversions' in:'PolicySetDefinitionVersions_ListAllAtManagementGroup'. Consider updating the operationId Location: Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json#L76
⚠️ PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'listpolicysetdefinitionversions' in:'PolicySetDefinitionVersions_ListAll'. Consider updating the operationId Location: Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json#L113
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.Authorization/stable/2023-04-01/policySetDefinitionVersions.json#L607
⚠️ ParameterNotUsingCommonTypes	Not using the common-types defined parameter 'scope'. Location: Microsoft.Authorization/stable/2024-04-01/policyAssignments.json#L52

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

Validation passes for Avocado.

️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]

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

openapi-pipeline-app · 2024-06-10T23:32:45Z

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 40f646e88e61259f26b3194989f9f58ccab85f05. 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:807
cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
cmderr	[Invoke-GenerateAndBuildV2.ps1]  807 |  … 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.
cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
cmderr	[Invoke-GenerateAndBuildV2.ps1]  714 |          GeneratePackage -projectFolder $projectFolder -sdkRootPath $s …
cmderr	[Invoke-GenerateAndBuildV2.ps1]      |          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to generate sdk artifact
warn	No file changes detected after generation

️✔️Azure.ResourceManager.Resources
```
info	[Changelog]
```

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

⚠️Warning in generating from 40f646e88e61259f26b3194989f9f58ccab85f05. 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.1
cmderr	[automation_init.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
cmderr	[automation_init.sh] npm notice To update run: npm install -g [email protected]
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.1.zip
azure_mgmt_resource-23.1.1-py3-none-any.whl

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation group PolicyDefinitionVersionsOperations
info	[Changelog]   - Added operation group PolicySetDefinitionVersionsOperations
info	[Changelog]   - Model ParameterDefinitionsValue has a new parameter schema
info	[Changelog]   - Model PolicyAssignment has a new parameter definition_version
info	[Changelog]   - Model PolicyDefinition has a new parameter version
info	[Changelog]   - Model PolicyDefinition has a new parameter versions
info	[Changelog]   - Model PolicyDefinitionReference has a new parameter definition_version
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 40f646e88e61259f26b3194989f9f58ccab85f05. 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-sources.jar
- azure-resourcemanager-resources-generated-1.0.0-beta.1.jar

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

️✔️Succeeded in generating from 40f646e88e61259f26b3194989f9f58ccab85f05. 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]

️✔️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]

❌Code Generator Failed in generating from 40f646e88e61259f26b3194989f9f58ccab85f05. 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.1
cmderr	[initScript.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
cmderr	[initScript.sh] npm notice To update run: npm install -g [email protected]
cmderr	[initScript.sh] npm notice
error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh
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
cmderr	[generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/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/[email protected][email protected]/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/[email protected][email protected]/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/[email protected][email protected]/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/[email protected][email protected]/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/[email protected][email protected]/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/[email protected][email protected]/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	Skip package processing as generation is failed
error	ERROR: The 'breakingChangesLabel' configuration is missing or incorrect from the 'swagger_to_sdk_config.json file.

️⚠️ azure-powershell warning [Detail]

⚠️Warning in generating from 40f646e88e61259f26b3194989f9f58ccab85f05. 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?}

openapi-pipeline-app · 2024-06-10T23:32:46Z

Generated ApiView

Language	Package Name	ApiView Link
Java	azure-resourcemanager-resources-generated	https://apiview.dev/Assemblies/Review/69d90a3c09dd41d388271d10f46fbed8?revisionId=83b46d800bed4fbd9561b1731be5d445
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=f69005a7d9a04e6396974524f2541907
Go	sdk/resourcemanager/resources/armdeploymentstacks	https://apiview.dev/Assemblies/Review/6313d59674254051ac3edf0447ad74de?revisionId=49aefc4bf46b42719b54724906f8f7c1
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=933d0c45b2d7475a857738e20d6db57c
Go	sdk/resourcemanager/resources/armresources	https://apiview.dev/Assemblies/Review/12843540e3a1467ea73d364496b55308?revisionId=4e41c90a31744e8dae9423506a245026
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

mentat9 · 2024-06-11T16:45:24Z

/azp run

azure-pipelines · 2024-06-11T16:45:46Z

Azure Pipelines successfully started running 4 pipeline(s).

Fix missing property in existing APIs

a0794fc

AzureRestAPISpecReview added ARMReview NotReadyForARMReview resource-manager VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required labels Jun 10, 2024

azure-sdk added the BreakingChange-JavaScript-Sdk label Jun 11, 2024

Fixing missing property caught by the linter

267e111

AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Jun 11, 2024

JeffreyRichter added the Versioning-Approved-BugFix https://github.com/Azure/azure-sdk-tools/issues/6374 label Jun 11, 2024

AzureRestAPISpecReview added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview labels Jun 11, 2024

ms-bogdan-rotaru approved these changes Jun 12, 2024

View reviewed changes

ms-bogdan-rotaru added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jun 12, 2024

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

Merge branch 'main' into calec/ver-fix

d829f0a

azure-sdk mentioned this pull request Jun 13, 2024

[AutoPR azure-mgmt-resource] Fix missing property in existing APIs azure-sdk/azure-sdk-for-python#7340

Closed

qiaozha added the BreakingChange-JavaScript-Sdk-Approved label Jun 13, 2024

mentat9 merged commit 412364b into Azure:main Jun 13, 2024
28 of 32 checks passed

calecarter deleted the calec/ver-fix branch June 13, 2024 20:09

sshockley mentioned this pull request Sep 17, 2024

Missing policyAssignments definitionVersion attribute Azure/Enterprise-Scale#1769

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix missing property in existing APIs #29383

Fix missing property in existing APIs #29383

calecarter commented Jun 10, 2024

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

mentat9 commented Jun 11, 2024

azure-pipelines bot commented Jun 11, 2024

Fix missing property in existing APIs #29383

Fix missing property in existing APIs #29383

Conversation

calecarter commented Jun 10, 2024

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 Jun 10, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Jun 10, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jun 10, 2024 • edited Loading

Swagger Generation Artifacts

openapi-pipeline-app bot commented Jun 10, 2024 • edited Loading

Generated ApiView

mentat9 commented Jun 11, 2024

azure-pipelines bot commented Jun 11, 2024

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading