add community gallery image identifier #23820

grizzlytheodore · 2023-05-04T21:33:47Z

Resolving this issue: Incident 381588432 :
API is returning null for properties, but in Swagger has those properties as required. updating reference to the object that just has those properties not marked required

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2023-05-04T21:33:50Z

Hi, @grizzlytheodore Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

openapi-pipeline-app · 2023-05-04T21:33:53Z

Swagger Validation Report

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

compared swaggers (via Oad v0.10.4)]	new version	base version
communityGallery.json	2022-03-03(1ec42f3)	2022-03-03(main)

Rule	Message
`❌` 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: GalleryRP/stable/2022-03-03/communityGallery.json#L375:9 Old: GalleryRP/stable/2022-03-03/communityGallery.json#L375:9
`❌` 1025 - RequiredStatusChange	The 'required' status changed from the old version('True') to the new version('False'). New: GalleryRP/stable/2022-03-03/communityGallery.json#L487:7 Old: GalleryRP/stable/2022-03-03/galleryRPCommon.json#L52: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 tags (via openapi-validator v2.0.1)	new version	base version
package-2023-03-01	package-2023-03-01(1ec42f3)	package-2023-03-01(main)
package-2022-11-01	package-2022-11-01(1ec42f3)	package-2022-11-01(main)
package-2022-09-04	package-2022-09-04(1ec42f3)	package-2022-09-04(main)
package-2022-03-03	package-2022-03-03(1ec42f3)	package-2022-03-03(main)

The following errors/warnings exist before current PR submission:

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

Rule	Message
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L37
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L37
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L37
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L37
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
`❌` ResourceNameRestriction	The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
`❌` ResourceNameRestriction	The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
`❌` ResourceNameRestriction	The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
`❌` ResourceNameRestriction	The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
`❌` ResourceNameRestriction	The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
`❌` ResourceNameRestriction	The resource name parameter 'galleryImageVersionName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
`❌` ResourceNameRestriction	The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
`❌` ResourceNameRestriction	The resource name parameter 'galleryImageVersionName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
`❌` ResourceNameRestriction	The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
`❌` ResourceNameRestriction	The resource name parameter 'galleryImageVersionName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
`❌` ResourceNameRestriction	The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
`❌` ResourceNameRestriction	The resource name parameter 'galleryImageVersionName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L172
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L172
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L172
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L172
`❌` ResourceNameRestriction	The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L217
`❌` ResourceNameRestriction	The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L217

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
⚠️ MULTIPLE_API_VERSION	The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2023-03-01

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

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

️️✔️CadlAPIView 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.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

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

openapi-pipeline-app · 2023-05-04T21:33:53Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-go - sdk/resourcemanager/compute/armcompute - Approved - 5.0.0

-	Type of `GalleryTargetExtendedLocation.StorageAccountType` has been changed from `*StorageAccountType` to `*EdgeZoneStorageAccountType`
+	Type of `CommunityGalleryImageProperties.Identifier` has been changed from `*GalleryImageIdentifier` to `*CommunityGalleryImageIdentifier`
-	`StorageAccountTypeStandardSSDLRS` from enum `StorageAccountType` has been removed

❌azure-sdk-for-js - @azure/arm-compute - Approved - 21.0.0

-	Type of parameter storageAccountType of interface GalleryTargetExtendedLocation is changed from StorageAccountType to EdgeZoneStorageAccountType
+	Type of parameter identifier of interface CommunityGalleryImage is changed from GalleryImageIdentifier to CommunityGalleryImageIdentifier

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

❌Failed [Logs]Release - Generate from a2140e7. 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] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:712
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 712 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to build sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m

❌Azure.ResourceManager.Compute [View full logs] [Release SDK Changes] Breaking Change Detected

Azure.ResourceManager.Compute.1.2.0-alpha.20230517.1.nupkg

