Поделиться через

Backup-AzKeyVaultKey

Модуль:
Az.KeyVault Module

Резервное копирование ключа в хранилище ключей.

Синтаксис

ByKeyName (по умолчанию) 

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>]

Описание

Командлет Backup-AzKeyVaultKey сохраняет указанный ключ в хранилище ключей, скачав его и сохраняя его в файле. При наличии нескольких версий ключа все версии включаются в резервную копию. Так как скачанный контент зашифрован, его нельзя использовать за пределами Azure Key Vault. Вы можете восстановить резервную копию ключа в любом хранилище ключей в подписке, из которую она была создана. Типичными причинами использования этого командлета являются:

  • Вы хотите отключить копию ключа, чтобы у вас была автономная копия в случае случайного удаления ключа в хранилище ключей.

  • Вы создали ключ с помощью Key Vault и теперь хотите клонировать ключ в другой регион Azure, чтобы использовать его из всех экземпляров распределенного приложения. Используйте командлет Backup-AzKeyVaultKey , чтобы получить ключ в зашифрованном формате, а затем использовать командлет Restore-AzKeyVaultKey и указать хранилище ключей во втором регионе.

Примеры

Пример 1. Резервное копирование ключа с автоматически созданным именем файла

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

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

Эта команда извлекает ключ с именем MyKey из хранилища ключей с именем MyKeyVault и сохраняет резервную копию этого ключа в файл, который автоматически называется вами, и отображает имя файла.

Пример 2. Резервное копирование ключа в указанное имя файла

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

C:\Backup.blob

Эта команда извлекает ключ с именем MyKey из хранилища ключей MyKeyVault и сохраняет резервную копию этого ключа в файл с именем Backup.blob.

Пример 3. Резервное копирование ранее полученного ключа в указанное имя файла, перезаписывание целевого файла без запроса.

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

C:\Backup.blob

Эта команда создает резервную копию ключа с именем $key. Имя в хранилище с именем $key. VaultName в файл с именем Backup.blob автоматически перезаписывает файл, если он уже существует.

Параметры

-Confirm

Запрашивает подтверждение перед запуском cmdlet.

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:cf

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure

Свойства параметра

Тип:IAzureContextContainer
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Force

Перезаписать указанный файл, если он существует

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-HsmName

Имя HSM. Командлет создает полное доменное имя управляемого модуля HSM на основе имени и выбранной среды.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

HsmByKeyName
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-InputObject

Пакет ключей для резервного копирования, конвейерированный из выходных данных вызова извлечения.

Свойства параметра

Тип:PSKeyVaultKeyIdentityItem
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:Key

Наборы параметров

ByKey
Position:0
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Name

Указывает имя ключа для резервного копирования.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:KeyName (Имя ключа)

Наборы параметров

ByKeyName
Position:1
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False
HsmByKeyName
Position:1
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-OutputFile

Указывает выходной файл, в котором хранится резервный BLOB-объект. Если этот параметр не указан, этот командлет создает имя файла для вас. Если указать имя существующего выходного файла, операция не завершится и возвращает сообщение об ошибке о том, что файл резервной копии уже существует.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:2
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-VaultName

Указывает имя хранилища ключей, содержащего ключ для резервного копирования.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

ByKeyName
Position:0
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-WhatIf

Показывает, что произойдет, если командлет будет запущен. Командлет не запускается.

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:wi

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Входные данные

PSKeyVaultKeyIdentityItem

Выходные данные

String