Compartilhar via


Services - Create Or Update

Crie ou atualize 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 de URI

Nome Em Obrigató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 assinatura.

api-version
query True

string

Versão da API do cliente.

Corpo da solicitação

Nome Obrigatório Tipo Description
kind True

kind

O tipo de serviço.

location True

string

O local do recurso.

etag

string

Uma etag associada ao recurso, usada para simultaneidade otimista ao editá-lo.

identity

Identity

Configuração que indica se o serviço tem uma identidade gerenciada associada a ele.

properties

ServicesProperties

As propriedades comuns de um serviço.

tags

object

As marcas do recurso.

Respostas

Nome Tipo Description
200 OK

ServicesDescription

Atualizado – solicitação put aceita e um recurso existente está sendo atualizado; a operação será concluída de forma assíncrona.

201 Created

ServicesDescription

Criado – Solicitação put aceita e um novo recurso foi criado; a operação será concluída de forma assíncrona.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

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

Solicitação de exemplo

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

Resposta de exemplo

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

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
createdByType

O tipo de identidade que criou o recurso.

ErrorDetails

Detalhes do erro.

ErrorDetailsInternal

Detalhes do erro.

Identity

Configuração que indica se o serviço tem uma identidade gerenciada associada a ele.

kind

O tipo de serviço.

ManagedServiceIdentityType

Tipo de identidade que está sendo especificada, atualmente SystemAssigned e None são permitidos.

PrivateEndpoint

O recurso ponto de extremidade privado.

PrivateEndpointConnection

O recurso conexão de ponto de extremidade privado.

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

PrivateEndpointServiceConnectionStatus

A conexão do ponto de extremidade privado status.

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

provisioningState

O estado de provisionamento.

PublicNetworkAccess

Permissão de controle para o tráfego do plano de dados proveniente de redes públicas enquanto o ponto de extremidade privado está habilitado.

ServiceAccessPolicyEntry

Uma entrada de política de acesso.

ServiceAcrConfigurationInfo

Informações de configuração do Registro de Contêiner do Azure

ServiceAuthenticationConfigurationInfo

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

ServiceCorsConfigurationInfo

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

ServiceCosmosDbConfigurationInfo

As configurações do banco de dados do Cosmos DB que dão suporte ao serviço.

ServiceExportConfigurationInfo

Exportar informações de configuração da operação

ServiceImportConfigurationInfo

Importar informações de configuração da operação

ServiceOciArtifactEntry

Um artefato OCI (Open Container Initiative).

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.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

Detalhes do erro.

Nome Tipo Description
error

ErrorDetailsInternal

Detalhes do erro

ErrorDetailsInternal

Detalhes do erro.

Nome Tipo Description
code

string

O código de erro.

message

string

A mensagem de erro.

target

string

O destino do erro específico.

Identity

Configuração que indica se o serviço tem uma identidade gerenciada associada a ele.

Nome Tipo Description
principalId

string

A ID da entidade de segurança da identidade do recurso.

tenantId

string

A ID do locatário do recurso.

type

ManagedServiceIdentityType

Tipo de identidade que está sendo especificada, atualmente SystemAssigned e None são permitidos.

kind

O tipo de serviço.

Nome Tipo Description
fhir

string

fhir-R4

string

fhir-Stu3

string

ManagedServiceIdentityType

Tipo de identidade que está sendo especificada, atualmente SystemAssigned e None são permitidos.

Nome Tipo Description
None

string

SystemAssigned

string

PrivateEndpoint

O recurso ponto de extremidade privado.

Nome Tipo Description
id

string

O identificador do ARM para o ponto de extremidade privado

PrivateEndpointConnection

O recurso conexão de ponto de extremidade privado.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada 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 de extremidade privado.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

O estado de provisionamento do recurso de conexão de ponto de extremidade privado.

type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

Nome Tipo Description
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

A conexão do ponto de extremidade privado status.

Nome Tipo Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

Nome Tipo Description
actionsRequired

string

Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor.

description

string

O motivo da aprovação/rejeição da conexão.

status

PrivateEndpointServiceConnectionStatus

Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.

provisioningState

O estado de provisionamento.

