az keyvault role definition

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

Команды

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

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

 Core GA
az keyvault role definition delete

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

 Core GA
az keyvault role definition list

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

 Core GA
az keyvault role definition show

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

 Core GA
az keyvault role definition update

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

 Core GA

az keyvault role definition create

Изменить

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

az keyvault role definition create --hsm-name
                                   --role-definition
                                   [--acquire-policy-token]
                                   [--change-reference]

Примеры

Создайте роль строкой 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.

Свойство Значение
Группа параметров: Id Arguments
--role-definition

Описание роли в формате JSON или путь к файлу с описанием JSON.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Значение по умолчанию: False
--output -o

Формат вывода.

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Значение по умолчанию: False

az keyvault role definition delete

Изменить

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

az keyvault role definition delete --hsm-name
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--name]
                                   [--role-id]

Обязательные параметры

--hsm-name

Имя HSM.

Свойство Значение
Группа параметров: Id Arguments

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--name -n

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

--role-id

Идентификатор определения роли.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Значение по умолчанию: False
--output -o

Формат вывода.

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Значение по умолчанию: False

az keyvault role definition list

Изменить

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

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

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--custom-role-only

Отображаются только определения пользовательских ролей.

Свойство Значение
Значение по умолчанию: False
Допустимые значения: false, true
--hsm-name

Имя HSM.

Свойство Значение
Группа параметров: Id Arguments
--scope

Область, к которой применяется назначение или определение роли, например "/" или "/keys" или "/keys/{keyname}".

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Значение по умолчанию: False
--output -o

Формат вывода.

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Значение по умолчанию: False

az keyvault role definition show

Изменить

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

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

Обязательные параметры

--hsm-name

Имя HSM.

Свойство Значение
Группа параметров: Id Arguments

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--name -n

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

--role-id

Идентификатор определения роли.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Значение по умолчанию: False
--output -o

Формат вывода.

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Значение по умолчанию: False

az keyvault role definition update

Изменить

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

az keyvault role definition update --hsm-name
                                   --role-definition
                                   [--acquire-policy-token]
                                   [--change-reference]

Примеры

Обновите роль по строке 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.

Свойство Значение
Группа параметров: Id Arguments
--role-definition

Описание роли в формате JSON или путь к файлу с описанием JSON.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Значение по умолчанию: False
--output -o

Формат вывода.

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Значение по умолчанию: False