[Hub Generated] Review request for Microsoft.HealthcareApis to add version stable/2023-11-01 #26628

jnlycklama · 2023-11-08T21:42:20Z

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

New API version. (Such PR should have been generated with OpenAPI Hub).
Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
Update existing version to fix swagger quality issues in S360.
Other, please clarify:
- edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.

Breaking changes review (Step 1)

If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
- The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
- You believe there is no need for you to request breaking change approval, for any reason.
  Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

If this PR is in purview of ARM review then automation will add the ARMReview label.
If you want to force ARM review, add the label yourself.
Proceed according to the diagram at the top of this comment.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

Getting help

For general PR approval workflow, see the diagram at the top of this comment.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

…023-09-06 to version 2023-11-01

openapi-pipeline-app · 2023-11-08T21:42:23Z

Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

openapi-pipeline-app · 2023-11-08T21:42:24Z

Swagger Validation Report

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

There are no breaking changes.

️⚠️Breaking Change(Cross-Version): 16 Warnings warning [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
healthcare-apis.json	2023-11-01(9577d77)	2023-09-06(main)
healthcare-apis.json	2023-11-01(9577d77)	2022-10-01-preview(main)

The following breaking changes are detected by comparison with the latest preview version:

Rule	Message
⚠️ 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/analyticsconnectors' removed or restructured? Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2202:5
⚠️ 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/analyticsconnectors/{analyticsConnectorName}' removed or restructured? Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2247:5
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'FhirServiceAccessPolicies' removed or renamed? New: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L2287:3 Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorPatchResource' removed or renamed? New: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L2287:3 Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'AnalyticsConnector' removed or renamed? New: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L2287:3 Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorProperties' removed or renamed? New: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L2287:3 Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorDataSource' removed or renamed? New: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L2287:3 Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorFhirServiceDataSource' removed or renamed? New: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L2287:3 Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorMapping' removed or renamed? New: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L2287:3 Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorFhirToParquetMapping' removed or renamed? New: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L2287:3 Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorDataDestination' removed or renamed? New: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L2287:3 Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'AnalyticsConnectorDataLakeDataDestination' removed or renamed? New: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L2287:3 Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L2545:3
⚠️ 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'subscriptionId' removed or renamed? New: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L4127:3 Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L4582:3
⚠️ 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'apiVersion' removed or renamed? New: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L4127:3 Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L4582:3
⚠️ 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'analyticsConnectorName' removed or renamed? New: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L4127:3 Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L4582:3
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'accessPolicies' renamed or removed? New: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L3769:7 Old: Microsoft.HealthcareApis/preview/2022-10-01-preview/healthcare-apis.json#L4009:7

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

There is no credential detected.

️⚠️LintDiff: 1 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.6)	new version	base version
package-2023-11	package-2023-11(9577d77)	default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L4085

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 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L37
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L138
`❌` PatchResponseCodes	Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L143
`❌` PatchIdentityProperty	The patch operation body parameter schema should contain property 'identity'. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L168
`❌` LroPatch202	The async patch operation should return 202. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L178
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L188
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L220
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L229
`❌` ResourceNameRestriction	The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L361
`❌` GetCollectionOnlyHasValueAndNextLink	Get endpoints for collections of resources must only have the `value` and `nextLink` properties in their model. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L385
`❌` ResourceNameRestriction	The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L406
`❌` ResourceNameRestriction	The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L406
`❌` ProvisioningStateSpecifiedForLROPut	201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L450
`❌` PutRequestResponseSchemeArm	A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'PrivateEndpointConnections_CreateOrUpdate' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L450
`❌` PutResponseCodes	Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L450
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L492
`❌` DeleteResponseCodes	Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L503
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L530
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L539
`❌` ResourceNameRestriction	The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L551
`❌` GetCollectionOnlyHasValueAndNextLink	Get endpoints for collections of resources must only have the `value` and `nextLink` properties in their model. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L575
`❌` ResourceNameRestriction	The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L593
`❌` ResourceNameRestriction	The resource name parameter 'groupName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L593
`❌` ResourceNameRestriction	The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L723
`❌` PutResponseCodes	Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L764
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L812
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L821
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L868
`❌` LroErrorContent	Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L877
`❌` DeleteResponseCodes	Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json#L882

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

Validation passes for Avocado.

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

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

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

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

openapi-pipeline-app · 2023-11-08T21:42:25Z

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/healthcareapis/armhealthcareapis - Approved - 2.0.0

