Condividi tramite


Services - Create Or Update

Creare o aggiornare i metadati di un'istanza del servizio.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}?api-version=2022-06-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
path True

string

Nome del gruppo di risorse che contiene l'istanza del servizio.

Criterio di espressione regolare: ^[-\w\._\(\)]+$

resourceName
path True

string

Nome dell'istanza del servizio.

subscriptionId
path True

string

L'identificatore della sottoscrizione.

api-version
query True

string

Versione api client.

Corpo della richiesta

Nome Necessario Tipo Descrizione
kind True

kind

Tipo di servizio.

location True

string

Percorso della risorsa.

etag

string

Un etag associato alla risorsa, usato per la concorrenza ottimistica durante la modifica.

identity

Identity

Impostazione che indica se al servizio è associata un'identità gestita.

properties

ServicesProperties

Proprietà comuni di un servizio.

tags

object

Tag di risorsa.

Risposte

Nome Tipo Descrizione
200 OK

ServicesDescription

Aggiornato: richiesta put accettata e viene aggiornata una risorsa esistente; l'operazione verrà completata in modo asincrono.

201 Created

ServicesDescription

Creato: richiesta put accettata e creazione di una nuova risorsa; l'operazione verrà completata in modo asincrono.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Create or Update a service with all parameters
Create or Update a service with minimum parameters

Create or Update a service with all parameters

Esempio di richiesta

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"
  }
}

Risposta di esempio

{
  "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

Esempio di richiesta

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"
      }
    ]
  }
}

Risposta di esempio

{
  "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"
  }
}

Definizioni

Nome Descrizione
createdByType

Tipo di identità che ha creato la risorsa.

ErrorDetails

Dettagli errore.

ErrorDetailsInternal

Dettagli errore.

Identity

Impostazione che indica se al servizio è associata un'identità gestita.

kind

Tipo di servizio.

ManagedServiceIdentityType

Tipo di identità specificato, attualmente SystemAssigned e None sono consentiti.

PrivateEndpoint

Risorsa endpoint privato.

PrivateEndpointConnection

Risorsa Connessione endpoint privato.

PrivateEndpointConnectionProvisioningState

Stato di provisioning corrente.

PrivateEndpointServiceConnectionStatus

Stato della connessione dell'endpoint privato.

PrivateLinkServiceConnectionState

Raccolta di informazioni sullo stato della connessione tra il consumer del servizio e il provider.

provisioningState

Stato del provisioning.

PublicNetworkAccess

Autorizzazione di controllo per il traffico del piano dati proveniente da reti pubbliche mentre l'endpoint privato è abilitato.

ServiceAccessPolicyEntry

Voce dei criteri di accesso.

ServiceAcrConfigurationInfo

Informazioni di configurazione del Registro Azure Container

ServiceAuthenticationConfigurationInfo

Informazioni di configurazione dell'autenticazione

ServiceCorsConfigurationInfo

Impostazioni per la configurazione CORS dell'istanza del servizio.

ServiceCosmosDbConfigurationInfo

Impostazioni per il database Cosmos DB che esegue il backup del servizio.

ServiceExportConfigurationInfo

Esportare le informazioni di configurazione dell'operazione

ServiceImportConfigurationInfo

Importare le informazioni di configurazione dell'operazione

ServiceOciArtifactEntry

Elemento OCI (Open Container Initiative).

ServicesDescription

Descrizione del servizio.

ServicesProperties

Proprietà di un'istanza del servizio.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Tipo di identità che ha creato la risorsa.

Nome Tipo Descrizione
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

Dettagli errore.

Nome Tipo Descrizione
error

ErrorDetailsInternal

Dettagli errore

ErrorDetailsInternal

Dettagli errore.

Nome Tipo Descrizione
code

string

Codice di errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore specifico.

Identity

Impostazione che indica se al servizio è associata un'identità gestita.

Nome Tipo Descrizione
principalId

string

ID principale dell'identità della risorsa.

tenantId

string

L'ID tenant della risorsa.

type

ManagedServiceIdentityType

Tipo di identità specificato, attualmente SystemAssigned e None sono consentiti.

kind

Tipo di servizio.

Nome Tipo Descrizione
fhir

string

fhir-R4

string

fhir-Stu3

string

ManagedServiceIdentityType

Tipo di identità specificato, attualmente SystemAssigned e None sono consentiti.

Nome Tipo Descrizione
None

string

SystemAssigned

string

PrivateEndpoint

Risorsa endpoint privato.

Nome Tipo Descrizione
id

string

Identificatore arm per endpoint privato

PrivateEndpointConnection

Risorsa Connessione endpoint privato.

Nome Tipo Descrizione
id

string

ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nome della risorsa.

properties.privateEndpoint

PrivateEndpoint

Risorsa dell'endpoint privato.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Raccolta di informazioni sullo stato della connessione tra il consumer del servizio e il provider.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Stato di provisioning della risorsa di connessione dell'endpoint privato.

type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Stato di provisioning corrente.

Nome Tipo Descrizione
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

Stato della connessione dell'endpoint privato.

Nome Tipo Descrizione
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Raccolta di informazioni sullo stato della connessione tra il consumer del servizio e il provider.

