Services - Create Or Update
Skapa eller uppdatera metadata för en tjänstinstans.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}?api-version=2022-06-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._\(\)]+$ |
Namnet på resursgruppen som innehåller tjänstinstansen. |
resource
|
path | True |
string minLength: 3maxLength: 24 |
Namnet på tjänstinstansen. |
subscription
|
path | True |
string |
Prenumerationsidentifieraren. |
api-version
|
query | True |
string |
Klient-API-version. |
Begärandetext
Name | Obligatorisk | Typ | Description |
---|---|---|---|
kind | True |
Den typen av tjänst. |
|
location | True |
string |
Resursplatsen. |
etag |
string |
En etag som är associerad med resursen och som används för optimistisk samtidighet när den redigeras. |
|
identity |
Inställning som anger om tjänsten har en hanterad identitet som är associerad med den. |
||
properties |
De vanliga egenskaperna för en tjänst. |
||
tags |
object |
Resurstaggar. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Uppdaterad – Godkänn begäran och en befintlig resurs uppdateras. åtgärden slutförs asynkront. |
|
201 Created |
Skapad – Skicka begäran accepterad och en ny resurs har skapats. åtgärden slutförs asynkront. |
|
Other Status Codes |
DefaultErrorResponse |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
Create or Update a service with all parameters |
Create or Update a service with minimum parameters |
Create or Update a service with all parameters
Exempelbegäran
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"
}
}
Exempelsvar
{
"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
Exempelbegäran
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"
}
]
}
}
Exempelsvar
{
"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"
}
}
Definitioner
Name | Description |
---|---|
created |
Den typ av identitet som skapade resursen. |
Error |
Felinformation. |
Error |
Felinformation. |
Identity |
Inställning som anger om tjänsten har en hanterad identitet som är associerad med den. |
kind |
Den typen av tjänst. |
Managed |
Typ av identitet som anges, för närvarande SystemAssigned och None tillåts. |
Private |
Den privata slutpunktsresursen. |
Private |
Den privata slutpunktsanslutningsresursen. |
Private |
Det aktuella etableringstillståndet. |
Private |
Anslutningsstatus för privat slutpunkt. |
Private |
En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören. |
provisioning |
Etableringstillståndet. |
Public |
Kontrollbehörighet för dataplanstrafik som kommer från offentliga nätverk medan den privata slutpunkten är aktiverad. |
Service |
En åtkomstprincippost. |
Service |
Konfigurationsinformation för Azure Container Registry |
Service |
Konfigurationsinformation för autentisering |
Service |
Inställningarna för CORS-konfigurationen av tjänstinstansen. |
Service |
Inställningarna för Cosmos DB-databasen som stöder tjänsten. |
Service |
Information om konfiguration av exportåtgärder |
Service |
Konfigurationsinformation för importåtgärd |
Service |
En OCI-artefakt (Open Container Initiative). |
Services |
Beskrivningen av tjänsten. |
Services |
Egenskaperna för en tjänstinstans. |
system |
Metadata som rör skapande och senaste ändring av resursen. |
createdByType
Den typ av identitet som skapade resursen.
Värde | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
ErrorDetails
Felinformation.
Name | Typ | Description |
---|---|---|
error |
Felinformation |
ErrorDetailsInternal
Felinformation.
Name | Typ | Description |
---|---|---|
code |
string |
Felkoden. |
message |
string |
Felmeddelandet. |
target |
string |
Målet för det specifika felet. |
Identity
Inställning som anger om tjänsten har en hanterad identitet som är associerad med den.
Name | Typ | Description |
---|---|---|
principalId |
string |
Resursidentitetens huvud-ID. |
tenantId |
string |
Resursens klientorganisations-ID. |
type |
Typ av identitet som anges, för närvarande SystemAssigned och None tillåts. |
kind
Den typen av tjänst.
Värde | Description |
---|---|
fhir | |
fhir-R4 | |
fhir-Stu3 |
ManagedServiceIdentityType
Typ av identitet som anges, för närvarande SystemAssigned och None tillåts.
Värde | Description |
---|---|
None | |
SystemAssigned |
PrivateEndpoint
Den privata slutpunktsresursen.
Name | Typ | Description |
---|---|---|
id |
string |
ARM-identifieraren för privat slutpunkt |
PrivateEndpointConnection
Den privata slutpunktsanslutningsresursen.
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Namnet på resursen |
properties.privateEndpoint |
Resursen för den privata slutpunkten. |
|
properties.privateLinkServiceConnectionState |
En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören. |
|
properties.provisioningState |
Etableringstillståndet för den privata slutpunktsanslutningsresursen. |
|
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProvisioningState
Det aktuella etableringstillståndet.
Värde | Description |
---|---|
Creating | |
Deleting | |
Failed | |
Succeeded |
PrivateEndpointServiceConnectionStatus
Anslutningsstatus för privat slutpunkt.
Värde | Description |
---|---|
Approved | |
Pending | |
Rejected |
PrivateLinkServiceConnectionState
En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.
Name | Typ | Description |
---|---|---|
actionsRequired |
string |
Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten. |
description |
string |
Orsak till godkännande/avvisande av anslutningen. |
status |
Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare. |
provisioningState
Etableringstillståndet.
Värde | Description |
---|---|
Accepted | |
Canceled | |
Creating | |
Deleting | |
Deprovisioned | |
Failed | |
Moving | |
Succeeded | |
Suspended | |
SystemMaintenance | |
Updating | |
Verifying | |
Warned |
PublicNetworkAccess
Kontrollbehörighet för dataplanstrafik som kommer från offentliga nätverk medan den privata slutpunkten är aktiverad.
Värde | Description |
---|---|
Disabled | |
Enabled |
ServiceAccessPolicyEntry
En åtkomstprincippost.
Name | Typ | Description |
---|---|---|
objectId |
string pattern: ^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$ |
Ett Azure AD-objekt-ID (användare eller appar) som tillåts åtkomst till FHIR-tjänsten. |
ServiceAcrConfigurationInfo
Konfigurationsinformation för Azure Container Registry
Name | Typ | Description |
---|---|---|
loginServers |
string[] |
Listan över ACR-inloggningsservrarna. |
ociArtifacts |
Listan över OCI-artefakter (Open Container Initiative). |
ServiceAuthenticationConfigurationInfo
Konfigurationsinformation för autentisering
Name | Typ | Description |
---|---|---|
audience |
string |
Målgrupps-URL:en för tjänsten |
authority |
string |
Utfärdar-URL:en för tjänsten |
smartProxyEnabled |
boolean |
Om SMART på FHIR-proxyn är aktiverad |
ServiceCorsConfigurationInfo
Inställningarna för CORS-konfigurationen av tjänstinstansen.
Name | Typ | Description |
---|---|---|
allowCredentials |
boolean |
Om autentiseringsuppgifter tillåts via CORS. |
headers |
string[] |
Rubrikerna som ska tillåtas via CORS. |
maxAge |
integer minimum: 0maximum: 99999 |
Den högsta ålder som ska tillåtas via CORS. |
methods |
string[] |
De metoder som ska tillåtas via CORS. |
origins |
string[] pattern: ^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?|[*]))$ |
Ursprunget som ska tillåtas via CORS. |
ServiceCosmosDbConfigurationInfo
Inställningarna för Cosmos DB-databasen som stöder tjänsten.
Name | Typ | Description |
---|---|---|
keyVaultKeyUri |
string |
URI:n för den kundhanterade nyckeln för den säkerhetskopierade databasen. |
offerThroughput |
integer minimum: 400 |
Det etablerade dataflödet för den säkerhetskopierade databasen. |
ServiceExportConfigurationInfo
Information om konfiguration av exportåtgärder
Name | Typ | Description |
---|---|---|
storageAccountName |
string |
Namnet på standardlagringskontot för export. |
ServiceImportConfigurationInfo
Konfigurationsinformation för importåtgärd
Name | Typ | Description |
---|---|---|
enabled |
boolean |
Om importåtgärden är aktiverad. |
initialImportMode |
boolean |
Om FHIR-tjänsten finns i InitialImportMode. |
integrationDataStore |
string |
Namnet på standardintegreringslagringskontot. |
ServiceOciArtifactEntry
En OCI-artefakt (Open Container Initiative).
Name | Typ | Description |
---|---|---|
digest |
string |
Artefaktsammandraget. |
imageName |
string |
Artefaktnamnet. |
loginServer |
string |
Azure Container Registry-inloggningsservern. |
ServicesDescription
Beskrivningen av tjänsten.
Name | Typ | Description |
---|---|---|
etag |
string |
En etag som är associerad med resursen och som används för optimistisk samtidighet när den redigeras. |
id |
string |
Resursidentifieraren. |
identity |
Inställning som anger om tjänsten har en hanterad identitet som är associerad med den. |
|
kind |
Den typen av tjänst. |
|
location |
string |
Resursplatsen. |
name |
string pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$ |
Resursnamnet. |
properties |
De vanliga egenskaperna för en tjänst. |
|
systemData |
Metadata som rör skapande och senaste ändring av resursen. |
|
tags |
object |
Resurstaggar. |
type |
string |
Resurstypen. |
ServicesProperties
Egenskaperna för en tjänstinstans.
Name | Typ | Description |
---|---|---|
accessPolicies |
Åtkomstprinciperna för tjänstinstansen. |
|
acrConfiguration |
Azure Container Registry-inställningarna som används för att konvertera dataåtgärden för tjänstinstansen. |
|
authenticationConfiguration |
Autentiseringskonfigurationen för tjänstinstansen. |
|
corsConfiguration |
Inställningarna för CORS-konfigurationen av tjänstinstansen. |
|
cosmosDbConfiguration |
Inställningarna för Cosmos DB-databasen som stöder tjänsten. |
|
exportConfiguration |
Inställningarna för exportåtgärden för tjänstinstansen. |
|
importConfiguration |
Inställningarna för importåtgärden för tjänstinstansen. |
|
privateEndpointConnections |
Listan över privata slutpunktsanslutningar som har konfigurerats för den här resursen. |
|
provisioningState |
Etableringstillståndet. |
|
publicNetworkAccess |
Kontrollbehörighet för dataplanstrafik som kommer från offentliga nätverk medan den privata slutpunkten är aktiverad. |
systemData
Metadata som rör skapande och senaste ändring av resursen.
Name | Typ | Description |
---|---|---|
createdAt |
string (date-time) |
Tidsstämpeln för resursskapande (UTC). |
createdBy |
string |
Identiteten som skapade resursen. |
createdByType |
Den typ av identitet som skapade resursen. |
|
lastModifiedAt |
string (date-time) |
Tidsstämpeln för resursens senaste ändring (UTC) |
lastModifiedBy |
string |
Identiteten som senast ändrade resursen. |
lastModifiedByType |
Den typ av identitet som senast ändrade resursen. |