Services - Create Or Update

Referencia

Servicio:: Healthcare Apis

Versión de la API:: 2022-06-01

Cree o actualice los metadatos de una instancia de servicio.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nombre del grupo de recursos que contiene la instancia de servicio.
resourceName	path	True	string minLength: 3 maxLength: 24	Nombre de la instancia de servicio.
subscriptionId	path	True	string	Identificador de la suscripción.
api-version	query	True	string	Versión de api de cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
kind	True	kind	El tipo de servicio.
location	True	string	Ubicación del recurso.
etag		string	ETAG asociado al recurso, que se usa para la simultaneidad optimista al editarlo.
identity		Identity	Configuración que indica si el servicio tiene una identidad administrada asociada.
properties		ServicesProperties	Las propiedades comunes de un servicio.
tags		object	Etiquetas de recursos.

Respuestas

Nombre	Tipo	Description
200 OK	ServicesDescription	Actualizado: se acepta la solicitud put y se actualiza un recurso existente; la operación se completará de forma asincrónica.
201 Created	ServicesDescription	Creado: se aceptó la solicitud put y se creó un nuevo recurso; la operación se completará de forma asincrónica.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Create or Update a service with all parameters

Create or Update a service with minimum parameters

Create or Update a service with all parameters

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
  }
}

status code:: 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

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
  }
}

status code:: 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"
  }
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorDetails	Detalles del error.
ErrorDetailsInternal	Detalles del error.
Identity	Configuración que indica si el servicio tiene una identidad administrada asociada.
kind	El tipo de servicio.
ManagedServiceIdentityType	Tipo de identidad que se especifica, actualmente Se permiten SystemAssigned y None.
PrivateEndpoint	El recurso Punto de conexión privado.
PrivateEndpointConnection	El recurso Conexión de punto de conexión privado.
PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento actual.
PrivateEndpointServiceConnectionStatus	Estado de conexión del punto de conexión privado.
PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
provisioningState	Estado de aprovisionamiento.
PublicNetworkAccess	Permiso de control para el tráfico del plano de datos procedente de redes públicas mientras el punto de conexión privado está habilitado.
ServiceAccessPolicyEntry	Una entrada de directiva de acceso.
ServiceAcrConfigurationInfo	Información de configuración de Azure Container Registry
ServiceAuthenticationConfigurationInfo	Información de configuración de autenticación
ServiceCorsConfigurationInfo	La configuración de CORS de la instancia de servicio.
ServiceCosmosDbConfigurationInfo	La configuración de la base de datos de Cosmos DB que respalda el servicio.
ServiceExportConfigurationInfo	Exportar información de configuración de la operación
ServiceImportConfigurationInfo	Información de configuración de la operación de importación
ServiceOciArtifactEntry	Un artefacto de Open Container Initiative (OCI).
ServicesDescription	Descripción del servicio.
ServicesProperties	Propiedades de una instancia de servicio.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorDetails

Object

Detalles del error.

Nombre	Tipo	Description
error	ErrorDetailsInternal	Detalles del error

ErrorDetailsInternal

Object

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error.
target	string	Destino del error concreto.

Identity

Object

Configuración que indica si el servicio tiene una identidad administrada asociada.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad del recurso.
tenantId	string	Identificador de inquilino del recurso.
type	ManagedServiceIdentityType	Tipo de identidad que se especifica, actualmente Se permiten SystemAssigned y None.

kind

Enumeración

El tipo de servicio.

Valor	Description
fhir
fhir-R4
fhir-Stu3

ManagedServiceIdentityType

Enumeración

Tipo de identidad que se especifica, actualmente Se permiten SystemAssigned y None.

Valor	Description
None
SystemAssigned

PrivateEndpoint

Object

El recurso Punto de conexión privado.

Nombre	Tipo	Description
id	string	Identificador de ARM para punto de conexión privado

PrivateEndpointConnection

Object

El recurso Conexión de punto de conexión privado.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.privateEndpoint	PrivateEndpoint	Recurso del punto de conexión privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento del recurso de conexión de punto de conexión privado.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeración

Estado de aprovisionamiento actual.

Valor	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeración

Estado de conexión del punto de conexión privado.

Valor	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.

Nombre	Tipo	Description
actionsRequired	string	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
description	string	Motivo de aprobación o rechazo de la conexión.
status	PrivateEndpointServiceConnectionStatus	Indica si el propietario del servicio ha aprobado o rechazado o eliminado la conexión.

provisioningState

Enumeración

Estado de aprovisionamiento.

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

PublicNetworkAccess

Enumeración

Permiso de control para el tráfico del plano de datos procedente de redes públicas mientras el punto de conexión privado está habilitado.

Valor	Description
Disabled
Enabled

ServiceAccessPolicyEntry

Object

Una entrada de directiva de acceso.

Nombre	Tipo	Description
objectId	string pattern: ^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$	Identificador de objeto de Azure AD (usuario o aplicaciones) que permite el acceso al servicio FHIR.

