Microsoft. Usługi HealthcareApis 2022-10-01-preview

• Najnowsza
• 2022-10-01-preview
• 2022-06-01
• 2022-05-15
• 2022-01-31-preview
• 2021-11-01
• 2021-06-01-preview
• 2021-01-11
• 2020-03-30
• 2020-03-15
• 2019-09-16
• 2018-08-20-preview

Definicja zasobu Bicep

Typ zasobu usług można wdrożyć w następujących elementach:

• Grupy zasobów — zobacz polecenia wdrażania grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć Microsoft. Zasób HealthcareApis/services dodaj do szablonu następujący kod Bicep.

resource symbolicname 'Microsoft.HealthcareApis/services@2022-10-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  etag: 'string'
  identity: {
    type: 'string'
  }
  properties: {
    accessPolicies: [
      {
        objectId: 'string'
      }
    ]
    acrConfiguration: {
      loginServers: [
        'string'
      ]
      ociArtifacts: [
        {
          digest: 'string'
          imageName: 'string'
          loginServer: 'string'
        }
      ]
    }
    authenticationConfiguration: {
      audience: 'string'
      authority: 'string'
      smartProxyEnabled: bool
    }
    corsConfiguration: {
      allowCredentials: bool
      headers: [
        'string'
      ]
      maxAge: int
      methods: [
        'string'
      ]
      origins: [
        'string'
      ]
    }
    cosmosDbConfiguration: {
      keyVaultKeyUri: 'string'
      offerThroughput: int
    }
    exportConfiguration: {
      storageAccountName: 'string'
    }
    importConfiguration: {
      enabled: bool
      initialImportMode: bool
      integrationDataStore: 'string'
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
  }
}

Wartości właściwości

services

Nazwa	Opis	Wartość
name	Nazwa zasobu	ciąg (wymagany)
location	Lokalizacja zasobu.	ciąg (wymagany)
tags	Tagi zasobów.	Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
Rodzaju	Rodzaj usługi.	"fhir" "fhir-R4" "fhir-Stu3" (wymagane)
Etag	Etag skojarzony z zasobem, używany do optymistycznej współbieżności podczas edytowania.	ciąg
identity	Ustawienie wskazujące, czy usługa ma skojarzona tożsamość zarządzaną.	ServicesResourceIdentity
properties	Typowe właściwości usługi.	ServicesProperties

ServicesResourceIdentity

Nazwa	Opis	Wartość
typ	Określony typ tożsamości, obecnie systemAssigned i None są dozwolone.	"Brak" "SystemAssigned"

ServicesProperties

Nazwa	Opis	Wartość
accessPolicies	Zasady dostępu wystąpienia usługi.	ServiceAccessPolicyEntry[]
acrConfiguration	Ustawienia rejestru kontenerów platformy Azure używane do konwertowania operacji danych wystąpienia usługi.	ServiceAcrConfigurationInfo
authenticationConfiguration	Konfiguracja uwierzytelniania dla wystąpienia usługi.	ServiceAuthenticationConfigurationInfo
corsConfiguration	Ustawienia konfiguracji mechanizmu CORS wystąpienia usługi.	ServiceCorsConfigurationInfo
cosmosDbConfiguration	Ustawienia bazy danych Cosmos DB, która jest kopią zapasową usługi.	ServiceCosmosDbConfigurationInfo
exportConfiguration	Ustawienia operacji eksportowania wystąpienia usługi.	ServiceExportConfigurationInfo
importConfiguration	Ustawienia operacji importowania wystąpienia usługi.	ServiceImportConfigurationInfo
privateEndpointConnections	Lista połączeń prywatnego punktu końcowego skonfigurowanych dla tego zasobu.	PrivateEndpointConnection[]
publicNetworkAccess	Uprawnienie do kontrolowania ruchu płaszczyzny danych pochodzącego z sieci publicznych, gdy prywatny punkt końcowy jest włączony.	"Wyłączone" "Włączone"

ServiceAccessPolicyEntry

Nazwa	Opis	Wartość
objectId	Identyfikator obiektu Azure AD (użytkownik lub aplikacje), który może uzyskać dostęp do usługi FHIR.	ciąg (wymagany)

ServiceAcrConfigurationInfo

Nazwa	Opis	Wartość
loginServers	Lista serwerów logowania usługi ACR.	ciąg[]
ociArtifacts	Lista artefaktów Open Container Initiative (OCI).	ServiceOciArtifactEntry[]

