Remove-AzSynapseRoleAssignment

リファレンス

モジュール:: Az.Synapse

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 コマンドレットは、Azure Synapse Analytics ロールの割り当てを完全に削除します。

このコマンドレットは、入力パラメーターに従って、以下の Microsoft Graph API を呼び出す場合があります。

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

Note

サービスプリンシパルのロールの割り当てを削除するには、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

バックグラウンドでコマンドレットを実行する

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

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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 ワークスペースの itemtype。

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

このコマンドレットは、既定ではオブジェクトを返しません。このスイッチを指定すると、成功した場合は 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

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

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

次の方法で共有