+	Function `*timeRFC3339.Parse` has been removed
+	Function `*timeRFC3339.UnmarshalText` has been removed
+	Function `timeRFC3339.MarshalText` has been removed

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

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

️✔️Azure.ResourceManager.HealthcareApis [View full logs] [Release SDK Changes] Breaking Change Detected

Azure.ResourceManager.HealthcareApis.1.1.0-alpha.20231116.1.nupkg

info	[Changelog] Breaking Changes: /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.HealthcareApis/Debug/netstandard2.0/Azure.ResourceManager.HealthcareApis.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/healthcareapis/Azure.ResourceManager.HealthcareApis/src/Azure.ResourceManager.HealthcareApis.csproj::TargetFramework=netstandard2.0]

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

⚠️Warning [Logs]Release - Generate from e10f70e. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
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 major version of npm available! 9.8.1 -> 10.2.4
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.4>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.2.4` to update!
cmderr	[automation_generate.sh] npm notice

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

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Model DicomService has a new parameter cors_configuration
info	[Changelog]   - Model DicomService has a new parameter encryption
info	[Changelog]   - Model DicomService has a new parameter event_state
info	[Changelog]   - Model FhirService has a new parameter encryption
info	[Changelog]   - Model FhirService has a new parameter implementation_guides_configuration
info	[Changelog]   - Model FhirService has a new parameter import_configuration
info	[Changelog]   - Model MetricSpecification has a new parameter enable_regional_mdm_account
info	[Changelog]   - Model MetricSpecification has a new parameter is_internal
info	[Changelog]   - Model MetricSpecification has a new parameter metric_filter_pattern
info	[Changelog]   - Model MetricSpecification has a new parameter resource_id_dimension_name_override
info	[Changelog]   - Model MetricSpecification has a new parameter source_mdm_account
info	[Changelog]   - Model ServiceCosmosDbConfigurationInfo has a new parameter cross_tenant_cmk_application_id
info	[Changelog]   - Model ServicesProperties has a new parameter import_configuration
info	[Changelog]
info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog]   - Model FhirService no longer has parameter access_policies

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

⚠️Warning [Logs]Release - Generate from e10f70e. 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.3.1
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.3.1
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-healthcareapis [View full logs] [Release SDK Changes]

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

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

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Struct `FhirServiceAccessPolicyEntry` has been removed
info	[Changelog] - Field `AccessPolicies` of struct `FhirServiceProperties` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New struct `CorsConfiguration`
info	[Changelog] - New struct `Encryption`
info	[Changelog] - New struct `EncryptionCustomerManagedKeyEncryption`
info	[Changelog] - New struct `FhirServiceImportConfiguration`
info	[Changelog] - New struct `ImplementationGuidesConfiguration`
info	[Changelog] - New struct `ServiceImportConfigurationInfo`
info	[Changelog] - New field `CorsConfiguration`, `Encryption`, `EventState` in struct `DicomServiceProperties`
info	[Changelog] - New field `Encryption`, `ImplementationGuidesConfiguration`, `ImportConfiguration` in struct `FhirServiceProperties`
info	[Changelog] - New field `EnableRegionalMdmAccount`, `IsInternal`, `MetricFilterPattern`, `ResourceIDDimensionNameOverride`, `SourceMdmAccount` in struct `MetricSpecification`
info	[Changelog] - New field `CrossTenantCmkApplicationID` in struct `ServiceCosmosDbConfigurationInfo`
info	[Changelog] - New field `ImportConfiguration` in struct `ServicesProperties`
info	[Changelog]
info	[Changelog] Total 3 breaking change(s), 17 additive change(s).

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

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

azure-arm-healthcareapis-3.0.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Interface CorsConfiguration
info	[Changelog]   - Added Interface Encryption
info	[Changelog]   - Added Interface EncryptionCustomerManagedKeyEncryption
info	[Changelog]   - Added Interface FhirServiceImportConfiguration
info	[Changelog]   - Added Interface ImplementationGuidesConfiguration
info	[Changelog]   - Added Interface ServiceImportConfigurationInfo
info	[Changelog]   - Interface DicomService has a new optional parameter corsConfiguration
info	[Changelog]   - Interface DicomService has a new optional parameter encryption
info	[Changelog]   - Interface DicomService has a new optional parameter eventState
info	[Changelog]   - Interface FhirService has a new optional parameter encryption
info	[Changelog]   - Interface FhirService has a new optional parameter implementationGuidesConfiguration
info	[Changelog]   - Interface FhirService has a new optional parameter importConfiguration
info	[Changelog]   - Interface MetricSpecification has a new optional parameter enableRegionalMdmAccount
info	[Changelog]   - Interface MetricSpecification has a new optional parameter isInternal
info	[Changelog]   - Interface MetricSpecification has a new optional parameter metricFilterPattern
info	[Changelog]   - Interface MetricSpecification has a new optional parameter resourceIdDimensionNameOverride
info	[Changelog]   - Interface MetricSpecification has a new optional parameter sourceMdmAccount
info	[Changelog]   - Interface ServiceCosmosDbConfigurationInfo has a new optional parameter crossTenantCmkApplicationId
info	[Changelog]   - Interface ServicesProperties has a new optional parameter importConfiguration
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Interface FhirService no longer has parameter accessPolicies

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

⚠️Warning [Logs]Release - Generate from e10f70e. 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] npm notice
cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.2.4
cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.4>
cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.2.4` to update!
cmderr	[initScript.sh] npm notice
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

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

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from e10f70e. 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.healthcareapis.DefaultTag [View full logs]

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

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

