Services - Create Or Update
サービス インスタンスのメタデータを作成または更新します。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}?api-version=2022-06-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
resource
|
path | True |
string |
サービス インスタンスを含むリソース グループの名前。 正規表現パターン: |
resource
|
path | True |
string |
サービス インスタンスの名前。 |
subscription
|
path | True |
string |
サブスクリプションの識別子です。 |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
kind | True |
サービスの種類。 |
|
location | True |
string |
リソースの場所。 |
etag |
string |
リソースに関連付けられている etag。編集時にオプティミスティック コンカレンシーに使用されます。 |
|
identity |
サービスにマネージド ID が関連付けられているかどうかを示す設定。 |
||
properties |
サービスの共通プロパティ。 |
||
tags |
object |
リソース タグ。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
更新 - Put 要求が受け入れられ、既存のリソースが更新されています。操作は非同期的に完了します。 |
|
201 Created |
作成済み - Put 要求が受け入れられ、新しいリソースが作成されました。操作は非同期的に完了します。 |
|
Other Status Codes |
DefaultErrorResponse |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
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"
}
}
定義
名前 | 説明 |
---|---|
created |
リソースを作成した ID の種類。 |
Error |
エラーの詳細。 |
Error |
エラーの詳細。 |
Identity |
サービスにマネージド ID が関連付けられているかどうかを示す設定。 |
kind |
サービスの種類。 |
Managed |
指定されている ID の種類 (現在は SystemAssigned および None は許可されていません)。 |
Private |
プライベート エンドポイント リソース。 |
Private |
プライベート エンドポイント接続リソース。 |
Private |
現在のプロビジョニング状態。 |
Private |
プライベート エンドポイント接続の状態。 |
Private |
サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。 |
provisioning |
プロビジョニングの状態。 |
Public |
プライベート エンドポイントが有効になっている間にパブリック ネットワークから送信されるデータ プレーン トラフィックのアクセス許可を制御します。 |
Service |
アクセス ポリシー エントリ。 |
Service |
Azure コンテナー レジストリの構成情報 |
Service |
認証構成情報 |
Service |
サービス インスタンスの CORS 構成の設定。 |
Service |
サービスをバックアップする Cosmos DB データベースの設定。 |
Service |
操作構成情報のエクスポート |
Service |
インポート操作の構成情報 |
Service |
Open Container Initiative (OCI) 成果物。 |
Services |
サービスの説明。 |
Services |
サービス インスタンスのプロパティ。 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
createdByType
リソースを作成した ID の種類。
名前 | 型 | 説明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorDetails
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
error |
エラーの詳細 |
ErrorDetailsInternal
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
message |
string |
エラー メッセージ。 |
target |
string |
特定のエラーのターゲット。 |
Identity
サービスにマネージド ID が関連付けられているかどうかを示す設定。
名前 | 型 | 説明 |
---|---|---|
principalId |
string |
リソース ID のプリンシパル ID。 |
tenantId |
string |
リソースのテナント ID。 |
type |
指定されている ID の種類 (現在は SystemAssigned および None は許可されていません)。 |
kind
サービスの種類。
名前 | 型 | 説明 |
---|---|---|
fhir |
string |
|
fhir-R4 |
string |
|
fhir-Stu3 |
string |
ManagedServiceIdentityType
指定されている ID の種類 (現在は SystemAssigned および None は許可されていません)。
名前 | 型 | 説明 |
---|---|---|
None |
string |
|
SystemAssigned |
string |
PrivateEndpoint
プライベート エンドポイント リソース。
名前 | 型 | 説明 |
---|---|---|
id |
string |
プライベート エンドポイントの ARM 識別子 |
PrivateEndpointConnection
プライベート エンドポイント接続リソース。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /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
現在のプロビジョニング状態。
名前 | 型 | 説明 |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
プライベート エンドポイント接続の状態。
名前 | 型 | 説明 |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
名前 | 型 | 説明 |
---|---|---|
actionsRequired |
string |
サービス プロバイダーの変更にコンシューマーに対する更新が必要かどうかを示すメッセージ。 |
description |
string |
接続の承認/拒否の理由。 |
status |
サービスの所有者によって接続が承認/拒否/削除されたかどうかを示します。 |
provisioningState
プロビジョニングの状態。
名前 | 型 | 説明 |
---|---|---|
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
プライベート エンドポイントが有効になっている間にパブリック ネットワークから送信されるデータ プレーン トラフィックのアクセス許可を制御します。
名前 | 型 | 説明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ServiceAccessPolicyEntry
アクセス ポリシー エントリ。
名前 | 型 | 説明 |
---|---|---|
objectId |
string |
FHIR サービスへのアクセスが許可されている Azure AD オブジェクト ID (ユーザーまたはアプリ)。 |
ServiceAcrConfigurationInfo
Azure コンテナー レジストリの構成情報
名前 | 型 | 説明 |
---|---|---|
loginServers |
string[] |
ACR ログイン サーバーの一覧。 |
ociArtifacts |
Open Container Initiative (OCI) 成果物の一覧。 |
ServiceAuthenticationConfigurationInfo
認証構成情報
名前 | 型 | 説明 |
---|---|---|
audience |
string |
サービスの対象ユーザー URL |
authority |
string |
サービスの機関 URL |
smartProxyEnabled |
boolean |
SMART on FHIR プロキシが有効になっている場合 |
ServiceCorsConfigurationInfo
サービス インスタンスの CORS 構成の設定。
名前 | 型 | 説明 |
---|---|---|
allowCredentials |
boolean |
CORS 経由で資格情報が許可されている場合。 |
headers |
string[] |
CORS 経由で許可されるヘッダー。 |
maxAge |
integer |
CORS 経由で許可される最大年齢。 |
methods |
string[] |
CORS 経由で許可されるメソッド。 |
origins |
string[] |
CORS 経由で許可される配信元。 |
ServiceCosmosDbConfigurationInfo
サービスをバックアップする Cosmos DB データベースの設定。
名前 | 型 | 説明 |
---|---|---|
keyVaultKeyUri |
string |
バッキング データベースのカスタマー マネージド キーの URI。 |
offerThroughput |
integer |
バッキング データベースのプロビジョニングされたスループット。 |
ServiceExportConfigurationInfo
操作構成情報のエクスポート
名前 | 型 | 説明 |
---|---|---|
storageAccountName |
string |
既定のエクスポート ストレージ アカウントの名前。 |
ServiceImportConfigurationInfo
インポート操作の構成情報
名前 | 型 | 説明 |
---|---|---|
enabled |
boolean |
インポート操作が有効になっている場合。 |
initialImportMode |
boolean |
FHIR サービスが InitialImportMode にある場合。 |
integrationDataStore |
string |
既定の統合ストレージ アカウントの名前。 |
ServiceOciArtifactEntry
Open Container Initiative (OCI) 成果物。
名前 | 型 | 説明 |
---|---|---|
digest |
string |
成果物ダイジェスト。 |
imageName |
string |
成果物名。 |
loginServer |
string |
Azure Container Registry ログイン サーバー。 |
ServicesDescription
サービスの説明。
名前 | 型 | 説明 |
---|---|---|
etag |
string |
リソースに関連付けられている etag。編集時にオプティミスティック コンカレンシーに使用されます。 |
id |
string |
リソース識別子。 |
identity |
サービスにマネージド ID が関連付けられているかどうかを示す設定。 |
|
kind |
サービスの種類。 |
|
location |
string |
リソースの場所。 |
name |
string |
リソースの名前。 |
properties |
サービスの共通プロパティ。 |
|
systemData |
リソースの作成と最後の変更に関連するメタデータ。 |
|
tags |
object |
リソース タグ。 |
type |
string |
リソースの種類。 |
ServicesProperties
サービス インスタンスのプロパティ。
名前 | 型 | 説明 |
---|---|---|
accessPolicies |
サービス インスタンスのアクセス ポリシー。 |
|
acrConfiguration |
サービス インスタンスのデータ変換操作に使用される Azure コンテナー レジストリ設定。 |
|
authenticationConfiguration |
サービス インスタンスの認証構成。 |
|
corsConfiguration |
サービス インスタンスの CORS 構成の設定。 |
|
cosmosDbConfiguration |
サービスをバックアップする Cosmos DB データベースの設定。 |
|
exportConfiguration |
サービス インスタンスのエクスポート操作の設定。 |
|
importConfiguration |
サービス インスタンスのインポート操作の設定。 |
|
privateEndpointConnections |
このリソースに設定されているプライベート エンドポイント接続の一覧。 |
|
provisioningState |
プロビジョニングの状態。 |
|
publicNetworkAccess |
プライベート エンドポイントが有効になっている間にパブリック ネットワークから送信されるデータ プレーン トラフィックのアクセス許可を制御します。 |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |