Freigeben über


Services - Create Or Update

Erstellen oder aktualisieren Sie die Metadaten eines Diensts instance.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe, die den Dienst instance enthält.

RegEx-Muster: ^[-\w\._\(\)]+$

resourceName
path True

string

Der Name der Dienstinstanz.

subscriptionId
path True

string

Die Abonnement-ID.

api-version
query True

string

Client-API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
kind True

kind

Die Art des Diensts.

location True

string

Der Ressourcenspeicherort.

etag

string

Ein der Ressource zugeordnetes Etag, das für eine optimistische Parallelität beim Bearbeiten verwendet wird.

identity

Identity

Einstellung, die angibt, ob dem Dienst eine verwaltete Identität zugeordnet ist.

properties

ServicesProperties

Die allgemeinen Eigenschaften eines Diensts.

tags

object

Die Ressourcentags.

Antworten

Name Typ Beschreibung
200 OK

ServicesDescription

Aktualisiert: Put-Anforderung wird akzeptiert, und eine vorhandene Ressource wird aktualisiert. der Vorgang wird asynchron abgeschlossen.

201 Created

ServicesDescription

Erstellt: Put-Anforderung wurde akzeptiert, und eine neue Ressource wurde erstellt. der Vorgang wird asynchron abgeschlossen.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Create or Update a service with all parameters

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
createdByType

Der Identitätstyp, der die Ressource erstellt hat.

ErrorDetails

Fehlerdetails.

ErrorDetailsInternal

Fehlerdetails.

Identity

Einstellung, die angibt, ob dem Dienst eine verwaltete Identität zugeordnet ist.

kind

Die Art des Diensts.

ManagedServiceIdentityType

Der angegebene Identitätstyp ist derzeit "SystemAssigned" und "None" zulässig.

PrivateEndpoint

Die Ressource "Privater Endpunkt".

PrivateEndpointConnection

Die Ressource "Private Endpoint Connection".

PrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.

PrivateEndpointServiceConnectionStatus

Die private Endpunktverbindung status.

PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Status der Verbindung zwischen dem Dienst consumer und dem Anbieter.

provisioningState

Der Bereitstellungsstatus.

PublicNetworkAccess

Steuern Sie die Berechtigung für Datenverkehr auf Der Datenebene, der aus öffentlichen Netzwerken stammt, während der private Endpunkt aktiviert ist.

ServiceAccessPolicyEntry

Ein Zugriffsrichtlinieneintrag.

ServiceAcrConfigurationInfo

Konfigurationsinformationen zur Azure-Containerregistrierung

ServiceAuthenticationConfigurationInfo

Informationen zur Authentifizierungskonfiguration

ServiceCorsConfigurationInfo

Die Einstellungen für die CORS-Konfiguration des Diensts instance.

ServiceCosmosDbConfigurationInfo

Die Einstellungen für die Cosmos DB-Datenbank, die den Dienst unterstützt.

ServiceExportConfigurationInfo

Exportieren von Vorgangskonfigurationsinformationen

ServiceImportConfigurationInfo

Importieren von Vorgangskonfigurationsinformationen

ServiceOciArtifactEntry

Ein OCI-Artefakt (Open Container Initiative).

ServicesDescription

Die Beschreibung des Dienstes.

ServicesProperties

Die Eigenschaften eines Diensts instance.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

Fehlerdetails.

Name Typ Beschreibung
error

ErrorDetailsInternal

Fehlerdetails

ErrorDetailsInternal

Fehlerdetails.

Name Typ Beschreibung
code

string

Der Fehlercode.

message

string

Die Fehlermeldung.

target

string

Das Ziel des jeweiligen Fehlers.

Identity

Einstellung, die angibt, ob dem Dienst eine verwaltete Identität zugeordnet ist.

Name Typ Beschreibung
principalId

string

Die Prinzipal-ID der Ressourcenidentität.

tenantId

string

Die Mandanten-ID der Ressource.

type

ManagedServiceIdentityType

Der angegebene Identitätstyp ist derzeit "SystemAssigned" und "None" zulässig.

kind

Die Art des Diensts.

Name Typ Beschreibung
fhir

string

fhir-R4

string

fhir-Stu3

string

ManagedServiceIdentityType

Der angegebene Identitätstyp ist derzeit "SystemAssigned" und "None" zulässig.

Name Typ Beschreibung
None

string

SystemAssigned

string

PrivateEndpoint

Die Ressource "Privater Endpunkt".

Name Typ Beschreibung
id

string

Der ARM-Bezeichner für private Endpunkte

PrivateEndpointConnection

Die Ressource "Private Endpoint Connection".

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Der Name der Ressource

properties.privateEndpoint

PrivateEndpoint

Die Ressource des privaten Endpunkts.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Status der Verbindung zwischen dem Dienst consumer und dem Anbieter.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Der Bereitstellungsstatus der Verbindungsressource des privaten Endpunkts.

type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.

Name Typ Beschreibung
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

Die private Endpunktverbindung status.

Name Typ Beschreibung
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Status der Verbindung zwischen dem Dienst consumer und dem Anbieter.

Name Typ Beschreibung
actionsRequired

string

Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.

description

string

Der Grund für die Genehmigung/Ablehnung der Verbindung.

status

PrivateEndpointServiceConnectionStatus

Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde.

provisioningState

