Compartir a través de


Services - Create Or Update

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

Nombre del grupo de recursos que contiene la instancia de servicio.

Patrón de Regex: ^[-\w\._\(\)]+$

resourceName
path True

string

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

Una etag asociada al recurso, que se usa para la simultaneidad optimista al editarlo.

identity

Identity

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

properties

ServicesProperties

Propiedades comunes de un servicio.

tags

object

Etiquetas del recurso.

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 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 suplantación de su 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"
  }
}

Respuesta de muestra

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1",
  "name": "service1",
  "location": "West US 2",
  "type": "Microsoft.HealthcareApis/services",
  "kind": "fhir-R4",
  "etag": "etagvalue",
  "tags": {},
  "properties": {
    "provisioningState": "Creating",
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      },
      {
        "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f"
      }
    ],
    "cosmosDbConfiguration": {
      "offerThroughput": 1000,
      "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key"
    },
    "authenticationConfiguration": {
      "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
      "audience": "https://azurehealthcareapis.com",
      "smartProxyEnabled": true
    },
    "corsConfiguration": {
      "origins": [
        "*"
      ],
      "headers": [
        "*"
      ],
      "methods": [
        "DELETE",
        "GET",
        "OPTIONS",
        "PATCH",
        "POST",
        "PUT"
      ],
      "maxAge": 1440,
      "allowCredentials": false
    },
    "exportConfiguration": {
      "storageAccountName": "existingStorageAccount"
    },
    "privateEndpointConnections": [],
    "publicNetworkAccess": "Disabled"
  },
  "identity": {
    "principalId": "03fe6ae0-952c-4e4b-954b-cc0364dd252e",
    "tenantId": "72f988bf-86f1-41af-91ab-2d8cd011db47",
    "type": "SystemAssigned"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1",
  "name": "service1",
  "location": "West US 2",
  "type": "Microsoft.HealthcareApis/services",
  "kind": "fhir-R4",
  "etag": "etagvalue",
  "tags": {},
  "properties": {
    "provisioningState": "Creating",
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      },
      {
        "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f"
      }
    ],
    "cosmosDbConfiguration": {
      "offerThroughput": 1000
    },
    "authenticationConfiguration": {
      "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
      "audience": "https://azurehealthcareapis.com",
      "smartProxyEnabled": true
    },
    "corsConfiguration": {
      "origins": [
        "*"
      ],
      "headers": [
        "*"
      ],
      "methods": [
        "DELETE",
        "GET",
        "OPTIONS",
        "PATCH",
        "POST",
        "PUT"
      ],
      "maxAge": 1440,
      "allowCredentials": false
    },
    "exportConfiguration": {
      "storageAccountName": "existingStorageAccount"
    },
    "privateEndpointConnections": [],
    "publicNetworkAccess": "Disabled"
  },
  "identity": {
    "principalId": "03fe6ae0-952c-4e4b-954b-cc0364dd252e",
    "tenantId": "72f988bf-86f1-41af-91ab-2d8cd011db47",
    "type": "SystemAssigned"
  }
}

Create or Update a service with minimum parameters

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

Respuesta de muestra

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service2",
  "name": "service2",
  "type": "Microsoft.HealthcareApis/services",
  "etag": "etagvalue",
  "location": "westus2",
  "kind": "fhir-R4",
  "tags": {},
  "properties": {
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      }
    ],
    "cosmosDbConfiguration": {
      "offerThroughput": 1000
    },
    "authenticationConfiguration": {
      "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
      "audience": "https://azurehealthcareapis.com",
      "smartProxyEnabled": false
    },
    "corsConfiguration": {
      "origins": [],
      "headers": [],
      "methods": [],
      "maxAge": null,
      "allowCredentials": false
    },
    "provisioningState": "Creating",
    "privateEndpointConnections": [],
    "publicNetworkAccess": "Disabled"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service2",
  "name": "service2",
  "type": "Microsoft.HealthcareApis/services",
  "etag": "etagvalue",
  "location": "westus2",
  "kind": "fhir-R4",
  "tags": {},
  "properties": {
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      }
    ],
    "cosmosDbConfiguration": {
      "offerThroughput": 1000,
      "keyVaultKeyUri": null
    },
    "authenticationConfiguration": {
      "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
      "audience": "https://azurehealthcareapis.com",
      "smartProxyEnabled": false
    },
    "corsConfiguration": {
      "origins": [],
      "headers": [],
      "methods": [],
      "maxAge": null,
      "allowCredentials": false
    },
    "provisioningState": "Creating",
    "privateEndpointConnections": [],
    "publicNetworkAccess": "Disabled"
  }
}

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 asociada una identidad administrada.

