Delen via


Services - Create Or Update

De metagegevens van een service-exemplaar maken of bijwerken.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
path True

string

De naam van de resourcegroep die het service-exemplaar bevat.

Regex-patroon: ^[-\w\._\(\)]+$

resourceName
path True

string

De naam van het service-exemplaar.

subscriptionId
path True

string

De abonnements-id.

api-version
query True

string

Client-API-versie.

Aanvraagbody

Name Vereist Type Description
kind True

kind

Het soort service.

location True

string

De resourcelocatie.

etag

string

Een etag die is gekoppeld aan de resource, die wordt gebruikt voor optimistische gelijktijdigheid bij het bewerken ervan.

identity

Identity

Instelling die aangeeft of aan de service een beheerde identiteit is gekoppeld.

properties

ServicesProperties

De algemene eigenschappen van een service.

tags

object

De resourcetags.

Antwoorden

Name Type Description
200 OK

ServicesDescription

Bijgewerkt: aanvraag geaccepteerd plaatsen en een bestaande resource wordt bijgewerkt; de bewerking asynchroon wordt voltooid.

201 Created

ServicesDescription

Gemaakt: de aanvraag is geaccepteerd en er is een nieuwe resource gemaakt; de bewerking asynchroon wordt voltooid.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

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

Create or Update a service with all parameters

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
createdByType

Het type identiteit waarmee de resource is gemaakt.

ErrorDetails

Foutdetails.

ErrorDetailsInternal

Foutdetails.

Identity

Instelling die aangeeft of aan de service een beheerde identiteit is gekoppeld.

kind

Het soort service.

ManagedServiceIdentityType

Het type identiteit dat wordt opgegeven, momenteel SystemAssigned en None zijn toegestaan.

PrivateEndpoint

De privé-eindpuntresource.

PrivateEndpointConnection

De resource privé-eindpuntverbinding.

PrivateEndpointConnectionProvisioningState

De huidige inrichtingsstatus.

PrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.

provisioningState

De inrichtingsstatus.

PublicNetworkAccess

Machtigingen beheren voor gegevensvlakverkeer dat afkomstig is van openbare netwerken terwijl het privé-eindpunt is ingeschakeld.

ServiceAccessPolicyEntry

Een vermelding voor toegangsbeleid.

ServiceAcrConfigurationInfo

Configuratiegegevens van Azure-containerregister

ServiceAuthenticationConfigurationInfo

Informatie over verificatieconfiguratie

ServiceCorsConfigurationInfo

De instellingen voor de CORS-configuratie van het service-exemplaar.

ServiceCosmosDbConfigurationInfo

De instellingen voor de Cosmos DB-database die ondersteuning biedt voor de service.

ServiceExportConfigurationInfo

Configuratiegegevens van exportbewerking

ServiceImportConfigurationInfo

Configuratiegegevens van importbewerking

ServiceOciArtifactEntry

Een OCI-artefact (Open Container Initiative).

ServicesDescription

De beschrijving van de service.

ServicesProperties

De eigenschappen van een service-exemplaar.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

Foutdetails.

Name Type Description
error

ErrorDetailsInternal

Foutdetails

ErrorDetailsInternal

Foutdetails.

Name Type Description
code

string

De foutcode.

message

string

Het foutbericht.

target

string

Het doel van de specifieke fout.

Identity

Instelling die aangeeft of aan de service een beheerde identiteit is gekoppeld.

Name Type Description
principalId

string

De principal-id van de resource-id.

tenantId

string

De tenant-id van de resource.

type

ManagedServiceIdentityType

Het type identiteit dat wordt opgegeven, momenteel SystemAssigned en None zijn toegestaan.

kind

Het soort service.

Name Type Description
fhir

string

fhir-R4

string

fhir-Stu3

string

ManagedServiceIdentityType

Het type identiteit dat wordt opgegeven, momenteel SystemAssigned en None zijn toegestaan.

Name Type Description
None

string

SystemAssigned

string

PrivateEndpoint

De privé-eindpuntresource.

Name Type Description
id

string

De ARM-id voor privé-eindpunt

PrivateEndpointConnection

De resource privé-eindpuntverbinding.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

De naam van de resource

properties.privateEndpoint

PrivateEndpoint

De resource van het privé-eindpunt.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

De inrichtingsstatus van de privé-eindpuntverbindingsresource.

type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrivateEndpointConnectionProvisioningState

De huidige inrichtingsstatus.

Name Type Description
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.

Name Type Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.

Name Type Description
actionsRequired

string

Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates voor de consument vereisen.

description

string

De reden voor goedkeuring/afwijzing van de verbinding.

status

PrivateEndpointServiceConnectionStatus

Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service.

provisioningState

De inrichtingsstatus.

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

Machtigingen beheren voor gegevensvlakverkeer dat afkomstig is van openbare netwerken terwijl het privé-eindpunt is ingeschakeld.

Name Type Description
Disabled

