Megosztás a következőn keresztül:

Remove-AzureKeyVaultKey

  • Referencia
Modul:
AzureRM.KeyVault

Egy kulcstartóban lévő kulcs törlése.

Figyelmeztetés

Az AzureRM PowerShell-modul 2024. február 29-én hivatalosan elavult. Javasoljuk a felhasználóknak, hogy migráljanak az AzureRM-ből az Az PowerShell-modulba a folyamatos támogatás és frissítések biztosítása érdekében.

Bár az AzureRM-modul továbbra is működik, a továbbiakban nem tart fenn vagy nem támogatott, így a folyamatos használatot a felhasználó saját belátása szerint és kockázatára teheti. Az Az modulra való áttéréshez tekintse meg a migrálási erőforrásainkat.

Syntax

Remove-AzureKeyVaultKey
      [-VaultName] <String>
      [-Name] <String>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureKeyVaultKey
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

A Remove-AzureKeyVaultKey parancsmag töröl egy kulcsot egy kulcstartóból. Ha a kulcsot véletlenül törölték, a kulcs helyreállítható a Undo-AzureKeyVaultKeyRemoval paranccsal egy speciális "visszaállítási" engedélyekkel rendelkező felhasználó által. Ennek a parancsmagnak a ConfirmImpact tulajdonság értéke magas.

Példák

1. példa: Kulcs eltávolítása egy kulcstartóból

PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -PassThru

Vault Name           : contoso
Name                 : key2
Id                   : https://contoso.vault.azure.net:443/keys/itsoftware/fdad15793ba0437e960497908ef9eb32
Deleted Date         : 5/24/2018 11:28:25 PM
Scheduled Purge Date : 8/22/2018 11:28:25 PM
Enabled              : False
Expires              : 10/11/2018 11:32:49 PM
Not Before           : 4/11/2018 11:22:49 PM
Created              : 4/12/2018 10:16:38 PM
Updated              : 4/12/2018 10:16:38 PM
Purge Disabled       : False
Tags                 :

Ez a parancs eltávolítja az ITSoftware nevű kulcsot a Contoso nevű kulcstartóból.

2. példa: Kulcs eltávolítása felhasználói megerősítés nélkül

PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Force

Ez a parancs eltávolítja az ITSoftware nevű kulcsot a Contoso nevű kulcstartóból. A parancs megadja a Force paramétert, ezért a parancsmag nem kéri a megerősítést.

3. példa: Törölt kulcs végleges törlése a kulcstartóból

PS C:\> Remove-AzureKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -InRemovedState

Ez a parancs véglegesen eltávolítja az ITSoftware nevű kulcsot a Contoso nevű kulcstartóból. A parancsmag végrehajtásához "törlési" engedély szükséges, amelyet korábban és explicit módon meg kellett adni a felhasználónak ehhez a kulcstartóhoz.

4. példa: Kulcsok eltávolítása a folyamatkezelővel

PS C:\> Get-AzureKeyVaultKey -VaultName 'Contoso' | Where-Object {$_.Attributes.Enabled -eq $False} | Remove-AzureKeyVaultKey

Ez a parancs lekéri a Contoso nevű kulcstartó összes kulcsát, és átadja őket a Where-Object parancsmagnak a folyamatkezelő használatával. Ez a parancsmag átadja azokat a kulcsokat, amelyek értéke $False az Engedélyezett attribútumhoz az aktuális parancsmagnak. Ez a parancsmag eltávolítja ezeket a kulcsokat.

Paraméterek

-Confirm

Jóváhagyást kér a parancsmag futtatása előtt.

Típus:SwitchParameter
Aliasok:cf
Position:Named
Alapértelmezett érték:False
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-DefaultProfile

Az Azure-ral való kommunikációhoz használt hitelesítő adatok, fiók, bérlő és előfizetés

Típus:IAzureContextContainer
Aliasok:AzureRmContext, AzureCredential
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-Force

Kényszeríti a parancs futtatását anélkül, hogy felhasználói megerősítést kérne.

Típus:SwitchParameter
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-InputObject

KeyBundle-objektum

Típus:PSKeyVaultKeyIdentityItem
Position:0
Alapértelmezett érték:None
Kötelező:True
Folyamatbemenet elfogadása:True
Helyettesítő karakterek elfogadása:False

-InRemovedState

Távolítsa el véglegesen a korábban törölt kulcsot.

Típus:SwitchParameter
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-Name

Megadja az eltávolítani kívánt kulcs nevét. Ez a parancsmag egy kulcs teljes tartománynevét (FQDN) hozza létre a paraméter által megadott név, a kulcstartó neve és az aktuális környezet alapján.

Típus:String
Aliasok:KeyName
Position:1
Alapértelmezett érték:None
Kötelező:True
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-PassThru

Azt jelzi, hogy ez a parancsmag egy Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey objektumot ad vissza. Ez a parancsmag alapértelmezés szerint nem hoz létre kimenetet.

Típus:SwitchParameter
Position:Named
Alapértelmezett érték:None
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-VaultName

Megadja annak a kulcstartónak a nevét, amelyből el szeretné távolítani a kulcsot. Ez a parancsmag egy kulcstartó teljes tartománynevét hozza létre a paraméter által megadott név és az aktuális környezet alapján.

Típus:String
Position:0
Alapértelmezett érték:None
Kötelező:True
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

-WhatIf

Bemutatja, mi történne a parancsmag futtatásakor. A parancsmag nem fut. Megjeleníti, mi történne, ha a parancsmag futna. A parancsmag nem fut.

Típus:SwitchParameter
Aliasok:wi
Position:Named
Alapértelmezett érték:False
Kötelező:False
Folyamatbemenet elfogadása:False
Helyettesítő karakterek elfogadása:False

Bevitelek

PSKeyVaultKeyIdentityItem

Paraméterek: InputObject (ByValue)

Kimenetek

PSDeletedKeyVaultKey