Partager via

az keyvault role definition

Gérer les définitions de rôle.

Commandes

Nom Description Type État
az keyvault role definition create

Créez une définition de rôle personnalisée.

 Core GA
az keyvault role definition delete

Supprimez une définition de rôle.

 Core GA
az keyvault role definition list

Répertorier les définitions de rôle.

 Core GA
az keyvault role definition show

Afficher les détails d’une définition de rôle.

 Core GA
az keyvault role definition update

Mettez à jour une définition de rôle.

 Core GA

az keyvault role definition create

Modifier

Créez une définition de rôle personnalisée.

az keyvault role definition create --hsm-name
                                   --role-definition

Exemples

Créez un rôle par une chaîne JSON.

az keyvault role definition create --hsm-name MyHSM --role-definition '{
    "roleName": "My Custom Role",
    "description": "The description of the custom rule.",
    "actions": [],
    "notActions": [],
    "dataActions": [
        "Microsoft.KeyVault/managedHsm/keys/read/action"
    ],
    "notDataActions": []
}'

Créez un rôle à partir d’un fichier contenant une description JSON.

az keyvault role definition create --hsm-name MyHSM --role-definition @keyvault-role.json

Paramètres obligatoires

--hsm-name

Nom du HSM.

Propriété Valeur
Groupe de paramètres: Id Arguments
--role-definition

Description d’un rôle au format JSON ou chemin d’accès à un fichier contenant une description JSON.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault role definition delete

Modifier

Supprimez une définition de rôle.

az keyvault role definition delete --hsm-name
                                   [--name]
                                   [--role-id]

Paramètres obligatoires

--hsm-name

Nom du HSM.

Propriété Valeur
Groupe de paramètres: Id Arguments

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--name -n

Nom de la définition de rôle. Il s’agit d’un GUID dans la propriété « name » d’une définition de rôle.

--role-id

ID de définition de rôle.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault role definition list

Modifier

Répertorier les définitions de rôle.

az keyvault role definition list [--custom-role-only {false, true}]
                                 [--hsm-name]
                                 [--scope]

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--custom-role-only

Affichez uniquement les définitions de rôle personnalisées.

Propriété Valeur
Valeur par défaut: False
Valeurs acceptées: false, true
--hsm-name

Nom du HSM.

Propriété Valeur
Groupe de paramètres: Id Arguments
--scope

Étendue à laquelle l’attribution ou la définition de rôle s’applique, par exemple, « / » ou « /keys » ou « /keys/{keyname} ».

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault role definition show

Modifier

Afficher les détails d’une définition de rôle.

az keyvault role definition show --hsm-name
                                 [--name]
                                 [--role-id]

Paramètres obligatoires

--hsm-name

Nom du HSM.

Propriété Valeur
Groupe de paramètres: Id Arguments

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--name -n

Nom de la définition de rôle. Il s’agit d’un GUID dans la propriété « name » d’une définition de rôle.

--role-id

ID de définition de rôle.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az keyvault role definition update

Modifier

Mettez à jour une définition de rôle.

az keyvault role definition update --hsm-name
                                   --role-definition

Exemples

Mettez à jour un rôle par une chaîne JSON.

az keyvault role definition update --hsm-name MyHSM --role-definition '{
    "roleName": "My Custom Role",
    "name": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "id": "Microsoft.KeyVault/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "description": "The description of the custom rule.",
    "actions": [],
    "notActions": [],
    "dataActions": [
        "Microsoft.KeyVault/managedHsm/keys/read/action",
        "Microsoft.KeyVault/managedHsm/keys/write/action",
        "Microsoft.KeyVault/managedHsm/keys/backup/action",
        "Microsoft.KeyVault/managedHsm/keys/create"
    ],
    "notDataActions": []
}'

Mettez à jour un rôle à partir d’un fichier contenant une description JSON.

az keyvault role definition update --hsm-name MyHSM --role-definition @keyvault-role.json

Paramètres obligatoires

--hsm-name

Nom du HSM.

Propriété Valeur
Groupe de paramètres: Id Arguments
--role-definition

Description d’un rôle au format JSON ou chemin d’accès à un fichier contenant une description JSON.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False