az dedicated-hsm

  • Référence

Remarque

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

Gérez hsm dédié avec des modules de sécurité matériels.

Commandes

Nom Description Type Statut
az dedicated-hsm create

Créez un HSM dédié dans l’abonnement spécifié.

 Extension GA
az dedicated-hsm delete

Supprime le HSM dédié Azure spécifié.

 Extension GA
az dedicated-hsm list

L’opération De liste obtient des informations sur les hsms dédiés associés à l’abonnement et dans le groupe de ressources spécifié. Et l’opération De liste obtient des informations sur les HSM dédiés associés à l’abonnement.

 Extension GA
az dedicated-hsm list-outbound-network-dependency-endpoint

Obtient une liste de points de terminaison de sortie (points de terminaison réseau de toutes les dépendances sortantes) dans la ressource hsm dédiée spécifiée. L’opération retourne les propriétés de chaque point de terminaison de sortie.

 Extension GA
az dedicated-hsm show

Obtient le HSM dédié Azure spécifié.

 Extension GA
az dedicated-hsm update

Mettez à jour un HSM dédié dans l’abonnement spécifié.

 Extension GA
az dedicated-hsm wait

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

 Extension GA

az dedicated-hsm create

Créez un HSM dédié dans l’abonnement spécifié.

az dedicated-hsm create --name
                        --resource-group
                        [--location]
                        [--mgmt-network-interfaces]
                        [--mgmt-network-subnet]
                        [--network-interfaces]
                        [--no-wait]
                        [--sku {SafeNet Luna Network HSM A790, payShield10K_LMK1_CPS250, payShield10K_LMK1_CPS2500, payShield10K_LMK1_CPS60, payShield10K_LMK2_CPS250, payShield10K_LMK2_CPS2500, payShield10K_LMK2_CPS60}]
                        [--stamp-id]
                        [--subnet]
                        [--tags]
                        [--zones]

Exemples

Créer ou mettre à jour un HSM dédié existant

az dedicated-hsm create --name "hsm1" --location "westus" --network-interfaces private-ip-address="1.0.0.1" --subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --stamp-id "stamp01" --sku "SafeNet Luna Network HSM A790" --tags Dept="hsm" Environment="dogfood" --resource-group "hsm-group"

Créer ou mettre à jour un HSM de paiement existant

az dedicated-hsm create --name "hsm1" --location "westus" --mgmt-network-interfaces private-ip-address="1.0.0.1" --mgmt-network-subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --stamp-id "stamp01" --sku "payShield10K_LMK1_CPS60" --tags Dept="hsm" Environment="dogfood" --resource-group "hsm-group"

Créer ou mettre à jour un HSM de paiement existant avec profil de gestion

az dedicated-hsm create --name "hsm1" --location "westus" --network-interfaces private-ip-address="1.0.0.2" --subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --mgmt-network-interfaces private-ip-address="1.0.0.1" --mgmt-network-subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --stamp-id "stamp02" --sku "payShield10K_LMK1_CPS60" --tags Dept="hsm" Environment="dogfood" --resource-group "hsm-group"

Paramètres obligatoires

--name

Nom du Hsm dédié.

--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 facultatifs

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

--mgmt-network-interfaces -m

Spécifie la liste des ID de ressource pour les interfaces réseau associées au HSM dédié.

Utilisation : --mgmt-network-interfaces private-ip-address=XX

private-ip-address : adresse IP privée de l’interface

Plusieurs actions peuvent être spécifiées à l’aide de plusieurs arguments --mgmt-network-interfaces.

--mgmt-network-subnet

Spécifie l’identificateur du sous-réseau.

Utilisation : --mgmt-network-subnet id=XX

ID : ID de ressource ARM sous la forme /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

--network-interfaces -i

Spécifie la liste des ID de ressource pour les interfaces réseau associées au HSM dédié.

Utilisation : --network-interfaces private-ip-address=XX

private-ip-address : adresse IP privée de l’interface

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

--no-wait

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

valeur par défaut: False
--sku

Référence SKU du HSM dédié.

