public final class KeyVaultBackupAsyncClient extends Object
KeyVaultBackupAsyncClient
provides asynchronous methods to perform full backup and restore of an Azure
Key Vault.Modifier and Type | Method and Description |
---|---|
com.azure.core.util.polling.PollerFlux<KeyVaultBackupOperation,String> |
beginBackup(String blobStorageUrl,
String sasToken)
Initiates a full backup of the Key Vault.
|
com.azure.core.util.polling.PollerFlux<KeyVaultBackupOperation,String> |
beginBackup(String blobStorageUrl,
String sasToken,
Duration pollingInterval)
Initiates a full backup of the Key Vault.
|
com.azure.core.util.polling.PollerFlux<KeyVaultRestoreOperation,Void> |
beginRestore(String folderUrl,
String sasToken)
Initiates a full restore of the Key Vault.
|
com.azure.core.util.polling.PollerFlux<KeyVaultRestoreOperation,Void> |
beginRestore(String folderUrl,
String sasToken,
Duration pollingInterval)
Initiates a full restore of the Key Vault.
|
com.azure.core.util.polling.PollerFlux<KeyVaultRestoreOperation,Void> |
beginSelectiveRestore(String keyName,
String folderUrl,
String sasToken)
Restores all versions of a given key using the supplied SAS token pointing to a previously stored Azure Blob
storage backup folder.
|
com.azure.core.util.polling.PollerFlux<KeyVaultRestoreOperation,Void> |
beginSelectiveRestore(String keyName,
String folderUrl,
String sasToken,
Duration pollingInterval)
Restores all versions of a given key using the supplied SAS token pointing to a previously stored Azure Blob
storage backup folder.
|
String |
getVaultUrl()
Gets the URL for the Key Vault this client is associated with.
|
public String getVaultUrl()
public com.azure.core.util.polling.PollerFlux<KeyVaultBackupOperation,String> beginBackup(String blobStorageUrl, String sasToken)
blobStorageUrl
- The URL for the Blob Storage resource where the backup will be located.sasToken
- A Shared Access Signature (SAS) token to authorize access to the blob.PollerFlux
polling on the backup operation
status.KeyVaultAdministrationException
- If the given blobStorageUrl
or sasToken
are invalid.NullPointerException
- If the blobStorageUrl
or sasToken
are null
.public com.azure.core.util.polling.PollerFlux<KeyVaultBackupOperation,String> beginBackup(String blobStorageUrl, String sasToken, Duration pollingInterval)
blobStorageUrl
- The URL for the Blob Storage resource where the backup will be located.sasToken
- A Shared Access Signature (SAS) token to authorize access to the blob.pollingInterval
- The interval at which the operation status will be polled for.PollerFlux
polling on the backup operation
status.KeyVaultAdministrationException
- If the given blobStorageUrl
or sasToken
are invalid.NullPointerException
- If the blobStorageUrl
or sasToken
are null
.public com.azure.core.util.polling.PollerFlux<KeyVaultRestoreOperation,Void> beginRestore(String folderUrl, String sasToken)
folderUrl
- The URL for the Blob Storage resource where the backup is located, including the path to
the blob container where the backup resides. This would be the exact value that is returned as the result of a
backup operation. An example of such a URL may look like the following:
https://contoso.blob.core.windows.net/backup/mhsm-contoso-2020090117323313.sasToken
- A Shared Access Signature (SAS) token to authorize access to the blob.PollerFlux
polling on the restore operation
status.KeyVaultAdministrationException
- If the given folderUrl
or sasToken
are invalid.NullPointerException
- If the folderUrl
or sasToken
are null
.public com.azure.core.util.polling.PollerFlux<KeyVaultRestoreOperation,Void> beginRestore(String folderUrl, String sasToken, Duration pollingInterval)
folderUrl
- The URL for the Blob Storage resource where the backup is located, including the path to
the blob container where the backup resides. This would be the exact value that is returned as the result of a
backup operation. An example of such a URL may look like the following:
https://contoso.blob.core.windows.net/backup/mhsm-contoso-2020090117323313.sasToken
- A Shared Access Signature (SAS) token to authorize access to the blob.pollingInterval
- The interval at which the operation status will be polled for.PollerFlux
polling on the restore operation
status.KeyVaultAdministrationException
- If the given folderUrl
or sasToken
are invalid.NullPointerException
- If the folderUrl
or sasToken
are null
.public com.azure.core.util.polling.PollerFlux<KeyVaultRestoreOperation,Void> beginSelectiveRestore(String keyName, String folderUrl, String sasToken)
keyName
- The name of the key to be restored.folderUrl
- The URL for the Blob Storage resource where the backup is located, including the path to
the blob container where the backup resides. This would be the exact value that is returned as the result of a
backup operation. An example of such a URL may look like the following:
https://contoso.blob.core.windows.net/backup/mhsm-contoso-2020090117323313.sasToken
- A Shared Access Signature (SAS) token to authorize access to the blob.PollerFlux
polling on the restore operation
status.KeyVaultAdministrationException
- If the given keyName
, folderUrl
or sasToken
are
invalid.NullPointerException
- If the keyName
, folderUrl
or sasToken
are null
.public com.azure.core.util.polling.PollerFlux<KeyVaultRestoreOperation,Void> beginSelectiveRestore(String keyName, String folderUrl, String sasToken, Duration pollingInterval)
keyName
- The name of the key to be restored.folderUrl
- The URL for the Blob Storage resource where the backup is located, including the path to
the blob container where the backup resides. This would be the exact value that is returned as the result of a
backup operation. An example of such a URL may look like the following:
https://contoso.blob.core.windows.net/backup/mhsm-contoso-2020090117323313.sasToken
- A Shared Access Signature (SAS) token to authorize access to the blob.pollingInterval
- The interval at which the operation status will be polled for.PollerFlux
polling on the restore operation
status.KeyVaultAdministrationException
- If the given keyName
, folderUrl
or sasToken
are
invalid.NullPointerException
- If the keyName
, folderUrl
or sasToken
are null
.Copyright © 2021 Microsoft Corporation. All rights reserved.