Compartilhar via

az synapse role assignment

Gerenciar as atribuições de função do Synapse.

Comandos

Nome Description Tipo Status
az synapse role assignment create

Crie uma atribuição de função.

 Core GA
az synapse role assignment delete

Excluir atribuições de função do workspace.

 Core GA
az synapse role assignment list

Listar atribuições de função.

 Core GA
az synapse role assignment show

Obtenha uma atribuição de função por ID.

 Core GA

az synapse role assignment create

Editar

Crie uma atribuição de função.

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

Exemplos

Crie uma atribuição de função usando o nome da entidade de serviço.

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

Crie uma atribuição de função usando o nome de entidade de segurança do usuário.

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

Crie uma atribuição de função usando objectId do Usuário, Grupo ou Entidade de Serviço.

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

Crie uma atribuição de função no escopo.

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

Crie uma atribuição de função no escopo que combina o tipo de item e o nome do item.

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

Quando você for um usuário com permissão para gerenciar a atribuição de função RBAC do Azure no workspace, mas não um Administrador do Synapse, crie o assigment de função -role roleid. O motivo disso é que, quando você tenta adicionar uma função de "Administrador do Synapse", o cmdlet precisa obter a ID da função do nome da função que exige a permissão de leitura do workspace, que o usuário atual não tem.

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

Parâmetros Exigidos

--role

O nome/id da função atribuído à entidade de segurança.

--workspace-name

O nome do workspace.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--assignee

Represente um usuário ou entidade de serviço. Formato com suporte: id de objeto, nome de entrada do usuário ou nome da entidade de serviço.

--assignee-object-id

Use esse parâmetro em vez de '--assignee' para ignorar a invocação da API do Graph em caso de privilégios insuficientes. Esse parâmetro só funciona com IDs de objeto para usuários, grupos, entidades de serviço e identidades gerenciadas. Para identidades gerenciadas, use a ID da entidade de segurança. Para entidades de serviço, use a ID do objeto e não a ID do aplicativo.

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

Use com --assignee-object-id para evitar erros causados pela latência de propagação no AAD Graph.

Propriedade Valor
Valores aceitos: Group, ServicePrincipal, User
--assignment-id

A ID da atribuição de função personalizada no formato guid, se não for especificada, a ID da atribuição será gerada aleatoriamente.

--item

O item concedeu acesso no workspace. Usar com --item-type para combinar o escopo da atribuição.

--item-type

O tipo de item concedeu acesso no workspace. Usar com --item para combinar o escopo da atribuição.

Propriedade Valor
Valores aceitos: bigDataPools, credentials, integrationRuntimes, linkedServices
--scope

Um escopo define os recursos ou artefatos aos quais o acesso se aplica. O Synapse dá suporte a escopos hierárquicos. As permissões concedidas em um escopo de nível superior são herdadas por objetos em um nível inferior. No RBAC do Azure Synapse, o escopo de nível superior é um workspace. A atribuição de uma função com escopo de workspace concede permissões a todos os objetos aplicáveis no workspace.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az synapse role assignment delete

Editar

Excluir atribuições de função do workspace.

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

Exemplos

Excluir atribuições de função por função e atribuído.

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

Excluir atribuições de função por id/nome da função.

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

Excluir atribuições de função pelo nome da entidade de serviço.

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

Excluir atribuições de função por nome de entidade de usuário.

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

Excluir atribuições de função por objectId do Usuário, Grupo ou Entidade de Serviço.

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

Excluir atribuições de função por IDs.

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

Excluir atribuições de função por escopo.

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

Parâmetros Exigidos

--workspace-name

O nome do workspace.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--assignee

Represente um usuário ou entidade de serviço. Formato com suporte: id de objeto, nome de entrada do usuário ou nome da entidade de serviço.

--assignee-object-id

Use esse parâmetro em vez de '--assignee' para ignorar a invocação da API do Graph em caso de privilégios insuficientes. Esse parâmetro só funciona com IDs de objeto para usuários, grupos, entidades de serviço e identidades gerenciadas. Para identidades gerenciadas, use a ID da entidade de segurança. Para entidades de serviço, use a ID do objeto e não a ID do aplicativo.

--ids

IDs de atribuição de função separadas por espaço. Você não deve fornecer --role ou --assignee quando --ids são fornecidas.

--item

O item concedeu acesso no workspace. Usar com --item-type para combinar o escopo da atribuição. Usar a atribuição de função az com condição de filtro antes de executar a operação de exclusão para estar claramente ciente de quais atribuições serão excluídas.

--item-type

O tipo de item concedeu acesso no workspace. Usar com --item para combinar o escopo da atribuição. Usar a atribuição de função az com condição de filtro antes de executar a operação de exclusão para estar claramente ciente de quais atribuições serão excluídas.

Propriedade Valor
Valores aceitos: bigDataPools, credentials, integrationRuntimes, linkedServices
--role

O nome/id da função atribuído à entidade de segurança.

--scope

Um escopo define os recursos ou artefatos aos quais o acesso se aplica. O Synapse dá suporte a escopos hierárquicos. As permissões concedidas em um escopo de nível superior são herdadas por objetos em um nível inferior. No RBAC do Azure Synapse, o escopo de nível superior é um workspace. Usar a atribuição de função az com condição de filtro antes de executar a operação de exclusão para estar claramente ciente de quais atribuições serão excluídas.

--yes -y

Não solicite confirmação.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az synapse role assignment list

Editar

Listar atribuições de função.

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

Exemplos

Listar atribuições de função.

az synapse role assignment list --workspace-name testsynapseworkspace

Listar atribuições de função por id/nome da função.

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

Listar atribuições de função por atribuído.

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

Listar atribuições de função por objectId do Usuário, Grupo ou Entidade de Serviço.

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

Listar atribuições de função por escopo.

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

Listar atribuições de função por tipo de item e nome do item.

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

Parâmetros Exigidos

--workspace-name

O nome do workspace.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--assignee

Represente um usuário ou entidade de serviço. Formato com suporte: id de objeto, nome de entrada do usuário ou nome da entidade de serviço.

--assignee-object-id

Use esse parâmetro em vez de '--assignee' para ignorar a invocação da API do Graph em caso de privilégios insuficientes. Esse parâmetro só funciona com IDs de objeto para usuários, grupos, entidades de serviço e identidades gerenciadas. Para identidades gerenciadas, use a ID da entidade de segurança. Para entidades de serviço, use a ID do objeto e não a ID do aplicativo.

--item

O item concedeu acesso no workspace. Usar com --item-type para combinar o escopo da atribuição.

--item-type

O tipo de item concedeu acesso no workspace. Usar com --item para combinar o escopo da atribuição.

Propriedade Valor
Valores aceitos: bigDataPools, credentials, integrationRuntimes, linkedServices
--role

O nome/id da função atribuído à entidade de segurança.

--scope

Um escopo define os recursos ou artefatos aos quais o acesso se aplica. O Synapse dá suporte a escopos hierárquicos. As permissões concedidas em um escopo de nível superior são herdadas por objetos em um nível inferior. No RBAC do Azure Synapse, o escopo de nível superior é um workspace. A atribuição de uma função com escopo de workspace concede permissões a todos os objetos aplicáveis no workspace.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az synapse role assignment show

Editar

Obtenha uma atribuição de função por ID.

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

Exemplos

Obtenha uma atribuição de função por ID.

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

Parâmetros Exigidos

--id

ID da função atribuída à entidade de segurança.

--workspace-name

O nome do workspace.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False