Поделиться через


Services - Create Or Update

Создайте или обновите метаданные экземпляра службы.

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

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

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

Имя группы ресурсов, содержащей экземпляр службы.

resourceName
path True

string

minLength: 3
maxLength: 24

Имя экземпляра службы.

subscriptionId
path True

string

Идентификатор подписки.

api-version
query True

string

Версия клиентского API.

Текст запроса

Имя Обязательно Тип Описание
kind True

kind

Тип службы.

location True

string

Расположение ресурса.

etag

string

Etag, связанный с ресурсом, используемый для оптимистического параллелизма при редактировании.

identity

Identity

Параметр, указывающий, связана ли служба с управляемым удостоверением.

properties

ServicesProperties

Общие свойства службы.

tags

object

Теги ресурсов.

Ответы

Имя Тип Описание
200 OK

ServicesDescription

Обновлено: запрос, принятый и существующий ресурс обновляется; операция завершится асинхронно.

201 Created

ServicesDescription

Создано— запрос, принятый и создан новый ресурс; операция завершится асинхронно.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

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

Create or Update a service with all parameters

Образец запроса

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"
  }
}

Пример ответа

{
  "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"
  }
}
{
  "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

Образец запроса

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"
      }
    ]
  }
}

Пример ответа

{
  "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"
  }
}
{
  "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"
  }
}

Определения

Имя Описание
createdByType

Тип удостоверения, создавшего ресурс.

ErrorDetails

Сведения об ошибке.

ErrorDetailsInternal

Сведения об ошибке.

Identity

Параметр, указывающий, связана ли служба с управляемым удостоверением.

kind

Тип службы.

ManagedServiceIdentityType

Тип указанного удостоверения, в настоящее время SystemAssigned и None разрешены.

PrivateEndpoint

Ресурс частной конечной точки.

PrivateEndpointConnection

Ресурс подключения к частной конечной точке.

PrivateEndpointConnectionProvisioningState

Текущее состояние подготовки.

PrivateEndpointServiceConnectionStatus

Состояние подключения к частной конечной точке.

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.

provisioningState

Состояние подготовки.

PublicNetworkAccess

Разрешение на управление трафиком плоскости данных, поступающим из общедоступных сетей, в то время как частная конечная точка включена.

ServiceAccessPolicyEntry

Запись политики доступа.

ServiceAcrConfigurationInfo

Сведения о конфигурации реестра контейнеров Azure

ServiceAuthenticationConfigurationInfo

Сведения о конфигурации проверки подлинности

ServiceCorsConfigurationInfo

Параметры конфигурации CORS экземпляра службы.

ServiceCosmosDbConfigurationInfo

Параметры для базы данных Cosmos DB, поддерживаемой службой.

ServiceExportConfigurationInfo

Экспорт сведений о конфигурации операции

ServiceImportConfigurationInfo

Сведения о конфигурации операции импорта

ServiceOciArtifactEntry

Артефакт Open Container Initiative (OCI).

ServicesDescription

Описание службы.

ServicesProperties

Свойства экземпляра службы.

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

Тип удостоверения, создавшего ресурс.

Значение Описание
Application
Key
ManagedIdentity
User

ErrorDetails

Сведения об ошибке.

Имя Тип Описание
error

ErrorDetailsInternal

Сведения об ошибке

ErrorDetailsInternal

Сведения об ошибке.

Имя Тип Описание
code

string

Код ошибки.

message

string

Сообщение об ошибке.

target

string

Целевой объект конкретной ошибки.

Identity

Параметр, указывающий, связана ли служба с управляемым удостоверением.

Имя Тип Описание
principalId

string

Основной идентификатор удостоверения ресурса.

tenantId

string

Идентификатор клиента ресурса.

type

ManagedServiceIdentityType

Тип указанного удостоверения, в настоящее время SystemAssigned и None разрешены.

kind

Тип службы.

Значение Описание
fhir
fhir-R4
fhir-Stu3

ManagedServiceIdentityType

Тип указанного удостоверения, в настоящее время SystemAssigned и None разрешены.

Значение Описание
None
SystemAssigned

PrivateEndpoint

Ресурс частной конечной точки.

Имя Тип Описание
id

string

Идентификатор ARM для частной конечной точки

PrivateEndpointConnection

Ресурс подключения к частной конечной точке.

Имя Тип Описание
id

string

Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Имя ресурса

properties.privateEndpoint

PrivateEndpoint

Ресурс частной конечной точки.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Состояние подготовки ресурса подключения частной конечной точки.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Текущее состояние подготовки.

Значение Описание
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Состояние подключения к частной конечной точке.

Значение Описание
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.

Имя Тип Описание
actionsRequired

string

Сообщение, указывающее, требуются ли изменения в поставщике услуг, требуются какие-либо обновления для потребителя.

description

string

Причина утверждения или отклонения подключения.

status

PrivateEndpointServiceConnectionStatus

