Services - Create Or Update
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 |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do grupo de recursos que contém a instância de serviço. Padrão Regex: |
resource
|
path | True |
string |
O nome da instância de serviço. |
subscription
|
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 |
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 |
Definição que indica se o serviço tem uma identidade gerida associada. |
||
properties |
As propriedades comuns de um serviço. |
||
tags |
object |
As etiquetas de recursos. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
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 |
Criado - Coloque o pedido aceite e foi criado um novo recurso; a operação será concluída de forma assíncrona. |
|
Other Status Codes |
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
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 da amostra
{
"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
Pedido de amostra
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 da amostra
{
"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
Name | Description |
---|---|
created |
O tipo de identidade que criou o recurso. |
Error |
Detalhes do erro. |
Error |
Detalhes do erro. |
Identity |
Definição que indica se o serviço tem uma identidade gerida associada. |
kind |
O tipo de serviço. |
Managed |
O tipo de identidade que está a ser especificado, atualmente SystemAssigned e None são permitidos. |
Private |
O recurso ponto final privado. |
Private |
O recurso Ligação de Ponto Final Privado. |
Private |
O estado de aprovisionamento atual. |
Private |
O estado da ligação do ponto final privado. |
Private |
Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor de serviços. |
provisioning |
O estado de aprovisionamento. |
Public |
Permissão de controlo do tráfego do plano de dados proveniente de redes públicas enquanto o ponto final privado está ativado. |
Service |
Uma entrada de política de acesso. |
Service |
Informações de configuração do Azure Container Registry |
Service |
Informações de configuração da autenticação |
Service |
As definições para a configuração CORS da instância de serviço. |
Service |
As definições da base de dados do Cosmos DB que suporta o serviço. |
Service |
Informações de configuração da operação de exportação |
Service |
Informações de configuração da operação de importação |
Service |
Um artefacto Open Container Initiative (OCI). |
Services |
A descrição do serviço. |
Services |
As propriedades de uma instância de serviço. |
system |
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 |
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 |
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 |
O recurso do ponto final privado. |
|
properties.privateLinkServiceConnectionState |
Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor de serviços. |
|
properties.provisioningState |
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 |
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 |
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 |
Definição que indica se o serviço tem uma identidade gerida associada. |
|
kind |
O tipo de serviço. |
|
location |
string |
A localização do recurso. |
name |
string |
O nome do recurso. |
properties |
As propriedades comuns de um serviço. |
|
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 |
As políticas de acesso da instância de serviço. |
|
acrConfiguration |
As definições do azure container registry utilizadas para converter a operação de dados da instância de serviço. |
|
authenticationConfiguration |
A configuração de autenticação da instância de serviço. |
|
corsConfiguration |
As definições para a configuração CORS da instância de serviço. |
|
cosmosDbConfiguration |
As definições da base de dados do Cosmos DB que suporta o serviço. |
|
exportConfiguration |
As definições para a operação de exportação da instância de serviço. |
|
importConfiguration |
As definições para a operação de importação da instância de serviço. |
|
privateEndpointConnections |
A lista de ligações de ponto final privado que estão configuradas para este recurso. |
|
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. |
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 |
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 |
O tipo de identidade que modificou o recurso pela última vez. |