Dela via

Backup-AzKeyVaultKey

Modul:
Az.KeyVault Module

Säkerhetskopierar en nyckel i ett nyckelvalv.

Syntax

ByKeyName (Standard) 

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

Cmdleten Backup-AzKeyVaultKey säkerhetskopierar en angiven nyckel i ett nyckelvalv genom att ladda ned den och lagra den i en fil. Om det finns flera versioner av nyckeln ingår alla versioner i säkerhetskopian. Eftersom det nedladdade innehållet är krypterat kan det inte användas utanför Azure Key Vault. Du kan återställa en säkerhetskopierad nyckel till valfritt nyckelvalv i prenumerationen som den säkerhetskopierades från. Vanliga orsaker till att använda den här cmdleten är:

  • Du vill desponera en kopia av nyckeln så att du har en offlinekopia om du av misstag tar bort nyckeln i nyckelvalvet.

  • Du har skapat en nyckel med Key Vault och vill nu klona nyckeln till en annan Azure-region, så att du kan använda den från alla instanser av ditt distribuerade program. Använd cmdleten Backup-AzKeyVaultKey för att hämta nyckeln i krypterat format och använd sedan cmdleten Restore-AzKeyVaultKey och ange ett nyckelvalv i den andra regionen.

Exempel

Exempel 1: Säkerhetskopiera en nyckel med ett automatiskt genererat filnamn

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

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

Det här kommandot hämtar nyckeln mykey från nyckelvalvet med namnet MyKeyVault och sparar en säkerhetskopia av nyckeln till en fil som automatiskt namnges åt dig och visar filnamnet.

Exempel 2: Säkerhetskopiera en nyckel till ett angivet filnamn

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

C:\Backup.blob

Det här kommandot hämtar nyckeln med namnet MyKey från nyckelvalvet MyKeyVault och sparar en säkerhetskopia av nyckeln till en fil med namnet Backup.blob.

Exempel 3: Säkerhetskopiera en tidigare hämtad nyckel till ett angivet filnamn och skriv över målfilen utan att fråga.

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

C:\Backup.blob

Det här kommandot skapar en säkerhetskopia av nyckeln med namnet $key. Namn i valvet med namnet $key. VaultName till en fil med namnet Backup.blob, som tyst skriver över filen om den redan finns.

Parametrar

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:jfr

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure

Parameteregenskaper

Typ:IAzureContextContainer
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Force

Skriv över den angivna filen om den finns

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-HsmName

HSM-namn. Cmdleten konstruerar FQDN för en hanterad HSM baserat på namnet och den valda miljön.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

HsmByKeyName
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-InputObject

Nyckelpaket för att säkerhetskopiera, pipelines in från utdata från ett hämtningsanrop.

Parameteregenskaper

Typ:PSKeyVaultKeyIdentityItem
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:Key

Parameteruppsättningar

ByKey
Position:0
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Name

Anger namnet på nyckeln som ska säkerhetskopieras.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:Nyckelnamn

Parameteruppsättningar

ByKeyName
Position:1
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
HsmByKeyName
Position:1
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-OutputFile

Anger den utdatafil där säkerhetskopieringsbloben lagras. Om du inte anger den här parametern genererar den här cmdleten ett filnamn åt dig. Om du anger namnet på en befintlig utdatafil slutförs inte åtgärden och returnerar ett felmeddelande om att säkerhetskopieringsfilen redan finns.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:2
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-VaultName

Anger namnet på nyckelvalvet som innehåller nyckeln som ska säkerhetskopieras.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByKeyName
Position:0
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WhatIf

Visar vad som skulle hända om kommandot körs. Cmdleten körs inte.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:Wi

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

PSKeyVaultKeyIdentityItem

Utdata

String