Delen via

Backup-AzKeyVaultKey

Module:
Az.KeyVault Module

Maakt een back-up van een sleutel in een sleutelkluis.

Syntax

ByKeyName (Standaard) 

Backup-AzKeyVaultKey
    [-VaultName] <String>
    [-Name] <String>
    [[-OutputFile] <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

HsmByKeyName 

Backup-AzKeyVaultKey
    [-Name] <String>
    [[-OutputFile] <String>]
    -HsmName <String>
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByKey 

Backup-AzKeyVaultKey
    [-InputObject] <PSKeyVaultKeyIdentityItem>
    [[-OutputFile] <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

De cmdlet Backup-AzKeyVaultKey maakt een back-up van een opgegeven sleutel in een sleutelkluis door deze te downloaden en op te slaan in een bestand. Als er meerdere versies van de sleutel zijn, worden alle versies opgenomen in de back-up. Omdat de gedownloade inhoud is versleuteld, kan deze niet worden gebruikt buiten Azure Key Vault. U kunt een back-upsleutel herstellen naar elke sleutelkluis in het abonnement waarvan een back-up is gemaakt. Veelvoorkomende redenen voor het gebruik van deze cmdlet zijn:

  • U wilt een kopie van uw sleutel borgen, zodat u een offlinekopie hebt voor het geval u uw sleutel per ongeluk verwijdert in uw sleutelkluis.

  • U hebt een sleutel gemaakt met Key Vault en u wilt de sleutel nu klonen in een andere Azure-regio, zodat u deze kunt gebruiken vanuit alle exemplaren van uw gedistribueerde toepassing. Gebruik de cmdlet Backup-AzKeyVaultKey om de sleutel op te halen in versleutelde indeling en gebruik vervolgens de Restore-AzKeyVaultKey cmdlet en geef een sleutelkluis op in de tweede regio.

Voorbeelden

Voorbeeld 1: Een back-up maken van een sleutel met een automatisch gegenereerde bestandsnaam

Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'

C:\Users\username\mykeyvault-mykey-1527029447.01191

Met deze opdracht wordt de sleutel met de naam MyKey opgehaald uit de sleutelkluis met de naam MyKeyVault en wordt een back-up van die sleutel opgeslagen in een bestand dat automatisch voor u wordt genoemd en wordt de bestandsnaam weergegeven.

Voorbeeld 2: Een back-up maken van een sleutel naar een opgegeven bestandsnaam

Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob'

C:\Backup.blob

Met deze opdracht wordt de sleutel MyKey opgehaald uit de sleutelkluis met de naam MyKeyVault en wordt een back-up van die sleutel opgeslagen in een bestand met de naam Backup.blob.

Voorbeeld 3: Maak een back-up van een eerder opgehaalde sleutel naar een opgegeven bestandsnaam, waarbij het doelbestand wordt overschreven zonder dat u hierom wordt gevraagd.

$key = Get-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
Backup-AzKeyVaultKey -Key $key -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

Met deze opdracht maakt u een back-up van de sleutel met de naam $key. Naam in de kluis met de naam $key. VaultName naar een bestand met de naam Backup.blob, overschrijft het bestand op de achtergrond als het al bestaat.

Parameters

-Confirm

Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Cf

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-DefaultProfile

De referenties, het account, de tenant en het abonnement dat wordt gebruikt voor communicatie met Azure

Parametereigenschappen

Type:IAzureContextContainer
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:AzContext, AzureRmContext, AzureCredential

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Force

Het opgegeven bestand overschrijven als het bestaat

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-HsmName

HSM-naam. Cmdlet bouwt de FQDN van een beheerde HSM op basis van de naam en momenteel geselecteerde omgeving.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

HsmByKeyName
Position:Named
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-InputObject

Sleutelbundel om een back-up te maken, gepijplijnd vanuit de uitvoer van een ophaalaanroep.

Parametereigenschappen

Type:PSKeyVaultKeyIdentityItem
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Key

Parametersets

ByKey
Position:0
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Name

Hiermee geeft u de naam van de sleutel waarvan een back-up moet worden gemaakt.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Sleutelnaam

Parametersets

ByKeyName
Position:1
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False
HsmByKeyName
Position:1
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-OutputFile

Hiermee geeft u het uitvoerbestand waarin de back-upblob wordt opgeslagen. Als u deze parameter niet opgeeft, genereert deze cmdlet een bestandsnaam voor u. Als u de naam van een bestaand uitvoerbestand opgeeft, wordt de bewerking niet voltooid en wordt er een foutbericht geretourneerd dat het back-upbestand al bestaat.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:2
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-VaultName

Hiermee geeft u de naam op van de sleutelkluis die de sleutel bevat waarvan een back-up moet worden gemaakt.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

ByKeyName
Position:0
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-WhatIf

Toont wat er zou gebeuren wanneer de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Wi

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

PSKeyVaultKeyIdentityItem

Uitvoerwaarden

String