Services - Create Or Update

Serviço:

Healthcare Apis

Versão da API:

2022-06-01

Criar ou atualizar os metadados de uma instância de serviço.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém a instância de serviço. Padrão Regex: ^[-\w\._\(\)]+$
resourceName	path	True	string	O nome da instância de serviço.
subscriptionId	path	True	string	O identificador da subscrição.
api-version	query	True	string	Versão da API de Cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
kind	True	kind	O tipo de serviço.
location	True	string	A localização do recurso.
etag		string	Um etag associado ao recurso, utilizado para simultaneidade otimista ao editá-lo.
identity		Identity	Definição que indica se o serviço tem uma identidade gerida associada.
properties		ServicesProperties	As propriedades comuns de um serviço.
tags		object	As etiquetas de recursos.

Respostas

Name	Tipo	Description
200 OK	ServicesDescription	Atualizado – Coloque o pedido aceite e um recurso existente está a ser atualizado; a operação será concluída de forma assíncrona.
201 Created	ServicesDescription	Criado - Coloque o pedido aceite e foi criado um novo recurso; a operação será concluída de forma assíncrona.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Create or Update a service with all parameters

Create or Update a service with minimum parameters

Create or Update a service with all parameters

Pedido de amostra

HTTP

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

Python

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

dotnet

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

Resposta da amostra

Código de estado:

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

Código de estado:

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

Pedido de amostra

HTTP

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

Python

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

dotnet

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

Resposta da amostra

Código de estado:

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

Código de estado:

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

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorDetails	Detalhes do erro.
ErrorDetailsInternal	Detalhes do erro.
Identity	Definição que indica se o serviço tem uma identidade gerida associada.
kind	O tipo de serviço.
ManagedServiceIdentityType	O tipo de identidade que está a ser especificado, atualmente SystemAssigned e None são permitidos.
PrivateEndpoint	O recurso ponto final privado.
PrivateEndpointConnection	O recurso Ligação de Ponto Final Privado.
PrivateEndpointConnectionProvisioningState	O estado de aprovisionamento atual.
PrivateEndpointServiceConnectionStatus	O estado da ligação do ponto final privado.
PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor de serviços.
provisioningState	O estado de aprovisionamento.
PublicNetworkAccess	Permissão de controlo do tráfego do plano de dados proveniente de redes públicas enquanto o ponto final privado está ativado.
ServiceAccessPolicyEntry	Uma entrada de política de acesso.
ServiceAcrConfigurationInfo	Informações de configuração do Azure Container Registry
ServiceAuthenticationConfigurationInfo	Informações de configuração da autenticação
ServiceCorsConfigurationInfo	As definições para a configuração CORS da instância de serviço.
ServiceCosmosDbConfigurationInfo	As definições da base de dados do Cosmos DB que suporta o serviço.
ServiceExportConfigurationInfo	Informações de configuração da operação de exportação
ServiceImportConfigurationInfo	Informações de configuração da operação de importação
ServiceOciArtifactEntry	Um artefacto Open Container Initiative (OCI).
ServicesDescription	A descrição do serviço.
ServicesProperties	As propriedades de uma instância de serviço.
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

Detalhes do erro.

Name	Tipo	Description
error	ErrorDetailsInternal	Detalhes do erro

ErrorDetailsInternal

Detalhes do erro.

Name	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O destino do erro específico.

Identity

Definição que indica se o serviço tem uma identidade gerida associada.

Name	Tipo	Description
principalId	string	O ID principal da identidade do recurso.
tenantId	string	O ID do inquilino do recurso.
type	ManagedServiceIdentityType	O tipo de identidade que está a ser especificado, atualmente SystemAssigned e None são permitidos.

kind

O tipo de serviço.

Name	Tipo	Description
fhir	string
fhir-R4	string
fhir-Stu3	string

ManagedServiceIdentityType

O tipo de identidade que está a ser especificado, atualmente SystemAssigned e None são permitidos.

Name	Tipo	Description
None	string
SystemAssigned	string

PrivateEndpoint

O recurso ponto final privado.

Name	Tipo	Description
id	string	O identificador do ARM para o Ponto Final Privado

PrivateEndpointConnection

O recurso Ligação de Ponto Final Privado.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.privateEndpoint	PrivateEndpoint	O recurso do ponto final privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor de serviços.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	O estado de aprovisionamento do recurso de ligação de ponto final privado.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

O estado de aprovisionamento atual.

Name	Tipo	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

O estado da ligação do ponto final privado.

Name	Tipo	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor de serviços.

Name	Tipo	Description
actionsRequired	string	Uma mensagem a indicar se as alterações no fornecedor de serviços necessitam de atualizações no consumidor.
description	string	O motivo da aprovação/rejeição da ligação.
status	PrivateEndpointServiceConnectionStatus	Indica se a ligação foi Aprovada/Rejeitada/Removida pelo proprietário do serviço.