info	[Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public void Azure.ResourceManager.Compute.Models.GalleryTargetExtendedLocation.StorageAccountType.set(System.Nullable<Azure.ResourceManager.Compute.Models.ImageStorageAccountType>)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/compute/Azure.ResourceManager.Compute/src/Azure.ResourceManager.Compute.csproj::TargetFramework=netstandard2.0],
info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.ResourceManager.Compute/Debug/netstandard2.0/Azure.ResourceManager.Compute.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/compute/Azure.ResourceManager.Compute/src/Azure.ResourceManager.Compute.csproj::TargetFramework=netstandard2.0]

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

⚠️Warning [Logs]Release - Generate from a2140e7. 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.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh] npm notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.6.6
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.6>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.6` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-compute [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation DedicatedHostsOperations.list_available_sizes
info	[Changelog]   - Added operation VirtualMachineScaleSetsOperations.begin_reapply
info	[Changelog]   - Model DedicatedHostUpdate has a new parameter sku
info	[Changelog]   - Model LinuxVMGuestPatchAutomaticByPlatformSettings has a new parameter bypass_platform_safety_checks_on_user_schedule
info	[Changelog]   - Model RestorePointSourceMetadata has a new parameter hyper_v_generation
info	[Changelog]   - Model RestorePointSourceVMDataDisk has a new parameter write_accelerator_enabled
info	[Changelog]   - Model RestorePointSourceVMOSDisk has a new parameter write_accelerator_enabled
info	[Changelog]   - Model VirtualMachineExtension has a new parameter provision_after_extensions
info	[Changelog]   - Model VirtualMachineRunCommand has a new parameter error_blob_managed_identity
info	[Changelog]   - Model VirtualMachineRunCommand has a new parameter output_blob_managed_identity
info	[Changelog]   - Model VirtualMachineRunCommand has a new parameter treat_failure_as_deployment_failure
info	[Changelog]   - Model VirtualMachineRunCommandScriptSource has a new parameter script_uri_managed_identity
info	[Changelog]   - Model VirtualMachineRunCommandUpdate has a new parameter error_blob_managed_identity
info	[Changelog]   - Model VirtualMachineRunCommandUpdate has a new parameter output_blob_managed_identity
info	[Changelog]   - Model VirtualMachineRunCommandUpdate has a new parameter treat_failure_as_deployment_failure
info	[Changelog]   - Model VirtualMachineScaleSetUpdate has a new parameter priority_mix_policy
info	[Changelog]   - Model VirtualMachineScaleSetUpdate has a new parameter spot_restore_policy
info	[Changelog]   - Model VirtualMachineScaleSetVMExtension has a new parameter location
info	[Changelog]   - Model VirtualMachineScaleSetVMExtension has a new parameter provision_after_extensions
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter computer_name
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter hyper_v_generation
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter os_name
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter os_version
info	[Changelog]   - Model VirtualMachineScaleSetVMProfile has a new parameter security_posture_reference
info	[Changelog]   - Model WindowsVMGuestPatchAutomaticByPlatformSettings has a new parameter bypass_platform_safety_checks_on_user_schedule
info	[Changelog]   - Operation VirtualMachineScaleSetsOperations.begin_deallocate has a new optional parameter hibernate
info	[Changelog]   - Operation VirtualMachinesOperations.list has a new optional parameter expand
info	[Changelog]   - Operation VirtualMachinesOperations.list_all has a new optional parameter expand
info	[Changelog]
info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog]   - Model VirtualMachineScaleSetIPConfiguration no longer has parameter id
info	[Changelog]   - Model VirtualMachineScaleSetNetworkConfiguration no longer has parameter id
info	[Changelog]   - Model VirtualMachineScaleSetUpdateIPConfiguration no longer has parameter id
info	[Changelog]   - Model VirtualMachineScaleSetUpdateNetworkConfiguration no longer has parameter id

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

⚠️Warning [Logs]Release - Generate from a2140e7. 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
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-compute-generated [View full logs] [Release SDK Changes]

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

️✔️Succeeded [Logs]Release - Generate from a2140e7. 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	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/arm-compute [View full logs] [Release SDK Changes] Breaking Change Detected

azure-arm-compute-21.0.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation DedicatedHosts.listAvailableSizes
info	[Changelog]   - Added operation VirtualMachineScaleSets.beginReapply
info	[Changelog]   - Added operation VirtualMachineScaleSets.beginReapplyAndWait
info	[Changelog]   - Added Interface CommunityGalleryImageIdentifier
info	[Changelog]   - Added Interface DedicatedHostSizeListResult
info	[Changelog]   - Added Interface DedicatedHostsListAvailableSizesOptionalParams
info	[Changelog]   - Added Interface DiskRestorePointAttributes
info	[Changelog]   - Added Interface RestorePointEncryption
info	[Changelog]   - Added Interface RunCommandManagedIdentity
info	[Changelog]   - Added Interface SecurityPostureReference
info	[Changelog]   - Added Interface VirtualMachineScaleSetsReapplyHeaders
info	[Changelog]   - Added Interface VirtualMachineScaleSetsReapplyOptionalParams
info	[Changelog]   - Added Type Alias DedicatedHostsListAvailableSizesResponse
info	[Changelog]   - Added Type Alias EdgeZoneStorageAccountType
info	[Changelog]   - Added Type Alias ExpandTypeForListVMs
info	[Changelog]   - Added Type Alias ExpandTypesForListVMs
info	[Changelog]   - Added Type Alias RestorePointEncryptionType
info	[Changelog]   - Interface DedicatedHostUpdate has a new optional parameter sku
info	[Changelog]   - Interface LinuxVMGuestPatchAutomaticByPlatformSettings has a new optional parameter bypassPlatformSafetyChecksOnUserSchedule
info	[Changelog]   - Interface RestorePointSourceMetadata has a new optional parameter hyperVGeneration
info	[Changelog]   - Interface RestorePointSourceVMDataDisk has a new optional parameter writeAcceleratorEnabled
info	[Changelog]   - Interface RestorePointSourceVmosDisk has a new optional parameter writeAcceleratorEnabled
info	[Changelog]   - Interface VirtualMachineExtension has a new optional parameter provisionAfterExtensions
info	[Changelog]   - Interface VirtualMachineRunCommand has a new optional parameter errorBlobManagedIdentity
info	[Changelog]   - Interface VirtualMachineRunCommand has a new optional parameter outputBlobManagedIdentity
info	[Changelog]   - Interface VirtualMachineRunCommand has a new optional parameter treatFailureAsDeploymentFailure
info	[Changelog]   - Interface VirtualMachineRunCommandScriptSource has a new optional parameter scriptUriManagedIdentity
info	[Changelog]   - Interface VirtualMachineRunCommandUpdate has a new optional parameter errorBlobManagedIdentity
info	[Changelog]   - Interface VirtualMachineRunCommandUpdate has a new optional parameter outputBlobManagedIdentity
info	[Changelog]   - Interface VirtualMachineRunCommandUpdate has a new optional parameter treatFailureAsDeploymentFailure
info	[Changelog]   - Interface VirtualMachineScaleSetsDeallocateOptionalParams has a new optional parameter hibernate
info	[Changelog]   - Interface VirtualMachineScaleSetUpdate has a new optional parameter priorityMixPolicy
info	[Changelog]   - Interface VirtualMachineScaleSetUpdate has a new optional parameter spotRestorePolicy
info	[Changelog]   - Interface VirtualMachineScaleSetVMExtension has a new optional parameter location
info	[Changelog]   - Interface VirtualMachineScaleSetVMExtension has a new optional parameter provisionAfterExtensions
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter computerName
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter hyperVGeneration
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter osName
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter osVersion
info	[Changelog]   - Interface VirtualMachineScaleSetVMProfile has a new optional parameter securityPostureReference
info	[Changelog]   - Interface VirtualMachinesListAllOptionalParams has a new optional parameter expand
info	[Changelog]   - Interface VirtualMachinesListOptionalParams has a new optional parameter expand
info	[Changelog]   - Interface WindowsVMGuestPatchAutomaticByPlatformSettings has a new optional parameter bypassPlatformSafetyChecksOnUserSchedule
info	[Changelog]   - Added Enum KnownEdgeZoneStorageAccountType
info	[Changelog]   - Added Enum KnownExpandTypeForListVMs
info	[Changelog]   - Added Enum KnownExpandTypesForListVMs
info	[Changelog]   - Added Enum KnownRestorePointEncryptionType
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Type of parameter identifier of interface CommunityGalleryImage is changed from GalleryImageIdentifier to CommunityGalleryImageIdentifier
info	[Changelog]   - Type of parameter storageAccountType of interface GalleryTargetExtendedLocation is changed from StorageAccountType to EdgeZoneStorageAccountType
info	[Changelog]   - Type of parameter diskRestorePoint of interface RestorePointSourceVMDataDisk is changed from ApiEntityReference to DiskRestorePointAttributes
info	[Changelog]   - Type of parameter diskRestorePoint of interface RestorePointSourceVmosDisk is changed from ApiEntityReference to DiskRestorePointAttributes

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

️✔️Succeeded [Logs]Release - Generate from a2140e7. 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/compute/armcompute [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Type of `CommunityGalleryImageProperties.Identifier` has been changed from `*GalleryImageIdentifier` to `*CommunityGalleryImageIdentifier`
info	[Changelog] - Type of `GalleryTargetExtendedLocation.StorageAccountType` has been changed from `*StorageAccountType` to `*EdgeZoneStorageAccountType`
info	[Changelog] - Type of `RestorePointSourceVMDataDisk.DiskRestorePoint` has been changed from `*APIEntityReference` to `*DiskRestorePointAttributes`
info	[Changelog] - Type of `RestorePointSourceVMOSDisk.DiskRestorePoint` has been changed from `*APIEntityReference` to `*DiskRestorePointAttributes`
info	[Changelog] - `StorageAccountTypeStandardSSDLRS` from enum `StorageAccountType` has been removed
info	[Changelog] - Field `ID` of struct `VirtualMachineScaleSetIPConfiguration` has been removed
info	[Changelog] - Field `ID` of struct `VirtualMachineScaleSetNetworkConfiguration` has been removed
info	[Changelog] - Field `ID` of struct `VirtualMachineScaleSetUpdateIPConfiguration` has been removed
info	[Changelog] - Field `ID` of struct `VirtualMachineScaleSetUpdateNetworkConfiguration` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New enum type `EdgeZoneStorageAccountType` with values `EdgeZoneStorageAccountTypePremiumLRS`, `EdgeZoneStorageAccountTypeStandardLRS`, `EdgeZoneStorageAccountTypeStandardSSDLRS`, `EdgeZoneStorageAccountTypeStandardZRS`
info	[Changelog] - New enum type `ExpandTypeForListVMs` with values `ExpandTypeForListVMsInstanceView`
info	[Changelog] - New enum type `ExpandTypesForListVMs` with values `ExpandTypesForListVMsInstanceView`
info	[Changelog] - New enum type `RestorePointEncryptionType` with values `RestorePointEncryptionTypeEncryptionAtRestWithCustomerKey`, `RestorePointEncryptionTypeEncryptionAtRestWithPlatformAndCustomerKeys`, `RestorePointEncryptionTypeEncryptionAtRestWithPlatformKey`
info	[Changelog] - New function `*DedicatedHostsClient.NewListAvailableSizesPager(string, string, string, *DedicatedHostsClientListAvailableSizesOptions) *runtime.Pager[DedicatedHostsClientListAvailableSizesResponse]`
info	[Changelog] - New function `*VirtualMachineScaleSetsClient.BeginReapply(context.Context, string, string, *VirtualMachineScaleSetsClientBeginReapplyOptions) (*runtime.Poller[VirtualMachineScaleSetsClientReapplyResponse], error)`
info	[Changelog] - New struct `CommunityGalleryImageIdentifier`
info	[Changelog] - New struct `DedicatedHostSizeListResult`
info	[Changelog] - New struct `DiskRestorePointAttributes`
info	[Changelog] - New struct `RestorePointEncryption`
info	[Changelog] - New struct `RunCommandManagedIdentity`
info	[Changelog] - New struct `SecurityPostureReference`
info	[Changelog] - New field `SKU` in struct `DedicatedHostUpdate`
info	[Changelog] - New field `BypassPlatformSafetyChecksOnUserSchedule` in struct `LinuxVMGuestPatchAutomaticByPlatformSettings`
info	[Changelog] - New field `HyperVGeneration` in struct `RestorePointSourceMetadata`
info	[Changelog] - New field `WriteAcceleratorEnabled` in struct `RestorePointSourceVMDataDisk`
info	[Changelog] - New field `WriteAcceleratorEnabled` in struct `RestorePointSourceVMOSDisk`
info	[Changelog] - New field `ProvisionAfterExtensions` in struct `VirtualMachineExtensionProperties`
info	[Changelog] - New field `ErrorBlobManagedIdentity`, `OutputBlobManagedIdentity`, `TreatFailureAsDeploymentFailure` in struct `VirtualMachineRunCommandProperties`
info	[Changelog] - New field `ScriptURIManagedIdentity` in struct `VirtualMachineRunCommandScriptSource`
info	[Changelog] - New field `PriorityMixPolicy`, `SpotRestorePolicy` in struct `VirtualMachineScaleSetUpdateProperties`
info	[Changelog] - New field `Location` in struct `VirtualMachineScaleSetVMExtension`
info	[Changelog] - New field `SecurityPostureReference` in struct `VirtualMachineScaleSetVMProfile`
info	[Changelog] - New field `Hibernate` in struct `VirtualMachineScaleSetsClientBeginDeallocateOptions`
info	[Changelog] - New field `Expand` in struct `VirtualMachinesClientListAllOptions`
info	[Changelog] - New field `Expand` in struct `VirtualMachinesClientListOptions`
info	[Changelog] - New field `BypassPlatformSafetyChecksOnUserSchedule` in struct `WindowsVMGuestPatchAutomaticByPlatformSettings`
info	[Changelog]
info	[Changelog] Total 9 breaking change(s), 42 additive change(s).

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from a2140e7. 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]  WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
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

️✔️compute [View full logs] [Release Schema Changes]

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from a2140e7. 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
SSL error: syscall failure: Broken pipe
Error: SSL error: syscall failure: Broken pipe

❌Az.compute.DefaultTag [View full logs]

error	Fatal error: SSL error: syscall failure: Broken pipe
error	The following packages are still pending:
error		Az.compute.DefaultTag

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

openapi-pipeline-app · 2023-05-04T21:33:54Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/compute/armcompute	https://apiview.dev/Assemblies/Review/6dec01d8079147a6aaff74abc23d4f0a
Java	azure-resourcemanager-compute-generated	https://apiview.dev/Assemblies/Review/99d738e83c084eb4bf2618a77b6c426a
.Net	Azure.ResourceManager.Compute	https://apiview.dev/Assemblies/Review/27d876db3a504538a38daa32a13d0f37
JavaScript	@azure/arm-compute	https://apiview.dev/Assemblies/Review/fd83e8d1e4ce4137a5a0b631ecaca643

grizzlytheodore · 2023-05-04T21:38:56Z

...compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-03-03/communityGallery.json

+          "description": "The name of the gallery image definition SKU."
+        }
+      },
+      "description": "This is the community gallery image definition identifier."


this is the same object as GalleryImageIdentifier, except no required portion

kangsun-ctrl

LGTM

openapi-workflow-bot · 2023-05-05T00:28:42Z

Hi, @grizzlytheodore your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

grizzlytheodore · 2023-05-05T00:30:20Z

removing waitforARMReview tag because i accidentally marked "adding new service" but this is not adding new service

grizzlytheodore · 2023-05-05T00:34:55Z

@JeffreyRichter
please approve this breaking change. It is to fix the bug (ICM in the PR description),
For community gallery image, identifier.offer, publisher, sku properties to return as ‘null’ by design from API, but in swagger it is defined required: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-03-03/galleryRPCommon.json#L66

openapi-workflow-bot · 2023-05-05T05:25:33Z

Hi @grizzlytheodore, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

ArthurMa1978 · 2023-05-08T08:17:26Z

Hey @grizzlytheodore, as we replied in the email, please remove the required flag instead of introduce a new model.

grizzlytheodore · 2023-05-08T17:27:57Z

Hey @grizzlytheodore, as we replied in the email, please remove the required flag instead of introduce a new model.

please see my email on why i think creating this new model is necessary @ArthurMa1978

add community gallery image identifier

1ec42f3

ghost added the Compute label May 4, 2023

grizzlytheodore commented May 4, 2023

View reviewed changes

kangsun-ctrl approved these changes May 4, 2023

View reviewed changes

azure-sdk mentioned this pull request May 4, 2023

[AutoPR sdk/resourcemanager/compute/armcompute] add community gallery image identifier azure-sdk/azure-sdk-for-go#5571

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label May 4, 2023

AzureRestAPISpecReview added the resource-manager label May 4, 2023

azure-sdk mentioned this pull request May 4, 2023

[AutoPR @azure/arm-compute] add community gallery image identifier azure-sdk/azure-sdk-for-js#4982

Closed

openapi-pipeline-app bot added the CI-BreakingChange-JavaScript label May 4, 2023

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label May 4, 2023

grizzlytheodore marked this pull request as ready for review May 4, 2023 22:50

grizzlytheodore requested review from Sandido, dkulkarni-ms, haagha, madewithsmiles, MS-syh2qs and hyonholee as code owners May 4, 2023 22:50

openapi-assignment-bot bot assigned keryul May 4, 2023

openapi-workflow-bot bot added FixS360 ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 5, 2023

grizzlytheodore removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 5, 2023

raych1 added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label May 5, 2023

JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label May 5, 2023

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 5, 2023

sjanamma added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 5, 2023

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 5, 2023

ArcturusZhang added the DoNotMerge <valid label in PR review process> use to hold merge after approval label May 8, 2023

msyyc added the Approved-SdkBreakingChange-Python label May 16, 2023

tadelesh added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label May 16, 2023

qiaozha added the Approved-SdkBreakingChange-JavaScript label May 16, 2023

ArcturusZhang removed the DoNotMerge <valid label in PR review process> use to hold merge after approval label May 17, 2023

ArcturusZhang merged commit a2140e7 into main May 17, 2023

ArcturusZhang deleted the galleryFixBug branch May 17, 2023 03:00

tadelesh mentioned this pull request May 17, 2023

[Release] sdk/resourcemanager/compute/armcompute/5.0.0 Azure/azure-sdk-for-go#20784

Merged

This was referenced May 17, 2023

update 2022-08-03 with change that went into 2022-03-03 #23823

Closed

Compute community gallery fix track1 Azure/azure-sdk-for-net#36371

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add community gallery image identifier #23820

add community gallery image identifier #23820

grizzlytheodore commented May 4, 2023 •

edited

Loading

openapi-workflow-bot bot commented May 4, 2023

openapi-pipeline-app bot commented May 4, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 4, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented May 4, 2023 •

edited

Loading

grizzlytheodore May 4, 2023

kangsun-ctrl left a comment

openapi-workflow-bot bot commented May 5, 2023

grizzlytheodore commented May 5, 2023

grizzlytheodore commented May 5, 2023

openapi-workflow-bot bot commented May 5, 2023

ArthurMa1978 commented May 8, 2023

grizzlytheodore commented May 8, 2023

add community gallery image identifier #23820

add community gallery image identifier #23820

Conversation

grizzlytheodore commented May 4, 2023 • edited Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented May 4, 2023

openapi-pipeline-app bot commented May 4, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 4, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented May 4, 2023 • edited Loading

Generated ApiView

grizzlytheodore May 4, 2023

Choose a reason for hiding this comment

kangsun-ctrl left a comment

Choose a reason for hiding this comment

openapi-workflow-bot bot commented May 5, 2023

grizzlytheodore commented May 5, 2023

grizzlytheodore commented May 5, 2023

openapi-workflow-bot bot commented May 5, 2023

ArthurMa1978 commented May 8, 2023

grizzlytheodore commented May 8, 2023

grizzlytheodore commented May 4, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 4, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 4, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 4, 2023 •

edited

Loading