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

Remove-AzRoleDefinition

删除 Azure RBAC 中的自定义角色。 要删除的角色是使用角色的 Id 属性指定的。 如果对自定义角色进行现有角色分配,则删除将失败。

语法

RoleDefinitionIdParameterSet (默认值)

Remove-AzRoleDefinition
    -Id <Guid>
    [-Scope <String>]
    [-SkipClientSideScopeValidation]
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-AcquirePolicyToken]
    [-ChangeReference <String>]
    [<CommonParameters>]

RoleDefinitionNameParameterSet

Remove-AzRoleDefinition
    [-Name] <String>
    [-Scope <String>]
    [-SkipClientSideScopeValidation]
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-AcquirePolicyToken]
    [-ChangeReference <String>]
    [<CommonParameters>]

InputObjectParameterSet

Remove-AzRoleDefinition
    -InputObject <PSRoleDefinition>
    [-SkipClientSideScopeValidation]
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-AcquirePolicyToken]
    [-ChangeReference <String>]
    [<CommonParameters>]

说明

Remove-AzRoleDefinition cmdlet 删除Azure Role-Based 访问控制中的自定义角色。 提供现有自定义角色的 ID 参数以删除该自定义角色。 默认情况下,Remove-AzRoleDefinition 提示你进行确认。 若要取消提示,请使用 Force 参数。 如果对要删除的自定义角色进行现有角色分配,则删除作将失败。

使用 -PassThru 参数时,cmdlet 返回已删除的 PSRoleDefinition 对象。 返回的对象包含一个 Permissions 集合,其中包含每个权限条目的 Actions、NotActions、DataActions、NotDataActions 和任何 Attribute-Based 访问控制 (ABAC) 条件(Condition 和 ConditionVersion)。

示例

示例 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 对象,然后显示第一个权限条目中的操作。

参数

-AcquirePolicyToken

自动获取此资源操作的Azure Policy令牌。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ChangeReference

此资源操作的更改引用资源 ID。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Confirm

在运行 cmdlet 之前,提示你进行确认。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultProfile

用于与 azure 通信的凭据、帐户、租户和订阅

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Force

如果已设置,在删除自定义角色之前不提示确认

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Id

要删除的角色定义的 ID

参数属性

类型:Guid
默认值:None
支持通配符:False
不显示:False

参数集

RoleDefinitionIdParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-InputObject

表示要删除的角色定义的对象。

参数属性

类型:PSRoleDefinition
默认值:None
支持通配符:False
不显示:False

参数集

InputObjectParameterSet
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Name

要删除的角色定义的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

RoleDefinitionNameParameterSet
Position:0
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-PassThru

Remove-AzRoleDefinition cmdlet 删除Azure Role-Based 访问控制中的自定义角色。 提供现有自定义角色的 ID 参数以删除该自定义角色。 默认情况下,Remove-AzRoleDefinition 提示你进行确认。 若要取消提示,请使用 Force 参数。 如果对要删除的自定义角色进行现有角色分配,则删除作将失败。

使用 -PassThru 参数时,cmdlet 返回已删除的 PSRoleDefinition 对象。 返回的对象包含一个 Permissions 集合,其中包含每个权限条目的 Actions、NotActions、DataActions、NotDataActions 和任何 Attribute-Based 访问控制 (ABAC) 条件(Condition 和 ConditionVersion)。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Scope

角色定义范围。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

RoleDefinitionIdParameterSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False
RoleDefinitionNameParameterSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-SkipClientSideScopeValidation

如果指定,请跳过客户端范围验证。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

Remove-AzRoleDefinition cmdlet 删除Azure Role-Based 访问控制中的自定义角色。 提供现有自定义角色的 ID 参数以删除该自定义角色。 默认情况下,Remove-AzRoleDefinition 提示你进行确认。 若要取消提示,请使用 Force 参数。 如果对要删除的自定义角色进行现有角色分配,则删除作将失败。

使用 -PassThru 参数时,cmdlet 返回已删除的 PSRoleDefinition 对象。 返回的对象包含一个 Permissions 集合,其中包含每个权限条目的 Actions、NotActions、DataActions、NotDataActions 和任何 Attribute-Based 访问控制 (ABAC) 条件(Condition 和 ConditionVersion)。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:WI

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持以下常用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。

输入

Guid

String

PSRoleDefinition

输出

Boolean

备注

关键字:azure, azurerm, arm, 资源, 管理, 经理, 资源组, 模板, 部署