az keyvault role definition

ロール定義を管理します。

コマンド

名前	説明	型	状態
az keyvault role definition create	カスタム ロール定義を作成します。	コア	GA
az keyvault role definition delete	ロール定義を削除します。	コア	GA
az keyvault role definition list	ロール定義を一覧表示します。	コア	GA
az keyvault role definition show	ロール定義の詳細を表示します。	コア	GA
az keyvault role definition update	ロール定義を更新します。	コア	GA

az keyvault role definition create

カスタム ロール定義を作成します。

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

例

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

JSON の説明を含むファイルからロールを作成します。

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

必須のパラメーター

--hsm-name

HSM の名前。

--role-definition

JSON としてのロールの説明、または JSON の説明を含むファイルへのパス。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力フォーマット。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az keyvault role definition delete

ロール定義を削除します。

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

必須のパラメーター

--hsm-name

HSM の名前。

省略可能のパラメーター

--name -n

ロール定義名。 これは、ロール定義の "name" プロパティの GUID です。

--role-id

ロール定義 ID。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力フォーマット。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az keyvault role definition list

ロール定義を一覧表示します。

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

省略可能のパラメーター

--custom-role-only

カスタム ロール定義のみを表示します。

指定可能な値: false, true

規定値: False

--hsm-name

HSM の名前。

--scope

ロールの割り当てまたは定義が適用されるスコープ ("/" や "/keys" や "/keys/{keyname}" など)。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力フォーマット。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az keyvault role definition show

ロール定義の詳細を表示します。

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

必須のパラメーター

--hsm-name

HSM の名前。

省略可能のパラメーター

--name -n

ロール定義名。 これは、ロール定義の "name" プロパティの GUID です。

--role-id

ロール定義 ID。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力フォーマット。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

az keyvault role definition update

ロール定義を更新します。

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

例

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

JSON の説明を含むファイルからロールを更新します。

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

必須のパラメーター

--hsm-name

HSM の名前。

--role-definition

JSON としてのロールの説明、または JSON の説明を含むファイルへのパス。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

--output -o

出力フォーマット。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。