Udostępnij przez

Remove-AzKeyVault

Moduł:
Az.KeyVault Module

Usuwa magazyn kluczy.

Składnia

ByAvailableVault (Domyślne) 

Remove-AzKeyVault
    [-VaultName] <String>
    [[-ResourceGroupName] <String>]
    [[-Location] <String>]
    [-Force]
    [-AsJob]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ByDeletedVault 

Remove-AzKeyVault
    [-VaultName] <String>
    [-Location] <String>
    [-InRemovedState]
    [-Force]
    [-AsJob]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

InputObjectByAvailableVault 

Remove-AzKeyVault
    [-InputObject] <PSKeyVault>
    [-Force]
    [-AsJob]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

InputObjectByDeletedVault 

Remove-AzKeyVault
    [-InputObject] <PSKeyVault>
    [-InRemovedState]
    [-Force]
    [-AsJob]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ResourceIdByAvailableVault 

Remove-AzKeyVault
    [-ResourceId] <String>
    [[-Location] <String>]
    [-Force]
    [-AsJob]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ResourceIdByDeletedVault 

Remove-AzKeyVault
    [-ResourceId] <String>
    [-Location] <String>
    [-InRemovedState]
    [-Force]
    [-AsJob]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

Opis

Polecenie cmdlet Remove-AzKeyVault usuwa określony magazyn kluczy. Usuwa również wszystkie klucze i wpisy tajne zawarte w tym wystąpieniu. Należy pamiętać, że chociaż określenie grupy zasobów jest opcjonalne dla tego polecenia cmdlet, należy więc zapewnić lepszą wydajność.

Przykłady

Przykład 1. Usuwanie magazynu kluczy

Remove-AzKeyVault -VaultName "Contoso03Vault" -PassThru

True

To polecenie usuwa magazyn kluczy o nazwie Contoso03Vault z bieżącej subskrypcji.

Przykład 2. Usuwanie magazynu kluczy z określonej grupy zasobów

Remove-AzKeyVault -Name "Contoso03Vault" -ResourceGroupName "Group14" -PassThru

True

To polecenie usuwa magazyn kluczy o nazwie Contoso03Vault z nazwanej grupy zasobów. Jeśli nie określisz nazwy grupy zasobów, polecenie cmdlet wyszukuje nazwany magazyn kluczy do usunięcia w bieżącej subskrypcji.

Parametry

-AsJob

Uruchamianie polecenia cmdlet w tle

Właściwości parametrów

Typ:SwitchParameter
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-Confirm

Prosi o potwierdzenie przed uruchomieniem cmdletu.

Właściwości parametrów

Typ:SwitchParameter
Wartość domyślna:False
Wspiera dzikie karty:False
DontShow:False
Aliasy:por

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure

Właściwości parametrów

Typ:IAzureContextContainer
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False
Aliasy:AzContext, AzureRmContext, AzureCredential

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-Force

Wskazuje, że polecenie cmdlet nie wyświetla monitu o potwierdzenie. Domyślnie to polecenie cmdlet wyświetla monit o potwierdzenie, że chcesz usunąć magazyn kluczy.

Właściwości parametrów

Typ:SwitchParameter
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-InputObject

Obiekt usługi Key Vault do usunięcia.

Właściwości parametrów

Typ:PSKeyVault
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

InputObjectByAvailableVault
Pozycja:0
Obowiązkowy:True
Wartość z pipeline:True
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False
InputObjectByDeletedVault
Pozycja:0
Obowiązkowy:True
Wartość z pipeline:True
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-InRemovedState

Usuń wcześniej usunięty magazyn trwale.

Właściwości parametrów

Typ:SwitchParameter
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

ByDeletedVault
Pozycja:Named
Obowiązkowy:True
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False
InputObjectByDeletedVault
Pozycja:Named
Obowiązkowy:True
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False
ResourceIdByDeletedVault
Pozycja:Named
Obowiązkowy:True
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-Location

Lokalizacja usuniętego magazynu.

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

ByAvailableVault
Pozycja:2
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False
ResourceIdByAvailableVault
Pozycja:2
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-PassThru

To polecenie cmdlet nie zwraca obiektu domyślnie. Jeśli ten przełącznik zostanie określony, zwraca wartość true, jeśli operacja powiedzie się.

Właściwości parametrów

Typ:SwitchParameter
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-ResourceGroupName

Określa nazwę grupy zasobów.

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

ByAvailableVault
Pozycja:1
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-ResourceId

Identyfikator zasobu usługi KeyVault.

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

ResourceIdByAvailableVault
Pozycja:0
Obowiązkowy:True
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:True
Wartość pozostałych argumentów:False
ResourceIdByDeletedVault
Pozycja:0
Obowiązkowy:True
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:True
Wartość pozostałych argumentów:False

-SubscriptionId

Identyfikator subskrypcji. Domyślnie polecenia cmdlet są wykonywane w subskrypcji ustawionej w bieżącym kontekście. Jeśli użytkownik określi inną subskrypcję, bieżące polecenie cmdlet zostanie wykonane w subskrypcji określonej przez użytkownika. Zastępowanie subskrypcji ma zastosowanie tylko w cyklu życia bieżącego polecenia cmdlet. Nie zmienia subskrypcji w kontekście i nie ma wpływu na kolejne polecenia cmdlet.

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:True
Wartość pozostałych argumentów:False

-VaultName

Określa nazwę magazynu kluczy do usunięcia.

Właściwości parametrów

Typ:String
Wartość domyślna:None
Wspiera dzikie karty:False
DontShow:False
Aliasy:Name

Zbiory parametrów

ByAvailableVault
Pozycja:0
Obowiązkowy:True
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False
ByDeletedVault
Pozycja:0
Obowiązkowy:True
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

-WhatIf

Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Polecenie cmdlet nie jest uruchamiane. Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Cmdlet nie jest uruchomiony.

Właściwości parametrów

Typ:SwitchParameter
Wartość domyślna:False
Wspiera dzikie karty:False
DontShow:False
Aliasy:Wi

Zbiory parametrów

(All)
Pozycja:Named
Obowiązkowy:False
Wartość z pipeline:False
Wartość z pipeline według nazwy właściwości:False
Wartość pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Wejścia

PSKeyVault

String

Wyjść

Boolean