Share via

Services - Create Or Update

Service:
Healthcare Apis
API Version:
2022-06-01

Create or update the metadata of a service instance.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}?api-version=2022-06-01

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

The name of the resource group that contains the service instance.
resourceName
 path True

string

minLength: 3
maxLength: 24

The name of the service instance.
subscriptionId
 path True

string

The subscription identifier.
api-version
 query True

string

Client Api Version.

Request Body

Name Required Type Description
kind True

kind

The kind of the service.
___location True

string

The resource ___location.
etag

string

An etag associated with the resource, used for optimistic concurrency when editing it.
identity

Identity

Setting indicating whether the service has a managed identity associated with it.
properties

ServicesProperties

The common properties of a service.
tags

object

The resource tags.

Responses

Name Type Description
200 OK

ServicesDescription

Updated - Put request accepted and an existing resource is being updated; the operation will complete asynchronously.
201 Created

ServicesDescription

Created - Put request accepted and a new resource was created; the operation will complete asynchronously.
Other Status Codes

ErrorDetails

DefaultErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Create or Update a service with all parameters
Create or Update a service with minimum parameters

Create or Update a service with all parameters

Sample request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1?api-version=2022-06-01

{
  "___location": "westus2",
  "tags": {},
  "kind": "fhir-R4",
  "properties": {
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      },
      {
        "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f"
      }
    ],
    "cosmosDbConfiguration": {
      "offerThroughput": 1000,
      "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key"
    },
    "authenticationConfiguration": {
      "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
      "audience": "https://azurehealthcareapis.com",
      "smartProxyEnabled": true
    },
    "corsConfiguration": {
      "origins": [
        "*"
      ],
      "headers": [
        "*"
      ],
      "methods": [
        "DELETE",
        "GET",
        "OPTIONS",
        "PATCH",
        "POST",
        "PUT"
      ],
      "maxAge": 1440,
      "allowCredentials": false
    },
    "exportConfiguration": {
      "storageAccountName": "existingStorageAccount"
    },
    "privateEndpointConnections": [],
    "publicNetworkAccess": "Disabled"
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1",
  "name": "service1",
  "___location": "West US 2",
  "type": "Microsoft.HealthcareApis/services",
  "kind": "fhir-R4",
  "etag": "etagvalue",
  "tags": {},
  "properties": {
    "provisioningState": "Creating",
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      },
      {
        "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f"
      }
    ],
    "cosmosDbConfiguration": {
      "offerThroughput": 1000,
      "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key"
    },
    "authenticationConfiguration": {
      "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
      "audience": "https://azurehealthcareapis.com",
      "smartProxyEnabled": true
    },
    "corsConfiguration": {
      "origins": [
        "*"
      ],
      "headers": [
        "*"
      ],
      "methods": [
        "DELETE",
        "GET",
        "OPTIONS",
        "PATCH",
        "POST",
        "PUT"
      ],
      "maxAge": 1440,
      "allowCredentials": false
    },
    "exportConfiguration": {
      "storageAccountName": "existingStorageAccount"
    },
    "privateEndpointConnections": [],
    "publicNetworkAccess": "Disabled"
  },
  "identity": {
    "principalId": "03fe6ae0-952c-4e4b-954b-cc0364dd252e",
    "tenantId": "72f988bf-86f1-41af-91ab-2d8cd011db47",
    "type": "SystemAssigned"
  }
}
Status code:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1",
  "name": "service1",
  "___location": "West US 2",
  "type": "Microsoft.HealthcareApis/services",
  "kind": "fhir-R4",
  "etag": "etagvalue",
  "tags": {},
  "properties": {
    "provisioningState": "Creating",
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      },
      {
        "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f"
      }
    ],
    "cosmosDbConfiguration": {
      "offerThroughput": 1000
    },
    "authenticationConfiguration": {
      "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
      "audience": "https://azurehealthcareapis.com",
      "smartProxyEnabled": true
    },
    "corsConfiguration": {
      "origins": [
        "*"
      ],
      "headers": [
        "*"
      ],
      "methods": [
        "DELETE",
        "GET",
        "OPTIONS",
        "PATCH",
        "POST",
        "PUT"
      ],
      "maxAge": 1440,
      "allowCredentials": false
    },
    "exportConfiguration": {
      "storageAccountName": "existingStorageAccount"
    },
    "privateEndpointConnections": [],
    "publicNetworkAccess": "Disabled"
  },
  "identity": {
    "principalId": "03fe6ae0-952c-4e4b-954b-cc0364dd252e",
    "tenantId": "72f988bf-86f1-41af-91ab-2d8cd011db47",
    "type": "SystemAssigned"
  }
}

