Services - Create Or Update
Membuat atau memperbarui metadata instans layanan.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}?api-version=2022-06-01
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
resource
|
path | True |
string |
Nama grup sumber daya yang berisi instans layanan. Pola regex: |
resource
|
path | True |
string |
Nama instans layanan. |
subscription
|
path | True |
string |
Pengidentifikasi langganan. |
api-version
|
query | True |
string |
Versi Api Klien. |
Isi Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
kind | True |
Jenis layanan. |
|
location | True |
string |
Lokasi sumber daya. |
etag |
string |
Etag yang terkait dengan sumber daya, digunakan untuk konkurensi optimis saat mengeditnya. |
|
identity |
Pengaturan yang menunjukkan apakah layanan memiliki identitas terkelola yang terkait dengannya. |
||
properties |
Properti umum layanan. |
||
tags |
object |
Tag sumber daya. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Diperbarui - Permintaan put diterima dan sumber daya yang ada sedang diperbarui; operasi akan selesai secara asinkron. |
|
201 Created |
Dibuat - Letakkan permintaan diterima dan sumber daya baru dibuat; operasi akan selesai secara asinkron. |
|
Other Status Codes |
DefaultErrorResponse |
Keamanan
azure_auth
Alur OAuth2 Azure Active Directory
Jenis:
oauth2
Alur:
implicit
URL Otorisasi:
https://login.microsoftonline.com/common/oauth2/authorize
Cakupan
Nama | Deskripsi |
---|---|
user_impersonation | meniru akun pengguna Anda |
Contoh
Create or Update a service with all parameters |
Create or Update a service with minimum parameters |
Create or Update a service with all parameters
Permintaan sampel
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"
}
}
Respon sampel
{
"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
Permintaan sampel
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"
}
]
}
}
Respon sampel
{
"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"
}
}
Definisi
Nama | Deskripsi |
---|---|
created |
Jenis identitas yang membuat sumber daya. |
Error |
Detail kesalahan. |
Error |
Detail kesalahan. |
Identity |
Pengaturan yang menunjukkan apakah layanan memiliki identitas terkelola yang terkait dengannya. |
kind |
Jenis layanan. |
Managed |
Jenis identitas yang ditentukan, saat ini SystemAssigned dan None diperbolehkan. |
Private |
Sumber daya Titik Akhir Privat. |
Private |
Sumber daya Koneksi Titik Akhir Privat. |
Private |
Status penyediaan saat ini. |
Private |
Status koneksi titik akhir privat. |
Private |
Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia. |
provisioning |
Status penyediaan. |
Public |
Izin kontrol untuk lalu lintas sarana data yang berasal dari jaringan publik saat titik akhir privat diaktifkan. |
Service |
Entri kebijakan akses. |
Service |
Informasi konfigurasi registri kontainer Azure |
Service |
Informasi konfigurasi autentikasi |
Service |
Pengaturan untuk konfigurasi CORS instans layanan. |
Service |
Pengaturan untuk database Cosmos DB yang mendukung layanan. |
Service |
Mengekspor informasi konfigurasi operasi |
Service |
Mengimpor informasi konfigurasi operasi |
Service |
Artefak Open Container Initiative (OCI). |
Services |
Deskripsi layanan. |
Services |
Properti instans layanan. |
system |
Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya. |
createdByType
Jenis identitas yang membuat sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorDetails
Detail kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
error |
Detail kesalahan |
ErrorDetailsInternal
Detail kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Kode kesalahan. |
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan tertentu. |
Identity
Pengaturan yang menunjukkan apakah layanan memiliki identitas terkelola yang terkait dengannya.
Nama | Jenis | Deskripsi |
---|---|---|
principalId |
string |
ID utama identitas sumber daya. |
tenantId |
string |
ID tenant sumber daya. |
type |
Jenis identitas yang ditentukan, saat ini SystemAssigned dan None diperbolehkan. |
kind
Jenis layanan.
Nama | Jenis | Deskripsi |
---|---|---|
fhir |
string |
|
fhir-R4 |
string |
|
fhir-Stu3 |
string |
ManagedServiceIdentityType
Jenis identitas yang ditentukan, saat ini SystemAssigned dan None diperbolehkan.
Nama | Jenis | Deskripsi |
---|---|---|
None |
string |
|
SystemAssigned |
string |
PrivateEndpoint
Sumber daya Titik Akhir Privat.
Nama | Jenis | Deskripsi |
---|---|---|
id |
string |
Pengidentifikasi ARM untuk Titik Akhir Privat |
PrivateEndpointConnection
Sumber daya Koneksi Titik Akhir Privat.
Nama | Jenis | Deskripsi |
---|---|---|
id |
string |
ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Nama sumber daya. |
properties.privateEndpoint |
Sumber daya titik akhir privat. |
|
properties.privateLinkServiceConnectionState |
Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia. |
|
properties.provisioningState |
Status penyediaan sumber daya koneksi titik akhir privat. |
|
type |
string |
Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProvisioningState
Status penyediaan saat ini.
Nama | Jenis | Deskripsi |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
Status koneksi titik akhir privat.
Nama | Jenis | Deskripsi |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.
Nama | Jenis | Deskripsi |
---|---|---|
actionsRequired |
string |
Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen. |
description |
string |
Alasan persetujuan/penolakan koneksi. |
status |
Menunjukkan apakah koneksi telah Disetujui/Ditolak/Dihapus oleh pemilik layanan. |
provisioningState
Status penyediaan.
Nama | Jenis | Deskripsi |
---|---|---|
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
Izin kontrol untuk lalu lintas sarana data yang berasal dari jaringan publik saat titik akhir privat diaktifkan.
Nama | Jenis | Deskripsi |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ServiceAccessPolicyEntry
Entri kebijakan akses.
Nama | Jenis | Deskripsi |
---|---|---|
objectId |
string |
ID objek Azure AD (Pengguna atau Aplikasi) yang diizinkan mengakses layanan FHIR. |
ServiceAcrConfigurationInfo
Informasi konfigurasi registri kontainer Azure
Nama | Jenis | Deskripsi |
---|---|---|
loginServers |
string[] |
Daftar server login ACR. |
ociArtifacts |
Daftar artefak Open Container Initiative (OCI). |
ServiceAuthenticationConfigurationInfo
Informasi konfigurasi autentikasi
Nama | Jenis | Deskripsi |
---|---|---|
audience |
string |
Url audiens untuk layanan |
authority |
string |
Url otoritas untuk layanan |
smartProxyEnabled |
boolean |
Jika proksi SMART di FHIR diaktifkan |
ServiceCorsConfigurationInfo
Pengaturan untuk konfigurasi CORS instans layanan.
Nama | Jenis | Deskripsi |
---|---|---|
allowCredentials |
boolean |
Jika kredensial diizinkan melalui CORS. |
headers |
string[] |
Header yang akan diizinkan melalui CORS. |
maxAge |
integer |
Usia maksimal yang diizinkan melalui CORS. |
methods |
string[] |
Metode yang diizinkan melalui CORS. |
origins |
string[] |
Asal-usul yang diizinkan melalui CORS. |
ServiceCosmosDbConfigurationInfo
Pengaturan untuk database Cosmos DB yang mendukung layanan.
Nama | Jenis | Deskripsi |
---|---|---|
keyVaultKeyUri |
string |
URI kunci yang dikelola pelanggan untuk database cadangan. |
offerThroughput |
integer |
Throughput yang disediakan untuk database cadangan. |
ServiceExportConfigurationInfo
Mengekspor informasi konfigurasi operasi
Nama | Jenis | Deskripsi |
---|---|---|
storageAccountName |
string |
Nama akun penyimpanan ekspor default. |
ServiceImportConfigurationInfo
Mengimpor informasi konfigurasi operasi
Nama | Jenis | Deskripsi |
---|---|---|
enabled |
boolean |
Jika operasi impor diaktifkan. |
initialImportMode |
boolean |
Jika layanan FHIR berada di InitialImportMode. |
integrationDataStore |
string |
Nama akun penyimpanan integrasi default. |
ServiceOciArtifactEntry
Artefak Open Container Initiative (OCI).
Nama | Jenis | Deskripsi |
---|---|---|
digest |
string |
Artefak digest. |
imageName |
string |
Nama artefak. |
loginServer |
string |
Server masuk Azure Container Registry. |
ServicesDescription
Deskripsi layanan.
Nama | Jenis | Deskripsi |
---|---|---|
etag |
string |
Etag yang terkait dengan sumber daya, digunakan untuk konkurensi optimis saat mengeditnya. |
id |
string |
Pengidentifikasi sumber daya. |
identity |
Pengaturan yang menunjukkan apakah layanan memiliki identitas terkelola yang terkait dengannya. |
|
kind |
Jenis layanan. |
|
location |
string |
Lokasi sumber daya. |
name |
string |
Nama sumber daya. |
properties |
Properti umum layanan. |
|
systemData |
Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya. |
|
tags |
object |
Tag sumber daya. |
type |
string |
Jenis sumber daya. |
ServicesProperties
Properti instans layanan.
Nama | Jenis | Deskripsi |
---|---|---|
accessPolicies |
Kebijakan akses instans layanan. |
|
acrConfiguration |
Pengaturan registri kontainer azure yang digunakan untuk mengonversi operasi data instans layanan. |
|
authenticationConfiguration |
Konfigurasi autentikasi untuk instans layanan. |
|
corsConfiguration |
Pengaturan untuk konfigurasi CORS instans layanan. |
|
cosmosDbConfiguration |
Pengaturan untuk database Cosmos DB yang mendukung layanan. |
|
exportConfiguration |
Pengaturan untuk operasi ekspor instans layanan. |
|
importConfiguration |
Pengaturan untuk operasi impor instans layanan. |
|
privateEndpointConnections |
Daftar koneksi titik akhir privat yang disiapkan untuk sumber daya ini. |
|
provisioningState |
Status penyediaan. |
|
publicNetworkAccess |
Izin kontrol untuk lalu lintas sarana data yang berasal dari jaringan publik saat titik akhir privat diaktifkan. |
systemData
Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
createdAt |
string |
Tanda waktu pembuatan sumber daya (UTC). |
createdBy |
string |
Identitas yang membuat sumber daya. |
createdByType |
Jenis identitas yang membuat sumber daya. |
|
lastModifiedAt |
string |
Tanda waktu modifikasi terakhir sumber daya (UTC) |
lastModifiedBy |
string |
Identitas yang terakhir mengubah sumber daya. |
lastModifiedByType |
Jenis identitas yang terakhir mengubah sumber daya. |