Microsoft.HealthcareApis (preview:2025-03-01)

2025/02/19 • 46 new 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: 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. ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
crossTenantCmkApplicationId:
{
Description: The multi-tenant application id used to enable CMK access for services in a data sovereign region. ,
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. ,
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 ,
acrConfiguration:
{
Description: The azure container registry settings used for convert data operation of the service instance. ,
Required: False ,
}
{
loginServers:
{
Description: The list of the ACR login servers. ,
Required: False ,
}
[
string ,
]
,
ociArtifacts:
{
Description: The list of Open Container Initiative (OCI) artifacts. ,
Required: False ,
}
[
{
loginServer:
{
Description: The Azure Container Registry login server. ,
Required: False ,
}
string ,
imageName:
{
Description: The artifact name. ,
Required: False ,
}
string ,
digest:
{
Description: The artifact digest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
importConfiguration:
{
Description: The settings for the import operation of the service instance. ,
Required: False ,
}
{
integrationDataStore:
{
Description: The name of the default integration storage account. ,
Required: False ,
}
string ,
initialImportMode:
{
Description: If the FHIR service is in InitialImportMode. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the import operation is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: 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. ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
crossTenantCmkApplicationId:
{
Description: The multi-tenant application id used to enable CMK access for services in a data sovereign region. ,
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. ,
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 ,
acrConfiguration:
{
Description: The azure container registry settings used for convert data operation of the service instance. ,
Required: False ,
}
{
loginServers:
{
Description: The list of the ACR login servers. ,
Required: False ,
}
[
string ,
]
,
ociArtifacts:
{
Description: The list of Open Container Initiative (OCI) artifacts. ,
Required: False ,
}
[
{
loginServer:
{
Description: The Azure Container Registry login server. ,
Required: False ,
}
string ,
imageName:
{
Description: The artifact name. ,
Required: False ,
}
string ,
digest:
{
Description: The artifact digest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
importConfiguration:
{
Description: The settings for the import operation of the service instance. ,
Required: False ,
}
{
integrationDataStore:
{
Description: The name of the default integration storage account. ,
Required: False ,
}
string ,
initialImportMode:
{
Description: If the FHIR service is in InitialImportMode. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the import operation is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: 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. ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
crossTenantCmkApplicationId:
{
Description: The multi-tenant application id used to enable CMK access for services in a data sovereign region. ,
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. ,
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 ,
acrConfiguration:
{
Description: The azure container registry settings used for convert data operation of the service instance. ,
Required: False ,
}
{
loginServers:
{
Description: The list of the ACR login servers. ,
Required: False ,
}
[
string ,
]
,
ociArtifacts:
{
Description: The list of Open Container Initiative (OCI) artifacts. ,
Required: False ,
}
[
{
loginServer:
{
Description: The Azure Container Registry login server. ,
Required: False ,
}
string ,
imageName:
{
Description: The artifact name. ,
Required: False ,
}
string ,
digest:
{
Description: The artifact digest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
importConfiguration:
{
Description: The settings for the import operation of the service instance. ,
Required: False ,
}
{
integrationDataStore:
{
Description: The name of the default integration storage account. ,
Required: False ,
}
string ,
initialImportMode:
{
Description: If the FHIR service is in InitialImportMode. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the import operation is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ 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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: 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. ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
crossTenantCmkApplicationId:
{
Description: The multi-tenant application id used to enable CMK access for services in a data sovereign region. ,
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. ,
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 ,
acrConfiguration:
{
Description: The azure container registry settings used for convert data operation of the service instance. ,
Required: False ,
}
{
loginServers:
{
Description: The list of the ACR login servers. ,
Required: False ,
}
[
string ,
]
,
ociArtifacts:
{
Description: The list of Open Container Initiative (OCI) artifacts. ,
Required: False ,
}
[
{
loginServer:
{
Description: The Azure Container Registry login server. ,
Required: False ,
}
string ,
imageName:
{
Description: The artifact name. ,
Required: False ,
}
string ,
digest:
{
Description: The artifact digest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
importConfiguration:
{
Description: The settings for the import operation of the service instance. ,
Required: False ,
}
{
integrationDataStore:
{
Description: The name of the default integration storage account. ,
Required: False ,
}
string ,
initialImportMode:
{
Description: If the FHIR service is in InitialImportMode. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the import operation is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: 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. ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
crossTenantCmkApplicationId:
{
Description: The multi-tenant application id used to enable CMK access for services in a data sovereign region. ,
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. ,
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 ,
acrConfiguration:
{
Description: The azure container registry settings used for convert data operation of the service instance. ,
Required: False ,
}
{
loginServers:
{
Description: The list of the ACR login servers. ,
Required: False ,
}
[
string ,
]
,
ociArtifacts:
{
Description: The list of Open Container Initiative (OCI) artifacts. ,
Required: False ,
}
[
{
loginServer:
{
Description: The Azure Container Registry login server. ,
Required: False ,
}
string ,
imageName:
{
Description: The artifact name. ,
Required: False ,
}
string ,
digest:
{
Description: The artifact digest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
importConfiguration:
{
Description: The settings for the import operation of the service instance. ,
Required: False ,
}
{
integrationDataStore:
{
Description: The name of the default integration storage account. ,
Required: False ,
}
string ,
initialImportMode:
{
Description: If the FHIR service is in InitialImportMode. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the import operation is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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: 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: 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. ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
crossTenantCmkApplicationId:
{
Description: The multi-tenant application id used to enable CMK access for services in a data sovereign region. ,
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. ,
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 ,
acrConfiguration:
{
Description: The azure container registry settings used for convert data operation of the service instance. ,
Required: False ,
}
{
loginServers:
{
Description: The list of the ACR login servers. ,
Required: False ,
}
[
string ,
]
,
ociArtifacts:
{
Description: The list of Open Container Initiative (OCI) artifacts. ,
Required: False ,
}
[
{
loginServer:
{
Description: The Azure Container Registry login server. ,
Required: False ,
}
string ,
imageName:
{
Description: The artifact name. ,
Required: False ,
}
string ,
digest:
{
Description: The artifact digest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
importConfiguration:
{
Description: The settings for the import operation of the service instance. ,
Required: False ,
}
{
integrationDataStore:
{
Description: The name of the default integration storage account. ,
Required: False ,
}
string ,
initialImportMode:
{
Description: If the FHIR service is in InitialImportMode. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the import operation is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: 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. ,
Required: False ,
}
integer ,
keyVaultKeyUri:
{
Description: The URI of the customer-managed key for the backing database. ,
Required: False ,
}
string ,
crossTenantCmkApplicationId:
{
Description: The multi-tenant application id used to enable CMK access for services in a data sovereign region. ,
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. ,
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 ,
acrConfiguration:
{
Description: The azure container registry settings used for convert data operation of the service instance. ,
Required: False ,
}
{
loginServers:
{
Description: The list of the ACR login servers. ,
Required: False ,
}
[
string ,
]
,
ociArtifacts:
{
Description: The list of Open Container Initiative (OCI) artifacts. ,
Required: False ,
}
[
{
loginServer:
{
Description: The Azure Container Registry login server. ,
Required: False ,
}
string ,
imageName:
{
Description: The artifact name. ,
Required: False ,
}
string ,
digest:
{
Description: The artifact digest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
importConfiguration:
{
Description: The settings for the import operation of the service instance. ,
Required: False ,
}
{
integrationDataStore:
{
Description: The name of the default integration storage account. ,
Required: False ,
}
string ,
initialImportMode:
{
Description: If the FHIR service is in InitialImportMode. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the import operation is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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: 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 ID of the target subscription. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: 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 ID of the target subscription. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ID of the target subscription. ,
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: The API version to use for this operation. ,
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)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ID of the target subscription. ,
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: The API version to use for this operation. ,
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: 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 ID of the target subscription. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: 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 ID of the target subscription. ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
groupName:
{
Description: The name of the private link resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
Workspaces_ListBySubscription (new)
Description :  Lists all the available workspaces under the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of resources. ,
Required: False ,
}
[
{
properties:
{
Description: Workspaces resource specific properties. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
Workspaces_ListByResourceGroup (new)
Description :  Lists all the available workspaces under the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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. ,
Required: False ,
}
string ,
value:
{
Description: Collection of resources. ,
Required: False ,
}
[
{
properties:
{
Description: Workspaces resource specific properties. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
Workspaces_Get (new)
Description :  Gets the properties of the specified workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Workspaces resource specific properties. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
Workspaces_CreateOrUpdate (new)
Description :  Creates or updates a workspace resource with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
workspace:
{
Description: The parameters for creating or updating a healthcare workspace. ,
Required: True ,
}
{
properties:
{
Description: Workspaces resource specific properties. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Workspaces resource specific properties. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Workspaces resource specific properties. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Workspaces resource specific properties. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
Workspaces_Update (new)
Description :  Patch workspace details.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
workspacePatchResource:
{
Description: The parameters for updating a specified workspace. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: Workspaces resource specific properties. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Workspaces resource specific properties. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
Workspaces_Delete (new)
Description :  Deletes a specified workspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
DicomServices_ListByWorkspace (new)
Description :  Lists all DICOM Services for the given workspace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of Dicom Services. ,
Required: False ,
}
string ,
value:
{
Description: The list of Dicom Services. ,
Required: False ,
}
[
{
properties:
{
Description: Dicom Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
authenticationConfiguration:
{
Description: Dicom Service authentication configuration. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audiences:
{
Description: The audiences for the service ,
Required: False ,
}
[
string ,
]
,
}
,
corsConfiguration:
{
Description: Dicom Service Cors configuration. ,
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 ,
}
,
serviceUrl:
{
Description: The url of the Dicom Services. ,
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 ,
eventState:
{
Description: DICOM Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The encryption settings of the DICOM service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
storageConfiguration:
{
Description: The configuration of external storage account ,
Required: False ,
}
{
storageResourceId:
{
Description: The resource id of connected storage account. ,
Required: False ,
}
string ,
fileSystemName:
{
Description: The filesystem name of connected storage account. ,
Required: False ,
}
string ,
storageMonitorConfiguration:
{
Description: The configuration for monitoring changes in the specified storage account. ,
Required: False ,
}
{
namespaceResourceId:
{
Description: The resource id of the Azure Event Grid Namespace. ,
Required: False ,
}
string ,
topicName:
{
Description: The name of the namespace topic within the specified namespace. ,
Required: False ,
}
string ,
eventSubscriptionName:
{
Description: The name of the event subscription associated with the given namespace topic that contains storage events. ,
Required: False ,
}
string ,
}
,
}
,
enableDataPartitions:
{
Description: If data partitions is enabled or not. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
DicomServices_Get (new)
Description :  Gets the properties of the specified DICOM Service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices/{dicomServiceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
dicomServiceName:
{
Description: The name of DICOM Service resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Dicom Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
authenticationConfiguration:
{
Description: Dicom Service authentication configuration. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audiences:
{
Description: The audiences for the service ,
Required: False ,
}
[
string ,
]
,
}
,
corsConfiguration:
{
Description: Dicom Service Cors configuration. ,
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 ,
}
,
serviceUrl:
{
Description: The url of the Dicom Services. ,
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 ,
eventState:
{
Description: DICOM Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The encryption settings of the DICOM service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
storageConfiguration:
{
Description: The configuration of external storage account ,
Required: False ,
}
{
storageResourceId:
{
Description: The resource id of connected storage account. ,
Required: False ,
}
string ,
fileSystemName:
{
Description: The filesystem name of connected storage account. ,
Required: False ,
}
string ,
storageMonitorConfiguration:
{
Description: The configuration for monitoring changes in the specified storage account. ,
Required: False ,
}
{
namespaceResourceId:
{
Description: The resource id of the Azure Event Grid Namespace. ,
Required: False ,
}
string ,
topicName:
{
Description: The name of the namespace topic within the specified namespace. ,
Required: False ,
}
string ,
eventSubscriptionName:
{
Description: The name of the event subscription associated with the given namespace topic that contains storage events. ,
Required: False ,
}
string ,
}
,
}
,
enableDataPartitions:
{
Description: If data partitions is enabled or not. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
DicomServices_CreateOrUpdate (new)
Description :  Creates or updates a DICOM Service resource with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices/{dicomServiceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
dicomServiceName:
{
Description: The name of DICOM Service resource. ,
Required: True ,
}
string ,
dicomservice:
{
Description: The parameters for creating or updating a Dicom Service resource. ,
Required: True ,
}
{
properties:
{
Description: Dicom Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
authenticationConfiguration:
{
Description: Dicom Service authentication configuration. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audiences:
{
Description: The audiences for the service ,
Required: False ,
}
[
string ,
]
,
}
,
corsConfiguration:
{
Description: Dicom Service Cors configuration. ,
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 ,
}
,
serviceUrl:
{
Description: The url of the Dicom Services. ,
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 ,
eventState:
{
Description: DICOM Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The encryption settings of the DICOM service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
storageConfiguration:
{
Description: The configuration of external storage account ,
Required: False ,
}
{
storageResourceId:
{
Description: The resource id of connected storage account. ,
Required: False ,
}
string ,
fileSystemName:
{
Description: The filesystem name of connected storage account. ,
Required: False ,
}
string ,
storageMonitorConfiguration:
{
Description: The configuration for monitoring changes in the specified storage account. ,
Required: False ,
}
{
namespaceResourceId:
{
Description: The resource id of the Azure Event Grid Namespace. ,
Required: False ,
}
string ,
topicName:
{
Description: The name of the namespace topic within the specified namespace. ,
Required: False ,
}
string ,
eventSubscriptionName:
{
Description: The name of the event subscription associated with the given namespace topic that contains storage events. ,
Required: False ,
}
string ,
}
,
}
,
enableDataPartitions:
{
Description: If data partitions is enabled or not. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Dicom Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
authenticationConfiguration:
{
Description: Dicom Service authentication configuration. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audiences:
{
Description: The audiences for the service ,
Required: False ,
}
[
string ,
]
,
}
,
corsConfiguration:
{
Description: Dicom Service Cors configuration. ,
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 ,
}
,
serviceUrl:
{
Description: The url of the Dicom Services. ,
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 ,
eventState:
{
Description: DICOM Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The encryption settings of the DICOM service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
storageConfiguration:
{
Description: The configuration of external storage account ,
Required: False ,
}
{
storageResourceId:
{
Description: The resource id of connected storage account. ,
Required: False ,
}
string ,
fileSystemName:
{
Description: The filesystem name of connected storage account. ,
Required: False ,
}
string ,
storageMonitorConfiguration:
{
Description: The configuration for monitoring changes in the specified storage account. ,
Required: False ,
}
{
namespaceResourceId:
{
Description: The resource id of the Azure Event Grid Namespace. ,
Required: False ,
}
string ,
topicName:
{
Description: The name of the namespace topic within the specified namespace. ,
Required: False ,
}
string ,
eventSubscriptionName:
{
Description: The name of the event subscription associated with the given namespace topic that contains storage events. ,
Required: False ,
}
string ,
}
,
}
,
enableDataPartitions:
{
Description: If data partitions is enabled or not. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Dicom Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
authenticationConfiguration:
{
Description: Dicom Service authentication configuration. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audiences:
{
Description: The audiences for the service ,
Required: False ,
}
[
string ,
]
,
}
,
corsConfiguration:
{
Description: Dicom Service Cors configuration. ,
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 ,
}
,
serviceUrl:
{
Description: The url of the Dicom Services. ,
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 ,
eventState:
{
Description: DICOM Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The encryption settings of the DICOM service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
storageConfiguration:
{
Description: The configuration of external storage account ,
Required: False ,
}
{
storageResourceId:
{
Description: The resource id of connected storage account. ,
Required: False ,
}
string ,
fileSystemName:
{
Description: The filesystem name of connected storage account. ,
Required: False ,
}
string ,
storageMonitorConfiguration:
{
Description: The configuration for monitoring changes in the specified storage account. ,
Required: False ,
}
{
namespaceResourceId:
{
Description: The resource id of the Azure Event Grid Namespace. ,
Required: False ,
}
string ,
topicName:
{
Description: The name of the namespace topic within the specified namespace. ,
Required: False ,
}
string ,
eventSubscriptionName:
{
Description: The name of the event subscription associated with the given namespace topic that contains storage events. ,
Required: False ,
}
string ,
}
,
}
,
enableDataPartitions:
{
Description: If data partitions is enabled or not. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Dicom Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
authenticationConfiguration:
{
Description: Dicom Service authentication configuration. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audiences:
{
Description: The audiences for the service ,
Required: False ,
}
[
string ,
]
,
}
,
corsConfiguration:
{
Description: Dicom Service Cors configuration. ,
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 ,
}
,
serviceUrl:
{
Description: The url of the Dicom Services. ,
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 ,
eventState:
{
Description: DICOM Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The encryption settings of the DICOM service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
storageConfiguration:
{
Description: The configuration of external storage account ,
Required: False ,
}
{
storageResourceId:
{
Description: The resource id of connected storage account. ,
Required: False ,
}
string ,
fileSystemName:
{
Description: The filesystem name of connected storage account. ,
Required: False ,
}
string ,
storageMonitorConfiguration:
{
Description: The configuration for monitoring changes in the specified storage account. ,
Required: False ,
}
{
namespaceResourceId:
{
Description: The resource id of the Azure Event Grid Namespace. ,
Required: False ,
}
string ,
topicName:
{
Description: The name of the namespace topic within the specified namespace. ,
Required: False ,
}
string ,
eventSubscriptionName:
{
Description: The name of the event subscription associated with the given namespace topic that contains storage events. ,
Required: False ,
}
string ,
}
,
}
,
enableDataPartitions:
{
Description: If data partitions is enabled or not. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
DicomServices_Update (new)
Description :  Patch DICOM Service details.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices/{dicomServiceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
dicomServiceName:
{
Description: The name of DICOM Service resource. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
dicomservicePatchResource:
{
Description: The parameters for updating a Dicom Service. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: Dicom Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
authenticationConfiguration:
{
Description: Dicom Service authentication configuration. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audiences:
{
Description: The audiences for the service ,
Required: False ,
}
[
string ,
]
,
}
,
corsConfiguration:
{
Description: Dicom Service Cors configuration. ,
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 ,
}
,
serviceUrl:
{
Description: The url of the Dicom Services. ,
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 ,
eventState:
{
Description: DICOM Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The encryption settings of the DICOM service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
storageConfiguration:
{
Description: The configuration of external storage account ,
Required: False ,
}
{
storageResourceId:
{
Description: The resource id of connected storage account. ,
Required: False ,
}
string ,
fileSystemName:
{
Description: The filesystem name of connected storage account. ,
Required: False ,
}
string ,
storageMonitorConfiguration:
{
Description: The configuration for monitoring changes in the specified storage account. ,
Required: False ,
}
{
namespaceResourceId:
{
Description: The resource id of the Azure Event Grid Namespace. ,
Required: False ,
}
string ,
topicName:
{
Description: The name of the namespace topic within the specified namespace. ,
Required: False ,
}
string ,
eventSubscriptionName:
{
Description: The name of the event subscription associated with the given namespace topic that contains storage events. ,
Required: False ,
}
string ,
}
,
}
,
enableDataPartitions:
{
Description: If data partitions is enabled or not. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Dicom Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
authenticationConfiguration:
{
Description: Dicom Service authentication configuration. ,
Required: False ,
}
{
authority:
{
Description: The authority url for the service ,
Required: False ,
}
string ,
audiences:
{
Description: The audiences for the service ,
Required: False ,
}
[
string ,
]
,
}
,
corsConfiguration:
{
Description: Dicom Service Cors configuration. ,
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 ,
}
,
serviceUrl:
{
Description: The url of the Dicom Services. ,
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 ,
eventState:
{
Description: DICOM Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The encryption settings of the DICOM service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
storageConfiguration:
{
Description: The configuration of external storage account ,
Required: False ,
}
{
storageResourceId:
{
Description: The resource id of connected storage account. ,
Required: False ,
}
string ,
fileSystemName:
{
Description: The filesystem name of connected storage account. ,
Required: False ,
}
string ,
storageMonitorConfiguration:
{
Description: The configuration for monitoring changes in the specified storage account. ,
Required: False ,
}
{
namespaceResourceId:
{
Description: The resource id of the Azure Event Grid Namespace. ,
Required: False ,
}
string ,
topicName:
{
Description: The name of the namespace topic within the specified namespace. ,
Required: False ,
}
string ,
eventSubscriptionName:
{
Description: The name of the event subscription associated with the given namespace topic that contains storage events. ,
Required: False ,
}
string ,
}
,
}
,
enableDataPartitions:
{
Description: If data partitions is enabled or not. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
DicomServices_Delete (new)
Description :  Deletes a DICOM Service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices/{dicomServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
dicomServiceName:
{
Description: The name of DICOM Service resource. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
IotConnectors_ListByWorkspace (new)
Description :  Lists all IoT Connectors for the given workspace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of IoT Connectors. ,
Required: False ,
}
string ,
value:
{
Description: The list of IoT Connectors. ,
Required: False ,
}
[
{
properties:
{
Description: IoT Connector configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionEndpointConfiguration:
{
Description: Source configuration. ,
Required: False ,
}
{
eventHubName:
{
Description: Event Hub name to connect to. ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Consumer group of the event hub to connected to. ,
Required: False ,
}
string ,
fullyQualifiedEventHubNamespace:
{
Description: Fully qualified namespace of the Event Hub to connect to. ,
Required: False ,
}
string ,
}
,
deviceMapping:
{
Description: Device Mappings. ,
Required: False ,
}
{
content:
{
Description: The mapping. ,
Required: False ,
}
object ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
IotConnectors_Get (new)
Description :  Gets the properties of the specified IoT Connector.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
iotConnectorName:
{
Description: The name of IoT Connector resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: IoT Connector configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionEndpointConfiguration:
{
Description: Source configuration. ,
Required: False ,
}
{
eventHubName:
{
Description: Event Hub name to connect to. ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Consumer group of the event hub to connected to. ,
Required: False ,
}
string ,
fullyQualifiedEventHubNamespace:
{
Description: Fully qualified namespace of the Event Hub to connect to. ,
Required: False ,
}
string ,
}
,
deviceMapping:
{
Description: Device Mappings. ,
Required: False ,
}
{
content:
{
Description: The mapping. ,
Required: False ,
}
object ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
IotConnectors_CreateOrUpdate (new)
Description :  Creates or updates an IoT Connector resource with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
iotConnectorName:
{
Description: The name of IoT Connector resource. ,
Required: True ,
}
string ,
iotConnector:
{
Description: The parameters for creating or updating an IoT Connectors resource. ,
Required: True ,
}
{
properties:
{
Description: IoT Connector configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionEndpointConfiguration:
{
Description: Source configuration. ,
Required: False ,
}
{
eventHubName:
{
Description: Event Hub name to connect to. ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Consumer group of the event hub to connected to. ,
Required: False ,
}
string ,
fullyQualifiedEventHubNamespace:
{
Description: Fully qualified namespace of the Event Hub to connect to. ,
Required: False ,
}
string ,
}
,
deviceMapping:
{
Description: Device Mappings. ,
Required: False ,
}
{
content:
{
Description: The mapping. ,
Required: False ,
}
object ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: IoT Connector configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionEndpointConfiguration:
{
Description: Source configuration. ,
Required: False ,
}
{
eventHubName:
{
Description: Event Hub name to connect to. ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Consumer group of the event hub to connected to. ,
Required: False ,
}
string ,
fullyQualifiedEventHubNamespace:
{
Description: Fully qualified namespace of the Event Hub to connect to. ,
Required: False ,
}
string ,
}
,
deviceMapping:
{
Description: Device Mappings. ,
Required: False ,
}
{
content:
{
Description: The mapping. ,
Required: False ,
}
object ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: IoT Connector configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionEndpointConfiguration:
{
Description: Source configuration. ,
Required: False ,
}
{
eventHubName:
{
Description: Event Hub name to connect to. ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Consumer group of the event hub to connected to. ,
Required: False ,
}
string ,
fullyQualifiedEventHubNamespace:
{
Description: Fully qualified namespace of the Event Hub to connect to. ,
Required: False ,
}
string ,
}
,
deviceMapping:
{
Description: Device Mappings. ,
Required: False ,
}
{
content:
{
Description: The mapping. ,
Required: False ,
}
object ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: IoT Connector configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionEndpointConfiguration:
{
Description: Source configuration. ,
Required: False ,
}
{
eventHubName:
{
Description: Event Hub name to connect to. ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Consumer group of the event hub to connected to. ,
Required: False ,
}
string ,
fullyQualifiedEventHubNamespace:
{
Description: Fully qualified namespace of the Event Hub to connect to. ,
Required: False ,
}
string ,
}
,
deviceMapping:
{
Description: Device Mappings. ,
Required: False ,
}
{
content:
{
Description: The mapping. ,
Required: False ,
}
object ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
IotConnectors_Update (new)
Description :  Patch an IoT Connector.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
iotConnectorName:
{
Description: The name of IoT Connector resource. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
iotConnectorPatchResource:
{
Description: The parameters for updating an IoT Connector. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
properties:
{
Description: IoT Connector configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionEndpointConfiguration:
{
Description: Source configuration. ,
Required: False ,
}
{
eventHubName:
{
Description: Event Hub name to connect to. ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Consumer group of the event hub to connected to. ,
Required: False ,
}
string ,
fullyQualifiedEventHubNamespace:
{
Description: Fully qualified namespace of the Event Hub to connect to. ,
Required: False ,
}
string ,
}
,
deviceMapping:
{
Description: Device Mappings. ,
Required: False ,
}
{
content:
{
Description: The mapping. ,
Required: False ,
}
object ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: IoT Connector configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionEndpointConfiguration:
{
Description: Source configuration. ,
Required: False ,
}
{
eventHubName:
{
Description: Event Hub name to connect to. ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Consumer group of the event hub to connected to. ,
Required: False ,
}
string ,
fullyQualifiedEventHubNamespace:
{
Description: Fully qualified namespace of the Event Hub to connect to. ,
Required: False ,
}
string ,
}
,
deviceMapping:
{
Description: Device Mappings. ,
Required: False ,
}
{
content:
{
Description: The mapping. ,
Required: False ,
}
object ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
IotConnectors_Delete (new)
Description :  Deletes an IoT Connector.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
iotConnectorName:
{
Description: The name of IoT Connector resource. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
FhirDestinations_ListByIotConnector (new)
Description :  Lists all FHIR destinations for the given IoT Connector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
iotConnectorName:
{
Description: The name of IoT Connector resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of IoT FHIR destinations. ,
Required: False ,
}
string ,
value:
{
Description: The list of IoT Connector FHIR destinations. ,
Required: False ,
}
[
{
properties:
{
Description: IoT FHIR Destination settings. ,
Required: True ,
}
{
resourceIdentityResolutionType:
{
Description: Determines how resource identity is resolved on the destination. ,
Enum:
{
Create: No description available. ,
Lookup: No description available. ,
}
,
Required: True ,
}
enum ,
fhirServiceResourceId:
{
Description: Fully qualified resource id of the FHIR service to connect to. ,
Required: True ,
}
string ,
fhirMapping:
{
Description: FHIR Mappings ,
Required: True ,
}
{
content:
{
Description: The mapping. ,
Required: False ,
}
object ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
IotConnectorFhirDestination_Get (new)
Description :  Gets the properties of the specified Iot Connector FHIR destination.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations/{fhirDestinationName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
iotConnectorName:
{
Description: The name of IoT Connector resource. ,
Required: True ,
}
string ,
fhirDestinationName:
{
Description: The name of IoT Connector FHIR destination resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: IoT FHIR Destination settings. ,
Required: True ,
}
{
resourceIdentityResolutionType:
{
Description: Determines how resource identity is resolved on the destination. ,
Enum:
{
Create: No description available. ,
Lookup: No description available. ,
}
,
Required: True ,
}
enum ,
fhirServiceResourceId:
{
Description: Fully qualified resource id of the FHIR service to connect to. ,
Required: True ,
}
string ,
fhirMapping:
{
Description: FHIR Mappings ,
Required: True ,
}
{
content:
{
Description: The mapping. ,
Required: False ,
}
object ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
IotConnectorFhirDestination_CreateOrUpdate (new)
Description :  Creates or updates an IoT Connector FHIR destination resource with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations/{fhirDestinationName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
iotConnectorName:
{
Description: The name of IoT Connector resource. ,
Required: True ,
}
string ,
fhirDestinationName:
{
Description: The name of IoT Connector FHIR destination resource. ,
Required: True ,
}
string ,
iotFhirDestination:
{
Description: The parameters for creating or updating an IoT Connector FHIR destination resource. ,
Required: True ,
}
{
properties:
{
Description: IoT FHIR Destination settings. ,
Required: True ,
}
{
resourceIdentityResolutionType:
{
Description: Determines how resource identity is resolved on the destination. ,
Enum:
{
Create: No description available. ,
Lookup: No description available. ,
}
,
Required: True ,
}
enum ,
fhirServiceResourceId:
{
Description: Fully qualified resource id of the FHIR service to connect to. ,
Required: True ,
}
string ,
fhirMapping:
{
Description: FHIR Mappings ,
Required: True ,
}
{
content:
{
Description: The mapping. ,
Required: False ,
}
object ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: IoT FHIR Destination settings. ,
Required: True ,
}
{
resourceIdentityResolutionType:
{
Description: Determines how resource identity is resolved on the destination. ,
Enum:
{
Create: No description available. ,
Lookup: No description available. ,
}
,
Required: True ,
}
enum ,
fhirServiceResourceId:
{
Description: Fully qualified resource id of the FHIR service to connect to. ,
Required: True ,
}
string ,
fhirMapping:
{
Description: FHIR Mappings ,
Required: True ,
}
{
content:
{
Description: The mapping. ,
Required: False ,
}
object ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: IoT FHIR Destination settings. ,
Required: True ,
}
{
resourceIdentityResolutionType:
{
Description: Determines how resource identity is resolved on the destination. ,
Enum:
{
Create: No description available. ,
Lookup: No description available. ,
}
,
Required: True ,
}
enum ,
fhirServiceResourceId:
{
Description: Fully qualified resource id of the FHIR service to connect to. ,
Required: True ,
}
string ,
fhirMapping:
{
Description: FHIR Mappings ,
Required: True ,
}
{
content:
{
Description: The mapping. ,
Required: False ,
}
object ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: IoT FHIR Destination settings. ,
Required: True ,
}
{
resourceIdentityResolutionType:
{
Description: Determines how resource identity is resolved on the destination. ,
Enum:
{
Create: No description available. ,
Lookup: No description available. ,
}
,
Required: True ,
}
enum ,
fhirServiceResourceId:
{
Description: Fully qualified resource id of the FHIR service to connect to. ,
Required: True ,
}
string ,
fhirMapping:
{
Description: FHIR Mappings ,
Required: True ,
}
{
content:
{
Description: The mapping. ,
Required: False ,
}
object ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
IotConnectorFhirDestination_Delete (new)
Description :  Deletes an IoT Connector FHIR destination.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations/{fhirDestinationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
iotConnectorName:
{
Description: The name of IoT Connector resource. ,
Required: True ,
}
string ,
fhirDestinationName:
{
Description: The name of IoT Connector FHIR destination resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
FhirServices_ListByWorkspace (new)
Description :  Lists all FHIR Services for the given workspace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of Fhir Services. ,
Required: False ,
}
string ,
value:
{
Description: The list of Fhir Services. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of the service. ,
Enum:
{
fhir-Stu3: No description available. ,
fhir-R4: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Fhir Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
acrConfiguration:
{
Description: Fhir Service Azure container registry configuration. ,
Required: False ,
}
{
loginServers:
{
Description: The list of the Azure container registry login servers. ,
Required: False ,
}
[
string ,
]
,
ociArtifacts:
{
Description: The list of Open Container Initiative (OCI) artifacts. ,
Required: False ,
}
[
{
loginServer:
{
Description: The Azure Container Registry login server. ,
Required: False ,
}
string ,
imageName:
{
Description: The artifact name. ,
Required: False ,
}
string ,
digest:
{
Description: The artifact digest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
authenticationConfiguration:
{
Description: Fhir Service authentication configuration. ,
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 ,
smartIdentityProviders:
{
Description: The array of identity provider configurations for SMART on FHIR authentication. ,
Required: False ,
}
[
{
authority:
{
Description: The identity provider token authority also known as the token issuing authority. ,
Required: False ,
}
string ,
applications:
{
Description: The array of identity provider applications for SMART on FHIR authentication. ,
Required: False ,
}
[
{
clientId:
{
Description: The application client id defined in the identity provider. This value will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
audience:
{
Description: The audience that will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
allowedDataActions:
{
Description: The actions that are permitted to be performed on FHIR resources for the application. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
corsConfiguration:
{
Description: Fhir Service Cors configuration. ,
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: Fhir Service export configuration. ,
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 ,
eventState:
{
Description: Fhir Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceVersionPolicyConfiguration:
{
Description: Determines tracking of history for resources. ,
Required: False ,
}
{
default:
{
Description: The default value for tracking history across all resources. ,
Enum:
{
no-version: No description available. ,
versioned: No description available. ,
versioned-update: No description available. ,
}
,
Required: False ,
}
enum ,
resourceTypeOverrides:
{
Description: A list of FHIR Resources and their version policy overrides. ,
Required: False ,
}
object ,
}
,
importConfiguration:
{
Description: Fhir Service import configuration. ,
Required: False ,
}
{
integrationDataStore:
{
Description: The name of the default integration storage account. ,
Required: False ,
}
string ,
initialImportMode:
{
Description: If the FHIR service is in InitialImportMode. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the import operation is enabled. ,
Required: False ,
}
boolean ,
}
,
implementationGuidesConfiguration:
{
Description: Implementation Guides configuration. ,
Required: False ,
}
{
usCoreMissingData:
{
Description: If US Core Missing Data requirement is enabled. ,
Required: False ,
}
boolean ,
}
,
encryption:
{
Description: The encryption settings of the FHIR service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
FhirServices_Get (new)
Description :  Gets the properties of the specified FHIR Service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
fhirServiceName:
{
Description: The name of FHIR Service resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: The kind of the service. ,
Enum:
{
fhir-Stu3: No description available. ,
fhir-R4: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Fhir Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
acrConfiguration:
{
Description: Fhir Service Azure container registry configuration. ,
Required: False ,
}
{
loginServers:
{
Description: The list of the Azure container registry login servers. ,
Required: False ,
}
[
string ,
]
,
ociArtifacts:
{
Description: The list of Open Container Initiative (OCI) artifacts. ,
Required: False ,
}
[
{
loginServer:
{
Description: The Azure Container Registry login server. ,
Required: False ,
}
string ,
imageName:
{
Description: The artifact name. ,
Required: False ,
}
string ,
digest:
{
Description: The artifact digest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
authenticationConfiguration:
{
Description: Fhir Service authentication configuration. ,
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 ,
smartIdentityProviders:
{
Description: The array of identity provider configurations for SMART on FHIR authentication. ,
Required: False ,
}
[
{
authority:
{
Description: The identity provider token authority also known as the token issuing authority. ,
Required: False ,
}
string ,
applications:
{
Description: The array of identity provider applications for SMART on FHIR authentication. ,
Required: False ,
}
[
{
clientId:
{
Description: The application client id defined in the identity provider. This value will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
audience:
{
Description: The audience that will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
allowedDataActions:
{
Description: The actions that are permitted to be performed on FHIR resources for the application. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
corsConfiguration:
{
Description: Fhir Service Cors configuration. ,
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: Fhir Service export configuration. ,
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 ,
eventState:
{
Description: Fhir Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceVersionPolicyConfiguration:
{
Description: Determines tracking of history for resources. ,
Required: False ,
}
{
default:
{
Description: The default value for tracking history across all resources. ,
Enum:
{
no-version: No description available. ,
versioned: No description available. ,
versioned-update: No description available. ,
}
,
Required: False ,
}
enum ,
resourceTypeOverrides:
{
Description: A list of FHIR Resources and their version policy overrides. ,
Required: False ,
}
object ,
}
,
importConfiguration:
{
Description: Fhir Service import configuration. ,
Required: False ,
}
{
integrationDataStore:
{
Description: The name of the default integration storage account. ,
Required: False ,
}
string ,
initialImportMode:
{
Description: If the FHIR service is in InitialImportMode. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the import operation is enabled. ,
Required: False ,
}
boolean ,
}
,
implementationGuidesConfiguration:
{
Description: Implementation Guides configuration. ,
Required: False ,
}
{
usCoreMissingData:
{
Description: If US Core Missing Data requirement is enabled. ,
Required: False ,
}
boolean ,
}
,
encryption:
{
Description: The encryption settings of the FHIR service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
FhirServices_CreateOrUpdate (new)
Description :  Creates or updates a FHIR Service resource with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
fhirServiceName:
{
Description: The name of FHIR Service resource. ,
Required: True ,
}
string ,
fhirservice:
{
Description: The parameters for creating or updating a Fhir Service resource. ,
Required: True ,
}
{
kind:
{
Description: The kind of the service. ,
Enum:
{
fhir-Stu3: No description available. ,
fhir-R4: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Fhir Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
acrConfiguration:
{
Description: Fhir Service Azure container registry configuration. ,
Required: False ,
}
{
loginServers:
{
Description: The list of the Azure container registry login servers. ,
Required: False ,
}
[
string ,
]
,
ociArtifacts:
{
Description: The list of Open Container Initiative (OCI) artifacts. ,
Required: False ,
}
[
{
loginServer:
{
Description: The Azure Container Registry login server. ,
Required: False ,
}
string ,
imageName:
{
Description: The artifact name. ,
Required: False ,
}
string ,
digest:
{
Description: The artifact digest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
authenticationConfiguration:
{
Description: Fhir Service authentication configuration. ,
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 ,
smartIdentityProviders:
{
Description: The array of identity provider configurations for SMART on FHIR authentication. ,
Required: False ,
}
[
{
authority:
{
Description: The identity provider token authority also known as the token issuing authority. ,
Required: False ,
}
string ,
applications:
{
Description: The array of identity provider applications for SMART on FHIR authentication. ,
Required: False ,
}
[
{
clientId:
{
Description: The application client id defined in the identity provider. This value will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
audience:
{
Description: The audience that will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
allowedDataActions:
{
Description: The actions that are permitted to be performed on FHIR resources for the application. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
corsConfiguration:
{
Description: Fhir Service Cors configuration. ,
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: Fhir Service export configuration. ,
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 ,
eventState:
{
Description: Fhir Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceVersionPolicyConfiguration:
{
Description: Determines tracking of history for resources. ,
Required: False ,
}
{
default:
{
Description: The default value for tracking history across all resources. ,
Enum:
{
no-version: No description available. ,
versioned: No description available. ,
versioned-update: No description available. ,
}
,
Required: False ,
}
enum ,
resourceTypeOverrides:
{
Description: A list of FHIR Resources and their version policy overrides. ,
Required: False ,
}
object ,
}
,
importConfiguration:
{
Description: Fhir Service import configuration. ,
Required: False ,
}
{
integrationDataStore:
{
Description: The name of the default integration storage account. ,
Required: False ,
}
string ,
initialImportMode:
{
Description: If the FHIR service is in InitialImportMode. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the import operation is enabled. ,
Required: False ,
}
boolean ,
}
,
implementationGuidesConfiguration:
{
Description: Implementation Guides configuration. ,
Required: False ,
}
{
usCoreMissingData:
{
Description: If US Core Missing Data requirement is enabled. ,
Required: False ,
}
boolean ,
}
,
encryption:
{
Description: The encryption settings of the FHIR service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: The kind of the service. ,
Enum:
{
fhir-Stu3: No description available. ,
fhir-R4: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Fhir Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
acrConfiguration:
{
Description: Fhir Service Azure container registry configuration. ,
Required: False ,
}
{
loginServers:
{
Description: The list of the Azure container registry login servers. ,
Required: False ,
}
[
string ,
]
,
ociArtifacts:
{
Description: The list of Open Container Initiative (OCI) artifacts. ,
Required: False ,
}
[
{
loginServer:
{
Description: The Azure Container Registry login server. ,
Required: False ,
}
string ,
imageName:
{
Description: The artifact name. ,
Required: False ,
}
string ,
digest:
{
Description: The artifact digest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
authenticationConfiguration:
{
Description: Fhir Service authentication configuration. ,
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 ,
smartIdentityProviders:
{
Description: The array of identity provider configurations for SMART on FHIR authentication. ,
Required: False ,
}
[
{
authority:
{
Description: The identity provider token authority also known as the token issuing authority. ,
Required: False ,
}
string ,
applications:
{
Description: The array of identity provider applications for SMART on FHIR authentication. ,
Required: False ,
}
[
{
clientId:
{
Description: The application client id defined in the identity provider. This value will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
audience:
{
Description: The audience that will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
allowedDataActions:
{
Description: The actions that are permitted to be performed on FHIR resources for the application. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
corsConfiguration:
{
Description: Fhir Service Cors configuration. ,
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: Fhir Service export configuration. ,
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 ,
eventState:
{
Description: Fhir Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceVersionPolicyConfiguration:
{
Description: Determines tracking of history for resources. ,
Required: False ,
}
{
default:
{
Description: The default value for tracking history across all resources. ,
Enum:
{
no-version: No description available. ,
versioned: No description available. ,
versioned-update: No description available. ,
}
,
Required: False ,
}
enum ,
resourceTypeOverrides:
{
Description: A list of FHIR Resources and their version policy overrides. ,
Required: False ,
}
object ,
}
,
importConfiguration:
{
Description: Fhir Service import configuration. ,
Required: False ,
}
{
integrationDataStore:
{
Description: The name of the default integration storage account. ,
Required: False ,
}
string ,
initialImportMode:
{
Description: If the FHIR service is in InitialImportMode. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the import operation is enabled. ,
Required: False ,
}
boolean ,
}
,
implementationGuidesConfiguration:
{
Description: Implementation Guides configuration. ,
Required: False ,
}
{
usCoreMissingData:
{
Description: If US Core Missing Data requirement is enabled. ,
Required: False ,
}
boolean ,
}
,
encryption:
{
Description: The encryption settings of the FHIR service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
kind:
{
Description: The kind of the service. ,
Enum:
{
fhir-Stu3: No description available. ,
fhir-R4: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Fhir Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
acrConfiguration:
{
Description: Fhir Service Azure container registry configuration. ,
Required: False ,
}
{
loginServers:
{
Description: The list of the Azure container registry login servers. ,
Required: False ,
}
[
string ,
]
,
ociArtifacts:
{
Description: The list of Open Container Initiative (OCI) artifacts. ,
Required: False ,
}
[
{
loginServer:
{
Description: The Azure Container Registry login server. ,
Required: False ,
}
string ,
imageName:
{
Description: The artifact name. ,
Required: False ,
}
string ,
digest:
{
Description: The artifact digest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
authenticationConfiguration:
{
Description: Fhir Service authentication configuration. ,
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 ,
smartIdentityProviders:
{
Description: The array of identity provider configurations for SMART on FHIR authentication. ,
Required: False ,
}
[
{
authority:
{
Description: The identity provider token authority also known as the token issuing authority. ,
Required: False ,
}
string ,
applications:
{
Description: The array of identity provider applications for SMART on FHIR authentication. ,
Required: False ,
}
[
{
clientId:
{
Description: The application client id defined in the identity provider. This value will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
audience:
{
Description: The audience that will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
allowedDataActions:
{
Description: The actions that are permitted to be performed on FHIR resources for the application. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
corsConfiguration:
{
Description: Fhir Service Cors configuration. ,
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: Fhir Service export configuration. ,
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 ,
eventState:
{
Description: Fhir Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceVersionPolicyConfiguration:
{
Description: Determines tracking of history for resources. ,
Required: False ,
}
{
default:
{
Description: The default value for tracking history across all resources. ,
Enum:
{
no-version: No description available. ,
versioned: No description available. ,
versioned-update: No description available. ,
}
,
Required: False ,
}
enum ,
resourceTypeOverrides:
{
Description: A list of FHIR Resources and their version policy overrides. ,
Required: False ,
}
object ,
}
,
importConfiguration:
{
Description: Fhir Service import configuration. ,
Required: False ,
}
{
integrationDataStore:
{
Description: The name of the default integration storage account. ,
Required: False ,
}
string ,
initialImportMode:
{
Description: If the FHIR service is in InitialImportMode. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the import operation is enabled. ,
Required: False ,
}
boolean ,
}
,
implementationGuidesConfiguration:
{
Description: Implementation Guides configuration. ,
Required: False ,
}
{
usCoreMissingData:
{
Description: If US Core Missing Data requirement is enabled. ,
Required: False ,
}
boolean ,
}
,
encryption:
{
Description: The encryption settings of the FHIR service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
kind:
{
Description: The kind of the service. ,
Enum:
{
fhir-Stu3: No description available. ,
fhir-R4: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Fhir Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
acrConfiguration:
{
Description: Fhir Service Azure container registry configuration. ,
Required: False ,
}
{
loginServers:
{
Description: The list of the Azure container registry login servers. ,
Required: False ,
}
[
string ,
]
,
ociArtifacts:
{
Description: The list of Open Container Initiative (OCI) artifacts. ,
Required: False ,
}
[
{
loginServer:
{
Description: The Azure Container Registry login server. ,
Required: False ,
}
string ,
imageName:
{
Description: The artifact name. ,
Required: False ,
}
string ,
digest:
{
Description: The artifact digest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
authenticationConfiguration:
{
Description: Fhir Service authentication configuration. ,
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 ,
smartIdentityProviders:
{
Description: The array of identity provider configurations for SMART on FHIR authentication. ,
Required: False ,
}
[
{
authority:
{
Description: The identity provider token authority also known as the token issuing authority. ,
Required: False ,
}
string ,
applications:
{
Description: The array of identity provider applications for SMART on FHIR authentication. ,
Required: False ,
}
[
{
clientId:
{
Description: The application client id defined in the identity provider. This value will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
audience:
{
Description: The audience that will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
allowedDataActions:
{
Description: The actions that are permitted to be performed on FHIR resources for the application. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
corsConfiguration:
{
Description: Fhir Service Cors configuration. ,
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: Fhir Service export configuration. ,
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 ,
eventState:
{
Description: Fhir Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceVersionPolicyConfiguration:
{
Description: Determines tracking of history for resources. ,
Required: False ,
}
{
default:
{
Description: The default value for tracking history across all resources. ,
Enum:
{
no-version: No description available. ,
versioned: No description available. ,
versioned-update: No description available. ,
}
,
Required: False ,
}
enum ,
resourceTypeOverrides:
{
Description: A list of FHIR Resources and their version policy overrides. ,
Required: False ,
}
object ,
}
,
importConfiguration:
{
Description: Fhir Service import configuration. ,
Required: False ,
}
{
integrationDataStore:
{
Description: The name of the default integration storage account. ,
Required: False ,
}
string ,
initialImportMode:
{
Description: If the FHIR service is in InitialImportMode. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the import operation is enabled. ,
Required: False ,
}
boolean ,
}
,
implementationGuidesConfiguration:
{
Description: Implementation Guides configuration. ,
Required: False ,
}
{
usCoreMissingData:
{
Description: If US Core Missing Data requirement is enabled. ,
Required: False ,
}
boolean ,
}
,
encryption:
{
Description: The encryption settings of the FHIR service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
FhirServices_Update (new)
Description :  Patch FHIR Service details.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
fhirServiceName:
{
Description: The name of FHIR Service resource. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
fhirservicePatchResource:
{
Description: The parameters for updating a Fhir Service. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
kind:
{
Description: The kind of the service. ,
Enum:
{
fhir-Stu3: No description available. ,
fhir-R4: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Fhir Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
acrConfiguration:
{
Description: Fhir Service Azure container registry configuration. ,
Required: False ,
}
{
loginServers:
{
Description: The list of the Azure container registry login servers. ,
Required: False ,
}
[
string ,
]
,
ociArtifacts:
{
Description: The list of Open Container Initiative (OCI) artifacts. ,
Required: False ,
}
[
{
loginServer:
{
Description: The Azure Container Registry login server. ,
Required: False ,
}
string ,
imageName:
{
Description: The artifact name. ,
Required: False ,
}
string ,
digest:
{
Description: The artifact digest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
authenticationConfiguration:
{
Description: Fhir Service authentication configuration. ,
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 ,
smartIdentityProviders:
{
Description: The array of identity provider configurations for SMART on FHIR authentication. ,
Required: False ,
}
[
{
authority:
{
Description: The identity provider token authority also known as the token issuing authority. ,
Required: False ,
}
string ,
applications:
{
Description: The array of identity provider applications for SMART on FHIR authentication. ,
Required: False ,
}
[
{
clientId:
{
Description: The application client id defined in the identity provider. This value will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
audience:
{
Description: The audience that will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
allowedDataActions:
{
Description: The actions that are permitted to be performed on FHIR resources for the application. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
corsConfiguration:
{
Description: Fhir Service Cors configuration. ,
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: Fhir Service export configuration. ,
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 ,
eventState:
{
Description: Fhir Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceVersionPolicyConfiguration:
{
Description: Determines tracking of history for resources. ,
Required: False ,
}
{
default:
{
Description: The default value for tracking history across all resources. ,
Enum:
{
no-version: No description available. ,
versioned: No description available. ,
versioned-update: No description available. ,
}
,
Required: False ,
}
enum ,
resourceTypeOverrides:
{
Description: A list of FHIR Resources and their version policy overrides. ,
Required: False ,
}
object ,
}
,
importConfiguration:
{
Description: Fhir Service import configuration. ,
Required: False ,
}
{
integrationDataStore:
{
Description: The name of the default integration storage account. ,
Required: False ,
}
string ,
initialImportMode:
{
Description: If the FHIR service is in InitialImportMode. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the import operation is enabled. ,
Required: False ,
}
boolean ,
}
,
implementationGuidesConfiguration:
{
Description: Implementation Guides configuration. ,
Required: False ,
}
{
usCoreMissingData:
{
Description: If US Core Missing Data requirement is enabled. ,
Required: False ,
}
boolean ,
}
,
encryption:
{
Description: The encryption settings of the FHIR service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
kind:
{
Description: The kind of the service. ,
Enum:
{
fhir-Stu3: No description available. ,
fhir-R4: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Fhir Service configuration. ,
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. ,
Moving: No description available. ,
Suspended: No description available. ,
Warned: No description available. ,
SystemMaintenance: No description available. ,
}
,
Required: False ,
}
enum ,
acrConfiguration:
{
Description: Fhir Service Azure container registry configuration. ,
Required: False ,
}
{
loginServers:
{
Description: The list of the Azure container registry login servers. ,
Required: False ,
}
[
string ,
]
,
ociArtifacts:
{
Description: The list of Open Container Initiative (OCI) artifacts. ,
Required: False ,
}
[
{
loginServer:
{
Description: The Azure Container Registry login server. ,
Required: False ,
}
string ,
imageName:
{
Description: The artifact name. ,
Required: False ,
}
string ,
digest:
{
Description: The artifact digest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
authenticationConfiguration:
{
Description: Fhir Service authentication configuration. ,
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 ,
smartIdentityProviders:
{
Description: The array of identity provider configurations for SMART on FHIR authentication. ,
Required: False ,
}
[
{
authority:
{
Description: The identity provider token authority also known as the token issuing authority. ,
Required: False ,
}
string ,
applications:
{
Description: The array of identity provider applications for SMART on FHIR authentication. ,
Required: False ,
}
[
{
clientId:
{
Description: The application client id defined in the identity provider. This value will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
audience:
{
Description: The audience that will be used to validate bearer tokens against the given authority. ,
Required: False ,
}
string ,
allowedDataActions:
{
Description: The actions that are permitted to be performed on FHIR resources for the application. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
corsConfiguration:
{
Description: Fhir Service Cors configuration. ,
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: Fhir Service export configuration. ,
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 ,
eventState:
{
Description: Fhir Service event support status. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
resourceVersionPolicyConfiguration:
{
Description: Determines tracking of history for resources. ,
Required: False ,
}
{
default:
{
Description: The default value for tracking history across all resources. ,
Enum:
{
no-version: No description available. ,
versioned: No description available. ,
versioned-update: No description available. ,
}
,
Required: False ,
}
enum ,
resourceTypeOverrides:
{
Description: A list of FHIR Resources and their version policy overrides. ,
Required: False ,
}
object ,
}
,
importConfiguration:
{
Description: Fhir Service import configuration. ,
Required: False ,
}
{
integrationDataStore:
{
Description: The name of the default integration storage account. ,
Required: False ,
}
string ,
initialImportMode:
{
Description: If the FHIR service is in InitialImportMode. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the import operation is enabled. ,
Required: False ,
}
boolean ,
}
,
implementationGuidesConfiguration:
{
Description: Implementation Guides configuration. ,
Required: False ,
}
{
usCoreMissingData:
{
Description: If US Core Missing Data requirement is enabled. ,
Required: False ,
}
boolean ,
}
,
encryption:
{
Description: The encryption settings of the FHIR service ,
Required: False ,
}
{
customerManagedKeyEncryption:
{
Description: The encryption settings for the customer-managed key ,
Required: False ,
}
{
keyEncryptionKeyUrl:
{
Description: The URL of the key to use for encryption ,
Required: False ,
}
string ,
}
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
FhirServices_Delete (new)
Description :  Deletes a FHIR Service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
fhirServiceName:
{
Description: The name of FHIR Service resource. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
WorkspacePrivateEndpointConnections_ListByWorkspace (new)
Description :  Lists all private endpoint connections for a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateEndpointConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
WorkspacePrivateEndpointConnections_Get (new)
Description :  Gets the specified private endpoint connection associated with the workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
WorkspacePrivateEndpointConnections_CreateOrUpdate (new)
Description :  Update the state of the specified private endpoint connection associated with the workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
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 ,
}
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
WorkspacePrivateEndpointConnections_Delete (new)
Description :  Deletes a private endpoint connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
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: 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 ,
}
,
}
WorkspacePrivateLinkResources_ListByWorkspace (new)
Description :  Gets the private link resources that need to be created for a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}
WorkspacePrivateLinkResources_Get (new)
Description :  Gets a private link resource that need to be created for a workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateLinkResources/{groupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the service instance. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of workspace resource. ,
Required: True ,
}
string ,
groupName:
{
Description: The name of the private link resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: 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 operations supported by Microsoft Healthcare resource provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HealthcareApis/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of available operation details ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Display of 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 ,
}
,
origin:
{
Description: Default value is 'user,system'. ,
Required: False ,
}
string ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Properties of the operation ,
Required: False ,
}
{
serviceSpecification:
{
Description: Service specifications of the operation ,
Required: False ,
}
{
logSpecifications:
{
Description: Specifications of the Log for Azure Monitoring ,
Required: False ,
}
[
{
name:
{
Description: Name of the log ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the log ,
Required: False ,
}
string ,
blobDuration:
{
Description: Blob duration of the log ,
Required: False ,
}
string ,
}
,
]
,
metricSpecifications:
{
Description: Specifications of the Metrics for Azure Monitoring ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the metric ,
Required: False ,
}
string ,
displayDescription:
{
Description: Localized friendly description of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit that makes sense for the metric ,
Required: False ,
}
string ,
category:
{
Description: Name of the metric category that the metric belongs to. A metric can only belong to a single category. ,
Required: False ,
}
string ,
aggregationType:
{
Description: Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count. ,
Required: False ,
}
string ,
supportedAggregationTypes:
{
Description: Supported aggregation types ,
Required: False ,
}
[
string ,
]
,
supportedTimeGrainTypes:
{
Description: Supported time grain types ,
Required: False ,
}
[
string ,
]
,
fillGapWithZero:
{
Description: Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. ,
Required: False ,
}
boolean ,
metricFilterPattern:
{
Description: Pattern for the filter of the metric. ,
Required: False ,
}
string ,
dimensions:
{
Description: Dimensions of the metric ,
Required: False ,
}
[
{
name:
{
Description: Name of the dimension ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the dimension ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: Whether this dimension should be included for the Shoebox export scenario ,
Required: False ,
}
boolean ,
}
,
]
,
isInternal:
{
Description: Whether the metric is internal. ,
Required: False ,
}
boolean ,
sourceMdmAccount:
{
Description: The source MDM account. ,
Required: False ,
}
string ,
sourceMdmNamespace:
{
Description: The source MDM namespace. ,
Required: False ,
}
string ,
enableRegionalMdmAccount:
{
Description: Whether regional MDM account enabled. ,
Required: False ,
}
boolean ,
resourceIdDimensionNameOverride:
{
Description: The resource Id dimension name override. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
endTime:
{
Description: The time that the operation finished. ,
Required: False ,
}
string ,
properties:
{
Description: Additional properties of the operation result. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: 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 ,
}
,
}