azure-rest-api-specs Adding maximumFaultDomainCountSupported and currentCapacity property for the Capacity Reservation Resource in API Version 2022-08-01

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

Changelog

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

What's the purpose of the update?
- [ ] new service onboarding
- [x] 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.
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- [x] SDK of .NET (need service team to ensure code readiness)
- [x] SDK of Python
- [x] SDK of Java
- [x] SDK of Js
- [x] SDK of Go
- [x] PowerShell
- [x] CLI
- [x] Terraform
- [ ] No refresh required for updates in this PR

Contribution checklist:

[x] I commit to follow the Breaking Change Policy of "no breaking changes"
[x] I have reviewed the documentation for the workflow.
[x] 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: :warning:

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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
[x] 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

[ ] Removing API(s) in a stable version
[ ] Removing properties in a stable version
[ ] Removing API version(s) in a stable version
[ ] Updating API in a stable or public preview version with Breaking Change Validation errors
[ ] Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

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

Aug 02 '22 17:08 grizzlytheodore

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. [email protected]

Aug 02 '22 17:08 openapi-workflow-bot[bot]

Swagger pipeline can not start as the pull request has merge conflicts.

Aug 02 '22 17:08 openapi-pipeline-app[bot]

Swagger pipeline can not start as the pull request has merge conflicts.

Aug 02 '22 17:08 openapi-pipeline-app[bot]

Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.

Aug 02 '22 17:08 openapi-pipeline-app[bot]

Swagger Validation Report

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

There are no breaking changes.

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

There are no breaking changes.

compared swaggers (via Oad v0.9.7)]	new version	base version
capacityReservation.json	2022-08-01(ac62b81)	2022-03-01(main)

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2022-08-01	package-2022-08-01(ac62b81)	package-2022-08-01(feature/cplat-2022-08-01)

The following errors/warnings exist before current PR submission:

Rule	Message
:warning: R1001 - OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'CapacityReservations' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ComputeRP/stable/2022-08-01/capacityReservation.json#L670
:warning: R2029 - PageableOperation	Based on the response model schema, operation 'CapacityReservationGroups_Get' might be pageable. Consider adding the x-ms-pageable extension. Location: ComputeRP/stable/2022-08-01/capacityReservation.json#L212
:warning: R2029 - PageableOperation	Based on the response model schema, operation 'CapacityReservations_Get' might be pageable. Consider adding the x-ms-pageable extension. Location: ComputeRP/stable/2022-08-01/capacityReservation.json#L595
:warning: R4021 - DescriptionAndTitleMissing	'CapacityReservationGroupInstanceView' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: ComputeRP/stable/2022-08-01/capacityReservation.json#L720

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
:warning: 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-2022-08-01

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️❌SDK Track2 Validation: 1 Errors, 0 Warnings failed [Detail]

The following tags are being changed in this PR

"https://github.com/Azure/azure-rest-api-specs/blob/ac62b81c7b900d7a2f579289efb7b1612c4a745b/specification/compute/resource-manager/readme.md#tag-package-2022-08-01">compute/resource-manager/readme.md#package-2022-08-01
"https://github.com/Azure/azure-rest-api-specs/blob/ac62b81c7b900d7a2f579289efb7b1612c4a745b/specification/compute/resource-manager/readme.md#tag-package-2022-08-01-only">compute/resource-manager/readme.md#package-2022-08-01-only

The following errors/warnings are introduced by current PR:

Rule Message

❌ PreCheck/DuplicateSchema "readme":"compute/resource-manager/readme.md",
"tag":"package-2022-08-01",
"details":"Duplicate Schema named 'PurchasePlan' (1 differences):\n - properties.promotionCode: => "$ref":"#/components/schemas/schemas:1402",
"description":"The Offer Promotion Code."; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."

Rule	Message
`❌` PreCheck/DuplicateSchema	"readme":"compute/resource-manager/readme.md", "tag":"package-2022-08-01", "details":"Duplicate Schema named 'PurchasePlan' (1 differences):\n - properties.promotionCode: => "$ref":"#/components/schemas/schemas:1402", "description":"The Offer Promotion Code."; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."

The following errors/warnings exist before current PR submission:

Rule	Message
`❌`	"readme":"compute/resource-manager/readme.md", "tag":"package-2022-08-01", "details":"Error: 1 errors occured -- cannot continue."
:warning: UnkownSecurityScheme	"readme":"compute/resource-manager/readme.md", "tag":"package-2022-08-01-only", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous"

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

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

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

Validation passes for CadlValidation.

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

