Services - Create Or Update
서비스 instance 메타데이터를 만들거나 업데이트합니다.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}?api-version=2022-06-01
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
resource
|
path | True |
string |
서비스 instance 포함하는 리소스 그룹의 이름입니다. regex 패턴: |
resource
|
path | True |
string |
서비스 인스턴스의 이름입니다. |
subscription
|
path | True |
string |
구독 식별자입니다. |
api-version
|
query | True |
string |
클라이언트 API 버전. |
요청 본문
Name | 필수 | 형식 | Description |
---|---|---|---|
kind | True |
서비스의 종류입니다. |
|
location | True |
string |
리소스 위치입니다. |
etag |
string |
리소스를 편집할 때 낙관적 동시성에 사용되는 리소스와 연결된 etag입니다. |
|
identity |
서비스에 연결된 관리 ID가 있는지 여부를 나타내는 설정입니다. |
||
properties |
서비스의 공통 속성입니다. |
||
tags |
object |
리소스 태그입니다. |
응답
Name | 형식 | 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
범위
Name | 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"
}
}
정의
Name | Description |
---|---|
created |
리소스를 만든 ID의 형식입니다. |
Error |
오류 세부 정보입니다. |
Error |
오류 세부 정보입니다. |
Identity |
서비스에 연결된 관리 ID가 있는지 여부를 나타내는 설정입니다. |
kind |
서비스의 종류입니다. |
Managed |
지정되는 ID 유형이며, 현재 SystemAssigned 및 None은 허용됩니다. |
Private |
프라이빗 엔드포인트 리소스입니다. |
Private |
프라이빗 엔드포인트 연결 리소스입니다. |
Private |
현재 프로비저닝 상태입니다. |
Private |
프라이빗 엔드포인트 연결 상태. |
Private |
서비스 소비자와 공급자 간의 연결 상태에 대한 정보 컬렉션입니다. |
provisioning |
프로비저닝 상태입니다. |
Public |
프라이빗 엔드포인트를 사용하는 동안 공용 네트워크에서 들어오는 데이터 평면 트래픽에 대한 제어 권한입니다. |
Service |
액세스 정책 항목입니다. |
Service |
Azure Container Registry 구성 정보 |
Service |
인증 구성 정보 |
Service |
서비스의 CORS 구성에 대한 설정은 instance. |
Service |
서비스를 지원하는 Cosmos DB 데이터베이스에 대한 설정입니다. |
Service |
작업 구성 정보 내보내기 |
Service |
가져오기 작업 구성 정보 |
Service |
OCI(Open Container Initiative) 아티팩트입니다. |
Services |
서비스에 대한 설명입니다. |
Services |
서비스 instance 속성입니다. |
system |
리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다. |
createdByType
리소스를 만든 ID의 형식입니다.
Name | 형식 | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorDetails
오류 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
error |
오류 세부 정보 |
ErrorDetailsInternal
오류 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
code |
string |
오류 코드입니다. |
message |
string |
오류 메시지입니다. |
target |
string |
특정 오류의 대상입니다. |
Identity
서비스에 연결된 관리 ID가 있는지 여부를 나타내는 설정입니다.
Name | 형식 | Description |
---|---|---|
principalId |
string |
리소스 ID의 보안 주체 ID입니다. |
tenantId |
string |
리소스의 테넌트 ID입니다. |
type |
지정되는 ID 유형이며, 현재 SystemAssigned 및 None은 허용됩니다. |
kind
서비스의 종류입니다.
Name | 형식 | Description |
---|---|---|
fhir |
string |
|
fhir-R4 |
string |
|
fhir-Stu3 |
string |
ManagedServiceIdentityType
지정되는 ID 유형이며, 현재 SystemAssigned 및 None은 허용됩니다.
Name | 형식 | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
PrivateEndpoint
프라이빗 엔드포인트 리소스입니다.
Name | 형식 | Description |
---|---|---|
id |
string |
프라이빗 엔드포인트에 대한 ARM 식별자 |
PrivateEndpointConnection
프라이빗 엔드포인트 연결 리소스입니다.
Name | 형식 | Description |
---|---|---|
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
현재 프로비저닝 상태입니다.
Name | 형식 | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
프라이빗 엔드포인트 연결 상태.
Name | 형식 | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
서비스 소비자와 공급자 간의 연결 상태에 대한 정보 컬렉션입니다.
Name | 형식 | Description |
---|---|---|
actionsRequired |
string |
서비스 공급자의 변경 내용에 소비자에 대한 업데이트가 필요한지 여부를 나타내는 메시지입니다. |
description |
string |
연결의 승인/거부 이유입니다. |
status |
서비스 소유자가 연결을 승인/거부/제거했는지 여부를 나타냅니다. |
provisioningState
프로비저닝 상태입니다.
Name | 형식 | 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
프라이빗 엔드포인트를 사용하는 동안 공용 네트워크에서 들어오는 데이터 평면 트래픽에 대한 제어 권한입니다.
Name | 형식 | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ServiceAccessPolicyEntry
액세스 정책 항목입니다.
Name | 형식 | Description |
---|---|---|
objectId |
string |
FHIR 서비스에 액세스할 수 있는 Azure AD 개체 ID(사용자 또는 앱)입니다. |
ServiceAcrConfigurationInfo
Azure Container Registry 구성 정보
Name | 형식 | Description |
---|---|---|
loginServers |
string[] |
ACR 로그인 서버의 목록입니다. |
ociArtifacts |
OCI(Open Container Initiative) 아티팩트 목록입니다. |
ServiceAuthenticationConfigurationInfo
인증 구성 정보
Name | 형식 | Description |
---|---|---|
audience |
string |
서비스의 대상 그룹 URL |
authority |
string |
서비스에 대한 기관 URL |
smartProxyEnabled |
boolean |
SMART on FHIR 프록시를 사용하는 경우 |
ServiceCorsConfigurationInfo
서비스의 CORS 구성에 대한 설정은 instance.
Name | 형식 | Description |
---|---|---|
allowCredentials |
boolean |
CORS를 통해 자격 증명이 허용되는 경우 |
headers |
string[] |
CORS를 통해 허용되는 헤더입니다. |
maxAge |
integer |
CORS를 통해 허용되는 최대 기간입니다. |
methods |
string[] |
CORS를 통해 허용되는 메서드입니다. |
origins |
string[] |
CORS를 통해 허용되는 원본입니다. |
ServiceCosmosDbConfigurationInfo
서비스를 지원하는 Cosmos DB 데이터베이스에 대한 설정입니다.
Name | 형식 | Description |
---|---|---|
keyVaultKeyUri |
string |
지원 데이터베이스에 대한 고객 관리형 키의 URI입니다. |
offerThroughput |
integer |
지원 데이터베이스에 대해 프로비전된 처리량입니다. |
ServiceExportConfigurationInfo
작업 구성 정보 내보내기
Name | 형식 | Description |
---|---|---|
storageAccountName |
string |
기본 내보내기 스토리지 계정의 이름입니다. |
ServiceImportConfigurationInfo
가져오기 작업 구성 정보
Name | 형식 | Description |
---|---|---|
enabled |
boolean |
가져오기 작업을 사용하는 경우 |
initialImportMode |
boolean |
FHIR 서비스가 InitialImportMode에 있는 경우 |
integrationDataStore |
string |
기본 통합 스토리지 계정의 이름입니다. |
ServiceOciArtifactEntry
OCI(Open Container Initiative) 아티팩트입니다.
Name | 형식 | Description |
---|---|---|
digest |
string |
아티팩트 다이제스트입니다. |
imageName |
string |
아티팩트 이름입니다. |
loginServer |
string |
Azure Container Registry 로그인 서버입니다. |
ServicesDescription
서비스에 대한 설명입니다.
Name | 형식 | Description |
---|---|---|
etag |
string |
리소스를 편집할 때 낙관적 동시성에 사용되는 리소스와 연결된 etag입니다. |
id |
string |
리소스 식별자입니다. |
identity |
서비스에 연결된 관리 ID가 있는지 여부를 나타내는 설정입니다. |
|
kind |
서비스의 종류입니다. |
|
location |
string |
리소스 위치입니다. |
name |
string |
리소스 이름입니다. |
properties |
서비스의 공통 속성입니다. |
|
systemData |
리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다. |
|
tags |
object |
리소스 태그입니다. |
type |
string |
리소스 종류입니다. |
ServicesProperties
서비스 instance 속성입니다.
Name | 형식 | Description |
---|---|---|
accessPolicies |
서비스의 액세스 정책이 instance. |
|
acrConfiguration |
서비스 instance 데이터 변환 작업에 사용되는 Azure 컨테이너 레지스트리 설정입니다. |
|
authenticationConfiguration |
서비스에 대한 인증 구성이 instance. |
|
corsConfiguration |
서비스의 CORS 구성에 대한 설정은 instance. |
|
cosmosDbConfiguration |
서비스를 지원하는 Cosmos DB 데이터베이스에 대한 설정입니다. |
|
exportConfiguration |
서비스의 내보내기 작업에 대한 설정은 instance. |
|
importConfiguration |
서비스의 가져오기 작업에 대한 설정은 instance. |
|
privateEndpointConnections |
이 리소스에 대해 설정된 프라이빗 엔드포인트 연결 목록입니다. |
|
provisioningState |
프로비저닝 상태입니다. |
|
publicNetworkAccess |
프라이빗 엔드포인트를 사용하는 동안 공용 네트워크에서 들어오는 데이터 평면 트래픽에 대한 제어 권한입니다. |
systemData
리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
Name | 형식 | Description |
---|---|---|
createdAt |
string |
UTC(리소스 만들기)의 타임스탬프입니다. |
createdBy |
string |
리소스를 만든 ID입니다. |
createdByType |
리소스를 만든 ID의 형식입니다. |
|
lastModifiedAt |
string |
리소스 마지막 수정의 타임스탬프(UTC) |
lastModifiedBy |
string |
리소스를 마지막으로 수정한 ID입니다. |
lastModifiedByType |
리소스를 마지막으로 수정한 ID 유형입니다. |