az synapse role assignment

Управление назначениями ролей Synapse.

Команды

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

Создайте назначение роли.

Core GA
az synapse role assignment delete

Удаление назначений ролей рабочей области.

Core GA
az synapse role assignment list

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

Core GA
az synapse role assignment show

Получение назначения роли по идентификатору.

Core GA

az synapse role assignment create

Создайте назначение роли.

az synapse role assignment create --role
                                  --workspace-name
                                  [--acquire-policy-token]
                                  [--assignee]
                                  [--assignee-object-id]
                                  [--assignee-principal-type --assignee-type {Group, ServicePrincipal, User}]
                                  [--assignment-id]
                                  [--change-reference]
                                  [--item]
                                  [--item-type {bigDataPools, credentials, integrationRuntimes, linkedServices}]
                                  [--scope]

Примеры

Создайте назначение роли с помощью имени субъекта-службы.

az synapse role assignment create --workspace-name testsynapseworkspace \
--role "Synapse Administrator" --assignee sp_name

Создайте назначение роли с помощью имени участника-пользователя.

az synapse role assignment create --workspace-name testsynapseworkspace \
--role "Synapse Administrator" --assignee username@contoso.com

Создайте назначение роли с помощью objectId пользователя, группы или субъекта-службы.

az synapse role assignment create --workspace-name testsynapseworkspace \
--role "Synapse Administrator" --assignee 00000000-0000-0000-0000-000000000000

Создайте назначение роли в области.

az synapse role assignment create --workspace-name testsynapseworkspace \
--scope "workspaces/{workspaceName}" --role "Synapse Administrator" --assignee username@contoso.com

Создайте назначение роли в области, которая объединяет тип элемента и имя элемента.

az synapse role assignment create --workspace-name testsynapseworkspace \
--item-type "bigDataPools" --item "bigDataPoolName" --role "Synapse Administrator" \
--assignee username@contoso.com

Если вы являетесь пользователем с разрешением на управление назначением ролей RBAC Azure в рабочей области, но не администратором Synapse, создайте роль assigment, -role roleid. Причина этого заключается в том, что при попытке добавить роль "Администратор Synapse" командлет должен получить идентификатор роли из имени роли, для которого требуется разрешение на чтение рабочей области, которое у текущего пользователя нет.

az synapse role assignment create \
--workspace-name testsynapseworkspace \
--role "6e4bf58a-b8e1-4cc3-bbf9-d73143322b78" \
--assignee username@contoso.com

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

--role

Имя или идентификатор роли, назначенный субъекту.

--workspace-name

Имя рабочей области.

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

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

--acquire-policy-token

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

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

Представляет пользователя или субъекта-службы. Поддерживаемый формат: идентификатор объекта, имя входа пользователя или имя субъекта-службы.

--assignee-object-id

Используйте этот параметр вместо "--assignee", чтобы обойти вызов API Graph в случае нехватки привилегий. Этот параметр работает только с идентификаторами объектов для пользователей, групп, субъектов-служб и управляемых удостоверений. Для управляемых удостоверений используется идентификатор субъекта. Для субъектов-служб используйте идентификатор объекта, а не идентификатор приложения.

--assignee-principal-type --assignee-type

Используйте с идентификатором --assignee-object-id, чтобы избежать ошибок, вызванных задержкой распространения в AAD Graph.

Свойство Значение
Допустимые значения: Group, ServicePrincipal, User
--assignment-id

Пользовательский идентификатор назначения ролей в формате GUID, если он не указан, идентификатор назначения будет создан случайным образом.

--change-reference

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

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

Элемент, предоставленный в рабочей области. Использование с типом --item для объединения области назначения.

--item-type

Тип элемента, предоставленный в рабочей области. Использование с --item для объединения области назначения.

Свойство Значение
Допустимые значения: bigDataPools, credentials, integrationRuntimes, linkedServices
--scope

Область определяет ресурсы или артефакты, к которым применяется доступ. Synapse поддерживает иерархические области. Разрешения, предоставленные в области более высокого уровня, наследуются объектами более низкого уровня. В Synapse RBAC областью верхнего уровня является рабочая область. При назначении роли с областью действия в рабочей области разрешения предоставляются всем применимым объектам в рабочей области.

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az synapse role assignment delete

Удаление назначений ролей рабочей области.

az synapse role assignment delete --workspace-name
                                  [--acquire-policy-token]
                                  [--assignee]
                                  [--assignee-object-id]
                                  [--change-reference]
                                  [--ids]
                                  [--item]
                                  [--item-type {bigDataPools, credentials, integrationRuntimes, linkedServices}]
                                  [--role]
                                  [--scope]
                                  [--yes]

Примеры

Удаление назначений ролей по роли и назначению.

az synapse role assignment delete --workspace-name testsynapseworkspace \
--role "Synapse Administrator" --assignee sp_name

Удаление назначений ролей по идентификатору или имени роли.

az synapse role assignment delete --workspace-name testsynapseworkspace \
--role "Synapse Administrator"

Удаление назначений ролей по имени субъекта-службы.

az synapse role assignment delete --workspace-name testsynapseworkspace \
--assignee sp_name

Удаление назначений ролей по имени участника-пользователя.

az synapse role assignment delete --workspace-name testsynapseworkspace \
--assignee username@contoso.com

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

