Remove-AzRoleAssignment
特定のスコープで特定のロールに割り当てられている、指定したプリンシパルへのロールの割り当てを削除します。
このコマンドレットは、入力パラメーターに従って、以下の Microsoft Graph API を呼び出す場合があります。
- /users/{id} を取得してください
- /servicePrincipals/{id} を取得してください。
- /groups/{id} を取得してください
- GET /directoryObjects/{id}
- POST /directoryObjects/getByIds
このコマンドレットは、ロールの割り当てのオブジェクトが見つからない場合、または現在のアカウントにオブジェクトの種類を取得するための十分な権限がない場合、 ObjectType を出力に Unknown としてマークします。
構文
EmptyParameterSet (既定)
Remove-AzRoleAssignment
-ObjectId <String>
-RoleDefinitionName <String>
[-Scope <String>]
[-PassThru]
[-SkipClientSideScopeValidation]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ResourceWithObjectIdParameterSet
Remove-AzRoleAssignment
-ObjectId <String>
-ResourceGroupName <String>
-ResourceName <String>
-ResourceType <String>
-RoleDefinitionName <String>
[-ParentResource <String>]
[-PassThru]
[-SkipClientSideScopeValidation]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ResourceGroupWithObjectIdParameterSet
Remove-AzRoleAssignment
-ObjectId <String>
-ResourceGroupName <String>
-RoleDefinitionName <String>
[-PassThru]
[-SkipClientSideScopeValidation]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ScopeWithObjectIdParameterSet
Remove-AzRoleAssignment
-ObjectId <String>
-RoleDefinitionName <String>
[-Scope <String>]
[-PassThru]
[-SkipClientSideScopeValidation]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RoleIdWithScopeAndObjectIdParameterSet
Remove-AzRoleAssignment
-ObjectId <String>
-RoleDefinitionId <Guid>
[-Scope <String>]
[-PassThru]
[-SkipClientSideScopeValidation]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ResourceWithSignInNameParameterSet
Remove-AzRoleAssignment
-SignInName <String>
-ResourceGroupName <String>
-ResourceName <String>
-ResourceType <String>
-RoleDefinitionName <String>
[-ParentResource <String>]
[-PassThru]
[-SkipClientSideScopeValidation]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ResourceGroupWithSignInNameParameterSet
Remove-AzRoleAssignment
-SignInName <String>
-ResourceGroupName <String>
-RoleDefinitionName <String>
[-PassThru]
[-SkipClientSideScopeValidation]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ScopeWithSignInNameParameterSet
Remove-AzRoleAssignment
-SignInName <String>
-RoleDefinitionName <String>
[-Scope <String>]
[-PassThru]
[-SkipClientSideScopeValidation]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ResourceWithSPNParameterSet
Remove-AzRoleAssignment
-ServicePrincipalName <String>
-ResourceGroupName <String>
-ResourceName <String>
-ResourceType <String>
-RoleDefinitionName <String>
[-ParentResource <String>]
[-PassThru]
[-SkipClientSideScopeValidation]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ResourceGroupWithSPNParameterSet
Remove-AzRoleAssignment
-ServicePrincipalName <String>
-ResourceGroupName <String>
-RoleDefinitionName <String>
[-PassThru]
[-SkipClientSideScopeValidation]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ScopeWithSPNParameterSet
Remove-AzRoleAssignment
-ServicePrincipalName <String>
-RoleDefinitionName <String>
[-Scope <String>]
[-PassThru]
[-SkipClientSideScopeValidation]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RoleAssignmentParameterSet
Remove-AzRoleAssignment
[-InputObject] <PSRoleAssignment>
[-PassThru]
[-SkipClientSideScopeValidation]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Remove-AzRoleAssignment コマンドレットを使用して、特定のスコープと特定のロールで任意のプリンシパルへのアクセスを取り消します。
割り当てのオブジェクト、つまりプリンシパルを指定する必要があります。
プリンシパルには、ユーザー (SignInName パラメーターまたは ObjectId パラメーターを使用してユーザーを識別する)、セキュリティ グループ (ObjectId パラメーターを使用してグループを識別する)、サービス プリンシパル (ServicePrincipalName または ObjectId パラメーターを使用して ServicePrincipal を識別する) を指定できます。
プリンシパルが割り当てられているロールは、RoleDefinitionName パラメーターを使用して指定する必要があります。
割り当てのスコープは MAY を指定でき、指定されていない場合は既定でサブスクリプション スコープに設定されます。つまり、サブスクリプション スコープで指定されたプリンシパルとロールへの割り当ての削除が試行されます。
割り当てのスコープは、次のいずれかのパラメーターを使用して指定できます。
a.
スコープ - これは、/subscriptions/<subscriptionId> b で始まる完全修飾スコープです。
ResourceGroupName - サブスクリプションの下にある任意のリソース グループの名前。
c.
ResourceName、ResourceType、ResourceGroupName、および (必要に応じて) ParentResource - サブスクリプションの特定のリソースを識別します。
例
例 1
Remove-AzRoleAssignment -ResourceGroupName rg1 -SignInName john.doe@contoso.com -RoleDefinitionName Reader
rg1 リソース グループ スコープで閲覧者ロールに割り当てられている john.doe@contoso.com のロールの割り当てを削除します。
例 2
Remove-AzRoleAssignment -ObjectId 00001111-aaaa-2222-bbbb-3333cccc4444 -RoleDefinitionName Reader
ObjectId によって識別され、閲覧者ロールに割り当てられているグループ プリンシパルへのロールの割り当てを削除します。
既定では、現在のサブスクリプションをスコープとして使用して、削除する割り当てを検索します。
例 3
$roleassignment = Get-AzRoleAssignment |Select-Object -First 1 -Wait
Remove-AzRoleAssignment -InputObject $roleassignment
Get-AzRoleAssignment コマンドレットからフェッチされる最初のロール割り当てオブジェクトを削除します。
パラメーター
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ロールの割り当てオブジェクト。
RoleAssignmentParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ObjectId
ユーザー、グループ、またはサービス プリンシパルの Microsoft Entra ObjectId。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ID (アイディー), プリンシパルID |
パラメーター セット
EmptyParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceWithObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceGroupWithObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ScopeWithObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
RoleIdWithScopeAndObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ParentResource
ResourceName パラメーターを使用して指定されたリソースの階層内の親リソース (存在する場合)。
リソースを識別する相対 URI の形式で階層スコープを構築するには、ResourceGroupName、ResourceType、および ResourceName パラメーターと組み合わせて使用する必要があります。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ResourceWithObjectIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceWithSignInNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceWithSPNParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-PassThru
指定した場合は、削除されたロールの割り当てが表示されます
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
ロールが割り当てられているリソース グループ名。
指定したリソース グループ スコープでの割り当ての削除を試みます。
ResourceName、ResourceType、および (オプションで) ParentResource パラメーターと組み合わせて使用すると、リソースを識別する相対 URI の形式で階層スコープが構築されます。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ResourceWithObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceGroupWithObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceWithSignInNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceGroupWithSignInNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceWithSPNParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceGroupWithSPNParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ResourceName
リソースの名前。
例: storageaccountprod。
リソースを識別し、そのスコープで割り当てを削除する相対 URI の形式で階層スコープを構築するには、ResourceGroupName、ResourceType、および (必要に応じて)ParentResource パラメーターと組み合わせて使用する必要があります。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ResourceWithObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceWithSignInNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceWithSPNParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ResourceType
リソースの種類。
たとえば、Microsoft.Network/virtualNetworks などです。
リソースを識別し、そのリソース スコープで割り当てを削除する相対 URI の形式で階層スコープを構築するには、ResourceGroupName、ResourceName、および (必要に応じて) ParentResource パラメーターと組み合わせて使用する必要があります。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ResourceWithObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceWithSignInNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceWithSPNParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-RoleDefinitionId
割り当てを削除する必要がある RBAC ロールの ID。
パラメーターのプロパティ
| 型: | Guid
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
RoleIdWithScopeAndObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-RoleDefinitionName
割り当てを削除する必要がある RBAC ロールの名前 (閲覧者、共同作成者、仮想ネットワーク管理者など)。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
EmptyParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceWithObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceGroupWithObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ScopeWithObjectIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceWithSignInNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceGroupWithSignInNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ScopeWithSignInNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceWithSPNParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceGroupWithSPNParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ScopeWithSPNParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Scope
削除するロールの割り当てのスコープ。
相対 URI の形式。
例: "/subscriptions/9004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/TestRG"。
指定しない場合は、サブスクリプション レベルでロールの削除を試みます。
指定した場合は、"/subscriptions/{id}" で始まる必要があります。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
EmptyParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ScopeWithObjectIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
RoleIdWithScopeAndObjectIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ScopeWithSignInNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ScopeWithSPNParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ServicePrincipalName
Microsoft Entra アプリケーションの ServicePrincipalName
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | SPN, ApplicationId |
パラメーター セット
ResourceWithSPNParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceGroupWithSPNParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ScopeWithSPNParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-SignInName
ユーザーの電子メール アドレスまたはユーザー プリンシパル名。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | Email, ユーザープリンシパルネーム |
パラメーター セット
ResourceWithSignInNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ResourceGroupWithSignInNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ScopeWithSignInNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-SkipClientSideScopeValidation
指定した場合は、クライアント側のスコープの検証をスキップします。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
Remove-AzRoleAssignment コマンドレットを使用して、特定のスコープと特定のロールで任意のプリンシパルへのアクセスを取り消します。
割り当てのオブジェクト、つまりプリンシパルを指定する必要があります。
プリンシパルには、ユーザー (SignInName パラメーターまたは ObjectId パラメーターを使用してユーザーを識別する)、セキュリティ グループ (ObjectId パラメーターを使用してグループを識別する)、サービス プリンシパル (ServicePrincipalName または ObjectId パラメーターを使用して ServicePrincipal を識別する) を指定できます。
プリンシパルが割り当てられているロールは、RoleDefinitionName パラメーターを使用して指定する必要があります。
割り当てのスコープは MAY を指定でき、指定されていない場合は既定でサブスクリプション スコープに設定されます。つまり、サブスクリプション スコープで指定されたプリンシパルとロールへの割り当ての削除が試行されます。
割り当てのスコープは、次のいずれかのパラメーターを使用して指定できます。
a.
スコープ - これは、/subscriptions/<subscriptionId> b で始まる完全修飾スコープです。
ResourceGroupName - サブスクリプションの下にある任意のリソース グループの名前。
c.
ResourceName、ResourceType、ResourceGroupName、および (必要に応じて) ParentResource - サブスクリプションの特定のリソースを識別します。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力
メモ
キーワード: azure, azurerm, arm, リソース, 管理, マネージャー, リソース, グループ, テンプレート, デプロイ
