通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Set-AzSynapseSqlActiveDirectoryAdministrator

模块:
Az.Synapse Module

为 Synapse Analytics SQL 池预配Microsoft Entra管理员。

语法

SetByNameAndDisplayNameParameterSet (默认值) 

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>]

说明

Set-AzSynapseSqlActiveDirectoryAdministrator cmdlet 为当前订阅中的Azure Synapse Analytics工作区预配Microsoft Entra管理员。 一次只能预配一个管理员。 可以将Microsoft Entra ID的以下成员预配为 Synapse Analytics 工作区管理员：

  • Microsoft Entra ID的本机成员
  • Microsoft Entra ID的联合成员
  • 从属于本机或联合成员的其他 Azure AD 导入的成员
  • Microsoft Entra作为安全组创建的组Microsoft帐户（例如 Outlook.com、Hotmail.com 或 Live.com 域中的组）不支持管理员。 管理员不支持其他来宾帐户，例如 Gmail.com 或 Yahoo.com 域中的来宾帐户。 建议以管理员身份预配专用Microsoft Entra组。

cmdlet 可以根据输入参数调用以下Microsoft 图形 API：

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

示例

示例 1

Set-AzSynapseSqlActiveDirectoryAdministrator -WorkspaceName ContosoWorkspace -DisplayName "DBAs"

此命令为名为 ContosoWorkspace 的工作区预配名为 DBA 的Microsoft Entra管理员组。

示例 2

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

此命令通过名为 ContosoWorkspace 的工作区的 objectId 预配Microsoft Entra管理员。

参数

-AsJob

在后台运行 cmdlet

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Confirm

在运行 cmdlet 之前，提示你进行确认。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:Cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-DefaultProfile

用于与Azure通信的凭据、帐户、租户和订阅。

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-DisplayName

指定要向其授予权限的用户或组的显示名称。 此显示名称必须存在于与当前订阅关联的 Active Directory 中。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

SetByNameAndDisplayNameParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False
SetByInputObjectAndDisplayNameParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False
SetByResourceIdAndDisplayNameParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-InputObject

工作区输入对象，通常通过管道传递。

参数属性

类型:PSSynapseWorkspace
默认值:None
支持通配符:False
不显示:False

参数集

SetByInputObjectAndDisplayNameParameterSet
Position:Named
必需:True
来自管道的值:True
来自管道的值（按属性名称）:False
来自剩余参数的值:False
SetByInputObjectAndObjectIdParameterSet
Position:Named
必需:True
来自管道的值:True
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-ObjectId

指定要向其授予权限Microsoft Entra ID中的用户或组的对象 ID。

参数属性

类型:Guid
默认值:None
支持通配符:False
不显示:False

参数集

SetByNameAndObjectIdParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False
SetByInputObjectAndObjectIdParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False
SetByResourceIdAndObjectIdParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-ResourceGroupName

资源组名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

SetByNameAndDisplayNameParameterSet
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False
SetByNameAndObjectIdParameterSet
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-ResourceId

Synapse 工作区的资源标识符。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

SetByResourceIdAndDisplayNameParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False
SetByResourceIdAndObjectIdParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-WorkspaceName

Synapse 工作区的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

SetByNameAndDisplayNameParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False
SetByNameAndObjectIdParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

输入

PSSynapseWorkspace

输出

PSWorkspaceAadAdminInfo