Microsoft.HealthcareApis (stable:2020-03-30)

2025/09/26 • 15 new, 15 deleted methods

Services_Get (new)
Description :  Get the metadata of a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The common properties of a service. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Accepted: No description available. ,
Verifying: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicies:
{
Description: The access policies of the service instance. ,
Required: False ,
}
[
{
objectId:
{
Description: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. ,
Required: True ,
}
string ,
}
,
]
,
cosmosDbConfiguration:
{
Description: The settings for the Cosmos DB database backing the service. ,
Required: False ,
}
{
offerThroughput:
{
Description: The provisioned throughput for the backing database. ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
}
,
authenticationConfiguration:
{
Description: The authentication configuration for the service instance. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audience:
{
Description: The audience url for the service ,
Required: False ,
}
string ,
smartProxyEnabled:
{
Description: If the SMART on FHIR proxy is enabled ,
Required: False ,
}
boolean ,
}
,
corsConfiguration:
{
Description: The settings for the CORS configuration of the service instance. ,
Required: False ,
}
{
origins:
{
Description: The origins to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
headers:
{
Description: The headers to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
methods:
{
Description: The methods to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: The max age to be allowed via CORS. ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: If credentials are allowed via CORS. ,
Required: False ,
}
boolean ,
}
,
exportConfiguration:
{
Description: The settings for the export operation of the service instance. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the default export storage account. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Services_CreateOrUpdate (new)
Description :  Create or update the metadata of a service instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
serviceDescription:
{
Description: The service instance metadata. ,
Required: True ,
}
{
properties:
{
Description: The common properties of a service. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Accepted: No description available. ,
Verifying: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicies:
{
Description: The access policies of the service instance. ,
Required: False ,
}
[
{
objectId:
{
Description: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. ,
Required: True ,
}
string ,
}
,
]
,
cosmosDbConfiguration:
{
Description: The settings for the Cosmos DB database backing the service. ,
Required: False ,
}
{
offerThroughput:
{
Description: The provisioned throughput for the backing database. ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
}
,
authenticationConfiguration:
{
Description: The authentication configuration for the service instance. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audience:
{
Description: The audience url for the service ,
Required: False ,
}
string ,
smartProxyEnabled:
{
Description: If the SMART on FHIR proxy is enabled ,
Required: False ,
}
boolean ,
}
,
corsConfiguration:
{
Description: The settings for the CORS configuration of the service instance. ,
Required: False ,
}
{
origins:
{
Description: The origins to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
headers:
{
Description: The headers to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
methods:
{
Description: The methods to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: The max age to be allowed via CORS. ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: If credentials are allowed via CORS. ,
Required: False ,
}
boolean ,
}
,
exportConfiguration:
{
Description: The settings for the export operation of the service instance. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the default export storage account. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The common properties of a service. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Accepted: No description available. ,
Verifying: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicies:
{
Description: The access policies of the service instance. ,
Required: False ,
}
[
{
objectId:
{
Description: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. ,
Required: True ,
}
string ,
}
,
]
,
cosmosDbConfiguration:
{
Description: The settings for the Cosmos DB database backing the service. ,
Required: False ,
}
{
offerThroughput:
{
Description: The provisioned throughput for the backing database. ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
}
,
authenticationConfiguration:
{
Description: The authentication configuration for the service instance. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audience:
{
Description: The audience url for the service ,
Required: False ,
}
string ,
smartProxyEnabled:
{
Description: If the SMART on FHIR proxy is enabled ,
Required: False ,
}
boolean ,
}
,
corsConfiguration:
{
Description: The settings for the CORS configuration of the service instance. ,
Required: False ,
}
{
origins:
{
Description: The origins to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
headers:
{
Description: The headers to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
methods:
{
Description: The methods to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: The max age to be allowed via CORS. ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: If credentials are allowed via CORS. ,
Required: False ,
}
boolean ,
}
,
exportConfiguration:
{
Description: The settings for the export operation of the service instance. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the default export storage account. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The common properties of a service. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Accepted: No description available. ,
Verifying: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicies:
{
Description: The access policies of the service instance. ,
Required: False ,
}
[
{
objectId:
{
Description: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. ,
Required: True ,
}
string ,
}
,
]
,
cosmosDbConfiguration:
{
Description: The settings for the Cosmos DB database backing the service. ,
Required: False ,
}
{
offerThroughput:
{
Description: The provisioned throughput for the backing database. ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
}
,
authenticationConfiguration:
{
Description: The authentication configuration for the service instance. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audience:
{
Description: The audience url for the service ,
Required: False ,
}
string ,
smartProxyEnabled:
{
Description: If the SMART on FHIR proxy is enabled ,
Required: False ,
}
boolean ,
}
,
corsConfiguration:
{
Description: The settings for the CORS configuration of the service instance. ,
Required: False ,
}
{
origins:
{
Description: The origins to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
headers:
{
Description: The headers to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
methods:
{
Description: The methods to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: The max age to be allowed via CORS. ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: If credentials are allowed via CORS. ,
Required: False ,
}
boolean ,
}
,
exportConfiguration:
{
Description: The settings for the export operation of the service instance. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the default export storage account. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Services_Update (new)
Description :  Update the metadata of a service instance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
servicePatchDescription:
{
Description: The service instance metadata and security metadata. ,
Required: True ,
}
{
tags:
{
Description: Instance tags ,
Required: False ,
}
object ,
properties:
{
Description: The properties for updating a service instance. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The common properties of a service. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Accepted: No description available. ,
Verifying: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicies:
{
Description: The access policies of the service instance. ,
Required: False ,
}
[
{
objectId:
{
Description: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. ,
Required: True ,
}
string ,
}
,
]
,
cosmosDbConfiguration:
{
Description: The settings for the Cosmos DB database backing the service. ,
Required: False ,
}
{
offerThroughput:
{
Description: The provisioned throughput for the backing database. ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
}
,
authenticationConfiguration:
{
Description: The authentication configuration for the service instance. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audience:
{
Description: The audience url for the service ,
Required: False ,
}
string ,
smartProxyEnabled:
{
Description: If the SMART on FHIR proxy is enabled ,
Required: False ,
}
boolean ,
}
,
corsConfiguration:
{
Description: The settings for the CORS configuration of the service instance. ,
Required: False ,
}
{
origins:
{
Description: The origins to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
headers:
{
Description: The headers to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
methods:
{
Description: The methods to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: The max age to be allowed via CORS. ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: If credentials are allowed via CORS. ,
Required: False ,
}
boolean ,
}
,
exportConfiguration:
{
Description: The settings for the export operation of the service instance. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the default export storage account. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Services_Delete (new)
Description :  Delete a service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Services_List (new)
Description :  Get all the service instances in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/services
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of service description objects. ,
Required: False ,
}
string ,
value:
{
Description: A list of service description objects. ,
Required: False ,
}
[
{
properties:
{
Description: The common properties of a service. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Accepted: No description available. ,
Verifying: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicies:
{
Description: The access policies of the service instance. ,
Required: False ,
}
[
{
objectId:
{
Description: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. ,
Required: True ,
}
string ,
}
,
]
,
cosmosDbConfiguration:
{
Description: The settings for the Cosmos DB database backing the service. ,
Required: False ,
}
{
offerThroughput:
{
Description: The provisioned throughput for the backing database. ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
}
,
authenticationConfiguration:
{
Description: The authentication configuration for the service instance. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audience:
{
Description: The audience url for the service ,
Required: False ,
}
string ,
smartProxyEnabled:
{
Description: If the SMART on FHIR proxy is enabled ,
Required: False ,
}
boolean ,
}
,
corsConfiguration:
{
Description: The settings for the CORS configuration of the service instance. ,
Required: False ,
}
{
origins:
{
Description: The origins to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
headers:
{
Description: The headers to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
methods:
{
Description: The methods to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: The max age to be allowed via CORS. ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: If credentials are allowed via CORS. ,
Required: False ,
}
boolean ,
}
,
exportConfiguration:
{
Description: The settings for the export operation of the service instance. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the default export storage account. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Services_ListByResourceGroup (new)
Description :  Get all the service instances in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of service description objects. ,
Required: False ,
}
string ,
value:
{
Description: A list of service description objects. ,
Required: False ,
}
[
{
properties:
{
Description: The common properties of a service. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Accepted: No description available. ,
Verifying: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicies:
{
Description: The access policies of the service instance. ,
Required: False ,
}
[
{
objectId:
{
Description: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. ,
Required: True ,
}
string ,
}
,
]
,
cosmosDbConfiguration:
{
Description: The settings for the Cosmos DB database backing the service. ,
Required: False ,
}
{
offerThroughput:
{
Description: The provisioned throughput for the backing database. ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
}
,
authenticationConfiguration:
{
Description: The authentication configuration for the service instance. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audience:
{
Description: The audience url for the service ,
Required: False ,
}
string ,
smartProxyEnabled:
{
Description: If the SMART on FHIR proxy is enabled ,
Required: False ,
}
boolean ,
}
,
corsConfiguration:
{
Description: The settings for the CORS configuration of the service instance. ,
Required: False ,
}
{
origins:
{
Description: The origins to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
headers:
{
Description: The headers to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
methods:
{
Description: The methods to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: The max age to be allowed via CORS. ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: If credentials are allowed via CORS. ,
Required: False ,
}
boolean ,
}
,
exportConfiguration:
{
Description: The settings for the export operation of the service instance. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the default export storage account. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Lists all of the available Healthcare service REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HealthcareApis/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of service description objects. ,
Required: False ,
}
string ,
value:
{
Description: A list of service operations supported by the Microsoft.HealthcareApis resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{read | write | action | delete} ,
Required: False ,
}
string ,
isDataAction:
{
Description: Gets or sets a value indicating whether the operation is a data action or not ,
Required: False ,
}
boolean ,
origin:
{
Description: Default value is 'user,system'. ,
Required: False ,
}
string ,
display:
{
Description: The information displayed about the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.HealthcareApis ,
Required: False ,
}
string ,
resource:
{
Description: Resource Type: Services ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation ,
Required: False ,
}
string ,
description:
{
Description: Friendly description for the operation, ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the operation ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Services_CheckNameAvailability (new)
Description :  Check if a service instance name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/checkNameAvailability
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
checkNameAvailabilityInputs:
{
Description: Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check. ,
Required: True ,
}
{
name:
{
Description: The name of the service instance to check. ,
Required: True ,
}
string ,
type:
{
Description: The fully qualified resource type which includes provider namespace. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: The value which indicates whether the provided name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason for unavailability. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The detailed reason message. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
OperationResults_Get (new)
Description :  Get the operation result for a long running operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/{locationName}/operationresults/{operationResultId}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
locationName:
{
Description: The location of the operation. ,
Required: True ,
}
string ,
operationResultId:
{
Description: The ID of the operation result to get. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the operation returned. ,
Required: False ,
}
string ,
name:
{
Description: The name of the operation result. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation being performed. ,
Enum:
{
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Requested: No description available. ,
Running: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The time that the operation was started. ,
Required: False ,
}
string ,
properties:
{
Description: Additional properties of the operation result. ,
Required: False ,
}
string ,
}

⚐ Response (404)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_ListByService (new)
Description :  Lists all private endpoint connections for a service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets the specified private endpoint connection associated with the service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Update the state of the specified private endpoint connection associated with the service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes a private endpoint connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
PrivateLinkResources_ListByService (new)
Description :  Gets the private link resources that need to be created for a service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
PrivateLinkResources_Get (new)
Description :  Gets a private link resource that need to be created for a service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources/{groupName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
groupName:
{
Description: The name of the private link resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Services_Get (removed)
Description :  Get the metadata of a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The common properties of a service. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Accepted: No description available. ,
Verifying: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicies:
{
Description: The access policies of the service instance. ,
Required: False ,
}
[
{
objectId:
{
Description: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. ,
Required: True ,
}
string ,
}
,
]
,
cosmosDbConfiguration:
{
Description: The settings for the Cosmos DB database backing the service. ,
Required: False ,
}
{
offerThroughput:
{
Description: The provisioned throughput for the backing database. ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
}
,
authenticationConfiguration:
{
Description: The authentication configuration for the service instance. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audience:
{
Description: The audience url for the service ,
Required: False ,
}
string ,
smartProxyEnabled:
{
Description: If the SMART on FHIR proxy is enabled ,
Required: False ,
}
boolean ,
}
,
corsConfiguration:
{
Description: The settings for the CORS configuration of the service instance. ,
Required: False ,
}
{
origins:
{
Description: The origins to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
headers:
{
Description: The headers to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
methods:
{
Description: The methods to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: The max age to be allowed via CORS. ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: If credentials are allowed via CORS. ,
Required: False ,
}
boolean ,
}
,
exportConfiguration:
{
Description: The settings for the export operation of the service instance. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the default export storage account. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Services_CreateOrUpdate (removed)
Description :  Create or update the metadata of a service instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
serviceDescription:
{
Description: The service instance metadata. ,
Required: True ,
}
{
properties:
{
Description: The common properties of a service. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Accepted: No description available. ,
Verifying: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicies:
{
Description: The access policies of the service instance. ,
Required: False ,
}
[
{
objectId:
{
Description: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. ,
Required: True ,
}
string ,
}
,
]
,
cosmosDbConfiguration:
{
Description: The settings for the Cosmos DB database backing the service. ,
Required: False ,
}
{
offerThroughput:
{
Description: The provisioned throughput for the backing database. ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
}
,
authenticationConfiguration:
{
Description: The authentication configuration for the service instance. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audience:
{
Description: The audience url for the service ,
Required: False ,
}
string ,
smartProxyEnabled:
{
Description: If the SMART on FHIR proxy is enabled ,
Required: False ,
}
boolean ,
}
,
corsConfiguration:
{
Description: The settings for the CORS configuration of the service instance. ,
Required: False ,
}
{
origins:
{
Description: The origins to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
headers:
{
Description: The headers to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
methods:
{
Description: The methods to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: The max age to be allowed via CORS. ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: If credentials are allowed via CORS. ,
Required: False ,
}
boolean ,
}
,
exportConfiguration:
{
Description: The settings for the export operation of the service instance. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the default export storage account. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The common properties of a service. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Accepted: No description available. ,
Verifying: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicies:
{
Description: The access policies of the service instance. ,
Required: False ,
}
[
{
objectId:
{
Description: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. ,
Required: True ,
}
string ,
}
,
]
,
cosmosDbConfiguration:
{
Description: The settings for the Cosmos DB database backing the service. ,
Required: False ,
}
{
offerThroughput:
{
Description: The provisioned throughput for the backing database. ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
}
,
authenticationConfiguration:
{
Description: The authentication configuration for the service instance. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audience:
{
Description: The audience url for the service ,
Required: False ,
}
string ,
smartProxyEnabled:
{
Description: If the SMART on FHIR proxy is enabled ,
Required: False ,
}
boolean ,
}
,
corsConfiguration:
{
Description: The settings for the CORS configuration of the service instance. ,
Required: False ,
}
{
origins:
{
Description: The origins to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
headers:
{
Description: The headers to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
methods:
{
Description: The methods to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: The max age to be allowed via CORS. ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: If credentials are allowed via CORS. ,
Required: False ,
}
boolean ,
}
,
exportConfiguration:
{
Description: The settings for the export operation of the service instance. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the default export storage account. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The common properties of a service. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Accepted: No description available. ,
Verifying: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicies:
{
Description: The access policies of the service instance. ,
Required: False ,
}
[
{
objectId:
{
Description: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. ,
Required: True ,
}
string ,
}
,
]
,
cosmosDbConfiguration:
{
Description: The settings for the Cosmos DB database backing the service. ,
Required: False ,
}
{
offerThroughput:
{
Description: The provisioned throughput for the backing database. ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
}
,
authenticationConfiguration:
{
Description: The authentication configuration for the service instance. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audience:
{
Description: The audience url for the service ,
Required: False ,
}
string ,
smartProxyEnabled:
{
Description: If the SMART on FHIR proxy is enabled ,
Required: False ,
}
boolean ,
}
,
corsConfiguration:
{
Description: The settings for the CORS configuration of the service instance. ,
Required: False ,
}
{
origins:
{
Description: The origins to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
headers:
{
Description: The headers to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
methods:
{
Description: The methods to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: The max age to be allowed via CORS. ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: If credentials are allowed via CORS. ,
Required: False ,
}
boolean ,
}
,
exportConfiguration:
{
Description: The settings for the export operation of the service instance. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the default export storage account. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Services_Update (removed)
Description :  Update the metadata of a service instance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
servicePatchDescription:
{
Description: The service instance metadata and security metadata. ,
Required: True ,
}
{
tags:
{
Description: Instance tags ,
Required: False ,
}
object ,
properties:
{
Description: The properties for updating a service instance. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The common properties of a service. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Accepted: No description available. ,
Verifying: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicies:
{
Description: The access policies of the service instance. ,
Required: False ,
}
[
{
objectId:
{
Description: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. ,
Required: True ,
}
string ,
}
,
]
,
cosmosDbConfiguration:
{
Description: The settings for the Cosmos DB database backing the service. ,
Required: False ,
}
{
offerThroughput:
{
Description: The provisioned throughput for the backing database. ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
}
,
authenticationConfiguration:
{
Description: The authentication configuration for the service instance. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audience:
{
Description: The audience url for the service ,
Required: False ,
}
string ,
smartProxyEnabled:
{
Description: If the SMART on FHIR proxy is enabled ,
Required: False ,
}
boolean ,
}
,
corsConfiguration:
{
Description: The settings for the CORS configuration of the service instance. ,
Required: False ,
}
{
origins:
{
Description: The origins to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
headers:
{
Description: The headers to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
methods:
{
Description: The methods to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: The max age to be allowed via CORS. ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: If credentials are allowed via CORS. ,
Required: False ,
}
boolean ,
}
,
exportConfiguration:
{
Description: The settings for the export operation of the service instance. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the default export storage account. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Services_Delete (removed)
Description :  Delete a service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Services_List (removed)
Description :  Get all the service instances in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/services
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of service description objects. ,
Required: False ,
}
string ,
value:
{
Description: A list of service description objects. ,
Required: False ,
}
[
{
properties:
{
Description: The common properties of a service. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Accepted: No description available. ,
Verifying: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicies:
{
Description: The access policies of the service instance. ,
Required: False ,
}
[
{
objectId:
{
Description: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. ,
Required: True ,
}
string ,
}
,
]
,
cosmosDbConfiguration:
{
Description: The settings for the Cosmos DB database backing the service. ,
Required: False ,
}
{
offerThroughput:
{
Description: The provisioned throughput for the backing database. ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
}
,
authenticationConfiguration:
{
Description: The authentication configuration for the service instance. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audience:
{
Description: The audience url for the service ,
Required: False ,
}
string ,
smartProxyEnabled:
{
Description: If the SMART on FHIR proxy is enabled ,
Required: False ,
}
boolean ,
}
,
corsConfiguration:
{
Description: The settings for the CORS configuration of the service instance. ,
Required: False ,
}
{
origins:
{
Description: The origins to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
headers:
{
Description: The headers to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
methods:
{
Description: The methods to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: The max age to be allowed via CORS. ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: If credentials are allowed via CORS. ,
Required: False ,
}
boolean ,
}
,
exportConfiguration:
{
Description: The settings for the export operation of the service instance. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the default export storage account. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Services_ListByResourceGroup (removed)
Description :  Get all the service instances in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of service description objects. ,
Required: False ,
}
string ,
value:
{
Description: A list of service description objects. ,
Required: False ,
}
[
{
properties:
{
Description: The common properties of a service. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Creating: No description available. ,
Accepted: No description available. ,
Verifying: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Deprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
accessPolicies:
{
Description: The access policies of the service instance. ,
Required: False ,
}
[
{
objectId:
{
Description: An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. ,
Required: True ,
}
string ,
}
,
]
,
cosmosDbConfiguration:
{
Description: The settings for the Cosmos DB database backing the service. ,
Required: False ,
}
{
offerThroughput:
{
Description: The provisioned throughput for the backing database. ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
}
,
authenticationConfiguration:
{
Description: The authentication configuration for the service instance. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audience:
{
Description: The audience url for the service ,
Required: False ,
}
string ,
smartProxyEnabled:
{
Description: If the SMART on FHIR proxy is enabled ,
Required: False ,
}
boolean ,
}
,
corsConfiguration:
{
Description: The settings for the CORS configuration of the service instance. ,
Required: False ,
}
{
origins:
{
Description: The origins to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
headers:
{
Description: The headers to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
methods:
{
Description: The methods to be allowed via CORS. ,
Required: False ,
}
[
string ,
]
,
maxAge:
{
Description: The max age to be allowed via CORS. ,
Format: int32 ,
Required: False ,
}
integer ,
allowCredentials:
{
Description: If credentials are allowed via CORS. ,
Required: False ,
}
boolean ,
}
,
exportConfiguration:
{
Description: The settings for the export operation of the service instance. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the default export storage account. ,
Required: False ,
}
string ,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available Healthcare service REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HealthcareApis/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of service description objects. ,
Required: False ,
}
string ,
value:
{
Description: A list of service operations supported by the Microsoft.HealthcareApis resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{read | write | action | delete} ,
Required: False ,
}
string ,
isDataAction:
{
Description: Gets or sets a value indicating whether the operation is a data action or not ,
Required: False ,
}
boolean ,
origin:
{
Description: Default value is 'user,system'. ,
Required: False ,
}
string ,
display:
{
Description: The information displayed about the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.HealthcareApis ,
Required: False ,
}
string ,
resource:
{
Description: Resource Type: Services ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation ,
Required: False ,
}
string ,
description:
{
Description: Friendly description for the operation, ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the operation ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Services_CheckNameAvailability (removed)
Description :  Check if a service instance name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/checkNameAvailability
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
checkNameAvailabilityInputs:
{
Description: Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check. ,
Required: True ,
}
{
name:
{
Description: The name of the service instance to check. ,
Required: True ,
}
string ,
type:
{
Description: The fully qualified resource type which includes provider namespace. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: The value which indicates whether the provided name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason for unavailability. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The detailed reason message. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
OperationResults_Get (removed)
Description :  Get the operation result for a long running operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/{locationName}/operationresults/{operationResultId}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
locationName:
{
Description: The location of the operation. ,
Required: True ,
}
string ,
operationResultId:
{
Description: The ID of the operation result to get. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the operation returned. ,
Required: False ,
}
string ,
name:
{
Description: The name of the operation result. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation being performed. ,
Enum:
{
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Requested: No description available. ,
Running: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The time that the operation was started. ,
Required: False ,
}
string ,
properties:
{
Description: Additional properties of the operation result. ,
Required: False ,
}
string ,
}

⚐ Response (404)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_ListByService (removed)
Description :  Lists all private endpoint connections for a service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_Get (removed)
Description :  Gets the specified private endpoint connection associated with the service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (removed)
Description :  Update the state of the specified private endpoint connection associated with the service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_Delete (removed)
Description :  Deletes a private endpoint connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
PrivateLinkResources_ListByService (removed)
Description :  Gets the private link resources that need to be created for a service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
PrivateLinkResources_Get (removed)
Description :  Gets a private link resource that need to be created for a service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources/{groupName}
{
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
groupName:
{
Description: The name of the private link resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Object containing error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}