Remove-AzureRmRoleAssignment

モジュール:

AzureRM.Resources

特定のスコープで特定のロールに割り当てられている、指定したプリンシパルへのロールの割り当てを削除します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日に正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールの機能は今後も使用できますが、メンテナンスやサポートは行われないため、引き続きの使用はユーザーの判断に委ねられ、リスクが発生することがあります。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Remove-AzureRmRoleAssignment
      -ObjectId <Guid>
      [-Scope <String>]
      -RoleDefinitionName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmRoleAssignment
      -ObjectId <Guid>
      -ResourceGroupName <String>
      -ResourceName <String>
      -ResourceType <String>
      [-ParentResource <String>]
      -RoleDefinitionName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmRoleAssignment
      -ObjectId <Guid>
      -ResourceGroupName <String>
      -RoleDefinitionName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmRoleAssignment
      -ObjectId <Guid>
      [-Scope <String>]
      -RoleDefinitionName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmRoleAssignment
      -ObjectId <Guid>
      [-Scope <String>]
      -RoleDefinitionId <Guid>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmRoleAssignment
      -SignInName <String>
      -ResourceGroupName <String>
      -ResourceName <String>
      -ResourceType <String>
      [-ParentResource <String>]
      -RoleDefinitionName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmRoleAssignment
      -SignInName <String>
      -ResourceGroupName <String>
      -RoleDefinitionName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmRoleAssignment
      -SignInName <String>
      [-Scope <String>]
      -RoleDefinitionName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmRoleAssignment
      -ServicePrincipalName <String>
      -ResourceGroupName <String>
      -ResourceName <String>
      -ResourceType <String>
      [-ParentResource <String>]
      -RoleDefinitionName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmRoleAssignment
      -ServicePrincipalName <String>
      -ResourceGroupName <String>
      -RoleDefinitionName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmRoleAssignment
      -ServicePrincipalName <String>
      [-Scope <String>]
      -RoleDefinitionName <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzureRmRoleAssignment
      [-PassThru]
      [-InputObject] <PSRoleAssignment>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-AzureRmRoleAssignment コマンドレットを使用して、特定のスコープと特定のロールで任意のプリンシパルへのアクセスを取り消します。 割り当てのオブジェクト、つまりプリンシパルを指定する必要があります。 プリンシパルには、ユーザー (SignInName パラメーターまたは ObjectId パラメーターを使用してユーザーを識別する)、セキュリティ グループ (ObjectId パラメーターを使用してグループを識別する)、サービス プリンシパル (ServicePrincipalName または ObjectId パラメーターを使用して ServicePrincipal を識別する) を指定できます。 プリンシパルが割り当てられているロールは、RoleDefinitionName パラメーターを使用して指定する必要があります。 割り当てのスコープは MAY を指定でき、指定されていない場合は既定でサブスクリプション スコープに設定されます。つまり、サブスクリプション スコープで指定されたプリンシパルとロールへの割り当ての削除が試行されます。 割り当てのスコープは、次のいずれかのパラメーターを使用して指定できます。 a. スコープ - これは、/subscriptions/<subscriptionId> b で始まる完全修飾スコープです。 ResourceGroupName - サブスクリプションの下にある任意のリソース グループの名前。 c. ResourceName、ResourceType、ResourceGroupName、および (必要に応じて) ParentResource - サブスクリプションの特定のリソースを識別します。

例

例 1

PS C:\> Remove-AzureRmRoleAssignment -ResourceGroupName rg1 -SignInName john.doe@contoso.com -RoleDefinitionName Reader

rg1 リソース グループ スコープで閲覧者ロールに割り当てられている john.doe@contoso.com のロールの割り当てを削除します。

例 2

PS C:\> Remove-AzureRmRoleAssignment -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -RoleDefinitionName Reader

ObjectId によって識別され、閲覧者ロールに割り当てられているグループ プリンシパルへのロールの割り当てを削除します。 既定では、現在のサブスクリプションをスコープとして使用して、削除する割り当てを検索します。

例 3

PS C:\> $roleassignment = Get-AzureRmRoleAssignment |Select-Object -First 1 -Wait
PS C:\> Remove-AzureRmRoleAssignment -InputObject $roleassignment

Get-AzureRmRoleAssignment コマンドレットからフェッチされる最初のロール割り当てオブジェクトを削除します。

パラメーター

-Confirm

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

型:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

ロールの割り当てオブジェクト。

型:	PSRoleAssignment
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ObjectId

ユーザー、グループ、またはサービス プリンシパルの Microsoft Entra ObjectId。

型:	Guid
Aliases:	Id, PrincipalId
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ParentResource

ResourceName パラメーターを使用して指定されたリソースの階層内の親リソース (存在する場合)。 リソースを識別する相対 URI の形式で階層スコープを構築するには、ResourceGroupName、ResourceType、および ResourceName パラメーターと組み合わせて使用する必要があります。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-PassThru

指定した場合は、削除されたロールの割り当てが表示されます

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceGroupName

ロールが割り当てられているリソース グループ名。 指定したリソース グループ スコープでの割り当ての削除を試みます。 ResourceName、ResourceType、および (オプションで) ParentResource パラメーターと組み合わせて使用すると、リソースを識別する相対 URI の形式で階層スコープが構築されます。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ResourceName

リソースの名前。 例: storageaccountprod。 リソースを識別し、そのスコープで割り当てを削除する相対 URI の形式で階層スコープを構築するには、ResourceGroupName、ResourceType、および (必要に応じて)ParentResource パラメーターと組み合わせて使用する必要があります。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ResourceType

リソースの種類。 たとえば、Microsoft.Network/virtualNetworks などです。 リソースを識別し、そのリソース スコープで割り当てを削除する相対 URI の形式で階層スコープを構築するには、ResourceGroupName、ResourceName、および (必要に応じて) ParentResource パラメーターと組み合わせて使用する必要があります。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-RoleDefinitionId

割り当てを削除する必要がある RBAC ロールの ID。

型:	Guid
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-RoleDefinitionName

割り当てを削除する必要がある RBAC ロールの名前 (閲覧者、共同作成者、仮想ネットワーク管理者など)。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Scope

削除するロールの割り当てのスコープ。 相対 URI の形式。 例: "/subscriptions/9004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/TestRG"。 指定しない場合は、サブスクリプション レベルでロールの削除を試みます。 指定した場合は、"/subscriptions/{id}" で始まる必要があります。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ServicePrincipalName

Microsoft Entra アプリケーションの ServicePrincipalName

型:	String
Aliases:	SPN
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-SignInName

ユーザーの電子メール アドレスまたはユーザー プリンシパル名。

型:	String
Aliases:	Email, UserPrincipalName
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-WhatIf

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

Guid

String

PSRoleAssignment

Parameters: InputObject (ByValue)

出力

PSRoleAssignment

メモ

キーワード: azure, azurerm, arm, リソース, 管理, マネージャー, リソース, グループ, テンプレート, デプロイ

関連リンク

• New-AzureRmRoleAssignment
• Get-AzureRmRoleAssignment
• Get-AzureRmRoleDefinition