Services - Create Or Update

Referenz

Dienst:: Healthcare Apis

API-Version:: 2022-06-01

Erstellen oder aktualisieren Sie die Metadaten einer Dienstinstanz.

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 minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Der Name der Ressourcengruppe, die die Dienstinstanz enthält.
resourceName	path	True	string minLength: 3 maxLength: 24	Der Name der Dienstinstanz.
subscriptionId	path	True	string	Der Abonnementbezeichner.
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 Etag, das der Ressource zugeordnet ist, wird bei der Bearbeitung für optimistische Parallelität verwendet.
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 – Angenommene Anforderung und vorhandene Ressource werden aktualisiert; der Vorgang wird asynchron abgeschlossen.
201 Created	ServicesDescription	Erstellt – Put-Anforderung akzeptiert und eine neue Ressource wurde erstellt; der Vorgang wird asynchron abgeschlossen.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.healthcareapis import HealthcareApisManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-healthcareapis
# USAGE
    python service_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = HealthcareApisManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.services.begin_create_or_update(
        resource_group_name="rg1",
        resource_name="service1",
        service_description={
            "identity": {"type": "SystemAssigned"},
            "kind": "fhir-R4",
            "location": "westus2",
            "properties": {
                "accessPolicies": [
                    {"objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"},
                    {"objectId": "5b307da8-43d4-492b-8b66-b0294ade872f"},
                ],
                "authenticationConfiguration": {
                    "audience": "https://azurehealthcareapis.com",
                    "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
                    "smartProxyEnabled": True,
                },
                "corsConfiguration": {
                    "allowCredentials": False,
                    "headers": ["*"],
                    "maxAge": 1440,
                    "methods": ["DELETE", "GET", "OPTIONS", "PATCH", "POST", "PUT"],
                    "origins": ["*"],
                },
                "cosmosDbConfiguration": {
                    "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key",
                    "offerThroughput": 1000,
                },
                "exportConfiguration": {"storageAccountName": "existingStorageAccount"},
                "privateEndpointConnections": [],
                "publicNetworkAccess": "Disabled",
            },
            "tags": {},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/legacy/ServiceCreate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.HealthcareApis;
using Azure.ResourceManager.HealthcareApis.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/legacy/ServiceCreate.json
// this example is just showing the usage of "Services_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this HealthcareApisServiceResource
HealthcareApisServiceCollection collection = resourceGroupResource.GetHealthcareApisServices();

// invoke the operation
string resourceName = "service1";
HealthcareApisServiceData data = new HealthcareApisServiceData(new AzureLocation("westus2"), HealthcareApisKind.FhirR4)
{
    Properties = new HealthcareApisServiceProperties()
    {
        AccessPolicies =
        {
        new HealthcareApisServiceAccessPolicyEntry("c487e7d1-3210-41a3-8ccc-e9372b78da47"),new HealthcareApisServiceAccessPolicyEntry("5b307da8-43d4-492b-8b66-b0294ade872f")
        },
        CosmosDbConfiguration = new HealthcareApisServiceCosmosDbConfiguration()
        {
            OfferThroughput = 1000,
            KeyVaultKeyUri = new Uri("https://my-vault.vault.azure.net/keys/my-key"),
        },
        AuthenticationConfiguration = new HealthcareApisServiceAuthenticationConfiguration()
        {
            Authority = "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
            Audience = "https://azurehealthcareapis.com",
            IsSmartProxyEnabled = true,
        },
        CorsConfiguration = new HealthcareApisServiceCorsConfiguration()
        {
            Origins =
            {
            "*"
            },
            Headers =
            {
            "*"
            },
            Methods =
            {
            "DELETE","GET","OPTIONS","PATCH","POST","PUT"
            },
            MaxAge = 1440,
            AllowCredentials = false,
        },
        ExportStorageAccountName = "existingStorageAccount",
        PrivateEndpointConnections =
        {
        },
        PublicNetworkAccess = HealthcareApisPublicNetworkAccess.Disabled,
    },
    Identity = new ManagedServiceIdentity("SystemAssigned"),
    Tags =
    {
    },
};
ArmOperation<HealthcareApisServiceResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, resourceName, data);
HealthcareApisServiceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
HealthcareApisServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 201

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.healthcareapis import HealthcareApisManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-healthcareapis
# USAGE
    python service_create_minimum.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = HealthcareApisManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.services.begin_create_or_update(
        resource_group_name="rg1",
        resource_name="service2",
        service_description={
            "kind": "fhir-R4",
            "location": "westus2",
            "properties": {"accessPolicies": [{"objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"}]},
            "tags": {},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/legacy/ServiceCreateMinimum.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.HealthcareApis;
using Azure.ResourceManager.HealthcareApis.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/legacy/ServiceCreateMinimum.json
// this example is just showing the usage of "Services_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this HealthcareApisServiceResource
HealthcareApisServiceCollection collection = resourceGroupResource.GetHealthcareApisServices();

// invoke the operation
string resourceName = "service2";
HealthcareApisServiceData data = new HealthcareApisServiceData(new AzureLocation("westus2"), HealthcareApisKind.FhirR4)
{
    Properties = new HealthcareApisServiceProperties()
    {
        AccessPolicies =
        {
        new HealthcareApisServiceAccessPolicyEntry("c487e7d1-3210-41a3-8ccc-e9372b78da47")
        },
    },
    Tags =
    {
    },
};
ArmOperation<HealthcareApisServiceResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, resourceName, data);
HealthcareApisServiceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
HealthcareApisServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 201

{
  "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 Typ der angegebenen Identität, derzeit "SystemAssigned" und "None" sind zulässig.
PrivateEndpoint	Die Private Endpoint-Ressource.
PrivateEndpointConnection	Die Private Endpoint Connection-Ressource.
PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus.
PrivateEndpointServiceConnectionStatus	Der Status der privaten Endpunktverbindung.
PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
provisioningState	Der Bereitstellungsstatus.
PublicNetworkAccess	Steuern sie die Berechtigung für Datenebenendatenverkehr aus öffentlichen Netzwerken, während der private Endpunkt aktiviert ist.
ServiceAccessPolicyEntry	Ein Zugriffsrichtlinieneintrag.
ServiceAcrConfigurationInfo	Konfigurationsinformationen zur Azure-Containerregistrierung
ServiceAuthenticationConfigurationInfo	Authentifizierungskonfigurationsinformationen
ServiceCorsConfigurationInfo	Die Einstellungen für die CORS-Konfiguration der Dienstinstanz.
ServiceCosmosDbConfigurationInfo	Die Einstellungen für die Cosmos DB-Datenbank, die den Dienst unterstützt.
ServiceExportConfigurationInfo	Exportvorgangskonfigurationsinformationen
ServiceImportConfigurationInfo	Konfigurationsinformationen für Importvorgänge
ServiceOciArtifactEntry	Ein Open Container Initiative (OCI)-Artefakt.
ServicesDescription	Die Beschreibung des Diensts.
ServicesProperties	Die Eigenschaften einer Dienstinstanz.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorDetails

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
error	ErrorDetailsInternal	Fehlerdetails

ErrorDetailsInternal

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

Identity

Objekt

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 Typ der angegebenen Identität, derzeit "SystemAssigned" und "None" sind zulässig.

kind

Enumeration

Die Art des Diensts.

Wert	Beschreibung
fhir
fhir-R4
fhir-Stu3

ManagedServiceIdentityType

Enumeration

Der Typ der angegebenen Identität, derzeit "SystemAssigned" und "None" sind zulässig.

Wert	Beschreibung
None
SystemAssigned

PrivateEndpoint

Objekt

Die Private Endpoint-Ressource.

Name	Typ	Beschreibung
id	string	Der ARM-Bezeichner für private Endpunkte

PrivateEndpointConnection

Objekt

Die Private Endpoint Connection-Ressource.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /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 Service Consumer und Provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Der Bereitstellungsstatus der privaten Endpunktverbindungsressource.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus.

Wert	Beschreibung
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeration

Der Status der privaten Endpunktverbindung.

Wert	Beschreibung
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Objekt

Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.

Name	Typ	Beschreibung
actionsRequired	string	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher 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

Enumeration

Der Bereitstellungsstatus.

Wert	Beschreibung
Accepted
Canceled
Creating
Deleting
Deprovisioned
Failed
Moving
Succeeded
Suspended
SystemMaintenance
Updating
Verifying
Warned

PublicNetworkAccess

Enumeration

Steuern sie die Berechtigung für Datenebenendatenverkehr aus öffentlichen Netzwerken, während der private Endpunkt aktiviert ist.

Wert	Beschreibung
Disabled
Enabled

ServiceAccessPolicyEntry

Objekt

Ein Zugriffsrichtlinieneintrag.

Name	Typ	Beschreibung
objectId	string pattern: ^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$	Eine Azure AD-Objekt-ID (Benutzer oder Apps), die zugriff auf den FHIR-Dienst erlaubt ist.

ServiceAcrConfigurationInfo

Objekt

Konfigurationsinformationen zur Azure-Containerregistrierung

Name	Typ	Beschreibung
loginServers	string[]	Die Liste der ACR-Anmeldeserver.
ociArtifacts	ServiceOciArtifactEntry[]	Die Liste der Open Container Initiative (OCI)-Artefakte.

ServiceAuthenticationConfigurationInfo

Objekt

Authentifizierungskonfigurationsinformationen

Name	Typ	Beschreibung
audience	string	Die Benutzergruppen-URL für den Dienst
authority	string	Die Autoritäts-URL für den Dienst
smartProxyEnabled	boolean	Wenn der SMART unter FHIR-Proxy aktiviert ist

ServiceCorsConfigurationInfo

Objekt

Die Einstellungen für die CORS-Konfiguration der Dienstinstanz.

Name	Typ	Beschreibung
allowCredentials	boolean	Wenn Anmeldeinformationen über CORS zulässig sind.
headers	string[]	Die Kopfzeilen, die über CORS zulässig sind.
maxAge	integer minimum: 0 maximum: 99999	Das maximale Alter, das über CORS erlaubt werden soll.
methods	string[]	Die Methoden, die über CORS zugelassen werden sollen.
origins	string[] pattern: ^(?:(?:(?:[hH][tT][tT][pP](?:[sS]\|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?\|[*]))$	Die Ursprünge sollen über CORS zugelassen werden.

ServiceCosmosDbConfigurationInfo

Objekt

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

Name	Typ	Beschreibung
keyVaultKeyUri	string	Der URI des vom Kunden verwalteten Schlüssels für die Sicherungsdatenbank.
offerThroughput	integer minimum: 400	Der bereitgestellte Durchsatz für die Sicherungsdatenbank.

ServiceExportConfigurationInfo

Objekt

Exportvorgangskonfigurationsinformationen

Name	Typ	Beschreibung
storageAccountName	string	Der Name des standardmäßigen Exportspeicherkontos.

ServiceImportConfigurationInfo

Objekt

Konfigurationsinformationen für Importvorgänge

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 Standardmäßigen Integrationsspeicherkontos.

ServiceOciArtifactEntry

Objekt

Ein Open Container Initiative (OCI)-Artefakt.

Name	Typ	Beschreibung
digest	string	Der Artefaktdig.
imageName	string	Der Artefaktname.
loginServer	string	Der Azure Container Registry-Anmeldeserver.

ServicesDescription

Objekt

Die Beschreibung des Diensts.

Name	Typ	Beschreibung
etag	string	Ein Etag, das der Ressource zugeordnet ist, wird bei der Bearbeitung für optimistische Parallelität verwendet.
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 pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$	Der Ressourcenname.
properties	ServicesProperties	Die allgemeinen Eigenschaften eines Diensts.
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
tags	object	Die Ressourcentags.
type	string	Der Ressourcentyp.

ServicesProperties

Objekt

Die Eigenschaften einer Dienstinstanz.

Name	Typ	Beschreibung
accessPolicies	ServiceAccessPolicyEntry[]	Die Zugriffsrichtlinien der Dienstinstanz.
acrConfiguration	ServiceAcrConfigurationInfo	Die Azure-Containerregistrierungseinstellungen, die zum Konvertieren des Datenvorgangs der Dienstinstanz verwendet werden.
authenticationConfiguration	ServiceAuthenticationConfigurationInfo	Die Authentifizierungskonfiguration für die Dienstinstanz.
corsConfiguration	ServiceCorsConfigurationInfo	Die Einstellungen für die CORS-Konfiguration der Dienstinstanz.
cosmosDbConfiguration	ServiceCosmosDbConfigurationInfo	Die Einstellungen für die Cosmos DB-Datenbank, die den Dienst unterstützt.
exportConfiguration	ServiceExportConfigurationInfo	Die Einstellungen für den Exportvorgang der Dienstinstanz.
importConfiguration	ServiceImportConfigurationInfo	Die Einstellungen für den Importvorgang der Dienstinstanz.
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 Datenebenendatenverkehr aus öffentlichen Netzwerken, während der private Endpunkt aktiviert ist.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	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 (date-time)	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.

Freigeben über

Services - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Create or Update a service with all parameters

Beispielanforderung

Beispiel für eine Antwort

Create or Update a service with minimum parameters

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

ErrorDetails

ErrorDetailsInternal

Identity

kind

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

provisioningState

PublicNetworkAccess

ServiceAccessPolicyEntry

ServiceAcrConfigurationInfo

ServiceAuthenticationConfigurationInfo

ServiceCorsConfigurationInfo

ServiceCosmosDbConfigurationInfo

ServiceExportConfigurationInfo

ServiceImportConfigurationInfo

ServiceOciArtifactEntry

ServicesDescription

ServicesProperties

systemData

Zusätzliche Ressourcen