openapi-pipeline-app · 2023-11-08T21:42:26Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/healthcareapis/armhealthcareapis	https://apiview.dev/Assemblies/Review/bc0ea7d22312430382af752615f42609
JavaScript	@azure/arm-healthcareapis	https://apiview.dev/Assemblies/Review/b50243792a8f4eea8ae9b4722cf729dc
.Net	Azure.ResourceManager.HealthcareApis	https://apiview.dev/Assemblies/Review/a6f4fd7bf4854ac6831c5080eb707347
Java	azure-resourcemanager-healthcareapis	https://apiview.dev/Assemblies/Review/1945718f00b141889d9836169e8805ca

jnlycklama · 2023-11-13T17:37:51Z

/pr RequestMerge

TimLovellSmith · 2023-11-14T15:50:59Z

      "description": "The encryption settings of the DICOM service",

This is a nonblocking feedback but you might want to do a scrub of description docs - sometimes you're capitalizing Dicom, other times you're not. Also as a general programmer, I don't know what DICOM means, so maybe it would make sense to unabbreviate it.

Refers to: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json:3440 in 9577d77. [](commit_id = 9577d77, deletion_comment = False)

TimLovellSmith · 2023-11-14T15:52:19Z

      "description": "Fhir Service import configuration.",

Again you might want to check docs for consistent capitalization of Fhir/FHIR etc

Refers to: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json:3811 in 9577d77. [](commit_id = 9577d77, deletion_comment = False)

TimLovellSmith · 2023-11-14T15:55:48Z

