Add "Warning" to the EP HealthStatus field

[yirsu]

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:

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.
   June/July 2023
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
   June/July 2023
4. 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]

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

[openapi-pipeline-app]

Swagger Validation Report

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

compared swaggers (via Oad v0.10.4)]	new version	base version
enterprisePolicy.json	2020-10-30-preview(9506d00)	2020-10-30-preview(main)

Rule	Message
❌ 1020 - AddedEnumValue	The new version is adding enum value(s) 'Warning' from the old version. New: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L500:9 Old: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L500:9
❌ 1020 - AddedEnumValue	The new version is adding enum value(s) 'Warning' from the old version. New: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L647:5 Old: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L647:5

️️✔️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.1.1)	new version	base version
package-2020-10-30-preview	package-2020-10-30-preview(9506d00)	package-2020-10-30-preview(main)

The following errors/warnings exist before current PR submission:

Rule	Message
❌ ResourceNameRestriction	The resource name parameter 'enterprisePolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L30
❌ 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
❌ 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
❌ 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
❌ UnSupportedPatchProperties	The patch operation body parameter schema should not contains property name. Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L226
❌ UnSupportedPatchProperties	The patch operation body parameter schema should not contains property type. Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L226
❌ UnSupportedPatchProperties	The patch operation body parameter schema should not contains property location. Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L226
❌ 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#L590
⚠️ 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
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L466
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L476
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json#L490

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

Validation passes for Avocado.

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

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/powerplatform/armpowerplatform - 0.3.0

+	Operation `*PrivateEndpointConnectionsClient.BeginCreateOrUpdate` has been changed to non-LRO, use `*PrivateEndpointConnectionsClient.CreateOrUpdate` instead.
+	Operation `*PrivateEndpointConnectionsClient.BeginDelete` has been changed to non-LRO, use `*PrivateEndpointConnectionsClient.Delete` instead.

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

• ⚠️Warning [Logs]Release - Generate from ebf1c68. 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.7
  cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.7>
  cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
  cmderr	[automation_generate.sh] npm notice
  warn	No package detected after generation

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

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

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

• ️✔️Succeeded [Logs]Release - Generate from ebf1c68. 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/powerplatform/armpowerplatform [View full logs]  [Release SDK Changes] Breaking Change Detected

  info	[Changelog] ### Breaking Changes
  info	[Changelog]
  info	[Changelog] - Operation `*PrivateEndpointConnectionsClient.BeginCreateOrUpdate` has been changed to non-LRO, use `*PrivateEndpointConnectionsClient.CreateOrUpdate` instead.
  info	[Changelog] - Operation `*PrivateEndpointConnectionsClient.BeginDelete` has been changed to non-LRO, use `*PrivateEndpointConnectionsClient.Delete` instead.
  info	[Changelog]
  info	[Changelog] ### Features Added
  info	[Changelog]
  info	[Changelog] - New value `EnterprisePolicyKindIdentity` added to enum type `EnterprisePolicyKind`
  info	[Changelog] - New enum type `HealthStatus` with values `HealthStatusHealthy`, `HealthStatusUndetermined`, `HealthStatusUnhealthy`, `HealthStatusWarning`
  info	[Changelog] - New field `SystemID` in struct `AccountProperties`
  info	[Changelog] - New field `HealthStatus`, `SystemID` in struct `Properties`
  info	[Changelog]
  info	[Changelog] Total 2 breaking change(s), 8 additive change(s).

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

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

️❌ azure-powershell failed [Detail]

• ❌Pipeline Framework Failed [Logs]Release - Generate from ebf1c68. 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.powerplatform.DefaultTag [View full logs] 
  • Az.PowerPlatform.0.1.0.nupkg

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

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

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/powerplatform/armpowerplatform	https://apiview.dev/Assemblies/Review/b11cda4de61b4bc9bb2663e2e4c886f4
Java	azure-resourcemanager-powerplatform	https://apiview.dev/Assemblies/Review/dc648a764c5a440985c5d3289278963f

[openapi-workflow-bot]

Hi @yirsu, 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.

[yirsu]

breaking change scenario: https://msazure.visualstudio.com/One/_workitems/edit/23128392

[ankhyk]

breaking change scenario: https://msazure.visualstudio.com/One/_workitems/edit/23128392

Hi @yirsu I have no permission for this work item, can you bring it to pr comment?

[yirsu]

@keryul

Request:	Microsoft.PowerPlatform
Scope:	API
Problem space Scenario details	We need to add a new enum value "Warning" as an allowed value for readonly property "healthStatus" to the enterprise policy resource model.  Current values: "Undetermined", "Healthy", "Unhealthy"New values: "Undetermined", "Healthy", "Warning", "Unhealthy"Note that this field is readonly to the customer, and the health check feature has not rolled out yet so there is no customer impact of adding another allowed value into the enum
Proposal for review	Add enum value "Warning" to the readonly "healthStatus" field
Business Justification:	This is needed for Power Platform CMK feature
Client Library Implication	no
Announcement date:	No announcement requested
Implementation date:	already implemented
Current Customer count:	CMK feature is under public previewHealth status feature of CMK has not rolled out yet, 0 customer
Current S500 customers:	N/A
Migration	No action for the customer. It is a read-only property consumed by other internal services.
External comms	Communication not desired.

Details

Name of org	Power Platform Developer and Admin Experiences
Name of team contact	Yiran Sun
Name of service impacted	Microsoft.PowerPlatform
What is being changed?	API.
1-2 sentence detail on what is being changed	Adding enum value to a readonly property in the API swagger.
Lifecycle of the service being changed	CMK - public preview
External documentation available	Manage your customer-managed encryption key in Power Platform - Power Platform | Microsoft Learn
Specify the Impact category (breaking change, requires downtime, seamless)	Seamless
Is this breaking change essential (security, compliance)?	feature request
Adheres to the Breaking change policy for services (36 months)	no
Are you seeking an exception to the policy	Unclear. Some doc indicates that adding/changing a readonly property is not a breaking change.
Business Justification for the exception. (reasons, timeline for approval).Note: This requires service teams to present and seek sign off from the Office of the CTO.
Any dependencies on Non Microsoft Technologies	no
List the Non Microsoft Technology

Customer Impact

Number of customers impacted	0
Number of production subscriptions impacted	0
Number of S500/S400 impacted customers	0
Top 10 impacted customers	N/A
Customer specific mitigation plans	N/A
Do any other products have dependency on the scope of this breaking change?	no

[ankhyk]

We need to add a new enum value "Warning" as an allowed value for readonly property "healthStatus" to the enterprise policy resource model. Current values: "Undetermined", "Healthy", "Unhealthy"New values: "Undetermined", "Healthy", "Warning", "Unhealthy"Note that this field is readonly to the customer, and the health check feature has not rolled out yet so there is no customer impact of adding another allowed value into the enum

Breaking Change approved as no customer impact

[ArcturusZhang]

Go breaking change does not come from this swagger PR, ignoring