Aug 02 '22 18:08 openapi-pipeline-app[bot]

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️⚠️SDK Breaking Change Tracking warning [Detail]

Breaking Changes Tracking

⚠️azure-sdk-for-go - armcompute - 4.0.0

+	Function `*CloudServicesClient.BeginCreateOrUpdate` parameter(s) have been changed from `(context.Context, string, string, CloudService, *CloudServicesClientBeginCreateOrUpdateOptions)` to `(context.Context, string, string, *CloudServicesClientBeginCreateOrUpdateOptions)`
+	Function `*CloudServicesClient.BeginUpdate` parameter(s) have been changed from `(context.Context, string, string, CloudServiceUpdate, *CloudServicesClientBeginUpdateOptions)` to `(context.Context, string, string, *CloudServicesClientBeginUpdateOptions)`
+	Function `*CloudServicesUpdateDomainClient.BeginWalkUpdateDomain` parameter(s) have been changed from `(context.Context, string, string, int32, UpdateDomain, *CloudServicesUpdateDomainClientBeginWalkUpdateDomainOptions)` to `(context.Context, string, string, int32, *CloudServicesUpdateDomainClientBeginWalkUpdateDomainOptions)`
+	Type of `SharingProfile.CommunityGalleryInfo` has been changed from `interface{}` to `*CommunityGalleryInfo`

⚠️azure-sdk-for-python-track2 - track2_azure-mgmt-compute - 27.2.0

+	Model PurchasePlan no longer has parameter promotion_code
+	Operation VirtualMachineRunCommandsOperations.begin_create_or_update no longer has parameter content_type
+	Operation VirtualMachineRunCommandsOperations.begin_update no longer has parameter content_type
+	Operation VirtualMachineScaleSetVMRunCommandsOperations.begin_create_or_update no longer has parameter content_type
+	Operation VirtualMachineScaleSetVMRunCommandsOperations.begin_update no longer has parameter content_type
+	Operation VirtualMachineScaleSetVMsOperations.begin_run_command no longer has parameter content_type
+	Operation VirtualMachinesOperations.begin_run_command no longer has parameter content_type

⚠️azure-sdk-for-js - @azure/arm-compute - 20.0.0

+	Enum KnownOrchestrationServiceNames no longer has value DummyOrchestrationServiceName

⚠️azure-sdk-for-go - sdk/resourcemanager/compute/armcompute - 4.0.0

+	Function `*CloudServicesClient.BeginCreateOrUpdate` parameter(s) have been changed from `(context.Context, string, string, CloudService, *CloudServicesClientBeginCreateOrUpdateOptions)` to `(context.Context, string, string, *CloudServicesClientBeginCreateOrUpdateOptions)`
+	Function `*CloudServicesClient.BeginUpdate` parameter(s) have been changed from `(context.Context, string, string, CloudServiceUpdate, *CloudServicesClientBeginUpdateOptions)` to `(context.Context, string, string, *CloudServicesClientBeginUpdateOptions)`
+	Function `*CloudServicesUpdateDomainClient.BeginWalkUpdateDomain` parameter(s) have been changed from `(context.Context, string, string, int32, UpdateDomain, *CloudServicesUpdateDomainClientBeginWalkUpdateDomainOptions)` to `(context.Context, string, string, int32, *CloudServicesUpdateDomainClientBeginWalkUpdateDomainOptions)`
+	Type of `SharingProfile.CommunityGalleryInfo` has been changed from `interface{}` to `*CommunityGalleryInfo`

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 30bc8eef6816782c35a4a080825a9545d18eeced. 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
warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.Compute [View full logs] [Preview SDK Changes]
- Azure.ResourceManager.Compute.1.1.0-alpha.20220825.1.nupkg
```
info	[Changelog]
```

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

⚠️Warning [Logs] Generate from 30bc8eef6816782c35a4a080825a9545d18eeced. 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

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

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Model CapacityReservation has a new parameter platform_fault_domain_count
info	[Changelog]   - Model CapacityReservationUpdate has a new parameter platform_fault_domain_count
info	[Changelog]   - Model CapacityReservationUtilization has a new parameter current_capacity
info	[Changelog]
info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog]   - Model PurchasePlan no longer has parameter promotion_code
info	[Changelog]   - Operation VirtualMachineRunCommandsOperations.begin_create_or_update no longer has parameter content_type
info	[Changelog]   - Operation VirtualMachineRunCommandsOperations.begin_update no longer has parameter content_type
info	[Changelog]   - Operation VirtualMachineScaleSetVMRunCommandsOperations.begin_create_or_update no longer has parameter content_type
info	[Changelog]   - Operation VirtualMachineScaleSetVMRunCommandsOperations.begin_update no longer has parameter content_type
info	[Changelog]   - Operation VirtualMachineScaleSetVMsOperations.begin_run_command no longer has parameter content_type
info	[Changelog]   - Operation VirtualMachinesOperations.begin_run_command no longer has parameter content_type

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