az synapse role assignment delete --workspace-name testsynapseworkspace \
--assignee 00000000-0000-0000-0000-000000000001

Удаление назначений ролей по идентификаторам.

az synapse role assignment delete --workspace-name testsynapseworkspace \
--ids 10000000-0000-0000-0000-10000000-10000000-0000-0000-0000-10000000

Удаление назначений ролей по области.

az synapse role assignment delete --workspace-name testsynapseworkspace \
--scope "workspaces/testsynapseworkspace/linkedServices/testlinkedServices"

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

--workspace-name

Имя рабочей области.

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

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

--acquire-policy-token

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

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

Представляет пользователя или субъекта-службы. Поддерживаемый формат: идентификатор объекта, имя входа пользователя или имя субъекта-службы.

--assignee-object-id

Используйте этот параметр вместо "--assignee", чтобы обойти вызов API Graph в случае нехватки привилегий. Этот параметр работает только с идентификаторами объектов для пользователей, групп, субъектов-служб и управляемых удостоверений. Для управляемых удостоверений используется идентификатор субъекта. Для субъектов-служб используйте идентификатор объекта, а не идентификатор приложения.

--change-reference

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

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

Идентификаторы назначения ролей, разделенные пробелами. Не следует предоставлять имя --role или --assignee при предоставлении идентификаторов.

--item

Элемент, предоставленный в рабочей области. Использование с типом --item для объединения области назначения. Использование az role assignment с условием фильтра перед выполнением операции удаления, чтобы четко знать, какие назначения будут удалены.

--item-type

Тип элемента, предоставленный в рабочей области. Использование с --item для объединения области назначения. Использование az role assignment с условием фильтра перед выполнением операции удаления, чтобы четко знать, какие назначения будут удалены.

Свойство Значение
Допустимые значения: bigDataPools, credentials, integrationRuntimes, linkedServices
--role

Имя или идентификатор роли, назначенный субъекту.

--scope

Область определяет ресурсы или артефакты, к которым применяется доступ. Synapse поддерживает иерархические области. Разрешения, предоставленные в области более высокого уровня, наследуются объектами более низкого уровня. В Synapse RBAC областью верхнего уровня является рабочая область. Использование az role assignment с условием фильтра перед выполнением операции удаления, чтобы четко знать, какие назначения будут удалены.

--yes -y

Не запрашивать подтверждение.

Свойство Значение
Default value: False
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az synapse role assignment list

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

az synapse role assignment list --workspace-name
                                [--assignee]
                                [--assignee-object-id]
                                [--item]
                                [--item-type {bigDataPools, credentials, integrationRuntimes, linkedServices}]
                                [--role]
                                [--scope]

Примеры

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

az synapse role assignment list --workspace-name testsynapseworkspace

Вывод списка назначений ролей по идентификатору или имени роли.

az synapse role assignment list --workspace-name testsynapseworkspace \
--role "Synapse Apache Spark Administrator"

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

az synapse role assignment list --workspace-name testsynapseworkspace \
--assignee sp_name

Вывод списка назначений ролей по объекту User, Group или Service Principal.

az synapse role assignment list --workspace-name testsynapseworkspace \
--assignee-object-id 00000000-0000-0000-0000-000000000000

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

az synapse role assignment list --workspace-name testsynapseworkspace \
--scope "workspaces/{workspaceName}"

Вывод списка назначений ролей по типу элемента и имени элемента.

az synapse role assignment list --workspace-name testsynapseworkspace \
--item-type "bigDataPools" --item "bigDataPoolName"

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

--workspace-name

Имя рабочей области.

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

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

--assignee

Представляет пользователя или субъекта-службы. Поддерживаемый формат: идентификатор объекта, имя входа пользователя или имя субъекта-службы.

--assignee-object-id

Используйте этот параметр вместо "--assignee", чтобы обойти вызов API Graph в случае нехватки привилегий. Этот параметр работает только с идентификаторами объектов для пользователей, групп, субъектов-служб и управляемых удостоверений. Для управляемых удостоверений используется идентификатор субъекта. Для субъектов-служб используйте идентификатор объекта, а не идентификатор приложения.

--item

Элемент, предоставленный в рабочей области. Использование с типом --item для объединения области назначения.

--item-type

Тип элемента, предоставленный в рабочей области. Использование с --item для объединения области назначения.

Свойство Значение
Допустимые значения: bigDataPools, credentials, integrationRuntimes, linkedServices
--role

Имя или идентификатор роли, назначенный субъекту.

--scope

Область определяет ресурсы или артефакты, к которым применяется доступ. Synapse поддерживает иерархические области. Разрешения, предоставленные в области более высокого уровня, наследуются объектами более низкого уровня. В Synapse RBAC областью верхнего уровня является рабочая область. При назначении роли с областью действия в рабочей области разрешения предоставляются всем применимым объектам в рабочей области.

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az synapse role assignment show

Получение назначения роли по идентификатору.

az synapse role assignment show --id
                                --workspace-name

Примеры

Получение назначения роли по идентификатору.

az synapse role assignment show --workspace-name testsynapseworkspace \
--id 00000000-0000-0000-0000-000000000000

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

--id

Идентификатор роли, назначенной субъекту.

--workspace-name

Имя рабочей области.

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False