Указывает, утверждено ли подключение, отклонено или удалено владельцем службы.

provisioningState

Состояние подготовки.

Значение Описание
Accepted
Canceled
Creating
Deleting
Deprovisioned
Failed
Moving
Succeeded
Suspended
SystemMaintenance
Updating
Verifying
Warned

PublicNetworkAccess

Разрешение на управление трафиком плоскости данных, поступающим из общедоступных сетей, в то время как частная конечная точка включена.

Значение Описание
Disabled
Enabled

ServiceAccessPolicyEntry

Запись политики доступа.

Имя Тип Описание
objectId

string

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

Идентификатор объекта Azure AD (пользователь или приложения), допускающий доступ к службе FHIR.

ServiceAcrConfigurationInfo

Сведения о конфигурации реестра контейнеров Azure

Имя Тип Описание
loginServers

string[]

Список серверов входа ACR.

ociArtifacts

ServiceOciArtifactEntry[]

Список артефактов Open Container Initiative (OCI).

ServiceAuthenticationConfigurationInfo

Сведения о конфигурации проверки подлинности

Имя Тип Описание
audience

string

URL-адрес аудитории для службы

authority

string

URL-адрес центра для службы

smartProxyEnabled

boolean

Если прокси-сервер SMART в FHIR включен

ServiceCorsConfigurationInfo

Параметры конфигурации CORS экземпляра службы.

Имя Тип Описание
allowCredentials

boolean

Если учетные данные разрешены через CORS.

headers

string[]

Заголовки, которые должны быть разрешены через CORS.

maxAge

integer

minimum: 0
maximum: 99999

Максимальный возраст, разрешенный через CORS.

methods

string[]

Методы, разрешенные через CORS.

origins

string[]

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

Источники, которые должны быть разрешены через CORS.

ServiceCosmosDbConfigurationInfo

Параметры для базы данных Cosmos DB, поддерживаемой службой.

Имя Тип Описание
keyVaultKeyUri

string

Универсальный код ресурса (URI) управляемого клиентом ключа для резервной базы данных.

offerThroughput

integer

minimum: 400

Подготовленная пропускная способность для резервной базы данных.

ServiceExportConfigurationInfo

Экспорт сведений о конфигурации операции

Имя Тип Описание
storageAccountName

string

Имя учетной записи хранения экспорта по умолчанию.

ServiceImportConfigurationInfo

Сведения о конфигурации операции импорта

Имя Тип Описание
enabled

boolean

Если операция импорта включена.

initialImportMode

boolean

Если служба FHIR находится в InitialImportMode.

integrationDataStore

string

Имя учетной записи хранения интеграции по умолчанию.

ServiceOciArtifactEntry

Артефакт Open Container Initiative (OCI).

Имя Тип Описание
digest

string

Дайджест артефакта.

imageName

string

Имя артефакта.

loginServer

string

Сервер входа в реестр контейнеров Azure.

ServicesDescription

Описание службы.

Имя Тип Описание
etag

string

Etag, связанный с ресурсом, используемый для оптимистического параллелизма при редактировании.

id

string

Идентификатор ресурса.

identity

Identity

Параметр, указывающий, связана ли служба с управляемым удостоверением.

kind

kind

Тип службы.

location

string

Расположение ресурса.

name

string

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

Имя ресурса.

properties

ServicesProperties

Общие свойства службы.

systemData

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

tags

object

Теги ресурсов.

type

string

Тип ресурса.

ServicesProperties

Свойства экземпляра службы.

Имя Тип Описание
accessPolicies

ServiceAccessPolicyEntry[]

Политики доступа экземпляра службы.

acrConfiguration

ServiceAcrConfigurationInfo

Параметры реестра контейнеров Azure, используемые для преобразования операций данных экземпляра службы.

authenticationConfiguration

ServiceAuthenticationConfigurationInfo

Конфигурация проверки подлинности для экземпляра службы.

corsConfiguration

ServiceCorsConfigurationInfo

Параметры конфигурации CORS экземпляра службы.

cosmosDbConfiguration

ServiceCosmosDbConfigurationInfo

Параметры для базы данных Cosmos DB, поддерживаемой службой.

exportConfiguration

ServiceExportConfigurationInfo

Параметры операции экспорта экземпляра службы.

importConfiguration

ServiceImportConfigurationInfo

Параметры для операции импорта экземпляра службы.

privateEndpointConnections

PrivateEndpointConnection[]

Список подключений к частной конечной точке, настроенных для этого ресурса.

provisioningState

provisioningState

Состояние подготовки.

publicNetworkAccess

PublicNetworkAccess

Разрешение на управление трафиком плоскости данных, поступающим из общедоступных сетей, в то время как частная конечная точка включена.

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя Тип Описание
createdAt

string (date-time)

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string (date-time)

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.

lastModifiedByType

createdByType

Тип удостоверения, который последний раз изменил ресурс.