Document read-only system id property for Power Platform account and enterprise policy resources

[dkappes-msft]

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:

1. 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
2. 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. 7/2022
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. 7/2022
4. If updating an existing version, please select the specific language 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 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.

• 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]

Hi, @dkappes-msft 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]

Swagger Validation Report

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

compared swaggers (via Oad v0.9.6)]	new version	base version
2020-10-30-preview	2020-10-30(783d1ff)	2020-10-30(main)

Rule	Message
❌ 1045 - AddedOptionalProperty	The new version has a new optional property 'systemId' that was not found in the old version. New: Microsoft.PowerPlatform/preview/2020-10-30-preview/account.json#L399:7 Old: Microsoft.PowerPlatform/preview/2020-10-30-preview/account.json#L399:7
❌ 1045 - AddedOptionalProperty	The new version has a new optional property 'systemId' that was not found in the old version. New: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L460:7 Old: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L460: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 v1.13.0)	new version	base version
package-2020-10-30-preview	package-2020-10-30-preview(783d1ff)	package-2020-10-30-preview(main)

The following errors/warnings exist before current PR submission:

Rule	Message
❌ R4037 - MissingTypeObject	The schema 'VirtualNetworkPropertiesList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L585
❌ R4039 - ParametersOrder	The parameters:accountName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/account.json#L31
❌ R4039 - ParametersOrder	The parameters:accountName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/account.json#L97
❌ R4039 - ParametersOrder	The parameters:accountName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/account.json#L147
❌ R4039 - ParametersOrder	The parameters:accountName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/account.json#L198
❌ R4039 - ParametersOrder	The parameters:enterprisePolicyName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L31
❌ R4039 - ParametersOrder	The parameters:enterprisePolicyName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L97
❌ R4039 - ParametersOrder	The parameters:enterprisePolicyName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L198
⚠️ R4024 - PreviewVersionOverOneYear	The API version:2020-10-30-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/account.json#L4
⚠️ R4024 - PreviewVersionOverOneYear	The API version:2020-10-30-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L4

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

Validation passes for Avocado.

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

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

• The following tags are being changed in this PR
• powerplatform/resource-manager/readme.md#package-2020-10-30-preview

The following errors/warnings are introduced by current PR:

|:speech_balloon: |"readme":"powerplatform/resource-manager/readme.md",
"tag":"package-2020-10-30-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)"|
|:speech_balloon: |"readme":"powerplatform/resource-manager/readme.md",
"tag":"package-2020-10-30-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)"|
|:speech_balloon: |"readme":"powerplatform/resource-manager/readme.md",
"tag":"package-2020-10-30-preview",
"details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)"|
|:speech_balloon: |"readme":"powerplatform/resource-manager/readme.md",
"tag":"package-2020-10-30-preview",
"details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)"|
|:speech_balloon: |"readme":"powerplatform/resource-manager/readme.md",
"tag":"package-2020-10-30-preview",
"details":"Autorest completed in 10.34s. 0 files generated."|

The following errors/warnings exist before current PR submission:

|:speech_balloon: |"readme":"powerplatform/resource-manager/readme.md",
"tag":"package-2020-10-30-preview",
"details":"AutoRest core version selected from configuration: ^3.2.0."|

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

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

[openapi-pipeline-app]

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account. 

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️✔️azure-sdk-for-go - armpowerplatform - 0.2.0

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

• ⚠️Warning [Logs]Release - Generate from ea28da8. 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]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.
  cmderr	[automation_generate.sh] npm notice
  cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.11.0 -> 8.13.2
  cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.13.2>
  cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.13.2` to update!
  cmderr	[automation_generate.sh] npm notice
  warn	No package detected after generation

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

• ️✔️Succeeded [Logs]Release - Generate from ea28da8. 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-powerplatform [View full logs]  [Release SDK Changes]
  • pom.xml
  • azure-resourcemanager-powerplatform-1.0.0-beta.1.jar
  • azure-resourcemanager-powerplatform-1.0.0-beta.1-sources.jar

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

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

• ️✔️armpowerplatform [View full logs]  [Release SDK Changes]

  info	[Changelog] ### Features Added
  info	[Changelog]
  info	[Changelog] - New field `SystemID` in struct `Properties`
  info	[Changelog] - New field `SystemID` in struct `AccountProperties`
  info	[Changelog]
  info	[Changelog] Total 0 breaking change(s), 2 additive change(s).

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

• ⚠️Warning [Logs]Release - Generate from ea28da8. 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] deprecated 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] WARN deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
  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
  warn	No file changes detected after generation
  warn	No package detected after generation

️️✔️ azure-powershell succeeded [Detail] [Expand]

• ️✔️Succeeded [Logs]Release - Generate from ea28da8. 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.PowerPlatform [View full logs]  [Release SDK Changes]
  • Az.PowerPlatform.0.1.0.nupkg

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

[openapi-workflow-bot]

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

[sadjadbp]

@honghr PR is ready for your review