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

Backup-AzKeyVaultSecret

Модуль:
Az.KeyVault Module

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

Синтаксис

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

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

BySecretUri 

Backup-AzKeyVaultSecret
    [-Id] <String>
    [[-OutputFile] <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

BySecret 

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

Описание

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

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

Примеры

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

Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'

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

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

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

Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

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

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

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

C:\Backup.blob

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

Пример 4. Резервное копирование секрета с автоматически созданным именем файла (с помощью URI)

Backup-AzKeyVaultSecret -Id 'https://MyKeyVault.vault.azure.net:443/secrets/MySecret'

Параметры

-Confirm

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

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

Тип:SwitchParameter
Default value:False
Поддерживаются подстановочные знаки: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:False
Поддерживаются подстановочные знаки:False
DontShow:False

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

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

-Id

Универсальный код ресурса (URI) секрета KeyVault. Убедитесь, что он соответствует формату: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

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

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

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

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

-InputObject

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

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

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

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

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

-Name

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

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

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

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

BySecretName
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

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

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

-WhatIf

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

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

Тип:SwitchParameter
Default value:False
Поддерживаются подстановочные знаки: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.

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

PSKeyVaultSecretIdentityItem

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

String