Create or Update a service with minimum parameters

Sample request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service2?api-version=2022-06-01

{
  "___location": "westus2",
  "tags": {},
  "kind": "fhir-R4",
  "properties": {
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      }
    ]
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service2",
  "name": "service2",
  "type": "Microsoft.HealthcareApis/services",
  "etag": "etagvalue",
  "___location": "westus2",
  "kind": "fhir-R4",
  "tags": {},
  "properties": {
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      }
    ],
    "cosmosDbConfiguration": {
      "offerThroughput": 1000
    },
    "authenticationConfiguration": {
      "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
      "audience": "https://azurehealthcareapis.com",
      "smartProxyEnabled": false
    },
    "corsConfiguration": {
      "origins": [],
      "headers": [],
      "methods": [],
      "maxAge": null,
      "allowCredentials": false
    },
    "provisioningState": "Creating",
    "privateEndpointConnections": [],
    "publicNetworkAccess": "Disabled"
  }
}
Status code:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service2",
  "name": "service2",
  "type": "Microsoft.HealthcareApis/services",
  "etag": "etagvalue",
  "___location": "westus2",
  "kind": "fhir-R4",
  "tags": {},
  "properties": {
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      }
    ],
    "cosmosDbConfiguration": {
      "offerThroughput": 1000,
      "keyVaultKeyUri": null
    },
    "authenticationConfiguration": {
      "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
      "audience": "https://azurehealthcareapis.com",
      "smartProxyEnabled": false
    },
    "corsConfiguration": {
      "origins": [],
      "headers": [],
      "methods": [],
      "maxAge": null,
      "allowCredentials": false
    },
    "provisioningState": "Creating",
    "privateEndpointConnections": [],
    "publicNetworkAccess": "Disabled"
  }
}

Definitions

Name Description
createdByType

The type of identity that created the resource.
ErrorDetails

Error details.
ErrorDetailsInternal

Error details.
Identity

Setting indicating whether the service has a managed identity associated with it.
kind

The kind of the service.
ManagedServiceIdentityType

Type of identity being specified, currently SystemAssigned and None are allowed.
PrivateEndpoint

The Private Endpoint resource.
PrivateEndpointConnection

The Private Endpoint Connection resource.
PrivateEndpointConnectionProvisioningState

The current provisioning state.
PrivateEndpointServiceConnectionStatus

The private endpoint connection status.
PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.
provisioningState

The provisioning state.
PublicNetworkAccess

Control permission for data plane traffic coming from public networks while private endpoint is enabled.
ServiceAccessPolicyEntry

An access policy entry.
ServiceAcrConfigurationInfo

Azure container registry configuration information
ServiceAuthenticationConfigurationInfo

Authentication configuration information
ServiceCorsConfigurationInfo

The settings for the CORS configuration of the service instance.
ServiceCosmosDbConfigurationInfo

The settings for the Cosmos DB database backing the service.
ServiceExportConfigurationInfo

Export operation configuration information
ServiceImportConfigurationInfo

Import operation configuration information
ServiceOciArtifactEntry

An Open Container Initiative (OCI) artifact.
ServicesDescription

The description of the service.
ServicesProperties

The properties of a service instance.
systemData

Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

ErrorDetails

Object

Error details.

Name Type Description
error

ErrorDetailsInternal

Error details

ErrorDetailsInternal

Object

Error details.

Name Type Description
code

string

The error code.
message

string

The error message.
target

string

The target of the particular error.

Identity

Object

Setting indicating whether the service has a managed identity associated with it.

Name Type Description
principalId

string

The principal ID of the resource identity.
tenantId

string

The tenant ID of the resource.
type

ManagedServiceIdentityType

Type of identity being specified, currently SystemAssigned and None are allowed.

kind

Enumeration

The kind of the service.

Value Description
fhir
fhir-Stu3
fhir-R4

ManagedServiceIdentityType

Enumeration

Type of identity being specified, currently SystemAssigned and None are allowed.

Value Description
SystemAssigned
None

PrivateEndpoint

Object

The Private Endpoint resource.

Name Type Description
id

string

The ARM identifier for Private Endpoint

PrivateEndpointConnection

Object

The Private Endpoint Connection resource.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

The name of the resource
properties.privateEndpoint

PrivateEndpoint

The resource of private end point.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.
properties.provisioningState

PrivateEndpointConnectionProvisioningState

