az healthcareapis service

  • Référence

Remarque

Cette référence fait partie de l’extension healthcareapis pour Azure CLI (version 2.15.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande de service az healthcareapis. En savoir plus sur les extensions.

Service Healthcareapis.

Commandes

Nom Description Type Statut
az healthcareapis service create

Créez les métadonnées d’une instance de service.

 Extension GA
az healthcareapis service delete

Supprimez une instance de service.

 Extension GA
az healthcareapis service list

Obtenez toutes les instances de service dans un groupe de ressources. Obtenez toutes les instances de service dans un abonnement.

 Extension GA
az healthcareapis service show

Obtenir les métadonnées d’une instance de service.

 Extension GA
az healthcareapis service update

Mettez à jour les métadonnées d’une instance de service.

 Extension GA
az healthcareapis service wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition du service healthcareapis soit remplie.

 Extension GA

az healthcareapis service create

Créez les métadonnées d’une instance de service.

az healthcareapis service create --kind {fhir, fhir-R4, fhir-Stu3}
                                 --location
                                 --resource-group
                                 --resource-name
                                 [--access-policies]
                                 [--authentication-configuration]
                                 [--cors-configuration]
                                 [--cosmos-db-configuration]
                                 [--etag]
                                 [--export-configuration-storage-account-name]
                                 [--identity-type {None, SystemAssigned}]
                                 [--login-servers]
                                 [--no-wait]
                                 [--oci-artifacts]
                                 [--private-endpoint-connections]
                                 [--public-network-access {Disabled, Enabled}]
                                 [--tags]

Exemples

Créer ou mettre à jour un service avec tous les paramètres

az healthcareapis service create --resource-group "rg1" --resource-name "service1" --identity-type "SystemAssigned" --kind "fhir-R4" --location "westus2" --access-policies object-id="c487e7d1-3210-41a3-8ccc-e9372b78da47" --access-policies object-id="5b307da8-43d4-492b-8b66-b0294ade872f" --authentication-configuration audience="https://azurehealthcareapis.com" authority="https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc" smart-proxy-enabled=true --cors-configuration allow-credentials=false headers="*" max-age=1440 methods="DELETE" methods="GET" methods="OPTIONS" methods="PATCH" methods="POST" methods="PUT" origins="*" --cosmos-db-configuration key-vault-key-uri="https://my-vault.vault.azure.net/keys/my-key" offer-throughput=1000 --export-configuration-storage-account-name "existingStorageAccount" --public-network-access "Disabled"

Créer ou mettre à jour un service avec des paramètres minimaux

az healthcareapis service create --resource-group "rg1" --resource-name "service2" --kind "fhir-R4" --location "westus2" --access-policies object-id="c487e7d1-3210-41a3-8ccc-e9372b78da47"

Paramètres obligatoires

--kind

Type de service.

valeurs acceptées: fhir, fhir-R4, fhir-Stu3
--location -l

Emplacement. Valeurs provenant de : az account list-locations. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--resource-name

Nom de l’instance de service.

Paramètres facultatifs

--access-policies

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

Utilisation : --access-policies object-id=XX

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

Plusieurs actions peuvent être spécifiées à l’aide de plusieurs arguments --access-policies.

--authentication-configuration -c

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

Utilisation : --authentication-configuration authority=XX audience=XX smart-proxy-enabled=XX

autorité : URL de l’autorité pour l’audience du service : URL d’audience pour le service smart-proxy activé : si le proxy SMART sur FHIR est activé.

--cors-configuration

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

Utilisation : --cors-configuration origin=XX headers=XX methods=XX max-age=XX allow-credentials=XX

origines : Les origines à autoriser via CORS. en-têtes : en-têtes à autoriser via CORS. méthodes : méthodes à autoriser via CORS. max-age : âge maximal à autoriser via CORS. allow-credentials : si les informations d’identification sont autorisées via CORS.

--cosmos-db-configuration

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

Utilisation : --cosmos-db-configuration offer-débit=XX key-vault-key-uri=XX

offre-débit : débit provisionné pour la base de données de stockage. key-vault-key-uri : URI de la clé gérée par le client pour la base de données de stockage.

--etag

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

--export-configuration-storage-account-name -s

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

--identity-type

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

valeurs acceptées: None, SystemAssigned
--login-servers

Liste des serveurs de connexion qui doivent être ajoutés à l’instance de service.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
--oci-artifacts

Liste des artefacts OCI (Open Container Initiative).

Utilisation : --oci-artifacts login-server=XX image-name=XX digest=XX

login-server : serveur de connexion Azure Container Registry. image-name : nom de l’artefact. digest : synthèse de l’artefact.

Plusieurs actions peuvent être spécifiées à l’aide de plusieurs arguments --oci-artifacts.

--private-endpoint-connections

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

Utilisation : --private-endpoint-connections status=XX description=XX actions-required=XX

état : indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service. description : Raison de l’approbation/rejet de la connexion. actions requises : message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.

Plusieurs actions peuvent être spécifiées à l’aide de plusieurs arguments --private-endpoint-connections.

--public-network-access

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é.

valeurs acceptées: Disabled, Enabled
--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az healthcareapis service delete

Supprimez une instance de service.

az healthcareapis service delete [--ids]
                                 [--no-wait]
                                 [--resource-group]
                                 [--resource-name]
                                 [--subscription]
                                 [--yes]

Exemples

Suppression du service

az healthcareapis service delete --resource-group "rg1" --resource-name "service1"

Paramètres facultatifs

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--resource-name

Nom de l’instance de service.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--yes -y

Ne pas demander de confirmation.

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az healthcareapis service list

Obtenez toutes les instances de service dans un groupe de ressources. Obtenez toutes les instances de service dans un abonnement.

az healthcareapis service list [--resource-group]

Exemples

Répertorier tous les services dans le groupe de ressources

az healthcareapis service list --resource-group "rgname"

Répertorier tous les services dans l’abonnement

az healthcareapis service list

Paramètres facultatifs

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az healthcareapis service show

Obtenir les métadonnées d’une instance de service.

az healthcareapis service show [--ids]
                               [--resource-group]
                               [--resource-name]
                               [--subscription]

Exemples

Obtenir les métadonnées

az healthcareapis service show --resource-group "rg1" --resource-name "service1"

Paramètres facultatifs

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--resource-name

Nom de l’instance de service.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az healthcareapis service update

Mettez à jour les métadonnées d’une instance de service.

az healthcareapis service update [--ids]
                                 [--no-wait]
                                 [--public-network-access {Disabled, Enabled}]
                                 [--resource-group]
                                 [--resource-name]
                                 [--subscription]
                                 [--tags]

Exemples

Service de correctifs

az healthcareapis service update --resource-group "rg1" --resource-name "service1" --tags tag1="value1" tag2="value2"

Paramètres facultatifs

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
--public-network-access

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é.

valeurs acceptées: Disabled, Enabled
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--resource-name

Nom de l’instance de service.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az healthcareapis service wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition du service healthcareapis soit remplie.

az healthcareapis service wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--resource-group]
                               [--resource-name]
                               [--subscription]
                               [--timeout]
                               [--updated]

Exemples

Suspendre l’exécution de la ligne de script CLI suivante jusqu’à ce que le service healthcareapis soit correctement créé.

az healthcareapis service wait --resource-group "rg1" --resource-name "service1" --created

Suspendre l’exécution de la ligne de script CLI suivante jusqu’à ce que le service healthcareapis soit correctement mis à jour.

az healthcareapis service wait --resource-group "rg1" --resource-name "service1" --updated

Suspendre l’exécution de la ligne de script CLI suivante jusqu’à ce que le service healthcareapis soit correctement supprimé.

az healthcareapis service wait --resource-group "rg1" --resource-name "service1" --deleted

Paramètres facultatifs

--created

Attendez la création avec « provisioningState » sur « Succeeded ».

valeur par défaut: False
--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Attendez la suppression.

valeur par défaut: False
--exists

Attendez que la ressource existe.

valeur par défaut: False
--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--interval

Intervalle d’interrogation en secondes.

valeur par défaut: 30
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--resource-name

Nom de l’instance de service.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--timeout

Délai maximal d’attente en secondes.

valeur par défaut: 3600
--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.