ServiceOciArtifactEntry

Nazwa	Opis	Wartość
digest	Podsumowanie artefaktu.	ciąg
Imagename	Nazwa artefaktu.	ciąg
loginServer	Serwer logowania Azure Container Registry.	ciąg

ServiceAuthenticationConfigurationInfo

Nazwa	Opis	Wartość
Publiczności	Adres URL odbiorców usługi	ciąg
Organ	Adres URL urzędu dla usługi	ciąg
smartProxyEnabled	Jeśli włączono funkcję SMART na serwerze proxy FHIR	bool

ServiceCorsConfigurationInfo

Nazwa	Opis	Wartość
allowCredentials	Jeśli poświadczenia są dozwolone za pośrednictwem mechanizmu CORS.	bool
Nagłówki	Nagłówki mogą być dozwolone za pośrednictwem mechanizmu CORS.	ciąg[]
Maxage	Maksymalny wiek dozwolony za pośrednictwem mechanizmu CORS.	int
methods	Metody, które mają być dozwolone za pośrednictwem mechanizmu CORS.	ciąg[]
Pochodzenia	Źródła mogą być dozwolone za pośrednictwem mechanizmu CORS.	ciąg[]

ServiceCosmosDbConfigurationInfo

Nazwa	Opis	Wartość
keyVaultKeyUri	Identyfikator URI klucza zarządzanego przez klienta dla bazy danych kopii zapasowej.	ciąg
offerThroughput	Aprowizowana przepływność dla bazy danych kopii zapasowej.	int

ServiceExportConfigurationInfo

Nazwa	Opis	Wartość
storageAccountName	Nazwa domyślnego konta magazynu eksportu.	ciąg

ServiceImportConfigurationInfo

Nazwa	Opis	Wartość
enabled	Jeśli operacja importowania jest włączona.	bool
initialImportMode	Jeśli usługa FHIR jest w trybie InitialImportMode.	bool
integrationDataStore	Nazwa domyślnego konta magazynu integracji.	ciąg

PrivateEndpointConnection

Nazwa	Opis	Wartość
properties	Właściwości zasobu.	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nazwa	Opis	Wartość
privateEndpoint	Zasób prywatnego punktu końcowego.	PrivateEndpoint
privateLinkServiceConnectionState	Kolekcja informacji o stanie połączenia między konsumentem usługi a dostawcą.	PrivateLinkServiceConnectionState (wymagane)

PrivateEndpoint

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

PrivateLinkServiceConnectionState

Nazwa	Opis	Wartość
actionsRequired	Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji u konsumenta.	ciąg
description (opis)	Przyczyna zatwierdzenia/odrzucenia połączenia.	ciąg
status	Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.	"Zatwierdzone" "Oczekujące" "Odrzucono"

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Template	Opis
Wdrażanie usługi Azure API for FHIR	Ten szablon tworzy wystąpienie usługi Azure API for FHIR®. Interfejs API platformy Azure for FHIR® to zarządzana, oparta na standardach i zgodna platforma danych opieki zdrowotnej. Umożliwia organizacjom wprowadzanie danych zdrowotnych klinicznych do chmury na podstawie standardu FHIR® danych wzajemnie współpracujących.

Definicja zasobu szablonu usługi ARM

Typ zasobu usług można wdrożyć w następujących elementach:

• Grupy zasobów — zobacz polecenia wdrażania grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć Microsoft. Zasób HealthcareApis/services dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.HealthcareApis/services",
  "apiVersion": "2022-10-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "etag": "string",
  "identity": {
    "type": "string"
  },
  "properties": {
    "accessPolicies": [
      {
        "objectId": "string"
      }
    ],
    "acrConfiguration": {
      "loginServers": [ "string" ],
      "ociArtifacts": [
        {
          "digest": "string",
          "imageName": "string",
          "loginServer": "string"
        }
      ]
    },
    "authenticationConfiguration": {
      "audience": "string",
      "authority": "string",
      "smartProxyEnabled": "bool"
    },
    "corsConfiguration": {
      "allowCredentials": "bool",
      "headers": [ "string" ],
      "maxAge": "int",
      "methods": [ "string" ],
      "origins": [ "string" ]
    },
    "cosmosDbConfiguration": {
      "keyVaultKeyUri": "string",
      "offerThroughput": "int"
    },
    "exportConfiguration": {
      "storageAccountName": "string"
    },
    "importConfiguration": {
      "enabled": "bool",
      "initialImportMode": "bool",
      "integrationDataStore": "string"
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string"
  }
}

