你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Set-AzSynapseSqlActiveDirectoryAdministrator
为 Synapse Analytics SQL 池预配 Microsoft Entra 管理员。
语法
Set-AzSynapseSqlActiveDirectoryAdministrator
[-ResourceGroupName <String>]
-WorkspaceName <String>
-DisplayName <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSynapseSqlActiveDirectoryAdministrator
[-ResourceGroupName <String>]
-WorkspaceName <String>
-ObjectId <Guid>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSynapseSqlActiveDirectoryAdministrator
-InputObject <PSSynapseWorkspace>
-DisplayName <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSynapseSqlActiveDirectoryAdministrator
-InputObject <PSSynapseWorkspace>
-ObjectId <Guid>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSynapseSqlActiveDirectoryAdministrator
-ResourceId <String>
-DisplayName <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzSynapseSqlActiveDirectoryAdministrator
-ResourceId <String>
-ObjectId <Guid>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
Set-AzSynapseSqlActiveDirectory管理员istrator cmdlet 在当前订阅中为 Azure Synapse Analytics 工作区预配 Microsoft Entra 管理员。 一次只能预配一个管理员。 可以将以下 Microsoft Entra ID 成员预配为 Synapse Analytics 工作区管理员:
- Microsoft Entra ID 的本机成员
- Microsoft Entra ID 的联合成员
- 从本机或联合成员的其他 Azure AD 导入的成员
- 管理员不支持创建为安全组的 Microsoft Entra 组,例如 Outlook.com、Hotmail.com 或 Live.com 域中的安全组。 管理员不支持其他来宾帐户,例如 Gmail.com 或 Yahoo.com 域中的来宾帐户。 建议以管理员身份预配专用的 Microsoft Entra 组。
该 cmdlet 可以根据输入参数调用以下 Microsoft Graph 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"
此命令通过 objectId 为名为 ContosoWorkspace 的工作区预配 Microsoft Entra 管理员。
参数
-AsJob
在后台运行 cmdlet
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
提示你在运行 cmdlet 之前进行确认。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
用于与 Azure 通信的凭据、帐户、租户和订阅。
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisplayName
指定要向其授予权限的用户或组的显示名称。 此显示名称必须存在于与当前订阅关联的 Active Directory 中。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
工作区输入对象,通常通过管道传递。
Type: | PSSynapseWorkspace |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ObjectId
指定要向其授予权限的 Microsoft Entra ID 中的用户或组的对象 ID。
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
资源组名称。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceId
Synapse 工作区的资源标识符。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WorkspaceName
Synapse 工作区的名称。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
输入
输出
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