Services - Create Or Update
Vytvoření nebo aktualizace metadat instance služby
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}?api-version=2022-06-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Název skupiny prostředků, která obsahuje instanci služby. Vzor regulárního výrazu: |
resource
|
path | True |
string |
Název instance služby. |
subscription
|
path | True |
string |
Identifikátor předplatného. |
api-version
|
query | True |
string |
Verze rozhraní API klienta. |
Text požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
kind | True |
Druh služby. |
|
location | True |
string |
Umístění prostředku. |
etag |
string |
Značka etag přidružená k prostředku, která se používá pro optimistickou souběžnost při úpravách prostředku. |
|
identity |
Nastavení určující, jestli má služba přidruženou spravovanou identitu. |
||
properties |
Společné vlastnosti služby. |
||
tags |
object |
Značky prostředků. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Aktualizováno – Žádost o zadání byla přijata a existující prostředek se aktualizuje. operace se dokončí asynchronně. |
|
201 Created |
Vytvořeno – Žádost o zadání byla přijata a byl vytvořen nový prostředek. operace se dokončí asynchronně. |
|
Other Status Codes |
DefaultErrorResponse |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
Create or Update a service with all parameters |
Create or Update a service with minimum parameters |
Create or Update a service with all parameters
Ukázkový požadavek
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"
}
}
Ukázková odpověď
{
"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
Ukázkový požadavek
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"
}
]
}
}
Ukázková odpověď
{
"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"
}
}
Definice
Name | Description |
---|---|
created |
Typ identity, která vytvořila prostředek. |
Error |
Podrobnosti o chybě. |
Error |
Podrobnosti o chybě. |
Identity |
Nastavení určující, jestli má služba přidruženou spravovanou identitu. |
kind |
Druh služby. |
Managed |
Typ zadané identity, v současné době jsou povoleny hodnoty SystemAssigned a None. |
Private |
Prostředek privátního koncového bodu. |
Private |
Prostředek připojení privátního koncového bodu. |
Private |
Aktuální stav zřizování. |
Private |
Stav připojení privátního koncového bodu. |
Private |
Kolekce informací o stavu připojení mezi příjemcem služby a poskytovatelem. |
provisioning |
Stav zřizování. |
Public |
Řízení oprávnění pro provoz roviny dat přicházející z veřejných sítí, když je povolený privátní koncový bod. |
Service |
Položka zásad přístupu. |
Service |
Informace o konfiguraci registru kontejneru Azure |
Service |
Informace o konfiguraci ověřování |
Service |
Nastavení konfigurace CORS instance služby. |
Service |
Nastavení databáze Cosmos DB, která službu zálohuje. |
Service |
Informace o konfiguraci operace exportu |
Service |
Informace o konfiguraci operace importu |
Service |
Artefakt OCI (Open Container Initiative). |
Services |
Popis služby. |
Services |
Vlastnosti instance služby. |
system |
Metadata týkající se vytvoření a poslední změny prostředku |
createdByType
Typ identity, která vytvořila prostředek.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorDetails
Podrobnosti o chybě.
Name | Typ | Description |
---|---|---|
error |
Podrobnosti o chybě |
ErrorDetailsInternal
Podrobnosti o chybě.
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby |
message |
string |
Chybová zpráva |
target |
string |
Cíl konkrétní chyby. |
Identity
Nastavení určující, jestli má služba přidruženou spravovanou identitu.
Name | Typ | Description |
---|---|---|
principalId |
string |
ID objektu zabezpečení identity prostředku. |
tenantId |
string |
ID tenanta prostředku. |
type |
Typ zadané identity, v současné době jsou povoleny hodnoty SystemAssigned a None. |
kind
Druh služby.
Name | Typ | Description |
---|---|---|
fhir |
string |
|
fhir-R4 |
string |
|
fhir-Stu3 |
string |
ManagedServiceIdentityType
Typ zadané identity, v současné době jsou povoleny hodnoty SystemAssigned a None.
Name | Typ | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
PrivateEndpoint
Prostředek privátního koncového bodu.
Name | Typ | Description |
---|---|---|
id |
string |
Identifikátor ARM pro privátní koncový bod |
PrivateEndpointConnection
Prostředek připojení privátního koncového bodu.
Name | Typ | Description |
---|---|---|
id |
string |
Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Název prostředku |
properties.privateEndpoint |
Prostředek privátního koncového bodu. |
|
properties.privateLinkServiceConnectionState |
Kolekce informací o stavu připojení mezi příjemcem služby a poskytovatelem. |
|
properties.provisioningState |
Stav zřizování prostředku připojení privátního koncového bodu |
|
type |
string |
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts |
PrivateEndpointConnectionProvisioningState
Aktuální stav zřizování.
Name | Typ | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
Stav připojení privátního koncového bodu.
Name | Typ | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
Kolekce informací o stavu připojení mezi příjemcem služby a poskytovatelem.
Name | Typ | Description |
---|---|---|
actionsRequired |
string |
Zpráva s informací, že změny poskytovatele služeb vyžadují aktualizace příjemce. |
description |
string |
Důvod schválení nebo odmítnutí připojení. |
status |
Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby. |
provisioningState
Stav zřizování.
Name | Typ | 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
Řízení oprávnění pro provoz roviny dat přicházející z veřejných sítí, když je povolený privátní koncový bod.
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ServiceAccessPolicyEntry
Položka zásad přístupu.
Name | Typ | Description |
---|---|---|
objectId |
string |
ID objektu Azure AD (uživatel nebo aplikace), kterému je povolen přístup ke službě FHIR. |
ServiceAcrConfigurationInfo
Informace o konfiguraci registru kontejneru Azure
Name | Typ | Description |
---|---|---|
loginServers |
string[] |
Seznam přihlašovacích serverů ACR. |
ociArtifacts |
Seznam artefaktů OCI (Open Container Initiative). |
ServiceAuthenticationConfigurationInfo
Informace o konfiguraci ověřování
Name | Typ | Description |
---|---|---|
audience |
string |
Adresa URL cílové skupiny pro službu |
authority |
string |
Adresa URL autority pro službu |
smartProxyEnabled |
boolean |
Pokud je povolený proxy server SMART on FHIR |
ServiceCorsConfigurationInfo
Nastavení konfigurace CORS instance služby.
Name | Typ | Description |
---|---|---|
allowCredentials |
boolean |
Pokud jsou přihlašovací údaje povolené prostřednictvím CORS. |
headers |
string[] |
Hlavičky, které se mají povolit prostřednictvím CORS. |
maxAge |
integer |
Maximální věk, který má být povolen prostřednictvím CORS. |
methods |
string[] |
Metody, které mají být povoleny prostřednictvím CORS. |
origins |
string[] |
Původy, které mají být povoleny prostřednictvím CORS. |
ServiceCosmosDbConfigurationInfo
Nastavení databáze Cosmos DB, která službu zálohuje.
Name | Typ | Description |
---|---|---|
keyVaultKeyUri |
string |
Identifikátor URI klíče spravovaného zákazníkem pro záložní databázi |
offerThroughput |
integer |
Zřízená propustnost pro záložní databázi. |
ServiceExportConfigurationInfo
Informace o konfiguraci operace exportu
Name | Typ | Description |
---|---|---|
storageAccountName |
string |
Název výchozího účtu úložiště pro export. |
ServiceImportConfigurationInfo
Informace o konfiguraci operace importu
Name | Typ | Description |
---|---|---|
enabled |
boolean |
Pokud je povolená operace importu. |
initialImportMode |
boolean |
Pokud je služba FHIR v InitialImportMode. |
integrationDataStore |
string |
Název výchozího účtu úložiště integrace. |
ServiceOciArtifactEntry
Artefakt OCI (Open Container Initiative).
Name | Typ | Description |
---|---|---|
digest |
string |
Souhrn artefaktů. |
imageName |
string |
Název artefaktu. |
loginServer |
string |
Přihlašovací server Azure Container Registry. |
ServicesDescription
Popis služby.
Name | Typ | Description |
---|---|---|
etag |
string |
Značka etag přidružená k prostředku, která se používá pro optimistickou souběžnost při úpravách prostředku. |
id |
string |
Identifikátor prostředku. |
identity |
Nastavení určující, jestli má služba přidruženou spravovanou identitu. |
|
kind |
Druh služby. |
|
location |
string |
Umístění prostředku. |
name |
string |
Název prostředku. |
properties |
Společné vlastnosti služby. |
|
systemData |
Metadata týkající se vytvoření a poslední změny prostředku |
|
tags |
object |
Značky prostředků. |
type |
string |
Typ prostředku. |
ServicesProperties
Vlastnosti instance služby.
Name | Typ | Description |
---|---|---|
accessPolicies |
Zásady přístupu instance služby. |
|
acrConfiguration |
Nastavení registru kontejneru Azure použité pro operaci převodu dat instance služby |
|
authenticationConfiguration |
Konfigurace ověřování pro instanci služby. |
|
corsConfiguration |
Nastavení konfigurace CORS instance služby. |
|
cosmosDbConfiguration |
Nastavení databáze Cosmos DB, která službu zálohuje. |
|
exportConfiguration |
Nastavení operace exportu instance služby |
|
importConfiguration |
Nastavení pro operaci importu instance služby. |
|
privateEndpointConnections |
Seznam připojení privátních koncových bodů, která jsou pro tento prostředek nastavená. |
|
provisioningState |
Stav zřizování. |
|
publicNetworkAccess |
Řízení oprávnění pro provoz roviny dat přicházející z veřejných sítí, když je povolený privátní koncový bod. |
systemData
Metadata týkající se vytvoření a poslední změny prostředku
Name | Typ | Description |
---|---|---|
createdAt |
string |
Časové razítko vytvoření prostředku (UTC) |
createdBy |
string |
Identita, která prostředek vytvořila. |
createdByType |
Typ identity, která vytvořila prostředek. |
|
lastModifiedAt |
string |
Časové razítko poslední změny prostředku (UTC) |
lastModifiedBy |
string |
Identita, která naposledy změnila prostředek. |
lastModifiedByType |
Typ identity, která naposledy změnila prostředek. |