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

Remove-AzSynapseRoleAssignment

删除 Synapse Analytics 角色分配。

语法

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

说明

Remove-AzSynapseRoleAssignment cmdlet 永久删除 Azure Synapse Analytics 角色分配。

该 cmdlet 可以根据输入参数调用以下 Microsoft Graph API:

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

注意

若要删除服务主体的角色分配,请传递 ObjectId 参数中主体的对象 ID。

示例

示例 1

Remove-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleAssignmentId ContosoRoleAssignmentId

此命令删除具有角色分配 ID 的 Azure Synapse Analytics 角色分配。

示例 2

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

此命令使用角色名称和用户主体名称删除工作区级别的 Azure Synapse Analytics 角色分配。

示例 3

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

此命令删除具有角色名称、用户主体名称、项类型和项的 Azure Synapse Analytics 角色分配。

示例 4

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Remove-AzSynapseRoleAssignment -RoleAssignmentId ContosoRoleAssignmentId

此命令通过管道删除具有角色分配 ID 的 Azure Synapse Analytics 角色分配。

参数

-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

-Item

Azure Synapse 工作区的项。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ItemType

Azure Synapse 工作区的项类型。

Type:Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+WorkspaceItemType
Accepted values:ApacheSparkPool, IntegrationRuntime, LinkedService, Credential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ObjectId

用户、组或服务主体的 Microsoft Entra ObjectId。

Type:String
Aliases:Id, PrincipalId
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

默认情况下,此 Cmdlet 不返回对象。 如果指定了此开关,则如果成功,则返回 true。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RoleAssignmentId

角色分配的 ID。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RoleDefinitionId

分配给主体的角色的 ID。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RoleDefinitionName

分配给主体的角色的名称。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ServicePrincipalName

服务主体的 ServicePrincipalName。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SignInName

用户的电子邮件地址或用户主体名称。

Type:String
Aliases:Email, UserPrincipalName
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

-WorkspaceObject

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

Type:PSSynapseWorkspace
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

输入

PSSynapseWorkspace

输出

Boolean