"Encryption": {

I'd like to understand the differences between this definition of encryption settings, and others like

https://github.com/Azure/azure-rest-api-specs/blob/main/specification/common-types/resource-management/v5/customermanagedkeys.json

https://github.com/Azure/azure-rest-api-specs/blob/main/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2023-11-01/redisenterprise.json

Do you not support using a managed identity to access the encryption key?

Or is the idea that which identity to use would be implicit?

Refers to: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json:4081 in 9577d77. [](commit_id = 9577d77, deletion_comment = False)

TimLovellSmith · 2023-11-14T15:57:51Z

"Encryption": {

It seems like your resource type supports both system assigned and user assigned managed identity, does it not support use of both for CMK?

In reply to: 1810509262

Refers to: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json:4081 in 13d6f29. [](commit_id = 13d6f29, deletion_comment = False)

TimLovellSmith

🕐

openapi-workflow-bot · 2023-11-14T16:46:49Z

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

TimLovellSmith · 2023-11-14T16:47:26Z

Removed ARMSignedOff because new commits came in. Adding ARMChangesRequested to reflect the open question on the encryption settings.

jnlycklama · 2023-11-14T16:58:47Z

"Encryption": {
I'd like to understand the differences between this definition of encryption settings, and others like

https://github.com/Azure/azure-rest-api-specs/blob/main/specification/common-types/resource-management/v5/customermanagedkeys.json

https://github.com/Azure/azure-rest-api-specs/blob/main/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2023-11-01/redisenterprise.json

Do you not support using a managed identity to access the encryption key?

Or is the idea that which identity to use would be implicit?

Refers to: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json:4081 in 9577d77. [](commit_id = 9577d77, deletion_comment = False)

Yes, we follow these guidelines for the schema - https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#customer-managed-key-encryption

But leave out keyEncryptionKeyIdentity for now. Our services only support a single identity attached to them, so the identity property on the DICOM & FHIR services is the identity that encryption will use. Declaring the keyEncryptionKeyIdentity as well would be setting the same identity twice and could cause confusing.

We also do not support cross-tenant CMK yet, so do not need support with the federatedClientId property.

TimLovellSmith · 2023-11-14T19:15:41Z

"Encryption": {
I'd like to understand the differences between this definition of encryption settings, and others like
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/common-types/resource-management/v5/customermanagedkeys.json
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2023-11-01/redisenterprise.json
Do you not support using a managed identity to access the encryption key?
Or is the idea that which identity to use would be implicit?
Refers to: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json:4081 in 9577d77. [](commit_id = 9577d77, deletion_comment = False)
Yes, we follow these guidelines for the schema - https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#customer-managed-key-encryption

But leave out keyEncryptionKeyIdentity for now. Our services only support a single identity attached to them, so the identity property on the DICOM & FHIR services is the identity that encryption will use. Declaring the keyEncryptionKeyIdentity as well would be setting the same identity twice and could cause confusing.

We also do not support cross-tenant CMK yet, so do not need support with the federatedClientId property.

I think at a minimum its probably a good idea to add the 'keyEncryptionKeyIdentity' property as supported, with all possible enum values, so that you can show callers using this API version the type of identity set with future api versions that support more identity kinds. Even if you don't actually support setting it to anything but the default, or setting the other identity kinds for now.

jnlycklama · 2023-11-14T22:37:19Z

"Encryption": {
I'd like to understand the differences between this definition of encryption settings, and others like
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/common-types/resource-management/v5/customermanagedkeys.json
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2023-11-01/redisenterprise.json
Do you not support using a managed identity to access the encryption key?
Or is the idea that which identity to use would be implicit?
Refers to: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2023-11-01/healthcare-apis.json:4081 in 9577d77. [](commit_id = 9577d77, deletion_comment = False)
Yes, we follow these guidelines for the schema - https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#customer-managed-key-encryption
But leave out keyEncryptionKeyIdentity for now. Our services only support a single identity attached to them, so the identity property on the DICOM & FHIR services is the identity that encryption will use. Declaring the keyEncryptionKeyIdentity as well would be setting the same identity twice and could cause confusing.
We also do not support cross-tenant CMK yet, so do not need support with the federatedClientId property.
I think at a minimum its probably a good idea to add the 'keyEncryptionKeyIdentity' property as supported, with all possible enum values, so that you can show callers using this API version the type of identity set with future api versions that support more identity kinds. Even if you don't actually support setting it to anything but the default, or setting the other identity kinds for now.

Wondering if this is a hard requirement or a suggestion?

We unfortunately were not able to get a review out sooner because we had a previous API version, 2023-09-06, that didn't get its swagger checked in until last week, and was unable to get anyone to review a draft / previous PRs which did not branch off of main. Now we are at a point where adding keyEncryptionKeyIdentity for 2023-11-01 would be very difficult, especially given the holiday freeze. And supporting multiple identities is not something in the plan to support for either service, so its a hard sell for something we may or may not do in a couple of years

jnlycklama · 2023-11-15T01:14:12Z

/pr RequestMerge

TimLovellSmith

Approving for now for ARM, with the noted warning about future-proofness.

openapi-pipeline-app · 2023-11-16T17:49:02Z

Swagger pipeline restarted successfully, please wait for status update in this comment.

jnlycklama and others added 5 commits November 8, 2023 13:39

Adds base for updating Microsoft.HealthcareApis from version stable/2…

69b7c21

…023-09-06 to version 2023-11-01

Updates readme

415815f

Updates API version in new specs and examples

13d6f29

add encryption property

43575a2

fix example and readme

9577d77

azure-sdk mentioned this pull request Nov 8, 2023

[AutoPR sdk/resourcemanager/healthcareapis/armhealthcareapis] [Hub Generated] Review request for Microsoft.HealthcareApis to add version stable/2023-11-01 azure-sdk/azure-sdk-for-go#8182

Closed

AzureRestAPISpecReview added new-api-version resource-manager labels Nov 8, 2023

jnlycklama mentioned this pull request Nov 8, 2023

[Hub Generated] Review request for Microsoft.HealthcareApis to add version stable/2023-11-01 #26505

Closed

6 tasks

jnlycklama marked this pull request as ready for review November 8, 2023 22:11

openapi-assignment-bot bot assigned rkmanda Nov 8, 2023

jnlycklama added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 8, 2023

AzureRestAPISpecReview added ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test labels Nov 8, 2023

zizw123 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Nov 9, 2023

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

microsoft-github-policy-service bot added the MergeRequested label Nov 13, 2023

openapi-pipeline-app bot added the CI-BreakingChange-Go label Nov 14, 2023

TimLovellSmith requested changes Nov 14, 2023

View reviewed changes

TimLovellSmith added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review and removed ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Nov 14, 2023

TimLovellSmith removed the MergeRequested label Nov 14, 2023

TimLovellSmith added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Nov 15, 2023

openapi-workflow-bot bot removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 15, 2023

microsoft-github-policy-service bot added the MergeRequested label Nov 15, 2023

TimLovellSmith approved these changes Nov 15, 2023

View reviewed changes

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

TimLovellSmith merged commit e10f70e into main Nov 16, 2023
29 of 31 checks passed

TimLovellSmith deleted the jnlycklama-3-healthcareapis-Microsoft.HealthcareApis-2023-11-01 branch November 16, 2023 17:48

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Nov 16, 2023

azure-sdk mentioned this pull request Nov 16, 2023

[ReleasePR @azure/arm-healthcareapis] [Hub Generated] Review request for Microsoft.HealthcareApis to add version stable/2023-11-01 Azure/azure-sdk-for-js#21567

Closed

openapi-pipeline-app bot added the CI-BreakingChange-JavaScript label Nov 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Hub Generated] Review request for Microsoft.HealthcareApis to add version stable/2023-11-01 #26628

[Hub Generated] Review request for Microsoft.HealthcareApis to add version stable/2023-11-01 #26628

jnlycklama commented Nov 8, 2023 •

edited

Loading

openapi-pipeline-app bot commented Nov 8, 2023 •

edited

Loading

openapi-pipeline-app bot commented Nov 8, 2023 •

edited

Loading

openapi-pipeline-app bot commented Nov 8, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Nov 8, 2023 •

edited

Loading

jnlycklama commented Nov 13, 2023

TimLovellSmith commented Nov 14, 2023

TimLovellSmith commented Nov 14, 2023

TimLovellSmith commented Nov 14, 2023

TimLovellSmith commented Nov 14, 2023

TimLovellSmith left a comment

openapi-workflow-bot bot commented Nov 14, 2023

TimLovellSmith commented Nov 14, 2023

jnlycklama commented Nov 14, 2023

TimLovellSmith commented Nov 14, 2023

jnlycklama commented Nov 14, 2023

jnlycklama commented Nov 15, 2023

TimLovellSmith left a comment

openapi-pipeline-app bot commented Nov 16, 2023

[Hub Generated] Review request for Microsoft.HealthcareApis to add version stable/2023-11-01 #26628

[Hub Generated] Review request for Microsoft.HealthcareApis to add version stable/2023-11-01 #26628

Conversation

jnlycklama commented Nov 8, 2023 • edited Loading

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Breaking changes review (Step 1)

ARM API changes review (Step 2)

Viewing API changes

Suppressing failures

Getting help

openapi-pipeline-app bot commented Nov 8, 2023 • edited Loading

openapi-pipeline-app bot commented Nov 8, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Nov 8, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Nov 8, 2023 • edited Loading

Generated ApiView

jnlycklama commented Nov 13, 2023

TimLovellSmith commented Nov 14, 2023

TimLovellSmith commented Nov 14, 2023

TimLovellSmith commented Nov 14, 2023

TimLovellSmith commented Nov 14, 2023

TimLovellSmith left a comment

Choose a reason for hiding this comment

openapi-workflow-bot bot commented Nov 14, 2023

TimLovellSmith commented Nov 14, 2023

jnlycklama commented Nov 14, 2023

TimLovellSmith commented Nov 14, 2023

jnlycklama commented Nov 14, 2023

jnlycklama commented Nov 15, 2023

TimLovellSmith left a comment

Choose a reason for hiding this comment

openapi-pipeline-app bot commented Nov 16, 2023

jnlycklama commented Nov 8, 2023 •

edited

Loading

openapi-pipeline-app bot commented Nov 8, 2023 •

edited

Loading

openapi-pipeline-app bot commented Nov 8, 2023 •

edited

Loading

openapi-pipeline-app bot commented Nov 8, 2023 •

edited

Loading

openapi-pipeline-app bot commented Nov 8, 2023 •

edited

Loading