Udostępnij za pośrednictwem


Services - Create Or Update

Tworzenie lub aktualizowanie metadanych wystąpienia usługi.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
path True

string

Nazwa grupy zasobów zawierającej wystąpienie usługi.

Wzorzec wyrażenia regularnego: ^[-\w\._\(\)]+$

resourceName
path True

string

Nazwa wystąpienia usługi.

subscriptionId
path True

string

Identyfikator subskrypcji.

api-version
query True

string

Wersja interfejsu API klienta.

Treść żądania

Nazwa Wymagane Typ Opis
kind True

kind

Rodzaj usługi.

location True

string

Lokalizacja zasobu.

etag

string

Element etag skojarzony z zasobem, używany do optymistycznej współbieżności podczas jej edytowania.

identity

Identity

Ustawienie wskazujące, czy usługa ma skojarzona tożsamość zarządzaną.

properties

ServicesProperties

Typowe właściwości usługi.

tags

object

Tagi zasobów.

Odpowiedzi

Nazwa Typ Opis
200 OK

ServicesDescription

Zaktualizowano — umieść żądanie zaakceptowane i jest aktualizowany istniejący zasób; operacja zostanie ukończona asynchronicznie.

201 Created

ServicesDescription

Utworzone — umieść żądanie zaakceptowane i utworzono nowy zasób; operacja zostanie ukończona asynchronicznie.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Create or Update a service with all parameters
Create or Update a service with minimum parameters

Create or Update a service with all parameters

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
createdByType

Typ tożsamości, która utworzyła zasób.

ErrorDetails

Szczegóły błędu.

ErrorDetailsInternal

Szczegóły błędu.

Identity

Ustawienie wskazujące, czy usługa ma skojarzona tożsamość zarządzaną.

kind

Rodzaj usługi.

ManagedServiceIdentityType

Typ określonej tożsamości, obecnie SystemAssigned i None są dozwolone.

PrivateEndpoint

Zasób prywatnego punktu końcowego.

PrivateEndpointConnection

Zasób połączenia z prywatnym punktem końcowym.

PrivateEndpointConnectionProvisioningState

Bieżący stan aprowizacji.

PrivateEndpointServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego.

PrivateLinkServiceConnectionState

Kolekcja informacji o stanie połączenia między konsumentem usługi a dostawcą.

provisioningState

Stan aprowizacji.

PublicNetworkAccess

Uprawnienia do kontrolowania ruchu płaszczyzny danych pochodzącego z sieci publicznych, gdy prywatny punkt końcowy jest włączony.

ServiceAccessPolicyEntry

Wpis zasad dostępu.

ServiceAcrConfigurationInfo

Informacje o konfiguracji usługi Azure Container Registry

ServiceAuthenticationConfigurationInfo

Informacje o konfiguracji uwierzytelniania

ServiceCorsConfigurationInfo

Ustawienia konfiguracji mechanizmu CORS wystąpienia usługi.

ServiceCosmosDbConfigurationInfo

Ustawienia bazy danych Cosmos DB, która wspiera usługę.

ServiceExportConfigurationInfo

Informacje o konfiguracji operacji eksportowania

ServiceImportConfigurationInfo

Informacje o konfiguracji operacji importowania

ServiceOciArtifactEntry

Artefakt Open Container Initiative (OCI).

ServicesDescription

Opis usługi.

ServicesProperties

Właściwości wystąpienia usługi.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

Szczegóły błędu.

Nazwa Typ Opis
error

ErrorDetailsInternal

Szczegóły błędu

ErrorDetailsInternal

Szczegóły błędu.

Nazwa Typ Opis
code

string

Kod błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy określonego błędu.

Identity

Ustawienie wskazujące, czy usługa ma skojarzona tożsamość zarządzaną.

Nazwa Typ Opis
principalId

string

Identyfikator podmiotu zabezpieczeń tożsamości zasobu.

tenantId

string

Identyfikator dzierżawy zasobu.

type

ManagedServiceIdentityType

Typ określonej tożsamości, obecnie SystemAssigned i None są dozwolone.

kind

Rodzaj usługi.

Nazwa Typ Opis
fhir

string

fhir-R4

string

fhir-Stu3

string

ManagedServiceIdentityType

Typ określonej tożsamości, obecnie SystemAssigned i None są dozwolone.

Nazwa Typ Opis
None

string

SystemAssigned

string

PrivateEndpoint

Zasób prywatnego punktu końcowego.

Nazwa Typ Opis
id

string

Identyfikator usługi ARM dla prywatnego punktu końcowego

PrivateEndpointConnection

Zasób połączenia z prywatnym punktem końcowym.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nazwa zasobu

properties.privateEndpoint

PrivateEndpoint

Zasób prywatnego punktu końcowego.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Kolekcja informacji o stanie połączenia między konsumentem usługi a dostawcą.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Stan aprowizacji zasobu połączenia prywatnego punktu końcowego.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Bieżący stan aprowizacji.

Nazwa Typ Opis
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego.

Nazwa Typ Opis
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Kolekcja informacji o stanie połączenia między konsumentem usługi a dostawcą.

Nazwa Typ Opis
actionsRequired

string

Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji u konsumenta.

description

string

