Службы Microsoft.HealthcareApis 2020-03-15

Определение ресурсов Bicep

Тип ресурса служб можно развернуть с помощью операций, предназначенных для следующих операций:

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

Примеры использования

Примеры Bicep

Простой пример развертывания Healthcare Service.

param resourceName string = 'acctest0001'
param location string = 'westus2'

resource service 'Microsoft.HealthcareApis/services@2022-12-01' = {
  name: resourceName
  location: location
  kind: 'fhir'
  properties: {
    accessPolicies: [
      {
        objectId: deployer().objectId
      }
    ]
    authenticationConfiguration: {}
    corsConfiguration: {}
    cosmosDbConfiguration: {
      offerThroughput: 1000
    }
    publicNetworkAccess: 'Enabled'
  }
}

Примеры быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.

Bicep-файл Описание
Развертывание API Azure для FHIR Этот шаблон создает экземпляр Azure API для FHIR®. API Azure для FHIR® — это управляемая, стандартная и соответствующая платформа данных здравоохранения. Это позволяет организациям перенести данные о клинической работоспособности в облако на основе стандарта FHIR® для взаимодействия данных.

Формат ресурса

Чтобы создать ресурс Microsoft.HealthcareApis/services, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.HealthcareApis/services@2020-03-15' = {
  etag: 'string'
  identity: {
    type: 'string'
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    accessPolicies: [
      {
        objectId: 'string'
      }
    ]
    authenticationConfiguration: {
      audience: 'string'
      authority: 'string'
      smartProxyEnabled: bool
    }
    corsConfiguration: {
      allowCredentials: bool
      headers: [
        'string'
      ]
      maxAge: int
      methods: [
        'string'
      ]
      origins: [
        'string'
      ]
    }
    cosmosDbConfiguration: {
      keyVaultKeyUri: 'string'
      offerThroughput: int
    }
    exportConfiguration: {
      storageAccountName: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Значения свойств

Microsoft.HealthcareApis/services

Имя Описание Ценность
ETag Etag, связанный с ресурсом, используемый для оптимистического параллелизма при редактировании. струна
тождество Параметр, указывающий, связана ли служба с управляемым удостоверением. Идентификация ресурса
добрый Тип службы. «Фхир»
'fhir-R4'
Fhir-Stu3 (обязательно)
местоположение Расположение ресурса. строка (обязательно)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 3
Максимальная длина = 24 (обязательно)
свойства Общие свойства службы. УслугиСвойства
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

ResourceIdentity

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

Теги ресурса

Имя Описание Ценность

ServiceAccessPolicyEntry

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

Ограничения целостности:
Pattern = ^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$ (обязательно)

ServiceAuthenticationConfigurationInfo

Имя Описание Ценность
публика URL-адрес аудитории для службы струна
авторитет URL-адрес центра для службы струна
smartProxyEnabled Если прокси-сервер SMART в FHIR включен булевая переменная (bool)

ServiceCorsConfigurationInfo

Имя Описание Ценность
allowCredentials Если учетные данные разрешены через CORS. булевая переменная (bool)
Заголовки Заголовки, которые должны быть разрешены через CORS. строка[]
maxAge Максимальный возраст, разрешенный через CORS. int

Ограничения целостности:
Минимальное значение = 0
Максимальное значение = 99999
методика Методы, разрешенные через CORS. строка[]
Происхождение Источники, которые должны быть разрешены через CORS. струна

Ограничения целостности:
Шаблон = ^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?|[*]))$[]

ServiceCosmosDbConfigurationInfo

Имя Описание Ценность
keyVaultKeyUri Универсальный код ресурса (URI) управляемого клиентом ключа для резервной базы данных. струна
предложениеThroughput Подготовленная пропускная способность для резервной базы данных. int

Ограничения целостности:
Минимальное значение = 400

СервисЭкспортКонфигурацияИнформация

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

УслугиСвойства

Имя Описание Ценность
Политики доступа Политики доступа экземпляра службы. ServiceAccessPolicyEntry[]
аутентификацияКонфигурация Конфигурация проверки подлинности для экземпляра службы. ServiceAuthenticationConfigurationInfo
corsКонфигурация Параметры конфигурации CORS экземпляра службы. ServiceCorsConfigurationInfo
Конфигурация cosmosDb Параметры для базы данных Cosmos DB, поддерживаемой службой. ServiceCosmosDbConfigurationInfo
exportConfiguration Параметры операции экспорта экземпляра службы. СервисЭкспортКонфигурацияИнформация

