Services - Create Or Update

Referentie

Service:: Healthcare Apis

API-versie:: 2022-06-01

De metagegevens van een service-exemplaar maken of bijwerken.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	De naam van de resourcegroep die het service-exemplaar bevat.
resourceName	path	True	string minLength: 3 maxLength: 24	De naam van het service-exemplaar.
subscriptionId	path	True	string	De abonnement-ID.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Vereist	Type	Description
kind	True	kind	Het soort service.
location	True	string	De resourcelocatie.
etag		string	Een etag die is gekoppeld aan de resource, die wordt gebruikt voor optimistische gelijktijdigheid bij het bewerken ervan.
identity		Identity	Instelling die aangeeft of aan de service een beheerde identiteit is gekoppeld.
properties		ServicesProperties	De algemene eigenschappen van een service.
tags		object	De resourcetags.

Antwoorden

Name	Type	Description
200 OK	ServicesDescription	Bijgewerkt: geaccepteerde aanvraag plaatsen en een bestaande resource wordt bijgewerkt; de bewerking asynchroon wordt voltooid.
201 Created	ServicesDescription	Gemaakt - Aanvraag geaccepteerd plaatsen en er is een nieuwe resource gemaakt; de bewerking asynchroon wordt voltooid.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Create or Update a service with all parameters

Create or Update a service with minimum parameters

Create or Update a service with all parameters

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorDetails	Foutdetails.
ErrorDetailsInternal	Foutdetails.
Identity	Instelling die aangeeft of aan de service een beheerde identiteit is gekoppeld.
kind	Het soort service.
ManagedServiceIdentityType	Het type identiteit dat wordt opgegeven, momenteel SystemAssigned en None zijn toegestaan.
PrivateEndpoint	De privé-eindpuntresource.
PrivateEndpointConnection	De privé-eindpuntverbindingsresource.
PrivateEndpointConnectionProvisioningState	De huidige inrichtingsstatus.
PrivateEndpointServiceConnectionStatus	De verbindingsstatus van het privé-eindpunt.
PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.
provisioningState	De inrichtingsstatus.
PublicNetworkAccess	Beheermachtiging voor gegevensvlakverkeer dat afkomstig is van openbare netwerken terwijl privé-eindpunt is ingeschakeld.
ServiceAccessPolicyEntry	Een toegangsbeleidsvermelding.
ServiceAcrConfigurationInfo	Configuratiegegevens van Azure Container Registry
ServiceAuthenticationConfigurationInfo	Informatie over verificatieconfiguratie
ServiceCorsConfigurationInfo	De instellingen voor de CORS-configuratie van het service-exemplaar.
ServiceCosmosDbConfigurationInfo	De instellingen voor de Cosmos DB-database die de service back-up maken.
ServiceExportConfigurationInfo	Configuratiegegevens voor exportbewerkingen
ServiceImportConfigurationInfo	Configuratiegegevens voor importbewerkingen
ServiceOciArtifactEntry	Een OCI-artefact (Open Container Initiative).
ServicesDescription	De beschrijving van de service.
ServicesProperties	De eigenschappen van een service-exemplaar.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

ErrorDetails

Object

Foutdetails.

Name	Type	Description
error	ErrorDetailsInternal	Foutdetails

ErrorDetailsInternal

Object

Foutdetails.

Name	Type	Description
code	string	De foutcode.
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

Identity

Object

Instelling die aangeeft of aan de service een beheerde identiteit is gekoppeld.

Name	Type	Description
principalId	string	De principal-id van de resource-id.
tenantId	string	De tenant-id van de resource.
type	ManagedServiceIdentityType	Het type identiteit dat wordt opgegeven, momenteel SystemAssigned en None zijn toegestaan.

kind

Inventarisatie

Het soort service.

Waarde	Description
fhir
fhir-R4
fhir-Stu3

ManagedServiceIdentityType

Inventarisatie

Het type identiteit dat wordt opgegeven, momenteel SystemAssigned en None zijn toegestaan.

Waarde	Description
None
SystemAssigned

PrivateEndpoint

Object

De privé-eindpuntresource.

Name	Type	Description
id	string	De ARM-id voor privé-eindpunt

PrivateEndpointConnection

Object

De privé-eindpuntverbindingsresource.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.privateEndpoint	PrivateEndpoint	De resource van het privé-eindpunt.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	De inrichtingsstatus van de privé-eindpuntverbindingsresource.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrivateEndpointConnectionProvisioningState

Inventarisatie

De huidige inrichtingsstatus.

Waarde	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Inventarisatie

De verbindingsstatus van het privé-eindpunt.

Waarde	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.

Name	Type	Description
actionsRequired	string	Een bericht dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen.
description	string	De reden voor goedkeuring/afwijzing van de verbinding.
status	PrivateEndpointServiceConnectionStatus	Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service.

provisioningState

Inventarisatie

De inrichtingsstatus.

Waarde	Description
Accepted
Canceled
Creating
Deleting
Deprovisioned
Failed
Moving
Succeeded
Suspended
SystemMaintenance
Updating
Verifying
Warned

PublicNetworkAccess

Inventarisatie

Beheermachtiging voor gegevensvlakverkeer dat afkomstig is van openbare netwerken terwijl privé-eindpunt is ingeschakeld.

Waarde	Description
Disabled
Enabled

ServiceAccessPolicyEntry

Object

Een toegangsbeleidsvermelding.

