Freigeben über

az keyvault role definition

Rollendefinitionen verwalten.

Befehle

Name Beschreibung Typ Status
az keyvault role definition create

Erstellen Sie eine benutzerdefinierte Rollendefinition.

 Core GA
az keyvault role definition delete

Löschen sie eine Rollendefinition.

 Core GA
az keyvault role definition list

Rollendefinitionen auflisten.

 Core GA
az keyvault role definition show

Zeigen Sie die Details einer Rollendefinition an.

 Core GA
az keyvault role definition update

Aktualisieren einer Rollendefinition.

 Core GA

az keyvault role definition create

Bearbeiten

Erstellen Sie eine benutzerdefinierte Rollendefinition.

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

Beispiele

Erstellen Sie eine Rolle anhand einer JSON-Zeichenfolge.

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": []
}'

Erstellen Sie eine Rolle aus einer Datei, die eine JSON-Beschreibung enthält.

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

Erforderliche Parameter

--hsm-name

Name des HSM.

Eigenschaft Wert
Parametergruppe: Id Arguments
--role-definition

Beschreibung einer Rolle als JSON oder pfad zu einer Datei, die eine JSON-Beschreibung enthält.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az keyvault role definition delete

Bearbeiten

Löschen sie eine Rollendefinition.

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

Erforderliche Parameter

--hsm-name

Name des HSM.

Eigenschaft Wert
Parametergruppe: Id Arguments

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--name -n

Der Rollendefinitionsname. Dies ist eine GUID in der Eigenschaft "name" einer Rollendefinition.

--role-id

Die Rollendefinitions-ID.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az keyvault role definition list

Bearbeiten

Rollendefinitionen auflisten.

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

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--custom-role-only

Nur benutzerdefinierte Rollendefinitionen anzeigen.

Eigenschaft Wert
Standardwert: False
Zulässige Werte: false, true
--hsm-name

Name des HSM.

Eigenschaft Wert
Parametergruppe: Id Arguments
--scope

Bereich, für den die Rollenzuweisung oder Definition gilt, z. B. "/" oder "/keys" oder "/keys/{keyname}".

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az keyvault role definition show

Bearbeiten

Zeigen Sie die Details einer Rollendefinition an.

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

Erforderliche Parameter

--hsm-name

Name des HSM.

Eigenschaft Wert
Parametergruppe: Id Arguments

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--name -n

Der Rollendefinitionsname. Dies ist eine GUID in der Eigenschaft "name" einer Rollendefinition.

--role-id

Die Rollendefinitions-ID.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az keyvault role definition update

Bearbeiten

Aktualisieren einer Rollendefinition.

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

Beispiele

Aktualisieren einer Rolle durch eine JSON-Zeichenfolge.

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": []
}'

Aktualisieren Sie eine Rolle aus einer Datei, die eine JSON-Beschreibung enthält.

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

Erforderliche Parameter

--hsm-name

Name des HSM.

Eigenschaft Wert
Parametergruppe: Id Arguments
--role-definition

Beschreibung einer Rolle als JSON oder pfad zu einer Datei, die eine JSON-Beschreibung enthält.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False