Der Bereitstellungsstatus.

Name Typ Beschreibung
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

Steuern Sie die Berechtigung für Datenverkehr auf Der Datenebene, der aus öffentlichen Netzwerken stammt, während der private Endpunkt aktiviert ist.

Name Typ Beschreibung
Disabled

string

Enabled

string

ServiceAccessPolicyEntry

Ein Zugriffsrichtlinieneintrag.

Name Typ Beschreibung
objectId

string

Eine Azure AD-Objekt-ID (Benutzer oder Apps), für die der Zugriff auf den FHIR-Dienst zulässig ist.

ServiceAcrConfigurationInfo

Konfigurationsinformationen zur Azure-Containerregistrierung

Name Typ Beschreibung
loginServers

string[]

Die Liste der ACR-Anmeldeserver.

ociArtifacts

ServiceOciArtifactEntry[]

Die Liste der OCI-Artefakte (Open Container Initiative).

ServiceAuthenticationConfigurationInfo

Informationen zur Authentifizierungskonfiguration

Name Typ Beschreibung
audience

string

Die Zielgruppen-URL für den Dienst

authority

string

Die Autoritäts-URL für den Dienst

smartProxyEnabled

boolean

Wenn der SMART on FHIR-Proxy aktiviert ist

ServiceCorsConfigurationInfo

Die Einstellungen für die CORS-Konfiguration des Diensts instance.

Name Typ Beschreibung
allowCredentials

boolean

Wenn Anmeldeinformationen über CORS zulässig sind.

headers

string[]

Die Header, die über CORS zugelassen werden sollen.

maxAge

integer

Das maximale Alter, das über CORS zugelassen werden soll.

methods

string[]

Die Über CORS zuzulassenden Methoden.

origins

string[]

Die Ursprünge sollen über CORS zugelassen werden.

ServiceCosmosDbConfigurationInfo

Die Einstellungen für die Cosmos DB-Datenbank, die den Dienst unterstützt.

Name Typ Beschreibung
keyVaultKeyUri

string

Der URI des kundenseitig verwalteten Schlüssels für die unterstützende Datenbank.

offerThroughput

integer

Der bereitgestellte Durchsatz für die unterstützende Datenbank.

ServiceExportConfigurationInfo

Exportieren von Vorgangskonfigurationsinformationen

Name Typ Beschreibung
storageAccountName

string

Der Name des Standardexportspeicherkontos.

ServiceImportConfigurationInfo

Importieren von Vorgangskonfigurationsinformationen

Name Typ Beschreibung
enabled

boolean

Wenn der Importvorgang aktiviert ist.

initialImportMode

boolean

Wenn sich der FHIR-Dienst in InitialImportMode befindet.

integrationDataStore

string

Der Name des Standardspeicherkontos für die Integration.

ServiceOciArtifactEntry

Ein OCI-Artefakt (Open Container Initiative).

Name Typ Beschreibung
digest

string

Der Artefakt-Digest.

imageName

string

Der Artefaktname.

loginServer

string

Der Azure Container Registry-Anmeldeserver.

ServicesDescription

Die Beschreibung des Dienstes.

Name Typ Beschreibung
etag

string

Ein der Ressource zugeordnetes Etag, das für eine optimistische Parallelität beim Bearbeiten verwendet wird.

id

string

Der Ressourcenbezeichner.

identity

Identity

Einstellung, die angibt, ob dem Dienst eine verwaltete Identität zugeordnet ist.

kind

kind

Die Art des Diensts.

location

string

Der Ressourcenspeicherort.

name

string

Der Name der Ressource.

properties

ServicesProperties

Die allgemeinen Eigenschaften eines Diensts.

systemData

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

tags

object

Die Ressourcentags.

type

string

Der Ressourcentyp.

ServicesProperties

Die Eigenschaften eines Diensts instance.

Name Typ Beschreibung
accessPolicies

ServiceAccessPolicyEntry[]

Die Zugriffsrichtlinien des Diensts instance.

acrConfiguration

ServiceAcrConfigurationInfo

Die Azure Container Registry-Einstellungen, die für den Datenkonvertierungsvorgang des Diensts instance.

authenticationConfiguration

ServiceAuthenticationConfigurationInfo

Die Authentifizierungskonfiguration für den Dienst instance.

corsConfiguration

ServiceCorsConfigurationInfo

Die Einstellungen für die CORS-Konfiguration des Diensts instance.

cosmosDbConfiguration

ServiceCosmosDbConfigurationInfo

Die Einstellungen für die Cosmos DB-Datenbank, die den Dienst unterstützt.

exportConfiguration

ServiceExportConfigurationInfo

Die Einstellungen für den Exportvorgang des Diensts instance.

importConfiguration

ServiceImportConfigurationInfo

Die Einstellungen für den Importvorgang des Diensts instance.

privateEndpointConnections

PrivateEndpointConnection[]

Die Liste der privaten Endpunktverbindungen, die für diese Ressource eingerichtet sind.

provisioningState

provisioningState

Der Bereitstellungsstatus.

publicNetworkAccess

PublicNetworkAccess

Steuern Sie die Berechtigung für Datenverkehr auf Der Datenebene, der aus öffentlichen Netzwerken stammt, während der private Endpunkt aktiviert ist.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy

string

Die Identität, die die Ressource erstellt hat.

createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)

lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.