Partager via


Services - Create Or Update

Créez ou mettez à jour les métadonnées d’une instance de service.

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

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

Nom du groupe de ressources qui contient l’instance de service.

resourceName
path True

string

minLength: 3
maxLength: 24

Nom de l’instance de service.

subscriptionId
path True

string

Identificateur d’abonnement.

api-version
query True

string

Version de l’API cliente.

Corps de la demande

Nom Obligatoire Type Description
kind True

kind

Type de service.

location True

string

Emplacement de la ressource.

etag

string

Un etag associé à la ressource, utilisé pour l’accès concurrentiel optimiste lors de sa modification.

identity

Identity

Paramètre indiquant si le service a une identité managée associée.

properties

ServicesProperties

Propriétés communes d’un service.

tags

object

Balises de ressource.

Réponses

Nom Type Description
200 OK

ServicesDescription

Mise à jour : demande de mise à jour acceptée et mise à jour d’une ressource existante ; l’opération se termine de façon asynchrone.

201 Created

ServicesDescription

Créé - Demande de mise en place acceptée et création d’une nouvelle ressource ; l’opération se termine de façon asynchrone.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

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

Create or Update a service with all parameters

Exemple de requête

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

Exemple de réponse

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

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
createdByType

Type d’identité qui a créé la ressource.

ErrorDetails

Détails de l’erreur.

ErrorDetailsInternal

Détails de l’erreur.

Identity

Paramètre indiquant si le service a une identité managée associée.

kind

Type de service.

ManagedServiceIdentityType

Type d’identité spécifié, actuellement SystemAssigned et None sont autorisés.

PrivateEndpoint

Ressource de point de terminaison privé.

PrivateEndpointConnection

Ressource de connexion de point de terminaison privé.

PrivateEndpointConnectionProvisioningState

État d’approvisionnement actuel.

PrivateEndpointServiceConnectionStatus

État de la connexion de point de terminaison privé.

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

provisioningState

État d’approvisionnement.

PublicNetworkAccess

Contrôlez l’autorisation pour le trafic du plan de données provenant de réseaux publics tandis que le point de terminaison privé est activé.

ServiceAccessPolicyEntry

Entrée de stratégie d’accès.

ServiceAcrConfigurationInfo

Informations de configuration du registre de conteneurs Azure

ServiceAuthenticationConfigurationInfo

Informations de configuration de l’authentification

ServiceCorsConfigurationInfo

Paramètres de la configuration CORS de l’instance de service.

ServiceCosmosDbConfigurationInfo

Paramètres de la base de données Cosmos DB qui sauvegarde le service.

ServiceExportConfigurationInfo

Informations de configuration de l’opération d’exportation

ServiceImportConfigurationInfo

Informations de configuration de l’opération d’importation

ServiceOciArtifactEntry

Artefact OCI (Open Container Initiative).

ServicesDescription

Description du service.

ServicesProperties

Propriétés d’une instance de service.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Type d’identité qui a créé la ressource.

Valeur Description
Application
Key
ManagedIdentity
User

ErrorDetails

Détails de l’erreur.

Nom Type Description
error

ErrorDetailsInternal

Détails de l’erreur

ErrorDetailsInternal

Détails de l’erreur.

Nom Type Description
code

string

Code d’erreur.

message

string

Message d’erreur.

target

string

Cible de l’erreur particulière.

Identity

Paramètre indiquant si le service a une identité managée associée.

Nom Type Description
principalId

string

ID principal de l’identité de ressource.

tenantId

string

ID de locataire de la ressource.

type

ManagedServiceIdentityType

Type d’identité spécifié, actuellement SystemAssigned et None sont autorisés.

kind

Type de service.

Valeur Description
fhir
fhir-R4
fhir-Stu3

ManagedServiceIdentityType

Type d’identité spécifié, actuellement SystemAssigned et None sont autorisés.

Valeur Description
None
SystemAssigned

PrivateEndpoint

Ressource de point de terminaison privé.

Nom Type Description
id

string

Identificateur ARM pour le point de terminaison privé

PrivateEndpointConnection

Ressource de connexion de point de terminaison privé.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nom de la ressource

properties.privateEndpoint

PrivateEndpoint

Ressource du point de terminaison privé.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

État d’approvisionnement de la ressource de connexion de point de terminaison privé.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateEndpointConnectionProvisioningState

État d’approvisionnement actuel.

Valeur Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

État de la connexion de point de terminaison privé.

Valeur Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

Nom Type Description
actionsRequired

string

Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.

description

string

Raison de l’approbation/rejet de la connexion.

status

PrivateEndpointServiceConnectionStatus

Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service.

provisioningState

État d’approvisionnement.