Przyczyna zatwierdzenia/odrzucenia połączenia.

status

PrivateEndpointServiceConnectionStatus

Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.

provisioningState

Stan aprowizacji.

Nazwa Typ Opis
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

Uprawnienia do kontrolowania ruchu płaszczyzny danych pochodzącego z sieci publicznych, gdy prywatny punkt końcowy jest włączony.

Nazwa Typ Opis
Disabled

string

Enabled

string

ServiceAccessPolicyEntry

Wpis zasad dostępu.

Nazwa Typ Opis
objectId

string

Identyfikator obiektu Azure AD (użytkownik lub aplikacje), który może uzyskać dostęp do usługi FHIR.

ServiceAcrConfigurationInfo

Informacje o konfiguracji usługi Azure Container Registry

Nazwa Typ Opis
loginServers

string[]

Lista serwerów logowania usługi ACR.

ociArtifacts

ServiceOciArtifactEntry[]

Lista artefaktów Open Container Initiative (OCI).

ServiceAuthenticationConfigurationInfo

Informacje o konfiguracji uwierzytelniania

Nazwa Typ Opis
audience

string

Adres URL odbiorców usługi

authority

string

Adres URL urzędu dla usługi

smartProxyEnabled

boolean

Jeśli włączono funkcję SMART na serwerze proxy FHIR

ServiceCorsConfigurationInfo

Ustawienia konfiguracji mechanizmu CORS wystąpienia usługi.

Nazwa Typ Opis
allowCredentials

boolean

Jeśli poświadczenia są dozwolone za pośrednictwem mechanizmu CORS.

headers

string[]

Nagłówki mogą być dozwolone za pośrednictwem mechanizmu CORS.

maxAge

integer

Maksymalny wiek dozwolony za pośrednictwem mechanizmu CORS.

methods

string[]

Metody, które mają być dozwolone za pośrednictwem mechanizmu CORS.

origins

string[]

Źródła mogą być dozwolone za pośrednictwem mechanizmu CORS.

ServiceCosmosDbConfigurationInfo

Ustawienia bazy danych Cosmos DB, która wspiera usługę.

Nazwa Typ Opis
keyVaultKeyUri

string

Identyfikator URI klucza zarządzanego przez klienta dla bazy danych kopii zapasowej.

offerThroughput

integer

Aprowizowana przepływność dla bazy danych kopii zapasowej.

ServiceExportConfigurationInfo

Informacje o konfiguracji operacji eksportowania

Nazwa Typ Opis
storageAccountName

string

Nazwa domyślnego konta magazynu eksportu.

ServiceImportConfigurationInfo

Informacje o konfiguracji operacji importowania

Nazwa Typ Opis
enabled

boolean

Jeśli operacja importowania jest włączona.

initialImportMode

boolean

Jeśli usługa FHIR jest w trybie InitialImportMode.

integrationDataStore

string

Nazwa domyślnego konta magazynu integracji.

ServiceOciArtifactEntry

Artefakt Open Container Initiative (OCI).

Nazwa Typ Opis
digest

string

Podsumowanie artefaktu.

imageName

string

Nazwa artefaktu.

loginServer

string

Serwer logowania Azure Container Registry.

ServicesDescription

Opis usługi.

Nazwa Typ Opis
etag

string

Element etag skojarzony z zasobem, używany do optymistycznej współbieżności podczas jej edytowania.

id

string

Identyfikator zasobu.

identity

Identity

Ustawienie wskazujące, czy usługa ma skojarzona tożsamość zarządzaną.

kind

kind

Rodzaj usługi.

location

string

Lokalizacja zasobu.

name

string

Nazwa zasobu.

properties

ServicesProperties

Typowe właściwości usługi.

systemData

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

tags

object

Tagi zasobów.

type

string

Typ zasobu.

ServicesProperties

Właściwości wystąpienia usługi.

Nazwa Typ Opis
accessPolicies

ServiceAccessPolicyEntry[]

Zasady dostępu wystąpienia usługi.

acrConfiguration

ServiceAcrConfigurationInfo

Ustawienia rejestru kontenerów platformy Azure używane do konwersji danych wystąpienia usługi.

authenticationConfiguration

ServiceAuthenticationConfigurationInfo

Konfiguracja uwierzytelniania dla wystąpienia usługi.

corsConfiguration

ServiceCorsConfigurationInfo

Ustawienia konfiguracji mechanizmu CORS wystąpienia usługi.

cosmosDbConfiguration

ServiceCosmosDbConfigurationInfo

Ustawienia bazy danych Cosmos DB, która wspiera usługę.

exportConfiguration

ServiceExportConfigurationInfo

Ustawienia operacji eksportowania wystąpienia usługi.

importConfiguration

ServiceImportConfigurationInfo

Ustawienia operacji importowania wystąpienia usługi.

privateEndpointConnections

PrivateEndpointConnection[]

Lista połączeń prywatnych punktów końcowych skonfigurowanych dla tego zasobu.

provisioningState

provisioningState

Stan aprowizacji.

publicNetworkAccess

PublicNetworkAccess

Uprawnienia do kontrolowania ruchu płaszczyzny danych pochodzącego z sieci publicznych, gdy prywatny punkt końcowy jest włączony.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobów (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.