Microsoft。HealthcareApis 服務 2022-10-01-preview
Bicep 資源定義
服務資源類型可以部署到：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
若要建立Microsoft。HealthcareApis/services 資源，將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.HealthcareApis/services@2022-10-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
etag: 'string'
identity: {
type: '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'
}
importConfiguration: {
enabled: bool
initialImportMode: bool
integrationDataStore: 'string'
}
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
publicNetworkAccess: 'string'
}
}
屬性值
服務
| 名稱 |
描述 |
值 |
| NAME |
資源名稱 |
字串 (必要) |
| location |
資源位置。 |
字串 (必要) |
| tags |
資源標籤。 |
標記名稱和值的字典。 請參閱 範本中的標記 |
| kind |
服務的種類。 |
'fhir'
'fhir-R4'
'fhir-Stu3' (必要) |
| etag |
與資源相關聯的 etag，用於編輯時開放式平行存取。 |
字串 |
|
身分識別
|
設定，指出服務是否有與其相關聯的受控識別。 |
ServicesResourceIdentity |
| properties |
服務的通用屬性。 |
ServicesProperties |
ServicesResourceIdentity
| 名稱 |
描述 |
值 |
| type |
指定的身分識別類型，目前允許 SystemAssigned 和 None。 |
'None'
'SystemAssigned' |
ServicesProperties
ServiceAccessPolicyEntry
| 名稱 |
描述 |
值 |
| objectId |
允許存取 FHIR 服務的 Azure AD 物件識別碼 (使用者或應用程式) 。 |
字串 (必要) |
ServiceAcrConfigurationInfo
| 名稱 |
描述 |
值 |
| loginServers |
ACR 登入伺服器的清單。 |
string[] |
| ociArtifacts |
Open Container Initiative (OCI) 成品的清單。 |
ServiceOciArtifactEntry[] |
ServiceOciArtifactEntry
| 名稱 |
描述 |
值 |
| digest |
成品摘要。 |
字串 |
| imageName |
成品名稱。 |
字串 |
| loginServer |
Azure Container Registry登入伺服器。 |
字串 |
ServiceAuthenticationConfigurationInfo
| 名稱 |
描述 |
值 |
| audience |
服務的物件 URL |
字串 |
| authority |
服務的授權 URL |
字串 |
| smartProxyEnabled |
如果已啟用 SMART on FHIR Proxy |
bool |
ServiceCorsConfigurationInfo
| 名稱 |
描述 |
值 |
| allowCredentials |
如果透過 CORS 允許認證。 |
bool |
| headers |
允許透過 CORS 的標頭。 |
string[] |
| maxAge |
允許透過 CORS 的最大存留期。 |
int |
| 方法 |
可透過 CORS 允許的方法。 |
string[] |
| 起源 |
允許透過 CORS 的來源。 |
string[] |
ServiceCosmosDbConfigurationInfo
| 名稱 |
描述 |
值 |
| keyVaultKeyUri |
支援資料庫的客戶自控金鑰 URI。 |
字串 |
| offerThroughput |
支援資料庫的布建輸送量。 |
int |
ServiceExportConfigurationInfo
| 名稱 |
描述 |
值 |
| storageAccountName |
預設匯出儲存體帳戶的名稱。 |
字串 |
ServiceImportConfigurationInfo
| 名稱 |
描述 |
值 |
| 已啟用 |
如果已啟用匯入作業。 |
bool |
| initialImportMode |
如果 FHIR 服務位於 InitialImportMode 中。 |
bool |
| integrationDataStore |
預設整合儲存體帳戶的名稱。 |
字串 |
PrivateEndpointConnection
PrivateEndpointConnectionProperties
PrivateEndpoint
此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。
PrivateLinkServiceConnectionState
| 名稱 |
描述 |
值 |
| actionsRequired |
訊息，指出服務提供者上的變更是否需要在取用者上進行任何更新。 |
字串 |
| description |
連接核准/拒絕的原因。 |
字串 |
| status |
指出服務擁有者是否已核准/拒絕/移除連線。 |
'Approved'
'Pending'
「已拒絕」 |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 |
描述 |
部署 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-10-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "string",
"etag": "string",
"identity": {
"type": "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"
},
"importConfiguration": {
"enabled": "bool",
"initialImportMode": "bool",
"integrationDataStore": "string"
},
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string"
}
}
屬性值
服務
| 名稱 |
描述 |
值 |
| type |
資源類型 |
'Microsoft。HealthcareApis/services' |
| apiVersion |
資源 API 版本 |
'2022-10-01-preview' |
| NAME |
資源名稱 |
需要字串 () |
| location |
資源位置。 |
需要字串 () |
| tags |
資源標籤。 |
標記名稱和值的字典。 請參閱 範本中的標籤 |
| kind |
服務的種類。 |
'fhir'
'fhir-R4'
'fhir-Stu3' (必要) |
| etag |
與資源相關聯的 etag，用於編輯時開放式平行存取。 |
字串 |
|
身分識別
|
設定，指出服務是否有與其相關聯的受控識別。 |
ServicesResourceIdentity |
| properties |
服務的通用屬性。 |
ServicesProperties |
ServicesResourceIdentity
| 名稱 |
描述 |
值 |
| type |
所指定的身分識別類型，目前允許 SystemAssigned 和 None。 |
'None'
'SystemAssigned' |
ServicesProperties
ServiceAccessPolicyEntry
| 名稱 |
描述 |
值 |
| objectId |
允許存取 FHIR 服務的 Azure AD 物件識別碼 (使用者或應用程式) 。 |
字串 (必要) |
ServiceAcrConfigurationInfo
| 名稱 |
描述 |
值 |
| loginServers |
ACR 登入伺服器的清單。 |
string[] |
| ociArtifacts |
Open Container Initiative (OCI) 成品的清單。 |
ServiceOciArtifactEntry[] |
ServiceOciArtifactEntry
| 名稱 |
描述 |
值 |
| digest |
成品摘要。 |
字串 |
| imageName |
成品名稱。 |
字串 |
| loginServer |
Azure Container Registry登入伺服器。 |
字串 |
ServiceAuthenticationConfigurationInfo
| 名稱 |
描述 |
值 |
| audience |
服務的物件 URL |
字串 |
| authority |
服務的授權單位 URL |
字串 |
| smartProxyEnabled |
如果已啟用 SMART on FHIR Proxy |
bool |
ServiceCorsConfigurationInfo
| 名稱 |
描述 |
值 |
| allowCredentials |
如果允許透過 CORS 進行認證。 |
bool |
| headers |
允許透過 CORS 的標頭。 |
string[] |
| maxAge |
允許透過 CORS 的最長存留期。 |
int |
| 方法 |
允許透過 CORS 的方法。 |
string[] |
| 起源 |
允許透過 CORS 的來源。 |
string[] |
ServiceCosmosDbConfigurationInfo
| 名稱 |
描述 |
值 |
| keyVaultKeyUri |
支援資料庫的客戶管理金鑰 URI。 |
字串 |
| offerThroughput |
支援資料庫的布建輸送量。 |
int |
ServiceExportConfigurationInfo
| 名稱 |
描述 |
值 |
| storageAccountName |
預設匯出儲存體帳戶的名稱。 |
字串 |
ServiceImportConfigurationInfo
| 名稱 |
描述 |
值 |
| 已啟用 |
如果已啟用匯入作業。 |
bool |
| initialImportMode |
如果 FHIR 服務位於 InitialImportMode 中。 |
bool |
| integrationDataStore |
預設整合儲存體帳戶的名稱。 |
字串 |
PrivateEndpointConnection
PrivateEndpointConnectionProperties
PrivateEndpoint
此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。
PrivateLinkServiceConnectionState
| 名稱 |
描述 |
值 |
| actionsRequired |
訊息，指出服務提供者上的變更是否需要在取用者上進行任何更新。 |
字串 |
| description |
連接核准/拒絕的原因。 |
字串 |
| status |
指出服務擁有者是否已核准/拒絕/移除連線。 |
'Approved'
'Pending'
「已拒絕」 |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 |
描述 |
部署 Azure API for FHIR
|
此範本會建立 Azure API for FHIR® 的實例。 Azure API for FHIR® 是以受控、標準為基礎且符合規範的醫療保健資料平臺。 它可讓組織根據其可互通的資料標準 FHIR®，將其臨床健康情況資料帶入雲端。 |
服務資源類型可以部署到：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
若要建立Microsoft。HealthcareApis/services 資源，將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HealthcareApis/services@2022-10-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "SystemAssigned"
}
body = jsonencode({
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"
}
importConfiguration = {
enabled = bool
initialImportMode = bool
integrationDataStore = "string"
}
privateEndpointConnections = [
{
properties = {
privateEndpoint = {}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
}
kind = "string"
etag = "string"
})
}
屬性值
服務
| 名稱 |
描述 |
值 |
| type |
資源類型 |
「Microsoft。HealthcareApis/services@2022-10-01-preview」 |
| NAME |
資源名稱 |
需要字串 () |
| location |
資源位置。 |
需要字串 () |
| parent_id |
若要部署至資源群組，請使用該資源群組的識別碼。 |
需要字串 () |
| tags |
資源標籤。 |
標記名稱和值的字典。 |
| kind |
服務的種類。 |
「fhir」
「fhir-R4」
「fhir-Stu3」 (必要) |
| etag |
與資源相關聯的 etag，用於編輯時開放式平行存取。 |
字串 |
|
身分識別
|
設定，指出服務是否有與其相關聯的受控識別。 |
ServicesResourceIdentity |
| properties |
服務的通用屬性。 |
ServicesProperties |
ServicesResourceIdentity
| 名稱 |
描述 |
值 |
| type |
所指定的身分識別類型，目前允許 SystemAssigned 和 None。 |
「SystemAssigned」 |
ServicesProperties
ServiceAccessPolicyEntry
| 名稱 |
描述 |
值 |
| objectId |
允許存取 FHIR 服務的 Azure AD 物件識別碼 (使用者或應用程式) 。 |
字串 (必要) |
ServiceAcrConfigurationInfo
| 名稱 |
描述 |
值 |
| loginServers |
ACR 登入伺服器的清單。 |
string[] |
| ociArtifacts |
Open Container Initiative (OCI) 成品的清單。 |
ServiceOciArtifactEntry[] |
ServiceOciArtifactEntry
| 名稱 |
描述 |
值 |
| digest |
成品摘要。 |
字串 |
| imageName |
成品名稱。 |
字串 |
| loginServer |
Azure Container Registry登入伺服器。 |
字串 |
ServiceAuthenticationConfigurationInfo
| 名稱 |
描述 |
值 |
| audience |
服務的物件 URL |
字串 |
| authority |
服務的授權單位 URL |
字串 |
| smartProxyEnabled |
如果已啟用 SMART on FHIR Proxy |
bool |
ServiceCorsConfigurationInfo
| 名稱 |
描述 |
值 |
| allowCredentials |
如果允許透過 CORS 進行認證。 |
bool |
| headers |
允許透過 CORS 的標頭。 |
string[] |
| maxAge |
允許透過 CORS 的最長存留期。 |
int |
| 方法 |
允許透過 CORS 的方法。 |
string[] |
| 起源 |
允許透過 CORS 的來源。 |
string[] |
ServiceCosmosDbConfigurationInfo
| 名稱 |
描述 |
值 |
| keyVaultKeyUri |
支援資料庫的客戶管理金鑰 URI。 |
字串 |
| offerThroughput |
支援資料庫的布建輸送量。 |
int |
ServiceExportConfigurationInfo
| 名稱 |
描述 |
值 |
| storageAccountName |
預設匯出儲存體帳戶的名稱。 |
字串 |
ServiceImportConfigurationInfo
| 名稱 |
描述 |
值 |
| 已啟用 |
如果已啟用匯入作業。 |
bool |
| initialImportMode |
如果 FHIR 服務位於 InitialImportMode 中。 |
bool |
| integrationDataStore |
預設整合儲存體帳戶的名稱。 |
字串 |
PrivateEndpointConnection
PrivateEndpointConnectionProperties
PrivateEndpoint
此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。
PrivateLinkServiceConnectionState
| 名稱 |
描述 |
值 |
| actionsRequired |
訊息，指出服務提供者上的變更是否需要在取用者上進行任何更新。 |
字串 |
| description |
連接核准/拒絕的原因。 |
字串 |
| status |
指出服務擁有者是否已核准/拒絕/移除連線。 |
「已核准」
「Pending」
「已拒絕」 |