az keyvault role definition

管理角色定義。

命令

名稱	Description	類型	狀態
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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

角色定義識別碼。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

角色定義識別碼。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。