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

Remove-AzKeyVaultRoleDefinition

从 HSM 中删除自定义角色定义。

语法

ByName (默认值)

Remove-AzKeyVaultRoleDefinition
    [-HsmName] <String>
    -RoleName <String>
    [-Scope <String>]
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObject

Remove-AzKeyVaultRoleDefinition
    [-HsmName] <String>
    -InputObject <PSKeyVaultRoleDefinition>
    [-Scope <String>]
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

Remove-AzKeyVaultRoleDefinition cmdlet 在 Azure Role-Based Azure KeyVault 托管 HSM 的访问控制中删除自定义角色。 -RoleName提供现有自定义角色或角色对象的参数以删除该自定义角色。 默认情况下, Remove-AzKeyVaultRoleDefinition 系统会提示你进行确认。 若要取消提示,请使用 -Force 参数。

示例

示例 1

Remove-AzKeyVaultRoleDefinition -HsmName myHsm -RoleName "my role"

此示例删除名为“my role”的自定义角色。

示例 2

$role = Get-AzKeyVaultRoleDefinition -HsmName myHsm -RoleName "my role"
$role | Remove-AzKeyVaultRoleDefinition -HsmName myHsm -Force

此示例通过管道角色对象删除名为“my role”的自定义角色。 它还禁止显示提示。-Force

参数

-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

-HsmName

HSM 的名称。

参数属性

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

参数集

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

-InputObject

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

参数属性

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

参数集

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

-PassThru

默认情况下,此 cmdlet 不返回对象。 如果指定了此开关,则如果成功,则返回 true。

参数属性

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

参数集

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

-RoleName

要获取的角色定义的名称。

参数属性

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

参数集

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

-Scope

角色分配或定义应用于的范围,例如“/”或“/keys”或“/keys/{keyName}”。

参数属性

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

参数集

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

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

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

参数集

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

CommonParameters

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

输入

PSKeyVaultRoleDefinition

输出

Boolean