Name	Type	Description
objectId	string pattern: ^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$	Een Azure AD-object-id (gebruiker of apps) die toegang heeft tot de FHIR-service.

ServiceAcrConfigurationInfo

Object

Configuratiegegevens van Azure Container Registry

Name	Type	Description
loginServers	string[]	De lijst met de ACR-aanmeldingsservers.
ociArtifacts	ServiceOciArtifactEntry[]	De lijst met OCI-artefacten (Open Container Initiative).

ServiceAuthenticationConfigurationInfo

Object

Informatie over verificatieconfiguratie

Name	Type	Description
audience	string	De doelgroep-URL voor de service
authority	string	De instantie-URL voor de service
smartProxyEnabled	boolean	Als de SMART on FHIR-proxy is ingeschakeld

ServiceCorsConfigurationInfo

Object

De instellingen voor de CORS-configuratie van het service-exemplaar.

Name	Type	Description
allowCredentials	boolean	Als referenties zijn toegestaan via CORS.
headers	string[]	De headers kunnen worden toegestaan via CORS.
maxAge	integer minimum: 0 maximum: 99999	De maximale leeftijd die via CORS mag worden toegestaan.
methods	string[]	De methoden die via CORS moeten worden toegestaan.
origins	string[] pattern: ^(?:(?:(?:[hH][tT][tT][pP](?:[sS]\|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?\|[*]))$	De oorsprong mag via CORS worden toegestaan.

ServiceCosmosDbConfigurationInfo

Object

De instellingen voor de Cosmos DB-database die de service back-up maken.

Name	Type	Description
keyVaultKeyUri	string	De URI van de door de klant beheerde sleutel voor de back-updatabase.
offerThroughput	integer minimum: 400	De ingerichte doorvoer voor de back-updatabase.

ServiceExportConfigurationInfo

Object

Configuratiegegevens voor exportbewerkingen

Name	Type	Description
storageAccountName	string	De naam van het standaardopslagaccount voor exporteren.

ServiceImportConfigurationInfo

Object

Configuratiegegevens voor importbewerkingen

Name	Type	Description
enabled	boolean	Als de importbewerking is ingeschakeld.
initialImportMode	boolean	Als de FHIR-service zich in InitialImportMode bevindt.
integrationDataStore	string	De naam van het standaardopslagaccount voor integratie.

ServiceOciArtifactEntry

Object

Een OCI-artefact (Open Container Initiative).

Name	Type	Description
digest	string	De artefactsamenvating.
imageName	string	De naam van het artefact.
loginServer	string	De azure Container Registry-aanmeldingsserver.

ServicesDescription

Object

De beschrijving van de service.

Name	Type	Description
etag	string	Een etag die is gekoppeld aan de resource, die wordt gebruikt voor optimistische gelijktijdigheid bij het bewerken ervan.
id	string	De resource-id.
identity	Identity	Instelling die aangeeft of aan de service een beheerde identiteit is gekoppeld.
kind	kind	Het soort service.
location	string	De resourcelocatie.
name	string pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$	De resourcenaam.
properties	ServicesProperties	De algemene eigenschappen van een service.
systemData	systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
tags	object	De resourcetags.
type	string	Het resourcetype.

ServicesProperties

Object

De eigenschappen van een service-exemplaar.

Name	Type	Description
accessPolicies	ServiceAccessPolicyEntry[]	Het toegangsbeleid van het service-exemplaar.
acrConfiguration	ServiceAcrConfigurationInfo	De azure Container Registry-instellingen die worden gebruikt voor het converteren van gegevensbewerkingen van het service-exemplaar.
authenticationConfiguration	ServiceAuthenticationConfigurationInfo	De verificatieconfiguratie voor het service-exemplaar.
corsConfiguration	ServiceCorsConfigurationInfo	De instellingen voor de CORS-configuratie van het service-exemplaar.
cosmosDbConfiguration	ServiceCosmosDbConfigurationInfo	De instellingen voor de Cosmos DB-database die de service back-up maken.
exportConfiguration	ServiceExportConfigurationInfo	De instellingen voor de exportbewerking van het service-exemplaar.
importConfiguration	ServiceImportConfigurationInfo	De instellingen voor de importbewerking van het service-exemplaar.
privateEndpointConnections	PrivateEndpointConnection[]	De lijst met privé-eindpuntverbindingen die zijn ingesteld voor deze resource.
provisioningState	provisioningState	De inrichtingsstatus.
publicNetworkAccess	PublicNetworkAccess	Beheermachtiging voor gegevensvlakverkeer dat afkomstig is van openbare netwerken terwijl privé-eindpunt is ingeschakeld.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Delen via

Services - Create Or Update

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

Create or Update a service with all parameters

Voorbeeldaanvraag

Voorbeeldrespons

Create or Update a service with minimum parameters

Voorbeeldaanvraag

Voorbeeldrespons

Definities

createdByType

ErrorDetails

ErrorDetailsInternal

Identity

kind

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

provisioningState

PublicNetworkAccess

ServiceAccessPolicyEntry

ServiceAcrConfigurationInfo

ServiceAuthenticationConfigurationInfo

ServiceCorsConfigurationInfo

ServiceCosmosDbConfigurationInfo

ServiceExportConfigurationInfo

ServiceImportConfigurationInfo

ServiceOciArtifactEntry

ServicesDescription

ServicesProperties

systemData

Aanvullende resources