provisioningState

O estado de aprovisionamento.

Name	Tipo	Description
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

Permissão de controlo do tráfego do plano de dados proveniente de redes públicas enquanto o ponto final privado está ativado.

Name	Tipo	Description
Disabled	string
Enabled	string

ServiceAccessPolicyEntry

Uma entrada de política de acesso.

Name	Tipo	Description
objectId	string	Um ID de objeto Azure AD (Utilizador ou Aplicações) que tem permissão para aceder ao serviço FHIR.

ServiceAcrConfigurationInfo

Informações de configuração do Azure Container Registry

Name	Tipo	Description
loginServers	string[]	A lista dos servidores de início de sessão do ACR.
ociArtifacts	ServiceOciArtifactEntry[]	A lista de artefactos do Open Container Initiative (OCI).

ServiceAuthenticationConfigurationInfo

Informações de configuração da autenticação

Name	Tipo	Description
audience	string	O URL da audiência do serviço
authority	string	O URL da autoridade para o serviço
smartProxyEnabled	boolean	Se o proxy SMART no FHIR estiver ativado

ServiceCorsConfigurationInfo

As definições para a configuração CORS da instância de serviço.

Name	Tipo	Description
allowCredentials	boolean	Se as credenciais forem permitidas através do CORS.
headers	string[]	Os cabeçalhos a serem permitidos através do CORS.
maxAge	integer	A idade máxima a ser permitida através do CORS.
methods	string[]	Os métodos a serem permitidos através do CORS.
origins	string[]	As origens a serem permitidas através do CORS.

ServiceCosmosDbConfigurationInfo

As definições da base de dados do Cosmos DB que suporta o serviço.

Name	Tipo	Description
keyVaultKeyUri	string	O URI da chave gerida pelo cliente para a base de dados de apoio.
offerThroughput	integer	O débito aprovisionado para a base de dados de cópia de segurança.

ServiceExportConfigurationInfo

Informações de configuração da operação de exportação

Name	Tipo	Description
storageAccountName	string	O nome da conta de armazenamento de exportação predefinida.

ServiceImportConfigurationInfo

Informações de configuração da operação de importação

Name	Tipo	Description
enabled	boolean	Se a operação de importação estiver ativada.
initialImportMode	boolean	Se o serviço FHIR estiver em InitialImportMode.
integrationDataStore	string	O nome da conta de armazenamento de integração predefinida.

ServiceOciArtifactEntry

Um artefacto Open Container Initiative (OCI).

Name	Tipo	Description
digest	string	A digestão do artefacto.
imageName	string	O nome do artefacto.
loginServer	string	O servidor de início de sessão Azure Container Registry.

ServicesDescription

A descrição do serviço.

Name	Tipo	Description
etag	string	Um etag associado ao recurso, utilizado para simultaneidade otimista ao editá-lo.
id	string	O identificador de recursos.
identity	Identity	Definição que indica se o serviço tem uma identidade gerida associada.
kind	kind	O tipo de serviço.
location	string	A localização do recurso.
name	string	O nome do recurso.
properties	ServicesProperties	As propriedades comuns de um serviço.
systemData	systemData	Metadados relativos à criação e última modificação do recurso.
tags	object	As etiquetas de recursos.
type	string	O tipo de recurso.

ServicesProperties

As propriedades de uma instância de serviço.

Name	Tipo	Description
accessPolicies	ServiceAccessPolicyEntry[]	As políticas de acesso da instância de serviço.
acrConfiguration	ServiceAcrConfigurationInfo	As definições do azure container registry utilizadas para converter a operação de dados da instância de serviço.
authenticationConfiguration	ServiceAuthenticationConfigurationInfo	A configuração de autenticação da instância de serviço.
corsConfiguration	ServiceCorsConfigurationInfo	As definições para a configuração CORS da instância de serviço.
cosmosDbConfiguration	ServiceCosmosDbConfigurationInfo	As definições da base de dados do Cosmos DB que suporta o serviço.
exportConfiguration	ServiceExportConfigurationInfo	As definições para a operação de exportação da instância de serviço.
importConfiguration	ServiceImportConfigurationInfo	As definições para a operação de importação da instância de serviço.
privateEndpointConnections	PrivateEndpointConnection[]	A lista de ligações de ponto final privado que estão configuradas para este recurso.
provisioningState	provisioningState	O estado de aprovisionamento.
publicNetworkAccess	PublicNetworkAccess	Permissão de controlo do tráfego do plano de dados proveniente de redes públicas enquanto o ponto final privado está ativado.

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.