共用方式為


Remove-AzureRmKeyVault

刪除金鑰保存庫。

警告

自 2024 年 2 月 29 日起,AzureRM PowerShell 模組已正式淘汰。 建議使用者從 AzureRM 遷移至 Az PowerShell 模組,以確保持續支援和更新。

雖然 AzureRM 模組可能仍可運作,但不再維護或支援它,但會根據用戶的判斷權和風險放置任何繼續使用。 如需轉換至 Az 模組的指引,請參閱我們的 移轉資源

語法

Remove-AzureRmKeyVault
      [-VaultName] <String>
      [[-ResourceGroupName] <String>]
      [[-Location] <String>]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmKeyVault
      [-VaultName] <String>
      [-Location] <String>
      [-InRemovedState]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmKeyVault
      [-InputObject] <PSKeyVault>
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmKeyVault
      [-InputObject] <PSKeyVault>
      [-InRemovedState]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmKeyVault
      [-ResourceId] <String>
      [[-Location] <String>]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmKeyVault
      [-ResourceId] <String>
      [-Location] <String>
      [-InRemovedState]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Remove-AzureRmKeyVault Cmdlet 會刪除指定的密鑰保存庫。 它也會刪除該實例中包含的所有密鑰和秘密。 請注意,雖然指定此 Cmdlet 的資源群組是選擇性的,但您應該因此獲得更好的效能。

範例

範例 1:移除金鑰保存庫

PS C:\> Remove-AzureRmKeyVault -VaultName "Contoso03Vault" -PassThru

True

此命令會從您目前的訂用帳戶中移除名為 Contoso03Vault 的金鑰保存庫。

範例 2:從指定的資源群組移除金鑰保存庫

PS C:\> Remove-AzureRmKeyVault -VaultName "Contoso03Vault" -ResourceGroupName "Group14" -PassThru

True

此命令會從具名資源群組中移除名為 Contoso03Vault 的密鑰保存庫。 如果您未指定資源組名,Cmdlet 會搜尋您目前訂用帳戶中要刪除的具名密鑰保存庫。

參數

-AsJob

在背景執行 Cmdlet

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Confirm

執行 Cmdlet 之前先提示您確認。

類型:SwitchParameter
別名:cf
Position:Named
預設值:False
必要:False
接受管線輸入:False
接受萬用字元:False

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶

類型:IAzureContextContainer
別名:AzureRmContext, AzureCredential
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Force

指出 Cmdlet 不會提示您進行確認。 根據預設,此 Cmdlet 會提示您確定要刪除金鑰保存庫。

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-InputObject

要刪除 金鑰保存庫物件。

類型:PSKeyVault
Position:0
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-InRemovedState

永久移除先前刪除的保存庫。

類型:SwitchParameter
Position:Named
預設值:None
必要:True
接受管線輸入:False
接受萬用字元:False

-Location

已刪除保存庫的位置。

類型:String
Position:2
預設值:None
必要:True
接受管線輸入:False
接受萬用字元:False

-PassThru

此 Cmdlet 預設不會傳回 物件。 如果指定此參數,如果成功,則會傳回 true。

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-ResourceGroupName

指定資源群組的名稱。

類型:String
Position:1
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-ResourceId

KeyVault 資源標識碼。

類型:String
Position:0
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-VaultName

指定要移除的金鑰儲存庫名稱。

類型:String
Position:0
預設值:None
必要:True
接受管線輸入:False
接受萬用字元:False

-WhatIf

顯示執行 Cmdlet 後會發生的情況。 Cmdlet 未執行。顯示 Cmdlet 執行時會發生什麼事。 未執行 Cmdlet。

類型:SwitchParameter
別名:wi
Position:Named
預設值:False
必要:False
接受管線輸入:False
接受萬用字元:False

輸入

PSKeyVault

參數:InputObject (ByValue)

String

輸出

Boolean