Microsoft.HealthcareApis 服務 2019-09-16

2025-07-08

Bicep 資源定義

服務資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.HealthcareApis/services 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.HealthcareApis/services@2019-09-16' = {
  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: {
      offerThroughput: int
    }
    exportConfiguration: {
      storageAccountName: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

屬性值

Microsoft.HealthcareApis/服務

名字	描述	價值
ETAG	與資源相關聯的 etag，在編輯資源時用於開放式並行存取。	字串
身分識別	設定，指出服務是否有與其相關聯的受控識別。	資源標識
類	服務的種類。	'fhir' 'fhir-R4' 'fhir-Stu3' （必要）
位置	資源位置。	字串（必要）
名字	資源名稱	字串約束：最小長度 = 3 最大長度 = 24 （必要）
性能	服務的通用屬性。	ServicesProperties
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤

ResourceIdentity

名字	描述	價值
型別	正在指定的身分識別類型，目前允許 SystemAssigned 和 None。	“無” “系統分配”

資源標籤

名字	描述	價值

ServiceAccessPolicyEntry

名字	描述	價值
物件ID	允許存取 FHIR 服務的 Azure AD 物件識別碼（使用者或應用程式）。	字串約束：模式 = `^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$` （必要）

ServiceAuthenticationConfigurationInfo

名字	描述	價值
觀眾	服務的物件URL	字串
柄	服務的授權單位 URL	字串
smartProxy已啟用	如果已啟用SMART on FHIR Proxy	布爾 (bool)

ServiceCorsConfigurationInfo

名字	描述	價值
allowCredentials	如果允許透過 CORS 認證。	布爾 (bool)
頭	允許透過 CORS 的標頭。	字串[]
最大年齡	允許透過 CORS 的最大存留期。	int 約束：最小值 = 0 最大值 = 99999
方法	允許透過 CORS 的方法。	字串[]
起源	允許透過 CORS 的來源。	字串約束：模式 = `^(?:(?:(?:[hH][tT][tT][pP](?:[sS]\|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?\|[*]))$`[]

ServiceCosmosDbConfigurationInfo

名字	描述	價值
offer輸送量	備份資料庫的布建輸送量。	int 約束：最小值 = 400

ServiceExportConfigurationInfo

名字	描述	價值
儲存帳戶名稱	默認匯出記憶體帳戶的名稱。	字串

ServicesProperties

名字	描述	價值
accessPolicies	服務實例的存取原則。	ServiceAccessPolicyEntry[]
authenticationConfiguration 認證	服務實例的驗證組態。	ServiceAuthenticationConfigurationInfo
cors配置	服務實例之 CORS 組態的設定。	ServiceCorsConfigurationInfo
cosmosDbConfiguration	支援服務的 Cosmos DB 資料庫設定。	ServiceCosmosDbConfigurationInfo
匯出配置	服務實例匯出作業的設定。	ServiceExportConfigurationInfo

使用範例

Azure 快速入門範例

下列 Azure 快速入門範本包含用於部署此資源類型的 Bicep 範例。

Bicep 檔案	描述
部署 Azure API for FHIR	此範本會建立 Azure API for FHIR® 的實例。 Azure API for FHIR® 是受控、以標準為基礎且符合規範的醫療保健數據平臺。它可讓組織根據可互通的數據標準 FHIR®，將其臨床健康情況數據帶入雲端。

ARM 樣本資源定義

服務資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.HealthcareApis/services 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.HealthcareApis/services",
  "apiVersion": "2019-09-16",
  "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": {
      "offerThroughput": "int"
    },
    "exportConfiguration": {
      "storageAccountName": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

屬性值

Microsoft.HealthcareApis/服務

名字	描述	價值
apiVersion	API 版本	'2019-09-16'
ETAG	與資源相關聯的 etag，在編輯資源時用於開放式並行存取。	字串
身分識別	設定，指出服務是否有與其相關聯的受控識別。	資源標識
類	服務的種類。	'fhir' 'fhir-R4' 'fhir-Stu3' （必要）
位置	資源位置。	字串（必要）
名字	資源名稱	字串約束：最小長度 = 3 最大長度 = 24 （必要）
性能	服務的通用屬性。	ServicesProperties
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤
型別	資源類型	“Microsoft.HealthcareApis/services”

ResourceIdentity

名字	描述	價值
型別	正在指定的身分識別類型，目前允許 SystemAssigned 和 None。	“無” “系統分配”

資源標籤

名字	描述	價值

ServiceAccessPolicyEntry

名字	描述	價值
物件ID	允許存取 FHIR 服務的 Azure AD 物件識別碼（使用者或應用程式）。	字串約束：模式 = `^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$` （必要）

ServiceAuthenticationConfigurationInfo

名字	描述	價值
觀眾	服務的物件URL	字串
柄	服務的授權單位 URL	字串
smartProxy已啟用	如果已啟用SMART on FHIR Proxy	布爾 (bool)

ServiceCorsConfigurationInfo

名字	描述	價值
allowCredentials	如果允許透過 CORS 認證。	布爾 (bool)
頭	允許透過 CORS 的標頭。	字串[]
最大年齡	允許透過 CORS 的最大存留期。	int 約束：最小值 = 0 最大值 = 99999
方法	允許透過 CORS 的方法。	字串[]
起源	允許透過 CORS 的來源。	字串約束：模式 = `^(?:(?:(?:[hH][tT][tT][pP](?:[sS]\|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?\|[*]))$`[]

ServiceCosmosDbConfigurationInfo

名字	描述	價值
offer輸送量	備份資料庫的布建輸送量。	int 約束：最小值 = 400

ServiceExportConfigurationInfo

名字	描述	價值
儲存帳戶名稱	默認匯出記憶體帳戶的名稱。	字串

ServicesProperties

名字	描述	價值
accessPolicies	服務實例的存取原則。	ServiceAccessPolicyEntry[]
authenticationConfiguration 認證	服務實例的驗證組態。	ServiceAuthenticationConfigurationInfo
cors配置	服務實例之 CORS 組態的設定。	ServiceCorsConfigurationInfo
cosmosDbConfiguration	支援服務的 Cosmos DB 資料庫設定。	ServiceCosmosDbConfigurationInfo
匯出配置	服務實例匯出作業的設定。	ServiceExportConfigurationInfo

使用範例

Azure 快速入門範本

下列 Azure 快速入門範本部署此資源類型。

範本	描述
部署 Azure API for FHIR	此範本會建立 Azure API for FHIR® 的實例。 Azure API for FHIR® 是受控、以標準為基礎且符合規範的醫療保健數據平臺。它可讓組織根據可互通的數據標準 FHIR®，將其臨床健康情況數據帶入雲端。

Terraform （AzAPI 提供者）資源定義

服務資源類型可以使用目標作業來部署：

資源群組

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.HealthcareApis/services 資源，請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HealthcareApis/services@2019-09-16"
  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 = {
        offerThroughput = int
      }
      exportConfiguration = {
        storageAccountName = "string"
      }
    }
  }
}