string

Enabled

string

ServiceAccessPolicyEntry

Een vermelding voor toegangsbeleid.

Name Type Description
objectId

string

Een Azure AD object-id (gebruiker of apps) die toegang krijgt tot de FHIR-service.

ServiceAcrConfigurationInfo

Configuratiegegevens van Azure-containerregister

Name Type Description
loginServers

string[]

De lijst met de ACR-aanmeldingsservers.

ociArtifacts

ServiceOciArtifactEntry[]

De lijst met OCI-artefacten (Open Container Initiative).

ServiceAuthenticationConfigurationInfo

Informatie over verificatieconfiguratie

Name Type Description
audience

string

De url van de doelgroep voor de service

authority

string

De instantie-URL voor de service

smartProxyEnabled

boolean

Als de SMART on FHIR-proxy is ingeschakeld

ServiceCorsConfigurationInfo

De instellingen voor de CORS-configuratie van het service-exemplaar.

Name Type Description
allowCredentials

boolean

Als referenties zijn toegestaan via CORS.

headers

string[]

De headers die moeten worden toegestaan via CORS.

maxAge

integer

De maximale leeftijd die via CORS moet worden toegestaan.

methods

string[]

De methoden die via CORS moeten worden toegestaan.

origins

string[]

De oorsprongen die via CORS moeten worden toegestaan.

ServiceCosmosDbConfigurationInfo

De instellingen voor de Cosmos DB-database die ondersteuning biedt voor de service.

Name Type Description
keyVaultKeyUri

string

De URI van de door de klant beheerde sleutel voor de back-updatabase.

offerThroughput

integer

De ingerichte doorvoer voor de back-updatabase.

ServiceExportConfigurationInfo

Configuratiegegevens van exportbewerking

Name Type Description
storageAccountName

string

De naam van het standaardopslagaccount voor export.

ServiceImportConfigurationInfo

Configuratiegegevens van importbewerking

Name Type Description
enabled

boolean

Als de importbewerking is ingeschakeld.

initialImportMode

boolean

Als de FHIR-service zich in InitialImportMode bevindt.

integrationDataStore

string

De naam van het standaardopslagaccount voor integratie.

ServiceOciArtifactEntry

Een OCI-artefact (Open Container Initiative).

Name Type Description
digest

string

De artefact-digest.

imageName

string

De naam van het artefact.

loginServer

string

De Azure Container Registry aanmeldingsserver.

ServicesDescription

De beschrijving van de service.

Name Type Description
etag

string

Een etag die is gekoppeld aan de resource, die wordt gebruikt voor optimistische gelijktijdigheid bij het bewerken ervan.

id

string

De resource-id.

identity

Identity

Instelling die aangeeft of aan de service een beheerde identiteit is gekoppeld.

kind

kind

Het soort service.

location

string

De resourcelocatie.

name

string

De resourcenaam.

properties

ServicesProperties

De algemene eigenschappen van een service.

systemData

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

tags

object

De resourcetags.

type

string

Het resourcetype.

ServicesProperties

De eigenschappen van een service-exemplaar.

Name Type Description
accessPolicies

ServiceAccessPolicyEntry[]

Het toegangsbeleid van het service-exemplaar.

acrConfiguration

ServiceAcrConfigurationInfo

De Azure Container Registry-instellingen die worden gebruikt voor het converteren van gegevensbewerkingen van het service-exemplaar.

authenticationConfiguration

ServiceAuthenticationConfigurationInfo

De verificatieconfiguratie voor het service-exemplaar.

corsConfiguration

ServiceCorsConfigurationInfo

De instellingen voor de CORS-configuratie van het service-exemplaar.

cosmosDbConfiguration

ServiceCosmosDbConfigurationInfo

De instellingen voor de Cosmos DB-database die ondersteuning biedt voor de service.

exportConfiguration

ServiceExportConfigurationInfo

De instellingen voor de exportbewerking van het service-exemplaar.

importConfiguration

ServiceImportConfigurationInfo

De instellingen voor de importbewerking van het service-exemplaar.

privateEndpointConnections

PrivateEndpointConnection[]

De lijst met privé-eindpuntverbindingen die zijn ingesteld voor deze resource.

provisioningState

provisioningState

De inrichtingsstatus.

publicNetworkAccess

PublicNetworkAccess

Machtigingen beheren voor gegevensvlakverkeer dat afkomstig is van openbare netwerken terwijl het privé-eindpunt is ingeschakeld.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name Type Description
createdAt

string

Het tijdstempel van het maken van resources (UTC).

createdBy

string

De identiteit waarmee de resource is gemaakt.

createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.

lastModifiedAt

string

De tijdstempel van de laatste wijziging van de resource (UTC)

lastModifiedBy

string

De identiteit die de resource het laatst heeft gewijzigd.

lastModifiedByType

createdByType

Het type identiteit dat de resource het laatst heeft gewijzigd.