Services - Create Or Update
建立或更新服務實例的元數據。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}?api-version=2022-06-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
resource
|
path | True |
string |
包含服務實例的資源群組名稱。 Regex 模式: |
resource
|
path | True |
string |
服務執行個體的名稱。 |
subscription
|
path | True |
string |
訂用帳戶識別碼。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
要求本文
名稱 | 必要 | 類型 | Description |
---|---|---|---|
kind | True |
服務的種類。 |
|
location | True |
string |
資源位置。 |
etag |
string |
與資源相關聯的 etag,用於編輯時開放式並行存取。 |
|
identity |
設定,指出服務是否有與其相關聯的受控識別。 |
||
properties |
服務的通用屬性。 |
||
tags |
object |
資源標籤。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
已更新 - 接受要求並正在更新現有的資源;作業將會以異步方式完成。 |
|
201 Created |
已建立 - 已接受要求,並已建立新的資源;作業將會以異步方式完成。 |
|
Other Status Codes |
DefaultErrorResponse |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
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"
}
}
定義
名稱 | Description |
---|---|
created |
建立資源的身分識別類型。 |
Error |
錯誤詳細數據。 |
Error |
錯誤詳細數據。 |
Identity |
設定,指出服務是否有與其相關聯的受控識別。 |
kind |
服務的種類。 |
Managed |
所指定的身分識別類型,目前允許 SystemAssigned 和 None。 |
Private |
私人端點資源。 |
Private |
私人端點聯機資源。 |
Private |
目前的布建狀態。 |
Private |
私人端點連線狀態。 |
Private |
服務取用者與提供者之間連線狀態的相關信息集合。 |
provisioning |
布建狀態。 |
Public |
啟用私人端點時,控制來自公用網路的數據平面流量許可權。 |
Service |
存取原則專案。 |
Service |
Azure Container Registry 組態資訊 |
Service |
驗證組態資訊 |
Service |
服務實例之 CORS 組態的設定。 |
Service |
支援服務的 Cosmos DB 資料庫設定。 |
Service |
匯出作業組態資訊 |
Service |
匯入作業組態資訊 |
Service |
開放式容器方案 (OCI) 成品。 |
Services |
服務的描述。 |
Services |
服務實例的屬性。 |
system |
與建立和上次修改資源相關的元數據。 |
createdByType
建立資源的身分識別類型。
名稱 | 類型 | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorDetails
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
error |
錯誤詳細資料 |
ErrorDetailsInternal
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
message |
string |
錯誤訊息。 |
target |
string |
特定錯誤的目標。 |
Identity
設定,指出服務是否有與其相關聯的受控識別。
名稱 | 類型 | Description |
---|---|---|
principalId |
string |
資源識別的主要標識碼。 |
tenantId |
string |
資源的租用戶識別碼。 |
type |
所指定的身分識別類型,目前允許 SystemAssigned 和 None。 |
kind
服務的種類。
名稱 | 類型 | Description |
---|---|---|
fhir |
string |
|
fhir-R4 |
string |
|
fhir-Stu3 |
string |
ManagedServiceIdentityType
所指定的身分識別類型,目前允許 SystemAssigned 和 None。
名稱 | 類型 | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
PrivateEndpoint
私人端點資源。
名稱 | 類型 | Description |
---|---|---|
id |
string |
私人端點的ARM標識碼 |
PrivateEndpointConnection
私人端點聯機資源。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源的完整資源識別碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
資源的名稱 |
properties.privateEndpoint |
私人端點的資源。 |
|
properties.privateLinkServiceConnectionState |
服務取用者與提供者之間連線狀態的相關信息集合。 |
|
properties.provisioningState |
私人端點聯機資源的布建狀態。 |
|
type |
string |
資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” |
PrivateEndpointConnectionProvisioningState
目前的布建狀態。
名稱 | 類型 | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
私人端點連線狀態。
名稱 | 類型 | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
服務取用者與提供者之間連線狀態的相關信息集合。
名稱 | 類型 | Description |
---|---|---|
actionsRequired |
string |
訊息,指出服務提供者上的變更是否需要在取用者上進行任何更新。 |
description |
string |
連接核准/拒絕的原因。 |
status |
指出服務擁有者是否已核准/拒絕/移除連線。 |
provisioningState
布建狀態。
名稱 | 類型 | Description |
---|---|---|
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
啟用私人端點時,控制來自公用網路的數據平面流量許可權。
名稱 | 類型 | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ServiceAccessPolicyEntry
存取原則專案。
名稱 | 類型 | Description |
---|---|---|
objectId |
string |
允許存取 FHIR 服務的 Azure AD 物件識別碼 (使用者或應用程式) 。 |
ServiceAcrConfigurationInfo
Azure Container Registry 組態資訊
名稱 | 類型 | Description |
---|---|---|
loginServers |
string[] |
ACR 登入伺服器的清單。 |
ociArtifacts |
Open Container Initiative (OCI) 成品的清單。 |
ServiceAuthenticationConfigurationInfo
驗證組態資訊
名稱 | 類型 | Description |
---|---|---|
audience |
string |
服務的物件URL |
authority |
string |
服務的授權URL |
smartProxyEnabled |
boolean |
如果已啟用SMART on FHIR Proxy |
ServiceCorsConfigurationInfo
服務實例之 CORS 組態的設定。
名稱 | 類型 | Description |
---|---|---|
allowCredentials |
boolean |
如果透過 CORS 允許認證。 |
headers |
string[] |
允許透過 CORS 的標頭。 |
maxAge |
integer |
允許透過 CORS 的最大存留期。 |
methods |
string[] |
可透過 CORS 允許的方法。 |
origins |
string[] |
允許透過 CORS 的來源。 |
ServiceCosmosDbConfigurationInfo
支援服務的 Cosmos DB 資料庫設定。
名稱 | 類型 | Description |
---|---|---|
keyVaultKeyUri |
string |
支援資料庫的客戶自控金鑰 URI。 |
offerThroughput |
integer |
支援資料庫的布建輸送量。 |
ServiceExportConfigurationInfo
匯出作業組態資訊
名稱 | 類型 | Description |
---|---|---|
storageAccountName |
string |
默認匯出記憶體帳戶的名稱。 |
ServiceImportConfigurationInfo
匯入作業組態資訊
名稱 | 類型 | Description |
---|---|---|
enabled |
boolean |
如果已啟用匯入作業。 |
initialImportMode |
boolean |
如果 FHIR 服務位於 InitialImportMode 中。 |
integrationDataStore |
string |
預設整合記憶體帳戶的名稱。 |
ServiceOciArtifactEntry
開放式容器方案 (OCI) 成品。
名稱 | 類型 | Description |
---|---|---|
digest |
string |
成品摘要。 |
imageName |
string |
成品名稱。 |
loginServer |
string |
Azure Container Registry 登入伺服器。 |
ServicesDescription
服務的描述。
名稱 | 類型 | Description |
---|---|---|
etag |
string |
與資源相關聯的 etag,用於編輯時開放式並行存取。 |
id |
string |
資源標識碼。 |
identity |
設定,指出服務是否有與其相關聯的受控識別。 |
|
kind |
服務的種類。 |
|
location |
string |
資源位置。 |
name |
string |
資源名稱。 |
properties |
服務的通用屬性。 |
|
systemData |
與建立和上次修改資源相關的元數據。 |
|
tags |
object |
資源標籤。 |
type |
string |
資源類型。 |
ServicesProperties
服務實例的屬性。
名稱 | 類型 | Description |
---|---|---|
accessPolicies |
服務實例的存取原則。 |
|
acrConfiguration |
用於轉換服務實例數據作業的 Azure 容器登錄設定。 |
|
authenticationConfiguration |
服務實例的驗證組態。 |
|
corsConfiguration |
服務實例之 CORS 組態的設定。 |
|
cosmosDbConfiguration |
支援服務的 Cosmos DB 資料庫設定。 |
|
exportConfiguration |
服務實例之導出作業的設定。 |
|
importConfiguration |
服務實例之匯入作業的設定。 |
|
privateEndpointConnections |
針對此資源設定的私人端點連線清單。 |
|
provisioningState |
布建狀態。 |
|
publicNetworkAccess |
啟用私人端點時,控制來自公用網路的數據平面流量許可權。 |
systemData
與建立和上次修改資源相關的元數據。
名稱 | 類型 | Description |
---|---|---|
createdAt |
string |
資源建立的時間戳 (UTC) 。 |
createdBy |
string |
建立資源的身分識別。 |
createdByType |
建立資源的身分識別類型。 |
|
lastModifiedAt |
string |
上次修改的資源時間戳 (UTC) |
lastModifiedBy |
string |
上次修改資源的身分識別。 |
lastModifiedByType |
上次修改資源的身分識別類型。 |