Compartilhar via


Set-AzSynapseSqlActiveDirectoryAdministrator

Provisiona um administrador Microsoft Entra para o pool de SQL do Synapse Analytics.

Sintaxe

SetByNameAndDisplayNameParameterSet (Default)

Set-AzSynapseSqlActiveDirectoryAdministrator
    -WorkspaceName <String>
    -DisplayName <String>
    [-ResourceGroupName <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByNameAndObjectIdParameterSet

Set-AzSynapseSqlActiveDirectoryAdministrator
    -WorkspaceName <String>
    -ObjectId <Guid>
    [-ResourceGroupName <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByInputObjectAndDisplayNameParameterSet

Set-AzSynapseSqlActiveDirectoryAdministrator
    -InputObject <PSSynapseWorkspace>
    -DisplayName <String>
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByInputObjectAndObjectIdParameterSet

Set-AzSynapseSqlActiveDirectoryAdministrator
    -InputObject <PSSynapseWorkspace>
    -ObjectId <Guid>
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByResourceIdAndDisplayNameParameterSet

Set-AzSynapseSqlActiveDirectoryAdministrator
    -ResourceId <String>
    -DisplayName <String>
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByResourceIdAndObjectIdParameterSet

Set-AzSynapseSqlActiveDirectoryAdministrator
    -ResourceId <String>
    -ObjectId <Guid>
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

O cmdlet Set-AzSynapseSqlActiveDirectoryAdministrator provisiona um administrador Microsoft Entra para Azure Synapse Analytics Workspace na assinatura atual. Você pode provisionar apenas um administrador por vez. Os seguintes membros do Microsoft Entra ID podem ser provisionados como um administrador do Workspace do Synapse Analytics:

  • Membros nativos do Microsoft Entra ID
  • Membros federados do Microsoft Entra ID
  • Membros importados de outros Azure ADs que são membros nativos ou federados
  • Microsoft Entra grupos criados como grupos de segurança Microsoft contas, como os dos domínios Outlook.com, Hotmail.com ou Live.com, não têm suporte como administradores. Outras contas de convidado, como as dos domínios Gmail.com ou Yahoo.com, não têm suporte como administradores. Recomendamos que você provisione um grupo de Microsoft Entra dedicado como administrador.

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

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

Exemplos

Exemplo 1

Set-AzSynapseSqlActiveDirectoryAdministrator -WorkspaceName ContosoWorkspace -DisplayName "DBAs"

Esse comando provisiona um grupo de administradores Microsoft Entra chamado DBAs para o workspace chamado ContosoWorkspace.

Exemplo 2

Set-AzSynapseSqlActiveDirectoryAdministrator -WorkspaceName ContosoWorkspace -ObjectId "40b79501-b343-44ed-9ce7-da4c8cc7353b"

Esse comando provisiona um administrador Microsoft Entra por objectId para o workspace chamado ContosoWorkspace.

Parâmetros

-AsJob

Executar cmdlet em segundo plano

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Confirm

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultProfile

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

Propriedades do parâmetro

Tipo:IAzureContextContainer
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DisplayName

Especifica o nome de exibição do usuário ou grupo para quem conceder permissões. Esse nome de exibição deve existir no active directory associado à assinatura atual.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

SetByNameAndDisplayNameParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
SetByInputObjectAndDisplayNameParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
SetByResourceIdAndDisplayNameParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-InputObject

objeto de entrada do workspace, geralmente passado pelo pipeline.

Propriedades do parâmetro

Tipo:PSSynapseWorkspace
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

SetByInputObjectAndDisplayNameParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
SetByInputObjectAndObjectIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ObjectId

Especifica a ID do objeto do usuário ou grupo no Microsoft Entra ID para o qual conceder permissões.

Propriedades do parâmetro

Tipo:Guid
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

SetByNameAndObjectIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
SetByInputObjectAndObjectIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
SetByResourceIdAndObjectIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ResourceGroupName

Nome do grupo de recursos.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

SetByNameAndDisplayNameParameterSet
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
SetByNameAndObjectIdParameterSet
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ResourceId

Identificador de recurso do workspace do Synapse.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

SetByResourceIdAndDisplayNameParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
SetByResourceIdAndObjectIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WorkspaceName

Nome do workspace do Synapse.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

SetByNameAndDisplayNameParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
SetByNameAndObjectIdParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSSynapseWorkspace

Saídas

PSWorkspaceAadAdminInfo