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


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

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

Шаблон регулярного выражения: ^[-\w\._\(\)]+$

resourceName
path True

string

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

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

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

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

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

ErrorDetailsInternal

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

ErrorDetailsInternal

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

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

string

Код ошибки.

message

string

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

target

string

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

Identity

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

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

string

Идентификатор субъекта удостоверения ресурса.

tenantId

string

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

type

ManagedServiceIdentityType

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

kind

Тип службы.

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

string

fhir-R4

string

fhir-Stu3

string

ManagedServiceIdentityType

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

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

string

SystemAssigned

string

PrivateEndpoint

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

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

string

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

PrivateEndpointConnection

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

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

string

Полный идентификатор ресурса. Например: /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

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

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

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

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

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

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

string

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

description

string

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

status

PrivateEndpointServiceConnectionStatus

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

provisioningState

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

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

string

Canceled

string

Creating

string

Deleting

string

Deprovisioned

string

Failed

string

Moving

string

Succeeded

string

Suspended

string

SystemMaintenance

string

Updating

string

Verifying

string

Warned

string

PublicNetworkAccess

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

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

string

Enabled

string

ServiceAccessPolicyEntry

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

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

string

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

ServiceAcrConfigurationInfo

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

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

string[]

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

ociArtifacts

ServiceOciArtifactEntry[]

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

ServiceAuthenticationConfigurationInfo

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

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

string

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

authority

string

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

smartProxyEnabled

boolean

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

ServiceCorsConfigurationInfo

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

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

boolean

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

headers

string[]

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

maxAge

integer

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

methods

string[]

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

origins

string[]

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

ServiceCosmosDbConfigurationInfo

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

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

string

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

offerThroughput

integer

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

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

Имя ресурса.

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

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

createdBy

string

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

createdByType

createdByType

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

lastModifiedAt

string

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

lastModifiedBy

string

Удостоверение, которое последним изменял ресурс.

lastModifiedByType

createdByType

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