Valeur Description
Accepted
Canceled
Creating
Deleting
Deprovisioned
Failed
Moving
Succeeded
Suspended
SystemMaintenance
Updating
Verifying
Warned

PublicNetworkAccess

Contrôlez l’autorisation pour le trafic du plan de données provenant de réseaux publics tandis que le point de terminaison privé est activé.

Valeur Description
Disabled
Enabled

ServiceAccessPolicyEntry

Entrée de stratégie d’accès.

Nom Type Description
objectId

string

pattern: ^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$

ID d’objet Azure AD (utilisateur ou applications) autorisé à accéder au service FHIR.

ServiceAcrConfigurationInfo

Informations de configuration du registre de conteneurs Azure

Nom Type Description
loginServers

string[]

Liste des serveurs de connexion ACR.

ociArtifacts

ServiceOciArtifactEntry[]

Liste des artefacts OCI (Open Container Initiative).

ServiceAuthenticationConfigurationInfo

Informations de configuration de l’authentification

Nom Type Description
audience

string

URL de l’audience pour le service

authority

string

URL de l’autorité pour le service

smartProxyEnabled

boolean

Si le proxy SMART sur FHIR est activé

ServiceCorsConfigurationInfo

Paramètres de la configuration CORS de l’instance de service.

Nom Type Description
allowCredentials

boolean

Si les informations d’identification sont autorisées via CORS.

headers

string[]

En-têtes à autoriser via CORS.

maxAge

integer

minimum: 0
maximum: 99999

Âge maximal à autoriser via CORS.

methods

string[]

Méthodes à autoriser via CORS.

origins

string[]

pattern: ^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?|[*]))$

Origines à autoriser via CORS.

ServiceCosmosDbConfigurationInfo

Paramètres de la base de données Cosmos DB qui sauvegarde le service.

Nom Type Description
keyVaultKeyUri

string

URI de la clé gérée par le client pour la base de données de stockage.

offerThroughput

integer

minimum: 400

Débit provisionné pour la base de données de stockage.

ServiceExportConfigurationInfo

Informations de configuration de l’opération d’exportation

Nom Type Description
storageAccountName

string

Nom du compte de stockage d’exportation par défaut.

ServiceImportConfigurationInfo

Informations de configuration de l’opération d’importation

Nom Type Description
enabled

boolean

Si l’opération d’importation est activée.

initialImportMode

boolean

Si le service FHIR est dans InitialImportMode.

integrationDataStore

string

Nom du compte de stockage d’intégration par défaut.

ServiceOciArtifactEntry

Artefact OCI (Open Container Initiative).

Nom Type Description
digest

string

Synthèse de l’artefact.

imageName

string

Nom de l’artefact.

loginServer

string

Serveur de connexion Azure Container Registry.

ServicesDescription

Description du service.

Nom Type Description
etag

string

Un etag associé à la ressource, utilisé pour l’accès concurrentiel optimiste lors de sa modification.

id

string

Identificateur de ressource.

identity

Identity

Paramètre indiquant si le service a une identité managée associée.

kind

kind

Type de service.

location

string

Emplacement de la ressource.

name

string

pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$

Nom de la ressource.

properties

ServicesProperties

Propriétés communes d’un service.

systemData

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

tags

object

Balises de ressource.

type

string

Type de ressource.

ServicesProperties

Propriétés d’une instance de service.

Nom Type Description
accessPolicies

ServiceAccessPolicyEntry[]

Stratégies d’accès de l’instance de service.

acrConfiguration

ServiceAcrConfigurationInfo

Paramètres azure Container Registry utilisés pour convertir l’opération de données de l’instance de service.

authenticationConfiguration

ServiceAuthenticationConfigurationInfo

Configuration de l’authentification pour l’instance de service.

corsConfiguration

ServiceCorsConfigurationInfo

Paramètres de la configuration CORS de l’instance de service.

cosmosDbConfiguration

ServiceCosmosDbConfigurationInfo

Paramètres de la base de données Cosmos DB qui sauvegarde le service.

exportConfiguration

ServiceExportConfigurationInfo

Paramètres de l’opération d’exportation de l’instance de service.

importConfiguration

ServiceImportConfigurationInfo

Paramètres de l’opération d’importation de l’instance de service.

privateEndpointConnections

PrivateEndpointConnection[]

Liste des connexions de point de terminaison privé configurées pour cette ressource.

provisioningState

provisioningState

État d’approvisionnement.

publicNetworkAccess

PublicNetworkAccess

Contrôlez l’autorisation pour le trafic du plan de données provenant de réseaux publics tandis que le point de terminaison privé est activé.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string (date-time)

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string (date-time)

Horodatage de la dernière modification de ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.