你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 获取完整的调试日志。