Nome 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 controle para o tráfego do plano de dados proveniente de redes públicas enquanto o ponto de extremidade privado está habilitado.

Nome Tipo Description
Disabled

string

Enabled

string

ServiceAccessPolicyEntry

Uma entrada de política de acesso.

Nome Tipo Description
objectId

string

Uma ID de objeto Azure AD (Usuário ou Aplicativos) que tem permissão de acesso ao serviço FHIR.

ServiceAcrConfigurationInfo

Informações de configuração do Registro de Contêiner do Azure

Nome Tipo Description
loginServers

string[]

A lista dos servidores de logon do ACR.

ociArtifacts

ServiceOciArtifactEntry[]

A lista de artefatos da OCI (Open Container Initiative).

ServiceAuthenticationConfigurationInfo

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

Nome Tipo Description
audience

string

A URL do público-alvo do serviço

authority

string

A URL de autoridade para o serviço

smartProxyEnabled

boolean

Se o proxy SMART on FHIR estiver habilitado

ServiceCorsConfigurationInfo

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

Nome Tipo Description
allowCredentials

boolean

Se as credenciais forem permitidas por meio do CORS.

headers

string[]

Os cabeçalhos a serem permitidos por meio do CORS.

maxAge

integer

A idade máxima a ser permitida por meio do CORS.

methods

string[]

Os métodos a serem permitidos por meio do CORS.

origins

string[]

As origens a serem permitidas por meio do CORS.

ServiceCosmosDbConfigurationInfo

As configurações do banco de dados do Cosmos DB que dão suporte ao serviço.

Nome Tipo Description
keyVaultKeyUri

string

O URI da chave gerenciada pelo cliente para o banco de dados de backup.

offerThroughput

integer

A taxa de transferência provisionada para o banco de dados de backup.

ServiceExportConfigurationInfo

Exportar informações de configuração da operação

Nome Tipo Description
storageAccountName

string

O nome da conta de armazenamento de exportação padrão.

ServiceImportConfigurationInfo

Importar informações de configuração da operação

Nome Tipo Description
enabled

boolean

Se a operação de importação estiver habilitada.

initialImportMode

boolean

Se o serviço FHIR estiver em InitialImportMode.

integrationDataStore

string

O nome da conta de armazenamento de integração padrão.

ServiceOciArtifactEntry

Um artefato OCI (Open Container Initiative).

Nome Tipo Description
digest

string

O resumo do artefato.

imageName

string

O nome do artefato.

loginServer

string

O Registro de Contêiner do Azure servidor de logon.

ServicesDescription

A descrição do serviço.

Nome Tipo Description
etag

string

Uma etag associada ao recurso, usada para simultaneidade otimista ao editá-lo.

id

string

O identificador do recurso.

identity

Identity

Configuração que indica se o serviço tem uma identidade gerenciada associada a ele.

kind

kind

O tipo de serviço.

location

string

O local 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 marcas do recurso.

type

string

O tipo de recurso.

ServicesProperties

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

Nome Tipo Description
accessPolicies

ServiceAccessPolicyEntry[]

As políticas de acesso da instância de serviço.

acrConfiguration

ServiceAcrConfigurationInfo

As configurações do Registro de Contêiner do Azure usadas para a operação de conversão de dados da instância de serviço.

authenticationConfiguration

ServiceAuthenticationConfigurationInfo

A configuração de autenticação para a instância de serviço.

corsConfiguration

ServiceCorsConfigurationInfo

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

cosmosDbConfiguration

ServiceCosmosDbConfigurationInfo

As configurações do banco de dados do Cosmos DB que dão suporte ao serviço.

exportConfiguration

ServiceExportConfigurationInfo

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

importConfiguration

ServiceImportConfigurationInfo

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

privateEndpointConnections

PrivateEndpointConnection[]

A lista de conexões de ponto de extremidade privado configuradas para esse recurso.

provisioningState

provisioningState

O estado de provisionamento.

publicNetworkAccess

PublicNetworkAccess

Permissão de controle para o tráfego do plano de dados proveniente de redes públicas enquanto o ponto de extremidade privado está habilitado.

systemData

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

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