az keyvault role definition

Управление определениями ролей.

Команды

Имя Описание Тип Состояние
az keyvault role definition create

Создайте определение настраиваемой роли.

Основные сведения Общедоступная версия
az keyvault role definition delete

Удаление определения роли.

Основные сведения Общедоступная версия
az keyvault role definition list

Вывод списка определений ролей.

Основные сведения Общедоступная версия
az keyvault role definition show

Отображение сведений о определении роли.

Основные сведения Общедоступная версия
az keyvault role definition update

Обновление определения роли.

Основные сведения Общедоступная версия

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

Имя определения роли. Это GUID в свойстве "name" определения роли.

--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

Имя определения роли. Это GUID в свойстве "name" определения роли.

--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.