The provisioning state of the private endpoint connection resource.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeration

The current provisioning state.

Value Description
Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

Enumeration

The private endpoint connection status.

Value Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Object

A collection of information about the state of the connection between service consumer and provider.

Name Type Description
actionsRequired

string

A message indicating if changes on the service provider require any updates on the consumer.
description

string

The reason for approval/rejection of the connection.
status

PrivateEndpointServiceConnectionStatus

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

provisioningState

Enumeration

The provisioning state.

Value Description
Deleting
Succeeded
Creating
Accepted
Verifying
Updating
Failed
Canceled
Deprovisioned
Moving
Suspended
Warned
SystemMaintenance

PublicNetworkAccess

Enumeration

Control permission for data plane traffic coming from public networks while private endpoint is enabled.

Value Description
Enabled
Disabled

ServiceAccessPolicyEntry

Object

An access policy entry.

Name Type Description
objectId

string

pattern: ^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$

An Azure AD object ID (User or Apps) that is allowed access to the FHIR service.

ServiceAcrConfigurationInfo

Object

Azure container registry configuration information

Name Type Description
loginServers

string[]

The list of the ACR login servers.
ociArtifacts

ServiceOciArtifactEntry[]

The list of Open Container Initiative (OCI) artifacts.

ServiceAuthenticationConfigurationInfo

Object

Authentication configuration information

Name Type Description
audience

string

The audience url for the service
authority

string

The authority url for the service
smartProxyEnabled

boolean

If the SMART on FHIR proxy is enabled

ServiceCorsConfigurationInfo

Object

The settings for the CORS configuration of the service instance.

Name Type Description
allowCredentials

boolean

If credentials are allowed via CORS.
headers

string[]

The headers to be allowed via CORS.
maxAge

integer

minimum: 0
maximum: 99999

The max age to be allowed via CORS.
methods

string[]

The methods to be allowed via CORS.
origins

string[]

pattern: ^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?|[*]))$

The origins to be allowed via CORS.

ServiceCosmosDbConfigurationInfo

Object

The settings for the Cosmos DB database backing the service.

Name Type Description
keyVaultKeyUri

string

The URI of the customer-managed key for the backing database.
offerThroughput

integer

minimum: 400

The provisioned throughput for the backing database.

ServiceExportConfigurationInfo

Object

Export operation configuration information

Name Type Description
storageAccountName

string

The name of the default export storage account.

ServiceImportConfigurationInfo

Object

Import operation configuration information

Name Type Description
enabled

boolean

If the import operation is enabled.
initialImportMode

boolean

If the FHIR service is in InitialImportMode.
integrationDataStore

string

The name of the default integration storage account.

ServiceOciArtifactEntry

Object

An Open Container Initiative (OCI) artifact.

Name Type Description
digest

string

The artifact digest.
imageName

string

The artifact name.
loginServer

string

The Azure Container Registry login server.

ServicesDescription

Object

The description of the service.

Name Type Description
etag

string

An etag associated with the resource, used for optimistic concurrency when editing it.
id

string

The resource identifier.
identity

Identity

Setting indicating whether the service has a managed identity associated with it.
kind

kind

The kind of the service.
___location

string

The resource ___location.
name

string

pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$

The resource name.
properties

ServicesProperties

The common properties of a service.
systemData

systemData

Metadata pertaining to creation and last modification of the resource.
tags

object

The resource tags.
type

string

The resource type.

ServicesProperties

Object

The properties of a service instance.

Name Type Description
accessPolicies

ServiceAccessPolicyEntry[]

The access policies of the service instance.
acrConfiguration

ServiceAcrConfigurationInfo

The azure container registry settings used for convert data operation of the service instance.
authenticationConfiguration

ServiceAuthenticationConfigurationInfo

The authentication configuration for the service instance.
corsConfiguration

ServiceCorsConfigurationInfo

The settings for the CORS configuration of the service instance.
cosmosDbConfiguration

ServiceCosmosDbConfigurationInfo

The settings for the Cosmos DB database backing the service.
exportConfiguration

ServiceExportConfigurationInfo

The settings for the export operation of the service instance.
importConfiguration

ServiceImportConfigurationInfo

The settings for the import operation of the service instance.
privateEndpointConnections

PrivateEndpointConnection[]

The list of private endpoint connections that are set up for this resource.
provisioningState

provisioningState

The provisioning state.
publicNetworkAccess

PublicNetworkAccess

Control permission for data plane traffic coming from public networks while private endpoint is enabled.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.