Remove-AzRoleDefinition
Azure RBAC のカスタム ロールを削除します。 削除するロールは、ロールの Id プロパティを使用して指定します。 カスタム ロールに対して既存のロールの割り当てが行われている場合、削除は失敗します。
構文
RoleDefinitionIdParameterSet (既定)
Remove-AzRoleDefinition
-Id <Guid>
[-Scope <String>]
[-SkipClientSideScopeValidation]
[-Force]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RoleDefinitionNameParameterSet
Remove-AzRoleDefinition
[-Name] <String>
[-Scope <String>]
[-SkipClientSideScopeValidation]
[-Force]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InputObjectParameterSet
Remove-AzRoleDefinition
-InputObject <PSRoleDefinition>
[-SkipClientSideScopeValidation]
[-Force]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Remove-AzRoleDefinition コマンドレットは、Azure Role-Based Access Controlのカスタム ロールを削除します。 既存のカスタム ロールの ID パラメーターを指定して、そのカスタム ロールを削除します。 既定では、Remove-AzRoleDefinition は確認を求められます。 プロンプトを表示しない場合は、Force パラメーターを使用します。 削除するカスタム ロールに対して既存のロールの割り当てが行われている場合、削除は失敗します。
-PassThru パラメーターを使用する場合、コマンドレットは削除された PSRoleDefinition オブジェクトを返します。 返されるオブジェクトには、Actions、NotActions、DataActions、NotDataActions、および各アクセス許可エントリの Attribute-Based Access Control (ABAC) 条件 (Condition と ConditionVersion) を含む Permissions コレクションが含まれています。
例
例 1: Get-AzRoleDefinition からパイプ処理してカスタム ロールを削除する
Get-AzRoleDefinition -Name "Virtual Machine Operator" | Remove-AzRoleDefinition
"仮想マシン オペレーター" カスタム ロールを取得し、それをパイプ処理して削除のために Remove-AzRoleDefinition します。 ロールが削除される前に、確認を求めるメッセージが表示されます。
例 2: ID によるカスタム ロールの削除
Remove-AzRoleDefinition -Id "00001111-aaaa-2222-bbbb-3333cccc4444"
指定した ID を持つカスタム ロールを削除します。確認を求められます。
例 3: 確認なしでカスタム ロールを削除する
Remove-AzRoleDefinition -Name "Custom Reader Role" -Force
確認を求めずに、"カスタム閲覧者ロール" という名前のカスタム ロールを削除します。
例 4: 削除されたロール定義を削除して返す
$deletedRole = Remove-AzRoleDefinition -Name "Custom Writer Role" -Force -PassThru
$deletedRole.Permissions[0].Actions
ロールを削除し、PSRoleDefinition オブジェクトを返し、最初のアクセス許可エントリのアクションを表示します。
パラメーター
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
パラメーターのプロパティ
| 型: | IAzureContextContainer |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
設定されている場合、カスタム ロールを削除する前に確認を求めません
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Id
削除するロール定義の ID
パラメーターのプロパティ
| 型: | Guid |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
RoleDefinitionIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-InputObject
削除するロール定義を表すオブジェクト。
パラメーターのプロパティ
| 型: | PSRoleDefinition |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
InputObjectParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
削除するロール定義の名前。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
RoleDefinitionNameParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-PassThru
Remove-AzRoleDefinition コマンドレットは、Azure Role-Based Access Controlのカスタム ロールを削除します。 既存のカスタム ロールの ID パラメーターを指定して、そのカスタム ロールを削除します。 既定では、Remove-AzRoleDefinition は確認を求められます。 プロンプトを表示しない場合は、Force パラメーターを使用します。 削除するカスタム ロールに対して既存のロールの割り当てが行われている場合、削除は失敗します。
-PassThru パラメーターを使用する場合、コマンドレットは削除された PSRoleDefinition オブジェクトを返します。 返されるオブジェクトには、Actions、NotActions、DataActions、NotDataActions、および各アクセス許可エントリの Attribute-Based Access Control (ABAC) 条件 (Condition と ConditionVersion) を含む Permissions コレクションが含まれています。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Scope
ロール定義スコープ。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
RoleDefinitionIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
RoleDefinitionNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-SkipClientSideScopeValidation
指定した場合は、クライアント側のスコープの検証をスキップします。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
Remove-AzRoleDefinition コマンドレットは、Azure Role-Based Access Controlのカスタム ロールを削除します。 既存のカスタム ロールの ID パラメーターを指定して、そのカスタム ロールを削除します。 既定では、Remove-AzRoleDefinition は確認を求められます。 プロンプトを表示しない場合は、Force パラメーターを使用します。 削除するカスタム ロールに対して既存のロールの割り当てが行われている場合、削除は失敗します。
-PassThru パラメーターを使用する場合、コマンドレットは削除された PSRoleDefinition オブジェクトを返します。 返されるオブジェクトには、Actions、NotActions、DataActions、NotDataActions、および各アクセス許可エントリの Attribute-Based Access Control (ABAC) 条件 (Condition と ConditionVersion) を含む Permissions コレクションが含まれています。
パラメーターのプロパティ
| 型: | 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を参照してください。
入力
Guid
String
PSRoleDefinition
出力
Boolean
メモ
キーワード: azure, azurerm, arm, リソース, 管理, マネージャー, リソース, グループ, テンプレート, デプロイ