Nome Tipo Descrizione
actionsRequired

string

Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer.

description

string

Motivo dell'approvazione/rifiuto della connessione.

status

PrivateEndpointServiceConnectionStatus

Indica se la connessione è stata approvata/rifiutata/rimossa dal proprietario del servizio.

provisioningState

Stato del provisioning.

Nome Tipo Descrizione
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

Autorizzazione di controllo per il traffico del piano dati proveniente da reti pubbliche mentre l'endpoint privato è abilitato.

Nome Tipo Descrizione
Disabled

string

Enabled

string

ServiceAccessPolicyEntry

Voce dei criteri di accesso.

Nome Tipo Descrizione
objectId

string

ID oggetto di Azure AD (utente o app) a cui è consentito l'accesso al servizio FHIR.

ServiceAcrConfigurationInfo

Informazioni di configurazione del Registro Azure Container

Nome Tipo Descrizione
loginServers

string[]

Elenco dei server di accesso del Registro Azure Container.

ociArtifacts

ServiceOciArtifactEntry[]

Elenco di artefatti OCI (Open Container Initiative).

ServiceAuthenticationConfigurationInfo

Informazioni di configurazione dell'autenticazione

Nome Tipo Descrizione
audience

string

URL del gruppo di destinatari per il servizio

authority

string

URL dell'autorità per il servizio

smartProxyEnabled

boolean

Se il proxy SMART on FHIR è abilitato

ServiceCorsConfigurationInfo

Impostazioni per la configurazione CORS dell'istanza del servizio.

Nome Tipo Descrizione
allowCredentials

boolean

Se le credenziali sono consentite tramite CORS.

headers

string[]

Intestazioni consentite tramite CORS.

maxAge

integer

Validità massima consentita tramite CORS.

methods

string[]

Metodi consentiti tramite CORS.

origins

string[]

Origini consentite tramite CORS.

ServiceCosmosDbConfigurationInfo

Impostazioni per il database Cosmos DB che esegue il backup del servizio.

Nome Tipo Descrizione
keyVaultKeyUri

string

URI della chiave gestita dal cliente per il database di backup.

offerThroughput

integer

Velocità effettiva con provisioning per il database di backup.

ServiceExportConfigurationInfo

Esportare le informazioni di configurazione dell'operazione

Nome Tipo Descrizione
storageAccountName

string

Nome dell'account di archiviazione di esportazione predefinito.

ServiceImportConfigurationInfo

Importare le informazioni di configurazione dell'operazione

Nome Tipo Descrizione
enabled

boolean

Se l'operazione di importazione è abilitata.

initialImportMode

boolean

Se il servizio FHIR è in InitialImportMode.

integrationDataStore

string

Nome dell'account di archiviazione di integrazione predefinito.

ServiceOciArtifactEntry

Elemento OCI (Open Container Initiative).

Nome Tipo Descrizione
digest

string

Digest dell'artefatto.

imageName

string

Nome dell'artefatto.

loginServer

string

Il server di accesso Registro Azure Container.

ServicesDescription

Descrizione del servizio.

Nome Tipo Descrizione
etag

string

Un etag associato alla risorsa, usato per la concorrenza ottimistica durante la modifica.

id

string

Identificatore della risorsa.

identity

Identity

Impostazione che indica se al servizio è associata un'identità gestita.

kind

kind

Tipo di servizio.

location

string

Percorso della risorsa.

name

string

Nome della risorsa.

properties

ServicesProperties

Proprietà comuni di un servizio.

systemData

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

tags

object

Tag di risorsa.

type

string

Tipo di risorsa.

ServicesProperties

Proprietà di un'istanza del servizio.

Nome Tipo Descrizione
accessPolicies

ServiceAccessPolicyEntry[]

Criteri di accesso dell'istanza del servizio.

acrConfiguration

ServiceAcrConfigurationInfo

Impostazioni del Registro Azure Container usate per convertire i dati dell'istanza del servizio.

authenticationConfiguration

ServiceAuthenticationConfigurationInfo

Configurazione di autenticazione per l'istanza del servizio.

corsConfiguration

ServiceCorsConfigurationInfo

Impostazioni per la configurazione CORS dell'istanza del servizio.

cosmosDbConfiguration

ServiceCosmosDbConfigurationInfo

Impostazioni per il database Cosmos DB che esegue il backup del servizio.

exportConfiguration

ServiceExportConfigurationInfo

Impostazioni per l'operazione di esportazione dell'istanza del servizio.

importConfiguration

ServiceImportConfigurationInfo

Impostazioni per l'operazione di importazione dell'istanza del servizio.

privateEndpointConnections

PrivateEndpointConnection[]

Elenco di connessioni di endpoint privato configurate per questa risorsa.

provisioningState

provisioningState

Stato del provisioning.

publicNetworkAccess

PublicNetworkAccess

Autorizzazione di controllo per il traffico del piano dati proveniente da reti pubbliche mentre l'endpoint privato è abilitato.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string

Timestamp della creazione di risorse (UTC).

createdBy

string

Identità che ha creato la risorsa.

createdByType

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt

string

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.

lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.