Remove-Secret

从指定的注册扩展保管库中删除机密。

语法

NameParameterSet (默认值)

Remove-Secret
    [-Name] <String>
    [-Vault] <String>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InfoParameterSet

Remove-Secret
    [-InputObject] <SecretInformation>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

按名称从已注册的扩展保管库中删除机密。 必须同时提供机密名称和扩展保管库名称。

示例

示例 1

Remove-Secret -Name secretTest -Vault CredMan
Get-Secret -Name secretTest -Vault CredMan
Get-Secret: The secret secretTest wasn't found.

此示例从 secretTest 保管库中删除 CredMan 机密。 Get-Secret 命令验证保管库中不再存在机密。

示例 2

Get-SecretInfo -Name Secret2 -Vault CredMan | Remove-Secret
Get-Secret -Name Secret2 -Vault CredMan
Get-Secret: The secret Secret2 wasn't found.

此示例从 Secret2 保管库中删除 CredMan 机密。 Get-SecretInfo 检索机密的信息,并通过管道发送结果以 Remove-SecretGet-Secret 验证保管库中不再存在机密。

参数

-Confirm

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

参数属性

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

参数集

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

-InputObject

指定描述保管库机密的 SecretInformation 对象。

参数属性

类型:Microsoft.PowerShell.SecretManagement.SecretInformation
默认值:None
支持通配符:False
不显示:False

参数集

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

-Name

指定要删除的机密的名称。 不允许使用通配符(*)。

参数属性

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

参数集

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

-Vault

指定要从中删除机密的保管库的名称。 不允许使用通配符(*)。

参数属性

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

参数集

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

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未能运行。

参数属性

类型:SwitchParameter
默认值:False
支持通配符: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

输入

String

Microsoft.PowerShell.SecretManagement.SecretInformation

输出

None