️✔️Succeeded [Logs] Generate from 30bc8eef6816782c35a4a080825a9545d18eeced. 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-compute-generated [View full logs] [Preview SDK Changes]

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

️✔️Succeeded [Logs] Generate from 30bc8eef6816782c35a4a080825a9545d18eeced. 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] [Preview SDK Changes]

azure-arm-compute-19.2.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Interface CapacityReservation has a new optional parameter platformFaultDomainCount
info	[Changelog]   - Interface CapacityReservationUpdate has a new optional parameter platformFaultDomainCount
info	[Changelog]   - Interface CapacityReservationUtilization has a new optional parameter currentCapacity
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

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

️✔️Succeeded [Logs] Generate from 30bc8eef6816782c35a4a080825a9545d18eeced. 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] [Preview SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `*CloudServicesUpdateDomainClient.BeginWalkUpdateDomain` parameter(s) have been changed from `(context.Context, string, string, int32, UpdateDomain, *CloudServicesUpdateDomainClientBeginWalkUpdateDomainOptions)` to `(context.Context, string, string, int32, *CloudServicesUpdateDomainClientBeginWalkUpdateDomainOptions)`
info	[Changelog] - Function `*CloudServicesClient.BeginUpdate` parameter(s) have been changed from `(context.Context, string, string, CloudServiceUpdate, *CloudServicesClientBeginUpdateOptions)` to `(context.Context, string, string, *CloudServicesClientBeginUpdateOptions)`
info	[Changelog] - Function `*CloudServicesClient.BeginCreateOrUpdate` parameter(s) have been changed from `(context.Context, string, string, CloudService, *CloudServicesClientBeginCreateOrUpdateOptions)` to `(context.Context, string, string, *CloudServicesClientBeginCreateOrUpdateOptions)`
info	[Changelog] - Type of `SharingProfile.CommunityGalleryInfo` has been changed from `interface{}` to `*CommunityGalleryInfo`
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New field `Parameters` in struct `CloudServicesUpdateDomainClientBeginWalkUpdateDomainOptions`
info	[Changelog] - New field `CurrentCapacity` in struct `CapacityReservationUtilization`
info	[Changelog] - New field `Parameters` in struct `CloudServicesClientBeginCreateOrUpdateOptions`
info	[Changelog] - New field `Parameters` in struct `CloudServicesClientBeginUpdateOptions`
info	[Changelog] - New field `PlatformFaultDomainCount` in struct `CapacityReservationProperties`
info	[Changelog]
info	[Changelog] Total 4 breaking change(s), 5 additive change(s).

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

⚠️Warning [Logs] Generate from 30bc8eef6816782c35a4a080825a9545d18eeced. 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] [Preview Schema Changes]

️❌ azure-powershell failed [Detail]

❌Failed [Logs] Generate from 30bc8eef6816782c35a4a080825a9545d18eeced. 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.compute [View full logs] [Preview SDK Changes]

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

Aug 02 '22 18:08 openapi-pipeline-app[bot]

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/compute/armcompute	Create ApiView failed. Please ask PR assignee for help
Java	azure-resourcemanager-compute-generated	Create ApiView failed. Please ask PR assignee for help
JavaScript	@azure/arm-compute	Create ApiView failed. Please ask PR assignee for help
.Net	Azure.ResourceManager.Compute	Create ApiView failed. Please ask PR assignee for help
Python	track2_azure-mgmt-compute	Create ApiView failed. Please ask PR assignee for help

Aug 02 '22 18:08 openapi-pipeline-app[bot]

Hi @grizzlytheodore, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

Aug 02 '22 19:08 openapi-workflow-bot[bot]

for some reason, it's not letting me set this as approved, but approving verbally

Aug 09 '22 19:08 grizzlytheodore

azure-rest-api-specs azure-rest-api-specs copied to clipboard

Adding maximumFaultDomainCountSupported and currentCapacity property for the Capacity Reservation Resource in API Version 2022-08-01

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Swagger Validation Report

Swagger Generation Artifacts

Breaking Changes Tracking

Generated ApiView

azure-rest-api-specs
azure-rest-api-specs copied to clipboard