Wartości właściwości

services

Nazwa	Opis	Wartość
typ	Typ zasobu	"Microsoft. HealthcareApis/services'
apiVersion	Wersja interfejsu API zasobów	"2022-10-01-preview"
name	Nazwa zasobu	ciąg (wymagany)
location	Lokalizacja zasobu.	ciąg (wymagany)
tags	Tagi zasobów.	Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
Rodzaju	Rodzaj usługi.	"Fhir" "fhir-R4" "fhir-Stu3" (wymagane)
Etag	Element etag skojarzony z zasobem używany do optymistycznej współbieżności podczas jej edytowania.	ciąg
identity	Ustawienie wskazujące, czy usługa ma skojarzona tożsamość zarządzaną.	ServicesResourceIdentity
properties	Typowe właściwości usługi.	UsługiWłaściwości

ServicesResourceIdentity

Nazwa	Opis	Wartość
typ	Typ określonej tożsamości, obecnie SystemAssigned i None są dozwolone.	"Brak" "SystemAssigned"

UsługiWłaściwości

Nazwa	Opis	Wartość
accessPolicies	Zasady dostępu wystąpienia usługi.	ServiceAccessPolicyEntry[]
acrConfiguration	Ustawienia rejestru kontenerów platformy Azure używane do konwersji danych wystąpienia usługi.	ServiceAcrConfigurationInfo
authenticationConfiguration	Konfiguracja uwierzytelniania dla wystąpienia usługi.	ServiceAuthenticationConfigurationInfo
corsConfiguration	Ustawienia konfiguracji mechanizmu CORS wystąpienia usługi.	ServiceCorsConfigurationInfo
cosmosDbConfiguration	Ustawienia bazy danych Cosmos DB, która wspiera usługę.	ServiceCosmosDbConfigurationInfo
exportConfiguration	Ustawienia operacji eksportowania wystąpienia usługi.	ServiceExportConfigurationInfo
importConfiguration	Ustawienia operacji importowania wystąpienia usługi.	ServiceImportConfigurationInfo
privateEndpointConnections	Lista połączeń prywatnego punktu końcowego skonfigurowanych dla tego zasobu.	PrivateEndpointConnection[]
publicNetworkAccess	Uprawnienie do kontrolowania ruchu płaszczyzny danych pochodzącego z sieci publicznych, gdy prywatny punkt końcowy jest włączony.	"Wyłączone" "Włączone"

ServiceAccessPolicyEntry

Nazwa	Opis	Wartość
objectId	Identyfikator obiektu Azure AD (użytkownik lub aplikacje), który może uzyskać dostęp do usługi FHIR.	ciąg (wymagany)

ServiceAcrConfigurationInfo

Nazwa	Opis	Wartość
loginServers	Lista serwerów logowania usługi ACR.	ciąg[]
ociArtifacts	Lista artefaktów Open Container Initiative (OCI).	ServiceOciArtifactEntry[]

ServiceOciArtifactEntry

Nazwa	Opis	Wartość
digest	Skrót artefaktu.	ciąg
Imagename	Nazwa artefaktu.	ciąg
loginServer	Serwer logowania Azure Container Registry.	ciąg

ServiceAuthenticationConfigurationInfo

Nazwa	Opis	Wartość
Publiczności	Adres URL odbiorców usługi	ciąg
Organ	Adres URL urzędu dla usługi	ciąg
smartProxyEnabled	Jeśli serwer proxy SMART na serwerze proxy FHIR jest włączony	bool

ServiceCorsConfigurationInfo

Nazwa	Opis	Wartość
allowCredentials	Jeśli poświadczenia są dozwolone za pośrednictwem mechanizmu CORS.	bool
Nagłówki	Nagłówki mogą być dozwolone za pośrednictwem mechanizmu CORS.	ciąg[]
Maxage	Maksymalny wiek dozwolony za pośrednictwem mechanizmu CORS.	int
methods	Metody, które mają być dozwolone za pośrednictwem mechanizmu CORS.	ciąg[]
Pochodzenia	Źródła mogą być dozwolone za pośrednictwem mechanizmu CORS.	ciąg[]

ServiceCosmosDbConfigurationInfo