屬性值

Microsoft.HealthcareApis/服務

名字	描述	價值
ETAG	與資源相關聯的 etag，在編輯資源時用於開放式並行存取。	字串
身分識別	設定，指出服務是否有與其相關聯的受控識別。	資源標識
類	服務的種類。	'fhir' 'fhir-R4' 'fhir-Stu3' （必要）
位置	資源位置。	字串（必要）
名字	資源名稱	字串約束：最小長度 = 3 最大長度 = 24 （必要）
性能	服務的通用屬性。	ServicesProperties
標籤	資源標籤	標記名稱和值的字典。
型別	資源類型	“Microsoft.HealthcareApis/services@2019-09-16”

ResourceIdentity

名字	描述	價值
型別	正在指定的身分識別類型，目前允許 SystemAssigned 和 None。	“無” “系統分配”

資源標籤

名字	描述	價值

ServiceAccessPolicyEntry

名字	描述	價值
物件ID	允許存取 FHIR 服務的 Azure AD 物件識別碼（使用者或應用程式）。	字串約束：模式 = `^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$` （必要）

ServiceAuthenticationConfigurationInfo

名字	描述	價值
觀眾	服務的物件URL	字串
柄	服務的授權單位 URL	字串
smartProxy已啟用	如果已啟用SMART on FHIR Proxy	布爾 (bool)

ServiceCorsConfigurationInfo

名字	描述	價值
allowCredentials	如果允許透過 CORS 認證。	布爾 (bool)
頭	允許透過 CORS 的標頭。	字串[]
最大年齡	允許透過 CORS 的最大存留期。	int 約束：最小值 = 0 最大值 = 99999
方法	允許透過 CORS 的方法。	字串[]
起源	允許透過 CORS 的來源。	字串約束：模式 = `^(?:(?:(?:[hH][tT][tT][pP](?:[sS]\|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?\|[*]))$`[]

ServiceCosmosDbConfigurationInfo

名字	描述	價值
offer輸送量	備份資料庫的布建輸送量。	int 約束：最小值 = 400

ServiceExportConfigurationInfo

名字	描述	價值
儲存帳戶名稱	默認匯出記憶體帳戶的名稱。	字串

ServicesProperties

名字	描述	價值
accessPolicies	服務實例的存取原則。	ServiceAccessPolicyEntry[]
authenticationConfiguration 認證	服務實例的驗證組態。	ServiceAuthenticationConfigurationInfo
cors配置	服務實例之 CORS 組態的設定。	ServiceCorsConfigurationInfo
cosmosDbConfiguration	支援服務的 Cosmos DB 資料庫設定。	ServiceCosmosDbConfigurationInfo
匯出配置	服務實例匯出作業的設定。	ServiceExportConfigurationInfo

共用方式為

Microsoft.HealthcareApis 服務 2019-09-16

Bicep 資源定義

資源格式

屬性值

Microsoft.HealthcareApis/服務

ResourceIdentity

資源標籤

ServiceAccessPolicyEntry

ServiceAuthenticationConfigurationInfo

ServiceCorsConfigurationInfo

ServiceCosmosDbConfigurationInfo

ServiceExportConfigurationInfo

ServicesProperties

使用範例

Azure 快速入門範例

ARM 樣本資源定義

資源格式

屬性值

Microsoft.HealthcareApis/服務

ResourceIdentity

資源標籤

ServiceAccessPolicyEntry

ServiceAuthenticationConfigurationInfo

ServiceCorsConfigurationInfo

ServiceCosmosDbConfigurationInfo

ServiceExportConfigurationInfo

ServicesProperties

使用範例

Azure 快速入門範本

Terraform （AzAPI 提供者） 資源定義

資源格式

屬性值

Microsoft.HealthcareApis/服務

ResourceIdentity

資源標籤

ServiceAccessPolicyEntry

ServiceAuthenticationConfigurationInfo

ServiceCorsConfigurationInfo

ServiceCosmosDbConfigurationInfo

ServiceExportConfigurationInfo

ServicesProperties

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義