kind

El tipo de servicio.

ManagedServiceIdentityType

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

PrivateEndpoint

Recurso de punto de conexión privado.

PrivateEndpointConnection

Recurso de 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 está habilitado el punto de conexión privado.

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

Información de configuración de la operación de exportación

ServiceImportConfigurationInfo

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

ServiceOciArtifactEntry

Un artefacto de Open Container Initiative (OCI).

ServicesDescription

La descripción del servicio.

ServicesProperties

Propiedades de una instancia de servicio.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

createdByType

Tipo de identidad que creó el recurso.

Nombre Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

Detalles del error.

Nombre Tipo Description
error

ErrorDetailsInternal

Detalles del error

ErrorDetailsInternal

Detalles del error.

Nombre Tipo Description
code

string

Código de error.

message

string

El mensaje de error.

target

string

Destino del error determinado.

Identity

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

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

El tipo de servicio.

Nombre Tipo Description
fhir

string

fhir-R4

string

fhir-Stu3

string

ManagedServiceIdentityType

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

Nombre Tipo Description
None

string

SystemAssigned

string

PrivateEndpoint

Recurso de punto de conexión privado.

Nombre Tipo Description
id

string

El identificador de ARM para el punto de conexión privado

PrivateEndpointConnection

Recurso de conexión de punto de conexión privado.

Nombre Tipo Description
id

string

Identificador de recurso completo del 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 de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Estado de aprovisionamiento actual.

Nombre Tipo Description
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

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

Nombre Tipo Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

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, rechazado o quitado la conexión.

provisioningState

Estado de aprovisionamiento.

Nombre 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

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

Nombre Tipo Description
Disabled

string

Enabled

string

ServiceAccessPolicyEntry

Una entrada de directiva de acceso.

Nombre Tipo Description
objectId

string

Identificador de objeto de Azure AD (usuario o aplicaciones) que permite el acceso al servicio FHIR.

ServiceAcrConfigurationInfo

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

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

La configuración de 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

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[]

Los orígenes que se permitirán a través de CORS.

ServiceCosmosDbConfigurationInfo

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

Nombre Tipo Description
keyVaultKeyUri

string

Identificador URI de la clave administrada por el cliente para la base de datos de respaldo.

offerThroughput

integer

Rendimiento aprovisionado para la base de datos de respaldo.

ServiceExportConfigurationInfo

Información de configuración de la operación de exportación

Nombre Tipo Description
storageAccountName

string

Nombre de la cuenta de almacenamiento de exportación predeterminada.

ServiceImportConfigurationInfo

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

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

La descripción del servicio.

Nombre Tipo Description
etag

string

Una etag asociada al recurso, que se usa para la simultaneidad optimista al editarlo.

id

string

Identificador del recurso.

identity

Identity

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

kind

kind

El tipo de servicio.

location

string

Ubicación del recurso.

name

string

Nombre del recurso.

properties

ServicesProperties

Propiedades comunes de un servicio.

systemData

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

tags

object

Etiquetas del recurso.

type

string

El tipo de recurso.

ServicesProperties

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 del registro de contenedor de Azure que se usa para convertir la operación de datos de la instancia de servicio.

authenticationConfiguration

ServiceAuthenticationConfigurationInfo

Configuración de autenticación para la instancia de servicio.

corsConfiguration

ServiceCorsConfigurationInfo

La configuración de 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

La configuración de la operación de exportación de la instancia de servicio.

importConfiguration

ServiceImportConfigurationInfo

La 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 está habilitado el punto de conexión privado.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre Tipo Description
createdAt

string

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

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.