ServiceAcrConfigurationInfo

Object

Información de configuración de Azure Container Registry

Nombre	Tipo	Description
loginServers	string[]	Lista de los servidores de inicio de sesión de ACR.
ociArtifacts	ServiceOciArtifactEntry[]	Lista de artefactos de Open Container Initiative (OCI).

ServiceAuthenticationConfigurationInfo

Object

Información de configuración de autenticación

Nombre	Tipo	Description
audience	string	Dirección URL de audiencia del servicio
authority	string	Dirección URL de autoridad del servicio
smartProxyEnabled	boolean	Si el proxy SMART on FHIR está habilitado

ServiceCorsConfigurationInfo

Object

La configuración de CORS de la instancia de servicio.

Nombre	Tipo	Description
allowCredentials	boolean	Si se permiten credenciales a través de CORS.
headers	string[]	Los encabezados que se van a permitir a través de CORS.
maxAge	integer minimum: 0 maximum: 99999	La edad máxima que se va a permitir a través de CORS.
methods	string[]	Los métodos que se van a permitir a través de CORS.
origins	string[] pattern: ^(?:(?:(?:[hH][tT][tT][pP](?:[sS]\|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?\|[*]))$	Los orígenes que se van a permitir a través de CORS.

ServiceCosmosDbConfigurationInfo

Object

La configuración de la base de datos de Cosmos DB que respalda el servicio.

Nombre	Tipo	Description
keyVaultKeyUri	string	URI de la clave administrada por el cliente para la base de datos de respaldo.
offerThroughput	integer minimum: 400	Rendimiento aprovisionado para la base de datos de respaldo.

ServiceExportConfigurationInfo

Object

Exportar información de configuración de la operación

Nombre	Tipo	Description
storageAccountName	string	Nombre de la cuenta de almacenamiento de exportación predeterminada.

ServiceImportConfigurationInfo

Object

Información de configuración de la operación de importación

Nombre	Tipo	Description
enabled	boolean	Si la operación de importación está habilitada.
initialImportMode	boolean	Si el servicio FHIR está en InitialImportMode.
integrationDataStore	string	Nombre de la cuenta de almacenamiento de integración predeterminada.

ServiceOciArtifactEntry

Object

Un artefacto de Open Container Initiative (OCI).

Nombre	Tipo	Description
digest	string	Resumen del artefacto.
imageName	string	Nombre del artefacto.
loginServer	string	Servidor de inicio de sesión de Azure Container Registry.

ServicesDescription

Object

Descripción del servicio.

Nombre	Tipo	Description
etag	string	ETAG asociado al recurso, que se usa para la simultaneidad optimista al editarlo.
id	string	Identificador de recurso.
identity	Identity	Configuración que indica si el servicio tiene una identidad administrada asociada.
kind	kind	El tipo de servicio.
location	string	Ubicación del recurso.
name	string pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$	Nombre del recurso.
properties	ServicesProperties	Las propiedades comunes de un servicio.
systemData	systemData	Metadatos relativos a la creación y última modificación del recurso.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

ServicesProperties

Object

Propiedades de una instancia de servicio.

Nombre	Tipo	Description
accessPolicies	ServiceAccessPolicyEntry[]	Las directivas de acceso de la instancia de servicio.
acrConfiguration	ServiceAcrConfigurationInfo	La configuración de Azure Container Registry que se usa para convertir la operación de datos de la instancia de servicio.
authenticationConfiguration	ServiceAuthenticationConfigurationInfo	Configuración de autenticación de la instancia de servicio.
corsConfiguration	ServiceCorsConfigurationInfo	La configuración de CORS de la instancia de servicio.
cosmosDbConfiguration	ServiceCosmosDbConfigurationInfo	La configuración de la base de datos de Cosmos DB que respalda el servicio.
exportConfiguration	ServiceExportConfigurationInfo	Configuración de la operación de exportación de la instancia de servicio.
importConfiguration	ServiceImportConfigurationInfo	Configuración de la operación de importación de la instancia de servicio.
privateEndpointConnections	PrivateEndpointConnection[]	Lista de conexiones de punto de conexión privado que están configuradas para este recurso.
provisioningState	provisioningState	Estado de aprovisionamiento.
publicNetworkAccess	PublicNetworkAccess	Permiso de control para el tráfico del plano de datos procedente de redes públicas mientras el punto de conexión privado está habilitado.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Services - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Create or Update a service with all parameters

Solicitud de ejemplo

Respuesta de muestra

Create or Update a service with minimum parameters

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

ErrorDetails

ErrorDetailsInternal

Identity

kind

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

provisioningState

PublicNetworkAccess

ServiceAccessPolicyEntry

ServiceAcrConfigurationInfo

ServiceAuthenticationConfigurationInfo

ServiceCorsConfigurationInfo

ServiceCosmosDbConfigurationInfo

ServiceExportConfigurationInfo

ServiceImportConfigurationInfo

ServiceOciArtifactEntry

ServicesDescription

ServicesProperties

systemData

Recursos adicionales