Nazwa	Opis	Wartość
keyVaultKeyUri	Identyfikator URI klucza zarządzanego przez klienta dla bazy danych zaplecza.	ciąg
offerThroughput	Aprowizowana przepływność dla bazy danych zaplecza.	int

ServiceExportConfigurationInfo

Nazwa	Opis	Wartość
storageAccountName	Nazwa domyślnego konta magazynu eksportu.	ciąg

ServiceImportConfigurationInfo

Nazwa	Opis	Wartość
enabled	Jeśli operacja importowania jest włączona.	bool
initialImportMode	Jeśli usługa FHIR znajduje się w obszarze InitialImportMode.	bool
integrationDataStore	Nazwa domyślnego konta magazynu integracji.	ciąg

PrivateEndpointConnection

Nazwa	Opis	Wartość
properties	Właściwości zasobu.	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nazwa	Opis	Wartość
privateEndpoint	Zasób prywatnego punktu końcowego.	PrivateEndpoint
privateLinkServiceConnectionState	Kolekcja informacji o stanie połączenia między konsumentem usługi a dostawcą.	PrivateLinkServiceConnectionState (wymagane)

PrivateEndpoint

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

PrivateLinkServiceConnectionState

Nazwa	Opis	Wartość
actionsRequired	Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji u konsumenta.	ciąg
description (opis)	Przyczyna zatwierdzenia/odrzucenia połączenia.	ciąg
status	Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.	"Zatwierdzone" "Oczekujące" "Odrzucono"

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Template	Opis
Wdrażanie usługi Azure API for FHIR	Ten szablon tworzy wystąpienie usługi Azure API for FHIR®. Interfejs API platformy Azure for FHIR® to zarządzana, oparta na standardach i zgodna platforma danych opieki zdrowotnej. Umożliwia organizacjom wprowadzanie danych zdrowotnych klinicznych do chmury na podstawie standardu FHIR® danych wzajemnie współpracujących.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu usług można wdrożyć w następujących elementach:

• Grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć Microsoft. Zasób HealthcareApis/services dodaj do szablonu następujący program Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HealthcareApis/services@2022-10-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      accessPolicies = [
        {
          objectId = "string"
        }
      ]
      acrConfiguration = {
        loginServers = [
          "string"
        ]
        ociArtifacts = [
          {
            digest = "string"
            imageName = "string"
            loginServer = "string"
          }
        ]
      }
      authenticationConfiguration = {
        audience = "string"
        authority = "string"
        smartProxyEnabled = bool
      }
      corsConfiguration = {
        allowCredentials = bool
        headers = [
          "string"
        ]
        maxAge = int
        methods = [
          "string"
        ]
        origins = [
          "string"
        ]
      }
      cosmosDbConfiguration = {
        keyVaultKeyUri = "string"
        offerThroughput = int
      }
      exportConfiguration = {
        storageAccountName = "string"
      }
      importConfiguration = {
        enabled = bool
        initialImportMode = bool
        integrationDataStore = "string"
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
    }
    kind = "string"
    etag = "string"
  })
}

Wartości właściwości

services

Nazwa	Opis	Wartość
typ	Typ zasobu	"Microsoft. HealthcareApis/services@2022-10-01-preview"
name	Nazwa zasobu	ciąg (wymagany)
location	Lokalizacja zasobu.	ciąg (wymagany)
parent_id	Aby przeprowadzić wdrożenie w grupie zasobów, użyj identyfikatora tej grupy zasobów.	ciąg (wymagany)
tags	Tagi zasobów.	Słownik nazw tagów i wartości.
Rodzaju	Rodzaj usługi.	"fhir" "fhir-R4" "fhir-Stu3" (wymagane)
Etag	Element etag skojarzony z zasobem używany do optymistycznej współbieżności podczas jej edytowania.	ciąg
identity	Ustawienie wskazujące, czy usługa ma skojarzona tożsamość zarządzaną.	ServicesResourceIdentity
properties	Typowe właściwości usługi.	UsługiWłaściwości

ServicesResourceIdentity

Nazwa	Opis	Wartość
typ	Typ określonej tożsamości, obecnie SystemAssigned i None są dozwolone.	"SystemAssigned"

UsługiWłaściwości

