Add xms-ids for mixedreality #17824

LinglingTong · 2022-02-11T22:09:46Z

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
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify

About this Change

APIs will need to start indicating item uniqueness in arrays. By default, uniqueness is the string property called "id" of items in an array. When that property does not exist, the x-ms-identifiers extension property must be used to specify the identifying property(s) or lack thereof. This pull request is my best guess effort to ease resource providers into the new requirement before it becomes enforced. Compliance and accuracy will need to be owned and maintained by the resource provider going forward.

See https://github.com/Azure/autorest/tree/main/docs/extensions#x-ms-identifiers.

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 langauge SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- 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.
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.

openapi-workflow-bot · 2022-02-11T22:09:48Z

Hi, @LinglingTong 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. vsswagger@microsoft.com

openapi-workflow-bot · 2022-02-11T22:09:49Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-pipeline-app · 2022-02-11T22:09:50Z

Swagger Validation Report

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

There are no breaking changes.

Compared Swaggers (Based on Oad v0.9.1)
- current:Microsoft.MixedReality/preview/2021-03-01-preview compared with base:Microsoft.MixedReality/preview/2021-03-01-preview

️🔄LintDiff inProgress [Detail]

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

Validation passes for Avocado.

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

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

️🔄SDK Track2 Validation inProgress [Detail]

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

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

openapi-pipeline-app · 2022-02-11T22:09:51Z

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-track2 - armmixedreality - 0.3.0

️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-mixedreality - 1.0.0
️✔️azure-sdk-for-go - mixedreality/mgmt/2021-01-01/mixedreality - v61.4.0
️✔️azure-sdk-for-go - preview/mixedreality/mgmt/2021-03-01-preview/mixedreality - v61.4.0
❌azure-sdk-for-go - preview/mixedreality/mgmt/2020-05-01-preview/mixedreality - v61.4.0

+	Const `False` has been removed
+	Const `True` has been removed
+	Function `PossibleNameAvailabilityValues` has been removed
+	Function `RemoteRenderingAccountIdentity.MarshalJSON` has been removed
+	Struct `RemoteRenderingAccountIdentity` has been removed
+	Type of `CheckNameAvailabilityResponse.NameAvailable` has been changed from `NameAvailability` to `*bool`
+	Type of `RemoteRenderingAccount.Identity` has been changed from `*RemoteRenderingAccountIdentity` to `*Identity`

️✔️azure-sdk-for-go - preview/mixedreality/mgmt/2019-02-28/mixedreality - v61.4.0

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

️✔️Succeeded [Logs]Release - Generate from a0c83df. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-6.0
command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/mixedreality/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied

️✔️Microsoft.Azure.Management.MixedReality [View full logs] [Release SDK Changes]
- Microsoft.Azure.Management.MixedReality.3.0.0.nupkg
- Microsoft.Azure.Management.MixedReality.3.0.0.symbols.nupkg

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

