Backup-AzureKeyVaultKey
Резервное копирование ключа в хранилище ключей.
Предупреждение
Модуль AzureRM PowerShell официально устарел с 29 февраля 2024 г. Пользователям рекомендуется выполнить миграцию из AzureRM в модуль Az PowerShell, чтобы обеспечить постоянную поддержку и обновления.
Хотя модуль AzureRM по-прежнему может функционировать, он больше не поддерживается или не поддерживается, размещая любое постоянное использование на усмотрение и риск пользователя. Ознакомьтесь с нашими ресурсами миграции, чтобы получить рекомендации по переходу в модуль Az.
Синтаксис
Backup-AzureKeyVaultKey
[-VaultName] <String>
[-Name] <String>
[[-OutputFile] <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Backup-AzureKeyVaultKey
[-InputObject] <PSKeyVaultKeyIdentityItem>
[[-OutputFile] <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Описание
Командлет Backup-AzureKeyVaultKey резервирует указанный ключ в хранилище ключей, скачав его и сохраняя его в файле. При наличии нескольких версий ключа все версии включаются в резервную копию. Так как скачанный контент зашифрован, его нельзя использовать за пределами Azure Key Vault. Вы можете восстановить резервную копию ключа в любом хранилище ключей в подписке, из которую она была создана. Типичными причинами использования этого командлета являются:
Вы хотите отключить копию ключа, чтобы у вас была автономная копия в случае случайного удаления ключа в хранилище ключей.
Вы создали ключ с помощью Key Vault и теперь хотите клонировать ключ в другой регион Azure, чтобы использовать его из всех экземпляров распределенного приложения. Используйте командлет Backup-AzureKeyVaultKey, чтобы получить ключ в зашифрованном формате, а затем использовать командлет Restore-AzureKeyVaultKey и указать хранилище ключей во втором регионе.
Примеры
Пример 1. Резервное копирование ключа с автоматически созданным именем файла
PS C:\Users\username\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
C:\Users\username\mykeyvault-mykey-1527029447.01191Эта команда извлекает ключ с именем MyKey из хранилища ключей с именем MyKeyVault и сохраняет резервную копию этого ключа в файл, который автоматически называется вами, и отображает имя файла.
Пример 2. Резервное копирование ключа в указанное имя файла
PS C:\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob'
C:\Backup.blobЭта команда извлекает ключ с именем MyKey из хранилища ключей MyKeyVault и сохраняет резервную копию этого ключа в файл с именем Backup.blob.
Пример 3. Резервное копирование ранее полученного ключа в указанное имя файла, перезаписывание целевого файла без запроса.
PS C:\> $key = Get-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
PS C:\> Backup-AzureKeyVaultKey -Key $key -OutputFile 'C:\Backup.blob' -Force
C:\Backup.blobЭта команда создает резервную копию ключа с именем $key. Имя в хранилище с именем $key. VaultName в файл с именем Backup.blob автоматически перезаписывает файл, если он уже существует.
Параметры
-Confirm
Запрос подтверждения перед выполнением командлета.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Перезаписать указанный файл, если он существует
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Пакет ключей для резервного копирования, конвейерированный из выходных данных вызова извлечения.
| Type: | PSKeyVaultKeyIdentityItem |
| Aliases: | Key |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Указывает имя ключа для резервного копирования.
| Type: | String |
| Aliases: | KeyName |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OutputFile
Указывает выходной файл, в котором хранится резервный BLOB-объект. Если этот параметр не указан, этот командлет создает имя файла для вас. Если указать имя существующего выходного файла, операция не завершится и возвращает сообщение об ошибке о том, что файл резервной копии уже существует.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VaultName
Указывает имя хранилища ключей, содержащего ключ для резервного копирования.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Показывает, что произойдет при запуске командлета. Командлет не выполняется.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Входные данные
Параметры: InputObject (ByValue)