Nazwa	Opis	Wartość
accessPolicies	Zasady dostępu wystąpienia usługi.	ServiceAccessPolicyEntry[]
acrConfiguration	Ustawienia rejestru kontenerów platformy Azure używane do konwersji danych wystąpienia usługi.	ServiceAcrConfigurationInfo
authenticationConfiguration	Konfiguracja uwierzytelniania dla wystąpienia usługi.	ServiceAuthenticationConfigurationInfo
corsConfiguration	Ustawienia konfiguracji mechanizmu CORS wystąpienia usługi.	ServiceCorsConfigurationInfo
cosmosDbConfiguration	Ustawienia bazy danych Cosmos DB, która jest kopią zapasową usługi.	ServiceCosmosDbConfigurationInfo
exportConfiguration	Ustawienia operacji eksportowania wystąpienia usługi.	ServiceExportConfigurationInfo
importConfiguration	Ustawienia operacji importowania wystąpienia usługi.	ServiceImportConfigurationInfo
privateEndpointConnections	Lista połączeń prywatnego punktu końcowego skonfigurowanych dla tego zasobu.	PrivateEndpointConnection[]
publicNetworkAccess	Uprawnienie do kontrolowania ruchu płaszczyzny danych pochodzącego z sieci publicznych, gdy prywatny punkt końcowy jest włączony.	"Wyłączone" "Włączone"

ServiceAccessPolicyEntry

Nazwa	Opis	Wartość
objectId	Identyfikator obiektu Azure AD (użytkownik lub aplikacje), który może uzyskać dostęp do usługi FHIR.	ciąg (wymagany)

ServiceAcrConfigurationInfo

Nazwa	Opis	Wartość
loginServers	Lista serwerów logowania usługi ACR.	ciąg[]
ociArtifacts	Lista artefaktów Open Container Initiative (OCI).	ServiceOciArtifactEntry[]

ServiceOciArtifactEntry

Nazwa	Opis	Wartość
digest	Skrót artefaktu.	ciąg
Imagename	Nazwa artefaktu.	ciąg
loginServer	Serwer logowania Azure Container Registry.	ciąg

ServiceAuthenticationConfigurationInfo

Nazwa	Opis	Wartość
Publiczności	Adres URL odbiorców usługi	ciąg
Organ	Adres URL urzędu dla usługi	ciąg
smartProxyEnabled	Jeśli serwer proxy SMART na serwerze proxy FHIR jest włączony	bool

ServiceCorsConfigurationInfo

Nazwa	Opis	Wartość
allowCredentials	Jeśli poświadczenia są dozwolone za pośrednictwem mechanizmu CORS.	bool
Nagłówki	Nagłówki mogą być dozwolone za pośrednictwem mechanizmu CORS.	ciąg[]
Maxage	Maksymalny wiek dozwolony za pośrednictwem mechanizmu CORS.	int
methods	Metody, które mają być dozwolone za pośrednictwem mechanizmu CORS.	ciąg[]
Pochodzenia	Źródła mogą być dozwolone za pośrednictwem mechanizmu CORS.	ciąg[]

ServiceCosmosDbConfigurationInfo

Nazwa	Opis	Wartość
keyVaultKeyUri	Identyfikator URI klucza zarządzanego przez klienta dla bazy danych zaplecza.	ciąg
offerThroughput	Aprowizowana przepływność dla bazy danych zaplecza.	int

ServiceExportConfigurationInfo

Nazwa	Opis	Wartość
storageAccountName	Nazwa domyślnego konta magazynu eksportu.	ciąg

ServiceImportConfigurationInfo

Nazwa	Opis	Wartość
enabled	Jeśli operacja importowania jest włączona.	bool
initialImportMode	Jeśli usługa FHIR znajduje się w obszarze InitialImportMode.	bool
integrationDataStore	Nazwa domyślnego konta magazynu integracji.	ciąg

PrivateEndpointConnection

Nazwa	Opis	Wartość
properties	Właściwości zasobu.	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nazwa	Opis	Wartość
privateEndpoint	Zasób prywatnego punktu końcowego.	PrivateEndpoint
privateLinkServiceConnectionState	Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą.	PrivateLinkServiceConnectionState (wymagane)

PrivateEndpoint

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

PrivateLinkServiceConnectionState

Nazwa	Opis	Wartość
actionsRequired	Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.	ciąg
description (opis)	Przyczyna zatwierdzenia/odrzucenia połączenia.	ciąg
status	Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.	"Zatwierdzone" "Oczekujące" "Odrzucone"