Backup-AzureKeyVaultSecret

  • Ссылка
Модуль:
AzureRM.KeyVault

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

Предупреждение

Модуль AzureRM PowerShell официально устарел с 29 февраля 2024 г. Пользователям рекомендуется выполнить миграцию из AzureRM в модуль Az PowerShell, чтобы обеспечить постоянную поддержку и обновления.

Хотя модуль AzureRM по-прежнему может функционировать, он больше не поддерживается или не поддерживается, размещая любое постоянное использование на усмотрение и риск пользователя. Ознакомьтесь с нашими ресурсами миграции, чтобы получить рекомендации по переходу в модуль Az.

Синтаксис

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

Описание

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

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

Примеры

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

PS C:\Users\username\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'

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

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

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

PS C:\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

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

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

PS C:\> $secret = Get-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
PS C:\> Backup-AzureKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob'

C:\Backup.blob

Эта команда использует имя и имя хранилища объекта $secret для получения секрета и сохранения резервной копии в файл с именем Backup.blob.

Параметры

-Confirm

Запрос подтверждения перед выполнением командлета.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
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:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

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

Type:PSKeyVaultSecretIdentityItem
Aliases:Secret
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

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

Type:String
Aliases:SecretName
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:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

PSKeyVaultSecretIdentityItem

Параметры: InputObject (ByValue)

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

String