Bicep 資源定義
服務資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.HealthcareApis/services 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.HealthcareApis/services@2022-05-15' = {
etag: 'string'
identity: {
type: 'string'
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
accessPolicies: [
{
objectId: 'string'
}
]
acrConfiguration: {
loginServers: [
'string'
]
ociArtifacts: [
{
digest: 'string'
imageName: 'string'
loginServer: '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'
}
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
publicNetworkAccess: 'string'
}
tags: {
{customized property}: 'string'
}
}
屬性值
Microsoft.HealthcareApis/服務
| 名字 | 描述 | 價值 |
|---|---|---|
| ETAG | 與資源相關聯的 etag，在編輯資源時用於開放式並行存取。 | 字串 |
| 身分識別 | 設定，指出服務是否有與其相關聯的受控識別。 | 服務資源標識 |
| 類 | 服務的種類。 | 'fhir' 'fhir-R4' 'fhir-Stu3' （必要） |
| 位置 | 資源位置。 | 字串 （必要） |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 3 最大長度 = 24 （必要） |
| 性能 | 服務的通用屬性。 | ServicesProperties |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
私有端點
| 名字 | 描述 | 價值 |
|---|
PrivateEndpointConnection
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | 資源屬性。 | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| privateEndpoint | 私人端點的資源。 | 私有端點 |
| privateLinkServiceConnectionState | 服務取用者與提供者之間連線狀態的相關信息集合。 | PrivateLinkServiceConnectionState （必要） |
PrivateLinkServiceConnectionState
| 名字 | 描述 | 價值 |
|---|---|---|
| 作必需 | 訊息，指出服務提供者上的變更是否需要取用者的任何更新。 | 字串 |
| 描述 | 核准/拒絕連線的原因。 | 字串 |
| 狀態 | 指出服務擁有者是否已核准/拒絕/移除連線。 | 「已核准」 “待定” “被拒絕” |
ServiceAccessPolicyEntry
| 名字 | 描述 | 價值 |
|---|---|---|
| 物件ID | 允許存取 FHIR 服務的 Azure AD 物件識別碼（使用者或應用程式）。 | 字串 約束： 模式 = ^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$ （必要） |
ServiceAcrConfigurationInfo
| 名字 | 描述 | 價值 |
|---|---|---|
| 登錄伺服器 | ACR 登入伺服器的清單。 | 字串[] |
| ociArtifacts （oci工件） | Open Container Initiative （OCI） 成品的清單。 | ServiceOciArtifactEntry[] |
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
| 名字 | 描述 | 價值 |
|---|---|---|
| keyVaultKeyUri 金鑰 | 支援資料庫的客戶自控金鑰 URI。 | 字串 |
| offer輸送量 | 備份資料庫的布建輸送量。 | int 約束： 最小值 = 400 |
ServiceExportConfigurationInfo
| 名字 | 描述 | 價值 |
|---|---|---|
| 儲存帳戶名稱 | 默認匯出記憶體帳戶的名稱。 | 字串 |
ServiceOciArtifactEntry
| 名字 | 描述 | 價值 |
|---|---|---|
| 摘要 | 成品摘要。 | 字串 |
| 圖像名稱 | 成品名稱。 | 字串 |
| 登錄伺服器 | Azure Container Registry 登入伺服器。 | 字串 |
ServicesProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| accessPolicies | 服務實例的存取原則。 | ServiceAccessPolicyEntry[] |
| acrConfiguration | 用於轉換服務實例數據作業的 Azure Container Registry 設定。 | ServiceAcrConfigurationInfo |
| authenticationConfiguration 認證 | 服務實例的驗證組態。 | ServiceAuthenticationConfigurationInfo |
| cors配置 | 服務實例之 CORS 組態的設定。 | ServiceCorsConfigurationInfo |
| cosmosDbConfiguration | 支援服務的 Cosmos DB 資料庫設定。 | ServiceCosmosDbConfigurationInfo |
| 匯出配置 | 服務實例匯出作業的設定。 | ServiceExportConfigurationInfo |
| privateEndpoint連接 | 為此資源設定的私人端點連線清單。 | PrivateEndpointConnection[] |
| 公共網路存取 | 在啟用私人端點時，控制來自公用網路的數據平面流量許可權。 | “已禁用” “已啟用” |
服務資源標識
| 名字 | 描述 | 價值 |
|---|---|---|
| 型別 | 正在指定的身分識別類型，目前允許 SystemAssigned 和 None。 | “無” “系統分配” |
ServicesResourceTags
| 名字 | 描述 | 價值 |
|---|
使用範例
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": "2022-05-15",
"name": "string",
"etag": "string",
"identity": {
"type": "string"
},
"kind": "string",
"location": "string",
"properties": {
"accessPolicies": [
{
"objectId": "string"
}
],
"acrConfiguration": {
"loginServers": [ "string" ],
"ociArtifacts": [
{
"digest": "string",
"imageName": "string",
"loginServer": "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"
},
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string"
},
"tags": {
"{customized property}": "string"
}
}
屬性值
Microsoft.HealthcareApis/服務
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2022-05-15' |
| ETAG | 與資源相關聯的 etag，在編輯資源時用於開放式並行存取。 | 字串 |
| 身分識別 | 設定，指出服務是否有與其相關聯的受控識別。 | 服務資源標識 |
| 類 | 服務的種類。 | 'fhir' 'fhir-R4' 'fhir-Stu3' （必要） |
| 位置 | 資源位置。 | 字串 （必要） |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 3 最大長度 = 24 （必要） |
| 性能 | 服務的通用屬性。 | ServicesProperties |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
| 型別 | 資源類型 | “Microsoft.HealthcareApis/services” |
私有端點
| 名字 | 描述 | 價值 |
|---|
PrivateEndpointConnection
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | 資源屬性。 | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| privateEndpoint | 私人端點的資源。 | 私有端點 |
| privateLinkServiceConnectionState | 服務取用者與提供者之間連線狀態的相關信息集合。 | PrivateLinkServiceConnectionState （必要） |
PrivateLinkServiceConnectionState
| 名字 | 描述 | 價值 |
|---|---|---|
| 作必需 | 訊息，指出服務提供者上的變更是否需要取用者的任何更新。 | 字串 |
| 描述 | 核准/拒絕連線的原因。 | 字串 |
| 狀態 | 指出服務擁有者是否已核准/拒絕/移除連線。 | 「已核准」 “待定” “被拒絕” |
ServiceAccessPolicyEntry
| 名字 | 描述 | 價值 |
|---|---|---|
| 物件ID | 允許存取 FHIR 服務的 Azure AD 物件識別碼（使用者或應用程式）。 | 字串 約束： 模式 = ^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$ （必要） |
ServiceAcrConfigurationInfo
| 名字 | 描述 | 價值 |
|---|---|---|
| 登錄伺服器 | ACR 登入伺服器的清單。 | 字串[] |
| ociArtifacts （oci工件） | Open Container Initiative （OCI） 成品的清單。 | ServiceOciArtifactEntry[] |
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
| 名字 | 描述 | 價值 |
|---|---|---|
| keyVaultKeyUri 金鑰 | 支援資料庫的客戶自控金鑰 URI。 | 字串 |
| offer輸送量 | 備份資料庫的布建輸送量。 | int 約束： 最小值 = 400 |
ServiceExportConfigurationInfo
| 名字 | 描述 | 價值 |
|---|---|---|
| 儲存帳戶名稱 | 默認匯出記憶體帳戶的名稱。 | 字串 |
ServiceOciArtifactEntry
| 名字 | 描述 | 價值 |
|---|---|---|
| 摘要 | 成品摘要。 | 字串 |
| 圖像名稱 | 成品名稱。 | 字串 |
| 登錄伺服器 | Azure Container Registry 登入伺服器。 | 字串 |
ServicesProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| accessPolicies | 服務實例的存取原則。 | ServiceAccessPolicyEntry[] |
| acrConfiguration | 用於轉換服務實例數據作業的 Azure Container Registry 設定。 | ServiceAcrConfigurationInfo |
| authenticationConfiguration 認證 | 服務實例的驗證組態。 | ServiceAuthenticationConfigurationInfo |
| cors配置 | 服務實例之 CORS 組態的設定。 | ServiceCorsConfigurationInfo |
| cosmosDbConfiguration | 支援服務的 Cosmos DB 資料庫設定。 | ServiceCosmosDbConfigurationInfo |
| 匯出配置 | 服務實例匯出作業的設定。 | ServiceExportConfigurationInfo |
| privateEndpoint連接 | 為此資源設定的私人端點連線清單。 | PrivateEndpointConnection[] |
| 公共網路存取 | 在啟用私人端點時，控制來自公用網路的數據平面流量許可權。 | “已禁用” “已啟用” |
服務資源標識
| 名字 | 描述 | 價值 |
|---|---|---|
| 型別 | 正在指定的身分識別類型，目前允許 SystemAssigned 和 None。 | “無” “系統分配” |
ServicesResourceTags
| 名字 | 描述 | 價值 |
|---|
使用範例
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@2022-05-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"
}
]
acrConfiguration = {
loginServers = [
"string"
]
ociArtifacts = [
{
digest = "string"
imageName = "string"
loginServer = "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"
}
privateEndpointConnections = [
{
properties = {
privateEndpoint = {
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
}
}
}
屬性值
Microsoft.HealthcareApis/服務
| 名字 | 描述 | 價值 |
|---|---|---|
| ETAG | 與資源相關聯的 etag，在編輯資源時用於開放式並行存取。 | 字串 |
| 身分識別 | 設定，指出服務是否有與其相關聯的受控識別。 | 服務資源標識 |
| 類 | 服務的種類。 | 'fhir' 'fhir-R4' 'fhir-Stu3' （必要） |
| 位置 | 資源位置。 | 字串 （必要） |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 3 最大長度 = 24 （必要） |
| 性能 | 服務的通用屬性。 | ServicesProperties |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 |
| 型別 | 資源類型 | “Microsoft.HealthcareApis/services@2022-05-15” |
私有端點
| 名字 | 描述 | 價值 |
|---|
PrivateEndpointConnection
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | 資源屬性。 | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| privateEndpoint | 私人端點的資源。 | 私有端點 |
| privateLinkServiceConnectionState | 服務取用者與提供者之間連線狀態的相關信息集合。 | PrivateLinkServiceConnectionState （必要） |
PrivateLinkServiceConnectionState
| 名字 | 描述 | 價值 |
|---|---|---|
| 作必需 | 訊息，指出服務提供者上的變更是否需要取用者的任何更新。 | 字串 |
| 描述 | 核准/拒絕連線的原因。 | 字串 |
| 狀態 | 指出服務擁有者是否已核准/拒絕/移除連線。 | 「已核准」 “待定” “被拒絕” |
ServiceAccessPolicyEntry
| 名字 | 描述 | 價值 |
|---|---|---|
| 物件ID | 允許存取 FHIR 服務的 Azure AD 物件識別碼（使用者或應用程式）。 | 字串 約束： 模式 = ^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$ （必要） |
ServiceAcrConfigurationInfo
| 名字 | 描述 | 價值 |
|---|---|---|
| 登錄伺服器 | ACR 登入伺服器的清單。 | 字串[] |
| ociArtifacts （oci工件） | Open Container Initiative （OCI） 成品的清單。 | ServiceOciArtifactEntry[] |
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
| 名字 | 描述 | 價值 |
|---|---|---|
| keyVaultKeyUri 金鑰 | 支援資料庫的客戶自控金鑰 URI。 | 字串 |
| offer輸送量 | 備份資料庫的布建輸送量。 | int 約束： 最小值 = 400 |
ServiceExportConfigurationInfo
| 名字 | 描述 | 價值 |
|---|---|---|
| 儲存帳戶名稱 | 默認匯出記憶體帳戶的名稱。 | 字串 |
ServiceOciArtifactEntry
| 名字 | 描述 | 價值 |
|---|---|---|
| 摘要 | 成品摘要。 | 字串 |
| 圖像名稱 | 成品名稱。 | 字串 |
| 登錄伺服器 | Azure Container Registry 登入伺服器。 | 字串 |
ServicesProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| accessPolicies | 服務實例的存取原則。 | ServiceAccessPolicyEntry[] |
| acrConfiguration | 用於轉換服務實例數據作業的 Azure Container Registry 設定。 | ServiceAcrConfigurationInfo |
| authenticationConfiguration 認證 | 服務實例的驗證組態。 | ServiceAuthenticationConfigurationInfo |
| cors配置 | 服務實例之 CORS 組態的設定。 | ServiceCorsConfigurationInfo |
| cosmosDbConfiguration | 支援服務的 Cosmos DB 資料庫設定。 | ServiceCosmosDbConfigurationInfo |
| 匯出配置 | 服務實例匯出作業的設定。 | ServiceExportConfigurationInfo |
| privateEndpoint連接 | 為此資源設定的私人端點連線清單。 | PrivateEndpointConnection[] |
| 公共網路存取 | 在啟用私人端點時，控制來自公用網路的數據平面流量許可權。 | “已禁用” “已啟用” |
服務資源標識
| 名字 | 描述 | 價值 |
|---|---|---|
| 型別 | 正在指定的身分識別類型，目前允許 SystemAssigned 和 None。 | “無” “系統分配” |
ServicesResourceTags
| 名字 | 描述 | 價值 |
|---|