Определение ресурса шаблона ARM

Тип ресурса служб можно развернуть с помощью операций, предназначенных для следующих операций:

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.

Шаблон Описание
Развертывание API Azure для FHIR

развертывание в Azure
Этот шаблон создает экземпляр Azure API для FHIR®. API Azure для FHIR® — это управляемая, стандартная и соответствующая платформа данных здравоохранения. Это позволяет организациям перенести данные о клинической работоспособности в облако на основе стандарта FHIR® для взаимодействия данных.

Формат ресурса

Чтобы создать ресурс Microsoft.HealthcareApis/services, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.HealthcareApis/services",
  "apiVersion": "2020-03-15",
  "name": "string",
  "etag": "string",
  "identity": {
    "type": "string"
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "accessPolicies": [
      {
        "objectId": "string"
      }
    ],
    "authenticationConfiguration": {
      "audience": "string",
      "authority": "string",
      "smartProxyEnabled": "bool"
    },
    "corsConfiguration": {
      "allowCredentials": "bool",
      "headers": [ "string" ],
      "maxAge": "int",
      "methods": [ "string" ],
      "origins": [ "string" ]
    },
    "cosmosDbConfiguration": {
      "keyVaultKeyUri": "string",
      "offerThroughput": "int"
    },
    "exportConfiguration": {
      "storageAccountName": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Значения свойств

Microsoft.HealthcareApis/services

Имя Описание Ценность
apiVersion Версия API '2020-03-15'
ETag Etag, связанный с ресурсом, используемый для оптимистического параллелизма при редактировании. струна
тождество Параметр, указывающий, связана ли служба с управляемым удостоверением. Идентификация ресурса
добрый Тип службы. «Фхир»
'fhir-R4'
Fhir-Stu3 (обязательно)
местоположение Расположение ресурса. строка (обязательно)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 3
Максимальная длина = 24 (обязательно)
свойства Общие свойства службы. УслугиСвойства
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса Microsoft.HealthcareApis/services

ResourceIdentity

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

Теги ресурса

Имя Описание Ценность

ServiceAccessPolicyEntry

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

Ограничения целостности:
Pattern = ^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$ (обязательно)

ServiceAuthenticationConfigurationInfo

Имя Описание Ценность
публика URL-адрес аудитории для службы струна
авторитет URL-адрес центра для службы струна
smartProxyEnabled Если прокси-сервер SMART в FHIR включен булевая переменная (bool)

ServiceCorsConfigurationInfo

Имя Описание Ценность
allowCredentials Если учетные данные разрешены через CORS. булевая переменная (bool)
Заголовки Заголовки, которые должны быть разрешены через CORS. строка[]
maxAge Максимальный возраст, разрешенный через CORS. int

Ограничения целостности:
Минимальное значение = 0
Максимальное значение = 99999
методика Методы, разрешенные через CORS. строка[]
Происхождение Источники, которые должны быть разрешены через CORS. струна

Ограничения целостности:
Шаблон = ^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?|[*]))$[]

ServiceCosmosDbConfigurationInfo

Имя Описание Ценность
keyVaultKeyUri Универсальный код ресурса (URI) управляемого клиентом ключа для резервной базы данных. струна
предложениеThroughput Подготовленная пропускная способность для резервной базы данных. int

Ограничения целостности:
Минимальное значение = 400

СервисЭкспортКонфигурацияИнформация

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

УслугиСвойства

Имя Описание Ценность
Политики доступа Политики доступа экземпляра службы. ServiceAccessPolicyEntry[]
аутентификацияКонфигурация Конфигурация проверки подлинности для экземпляра службы. ServiceAuthenticationConfigurationInfo
corsКонфигурация Параметры конфигурации CORS экземпляра службы. ServiceCorsConfigurationInfo
Конфигурация cosmosDb Параметры для базы данных Cosmos DB, поддерживаемой службой. ServiceCosmosDbConfigurationInfo
exportConfiguration Параметры операции экспорта экземпляра службы. СервисЭкспортКонфигурацияИнформация

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса служб можно развернуть с помощью операций, предназначенных для следующих операций:

