Compartilhar via

New-AzSynapseRoleAssignment

  • Referência
Módulo:
Az.Synapse

Cria uma atribuição de função do Synapse Analytics.

Sintaxe

New-AzSynapseRoleAssignment
   -WorkspaceName <String>
   -RoleDefinitionName <String>
   -SignInName <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseRoleAssignment
   -WorkspaceName <String>
   -RoleDefinitionName <String>
   -ObjectId <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseRoleAssignment
   -WorkspaceName <String>
   -RoleDefinitionId <String>
   -ObjectId <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseRoleAssignment
   -WorkspaceName <String>
   -RoleDefinitionName <String>
   -ServicePrincipalName <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseRoleAssignment
   -WorkspaceObject <PSSynapseWorkspace>
   -RoleDefinitionName <String>
   -SignInName <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseRoleAssignment
   -WorkspaceObject <PSSynapseWorkspace>
   -RoleDefinitionName <String>
   -ObjectId <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseRoleAssignment
   -WorkspaceObject <PSSynapseWorkspace>
   -RoleDefinitionId <String>
   -ObjectId <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzSynapseRoleAssignment
   -WorkspaceObject <PSSynapseWorkspace>
   -RoleDefinitionName <String>
   -ServicePrincipalName <String>
   [-ItemType <WorkspaceItemType>]
   [-Item <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

O cmdlet New-AzSynapseRoleAssignment cria uma atribuição de função do Azure Synapse Analytics.

O cmdlet pode chamar abaixo da API do Microsoft Graph de acordo com os parâmetros de entrada:

  • GET /users/{id}
  • GET /servicePrincipals/{id}

Nota

Para criar uma atribuição de função para uma entidade de serviço, passe a ID do objeto da entidade de segurança no parâmetro ObjectId. 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 uma função de Administrador do Synapse -RoleDefinitionId e -ObjectId diretamente, mas não por -RoleDefinitionName, para Administrador do Synapse, RoleDefinitionId é "aaaaaaaaa-0000-1111-2222-bbbbbbbbbbbb", veja abaixo o Exemplo 5 como referência. 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.

Exemplos

Exemplo 1

New-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName

Esse comando atribui ContosoRole ao usuário cujo nome principal é ContosoName.

Exemplo 2

New-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName -ItemType ContosoItemType -Item ContosoItem

Esse comando atribui ContosoRole ao usuário cujo nome principal é ContosoName e o tipo de item é ContosoItemType, o item é ContosoItem.

Exemplo 3

New-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName -ItemType ContosoItemType -Item ContosoItem

Esse comando atribui ContosoRole ao usuário cujo nome principal é ContosoName e o tipo de item é ContosoItemType, o item é ContosoItem.

Exemplo 4

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | New-AzSynapseRoleAssignment -RoleDefinitionName ContosoRole -SignInName ContosoName

Esse comando atribui ContosoRole ao usuário cujo nome principal é ContosoName por meio do pipeline.

Exemplo 5

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | New-AzSynapseRoleAssignment -RoleDefinitionId "00001111-aaaa-2222-bbbb-3333cccc4444" -ObjectId ContosoObjectId

Esse comando atribui a função de Administrador do Synapse ao usuário cuja ID de objeto é ContosoObjectId por meio do pipeline.

Parâmetros

-AsJob

Executar cmdlet em segundo plano

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Confirm

Solicita a confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Item

O item do workspace.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ItemType

O tipo de item do workspace.

Tipo:Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+WorkspaceItemType
Valores aceitos:ApacheSparkPool, IntegrationRuntime, LinkedService, Credential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ObjectId

O Microsoft Entra ObjectId do usuário, grupo ou entidade de serviço.

Tipo:String
Aliases:Id, PrincipalId
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-RoleDefinitionId

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

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-RoleDefinitionName

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

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ServicePrincipalName

O ServicePrincipalName da entidade de serviço.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-SignInName

O endereço de email ou o nome principal do usuário.

Tipo:String
Aliases:Email, UserPrincipalName
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WorkspaceName

Nome do workspace do Synapse.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WorkspaceObject

objeto de entrada do workspace, geralmente passado pelo pipeline.

Tipo:PSSynapseWorkspace
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

Entradas

PSSynapseWorkspace

Saídas

PSRoleAssignmentDetails