❌Failed [Logs]Release - Generate from a0c83df. 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]
cmderr	[automation_generate.sh] npm notice New patch version of npm available! 8.5.0 -> 8.5.5
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.5.5>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.5.5` to update!
cmderr	[automation_generate.sh] npm notice
cmdout	[automation_generate.sh] [Autorest]/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
warn	Skip package processing as generation is failed

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

⚠️Warning [Logs]Release - Generate from a0c83df. 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
cmderr	[automation_init.sh] deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh]  uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
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-mixedreality [View full logs] [Release SDK Changes]

azure-arm-mixedreality-4.1.0-beta.1.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation group ObjectAnchorsAccounts
info	[Changelog]   - Added Interface ObjectAnchorsAccountPage
info	[Changelog]   - Added Interface ObjectAnchorsAccountsCreateOptionalParams
info	[Changelog]   - Added Interface ObjectAnchorsAccountsDeleteOptionalParams
info	[Changelog]   - Added Interface ObjectAnchorsAccountsGetOptionalParams
info	[Changelog]   - Added Interface ObjectAnchorsAccountsListByResourceGroupNextOptionalParams
info	[Changelog]   - Added Interface ObjectAnchorsAccountsListByResourceGroupOptionalParams
info	[Changelog]   - Added Interface ObjectAnchorsAccountsListBySubscriptionNextOptionalParams
info	[Changelog]   - Added Interface ObjectAnchorsAccountsListBySubscriptionOptionalParams
info	[Changelog]   - Added Interface ObjectAnchorsAccountsListKeysOptionalParams
info	[Changelog]   - Added Interface ObjectAnchorsAccountsRegenerateKeysOptionalParams
info	[Changelog]   - Added Interface ObjectAnchorsAccountsUpdateOptionalParams
info	[Changelog]   - Added Type Alias ObjectAnchorsAccount
info	[Changelog]   - Added Type Alias ObjectAnchorsAccountIdentity
info	[Changelog]   - Added Type Alias ObjectAnchorsAccountsCreateResponse
info	[Changelog]   - Added Type Alias ObjectAnchorsAccountsGetResponse
info	[Changelog]   - Added Type Alias ObjectAnchorsAccountsListByResourceGroupNextResponse
info	[Changelog]   - Added Type Alias ObjectAnchorsAccountsListByResourceGroupResponse
info	[Changelog]   - Added Type Alias ObjectAnchorsAccountsListBySubscriptionNextResponse
info	[Changelog]   - Added Type Alias ObjectAnchorsAccountsListBySubscriptionResponse
info	[Changelog]   - Added Type Alias ObjectAnchorsAccountsListKeysResponse
info	[Changelog]   - Added Type Alias ObjectAnchorsAccountsRegenerateKeysResponse
info	[Changelog]   - Added Type Alias ObjectAnchorsAccountsUpdateResponse
info	[Changelog]   - Interface MetricDimension has a new optional parameter toBeExportedForShoebox
info	[Changelog]   - Class MixedRealityClient has a new parameter objectAnchorsAccounts
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

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

️✔️Succeeded [Logs]Release - Generate from a0c83df. SDK Automation 14.0.0

command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️mixedreality/mgmt/2021-01-01/mixedreality [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New field `SupportedTimeGrainTypes` in struct `MetricSpecification`
info	[Changelog] - New field `MetricFilterPattern` in struct `MetricSpecification`
info	[Changelog] - New field `Category` in struct `MetricSpecification`
info	[Changelog] - New field `EnableRegionalMdmAccount` in struct `MetricSpecification`
info	[Changelog] - New field `SupportedAggregationTypes` in struct `MetricSpecification`
info	[Changelog] - New field `SourceMdmAccount` in struct `MetricSpecification`
info	[Changelog] - New field `SourceMdmNamespace` in struct `MetricSpecification`
info	[Changelog] - New field `LockedAggregationType` in struct `MetricSpecification`
info	[Changelog] - New field `FillGapWithZero` in struct `MetricSpecification`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 1 additive change(s).

️✔️preview/mixedreality/mgmt/2021-03-01-preview/mixedreality [View full logs]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New field `SourceMdmAccount` in struct `MetricSpecification`
info	[Changelog] - New field `MetricFilterPattern` in struct `MetricSpecification`
info	[Changelog] - New field `FillGapWithZero` in struct `MetricSpecification`
info	[Changelog] - New field `EnableRegionalMdmAccount` in struct `MetricSpecification`
info	[Changelog] - New field `SupportedAggregationTypes` in struct `MetricSpecification`
info	[Changelog] - New field `SourceMdmNamespace` in struct `MetricSpecification`
info	[Changelog] - New field `LockedAggregationType` in struct `MetricSpecification`
info	[Changelog] - New field `Category` in struct `MetricSpecification`
info	[Changelog] - New field `SupportedTimeGrainTypes` in struct `MetricSpecification`
info	[Changelog] - New field `ToBeExportedForShoebox` in struct `MetricDimension`
info	[Changelog] - New field `Kind` in struct `ObjectAnchorsAccount`
info	[Changelog] - New field `Plan` in struct `ObjectAnchorsAccount`
info	[Changelog] - New field `Sku` in struct `ObjectAnchorsAccount`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 3 additive change(s).

️✔️preview/mixedreality/mgmt/2020-05-01-preview/mixedreality [View full logs]

Only show 30 items here, please refer to log for details.

info	[Changelog] - Struct `RemoteRenderingAccountIdentity` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `Application`
info	[Changelog] - New const `ManagedIdentity`
info	[Changelog] - New const `Key`
info	[Changelog] - New const `User`
info	[Changelog] - New function `PossibleCreatedByTypeValues() []CreatedByType`
info	[Changelog] - New struct `LogSpecification`
info	[Changelog] - New struct `MetricDimension`
info	[Changelog] - New struct `MetricSpecification`
info	[Changelog] - New struct `OperationProperties`
info	[Changelog] - New struct `ServiceSpecification`
info	[Changelog] - New struct `SystemData`
info	[Changelog] - New field `SystemData` in struct `RemoteRenderingAccount`
info	[Changelog] - New field `Sku` in struct `RemoteRenderingAccount`
info	[Changelog] - New field `Plan` in struct `RemoteRenderingAccount`
info	[Changelog] - New field `Kind` in struct `RemoteRenderingAccount`
info	[Changelog] - New field `StorageAccountName` in struct `AccountProperties`
info	[Changelog] - New field `IsDataAction` in struct `Operation`
info	[Changelog] - New field `Origin` in struct `Operation`
info	[Changelog] - New field `Properties` in struct `Operation`
info	[Changelog] - New field `Plan` in struct `SpatialAnchorsAccount`
info	[Changelog] - New field `Sku` in struct `SpatialAnchorsAccount`
info	[Changelog] - New field `Kind` in struct `SpatialAnchorsAccount`
info	[Changelog] - New field `SystemData` in struct `SpatialAnchorsAccount`
info	[Changelog] - New field `Identity` in struct `SpatialAnchorsAccount`
info	[Changelog]
info	[Changelog] Total 8 breaking change(s), 21 additive change(s).

️✔️preview/mixedreality/mgmt/2019-02-28/mixedreality [View full logs]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

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

️✔️Succeeded [Logs]Release - Generate from a0c83df. 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

️✔️armmixedreality [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `CloudErrorBody.MarshalJSON` has been removed
info	[Changelog] - Struct `CloudError` has been removed
info	[Changelog] - Struct `CloudErrorBody` has been removed
info	[Changelog]
info	[Changelog] Total 5 breaking change(s), 0 additive change(s).

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

️✔️Succeeded [Logs]Release - Generate from a0c83df. 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-mixedreality [View full logs] [Release SDK Changes]

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

⚠️Warning [Logs]Release - Generate from a0c83df. 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
warn	No file changes detected after generation

️✔️mixedreality [View full logs]

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

LinglingTong · 2022-02-28T17:58:37Z

@ruowan There are only a few lines of changes in this PR and the identifiers all look intuitive. I wonder if you could help me with a code review and mering this PR. Thanks a lot!

ghost · 2022-03-20T16:02:08Z

Hi, @LinglingTong. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

add xms-ids for mixedreality

26ddeba

openapi-assignment-bot bot assigned leniatgh Feb 11, 2022

openapi-pipeline-app bot added the CI-BreakingChange-Go-V2 label Feb 11, 2022

leniatgh assigned ruowan and unassigned leniatgh Feb 14, 2022

jianyexi added the Approved-LintDiff label Mar 1, 2022

ghost added no-recent-activity and removed no-recent-activity labels Mar 20, 2022

ruowan approved these changes Mar 31, 2022

View reviewed changes

ruowan merged commit a0c83df into Azure:main Mar 31, 2022

FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request May 16, 2022

add xms-ids for mixedreality (Azure#17824)

0deec35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add xms-ids for mixedreality #17824

Add xms-ids for mixedreality #17824

Uh oh!

LinglingTong commented Feb 11, 2022

Uh oh!

openapi-workflow-bot bot commented Feb 11, 2022

Uh oh!

openapi-workflow-bot bot commented Feb 11, 2022

Uh oh!

openapi-pipeline-app bot commented Feb 11, 2022 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Feb 11, 2022 •

edited

Loading

Breaking Changes Tracking

Uh oh!

LinglingTong commented Feb 28, 2022

Uh oh!

ghost commented Mar 20, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Add xms-ids for mixedreality #17824

Add xms-ids for mixedreality #17824

Uh oh!

Conversation

LinglingTong commented Feb 11, 2022

Changelog

About this Change

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented Feb 11, 2022

Uh oh!

openapi-workflow-bot bot commented Feb 11, 2022

Uh oh!

openapi-pipeline-app bot commented Feb 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented Feb 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

LinglingTong commented Feb 28, 2022

Uh oh!

ghost commented Mar 20, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

openapi-pipeline-app bot commented Feb 11, 2022 •

edited

Loading

openapi-pipeline-app bot commented Feb 11, 2022 •

edited

Loading