valeurs acceptées: SafeNet Luna Network HSM A790, payShield10K_LMK1_CPS250, payShield10K_LMK1_CPS2500, payShield10K_LMK1_CPS60, payShield10K_LMK2_CPS250, payShield10K_LMK2_CPS2500, payShield10K_LMK2_CPS60
--stamp-id

Ce champ est utilisé lorsque rp ne prend pas en charge les zones de disponibilité.

--subnet

Spécifie l’identificateur du sous-réseau.

Utilisation : --subnet id=XX

ID : ID de ressource ARM sous la forme /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

--tags

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

--zones

Zones Hsm dédiées.

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 dedicated-hsm delete

Supprime le HSM dédié Azure spécifié.

az dedicated-hsm delete [--ids]
                        [--name]
                        [--no-wait]
                        [--resource-group]
                        [--subscription]
                        [--yes]

Exemples

Supprimer un HSM dédié

az dedicated-hsm delete --name "hsm1" --resource-group "hsm-group"

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

--name

Nom du HSM dédié à supprimer.

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

--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 dedicated-hsm list

L’opération De liste obtient des informations sur les hsms dédiés associés à l’abonnement et dans le groupe de ressources spécifié. Et l’opération De liste obtient des informations sur les HSM dédiés associés à l’abonnement.

az dedicated-hsm list [--resource-group]
                      [--top]

Exemples

Répertorier les appareils HSM dédiés dans un groupe de ressources

az dedicated-hsm list --resource-group "hsm-group"

Répertorier les appareils HSM dédiés dans un groupe de ressources, y compris le HSM de paiement

az dedicated-hsm list --resource-group "hsm-group"

Répertorier les appareils HSM dédiés dans un abonnement

az dedicated-hsm list

Répertorier les appareils HSM dédiés dans un abonnement, y compris le HSM de paiement

az dedicated-hsm 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>.

--top

Nombre maximal de résultats à renvoyer.

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 dedicated-hsm list-outbound-network-dependency-endpoint

Obtient une liste de points de terminaison de sortie (points de terminaison réseau de toutes les dépendances sortantes) dans la ressource hsm dédiée spécifiée. L’opération retourne les propriétés de chaque point de terminaison de sortie.

az dedicated-hsm list-outbound-network-dependency-endpoint --name
                                                           --resource-group

Exemples

Répertorier OutboundNetworkDependenciesEndpoints by Managed Cluster

az dedicated-hsm list-outbound-network-dependency-endpoint --name "hsm1" --resource-group "hsm-group"

Paramètres obligatoires

--name

Nom du HSM dédié.

--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 dedicated-hsm show

Obtient le HSM dédié Azure spécifié.

az dedicated-hsm show [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

Exemples

Obtenir un HSM dédié

az dedicated-hsm show --name "hsm1" --resource-group "hsm-group"

Obtenir un HSM de paiement

az dedicated-hsm show --name "hsm1" --resource-group "hsm-group"

Obtenir un HSM de paiement avec la version de l’API 2018-10-31Preview

az dedicated-hsm show --name "hsm1" --resource-group "hsm-group"

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

--name

Nom du HSM dédié.

--resource-group -g

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

--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 dedicated-hsm update

Mettez à jour un HSM dédié dans l’abonnement spécifié.

az dedicated-hsm update [--ids]
                        [--name]
                        [--no-wait]
                        [--resource-group]
                        [--subscription]
                        [--tags]

Exemples

Mettre à jour un HSM dédié existant

az dedicated-hsm update --name "hsm1" --tags Dept="hsm" Environment="dogfood" Slice="A" --resource-group "hsm-group"

Mettre à jour un HSM de paiement existant

az dedicated-hsm update --name "hsm1" --tags Dept="hsm" Environment="dogfood" Slice="A" --resource-group "hsm-group"

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

--name

Nom du HSM dédié.

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

--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 dedicated-hsm wait

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

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

Exemples

Suspendre l’exécution de la ligne de script CLI suivante jusqu’à ce que le module dédié soit créé avec succès.

az dedicated-hsm wait --name "hsm1" --resource-group "hsm-group" --created

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

az dedicated-hsm wait --name "hsm1" --resource-group "hsm-group" --updated

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

az dedicated-hsm wait --name "hsm1" --resource-group "hsm-group" --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
--name

Nom du HSM dédié.

--resource-group -g

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

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