Примеры использования

Примеры Terraform

Простой пример развертывания Healthcare Service.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
    azurerm = {
      source = "hashicorp/azurerm"
    }
  }
}

provider "azurerm" {
  features {
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus2"
}

data "azurerm_client_config" "current" {
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "service" {
  type      = "Microsoft.HealthcareApis/services@2022-12-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "fhir"
    properties = {
      accessPolicies = [
        {
          objectId = data.azurerm_client_config.current.object_id
        },
      ]
      authenticationConfiguration = {
      }
      corsConfiguration = {
      }
      cosmosDbConfiguration = {
        offerThroughput = 1000
      }
      publicNetworkAccess = "Enabled"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Формат ресурса

Чтобы создать ресурс Microsoft.HealthcareApis/services, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HealthcareApis/services@2020-03-15"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    etag = "string"
    kind = "string"
    properties = {
      accessPolicies = [
        {
          objectId = "string"
        }
      ]
      authenticationConfiguration = {
        audience = "string"
        authority = "string"
        smartProxyEnabled = bool
      }
      corsConfiguration = {
        allowCredentials = bool
        headers = [
          "string"
        ]
        maxAge = int
        methods = [
          "string"
        ]
        origins = [
          "string"
        ]
      }
      cosmosDbConfiguration = {
        keyVaultKeyUri = "string"
        offerThroughput = int
      }
      exportConfiguration = {
        storageAccountName = "string"
      }
    }
  }
}

Значения свойств

Microsoft.HealthcareApis/services

Имя Описание Ценность
ETag Etag, связанный с ресурсом, используемый для оптимистического параллелизма при редактировании. струна
тождество Параметр, указывающий, связана ли служба с управляемым удостоверением. Идентификация ресурса
добрый Тип службы. «Фхир»
'fhir-R4'
Fhir-Stu3 (обязательно)
местоположение Расположение ресурса. строка (обязательно)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 3
Максимальная длина = 24 (обязательно)
свойства Общие свойства службы. УслугиСвойства
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.HealthcareApis/services@2020-03-15"

ResourceIdentity

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

Теги ресурса

Имя Описание Ценность

ServiceAccessPolicyEntry

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

Ограничения целостности:
Pattern = ^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$ (обязательно)

ServiceAuthenticationConfigurationInfo

Имя Описание Ценность
публика URL-адрес аудитории для службы струна
авторитет URL-адрес центра для службы струна
smartProxyEnabled Если прокси-сервер SMART в FHIR включен булевая переменная (bool)

ServiceCorsConfigurationInfo

Имя Описание Ценность
allowCredentials Если учетные данные разрешены через CORS. булевая переменная (bool)
Заголовки Заголовки, которые должны быть разрешены через CORS. строка[]
maxAge Максимальный возраст, разрешенный через CORS. int

Ограничения целостности:
Минимальное значение = 0
Максимальное значение = 99999
методика Методы, разрешенные через CORS. строка[]
Происхождение Источники, которые должны быть разрешены через CORS. струна

Ограничения целостности:
Шаблон = ^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?|[*]))$[]

ServiceCosmosDbConfigurationInfo

Имя Описание Ценность
keyVaultKeyUri Универсальный код ресурса (URI) управляемого клиентом ключа для резервной базы данных. струна
предложениеThroughput Подготовленная пропускная способность для резервной базы данных. int

Ограничения целостности:
Минимальное значение = 400

СервисЭкспортКонфигурацияИнформация

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

УслугиСвойства

Имя Описание Ценность
Политики доступа Политики доступа экземпляра службы. ServiceAccessPolicyEntry[]
аутентификацияКонфигурация Конфигурация проверки подлинности для экземпляра службы. ServiceAuthenticationConfigurationInfo
corsКонфигурация Параметры конфигурации CORS экземпляра службы. ServiceCorsConfigurationInfo
Конфигурация cosmosDb Параметры для базы данных Cosmos DB, поддерживаемой службой. ServiceCosmosDbConfigurationInfo
exportConfiguration Параметры операции экспорта экземпляра службы. СервисЭкспортКонфигурацияИнформация