You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[KeyVault] Enable v7.6 preview.2 for Administration (Azure#49060)
* Add headers files
* Expose PreRestore API and create PreRestoreOperation type
* Expose PreBackup API and refactor BackupOperation to share logic with new PreBackupOperation type
* Export API
* Add tests
* Fix DIagnosticScope name for PreRestore
* Remove PreBackupOperation and use BackupOperation instead
* Remove PreRestoreOperation and Headers
* Fix ClientDiagnostics scope name
* Allow the folderUri to be null
* nit changes
* Record tests
* Export API
* Remove PreBackup headers
* Apply suggestions from code review
Co-authored-by: Jesse Squire <[email protected]>
* Remove old comment
---------
Co-authored-by: Jesse Squire <[email protected]>
Copy file name to clipboardExpand all lines: sdk/keyvault/Azure.Security.KeyVault.Administration/api/Azure.Security.KeyVault.Administration.netstandard2.0.cs
+4Lines changed: 4 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -80,6 +80,10 @@ public KeyVaultBackupClient(System.Uri vaultUri, Azure.Core.TokenCredential cred
/// Initiate a pre-restore check on a Key Vault. This operation checks if it is possible to restore the entire collection of keys from a Key Vault.
405
+
/// </summary>
406
+
/// <param name="folderUri">
407
+
/// The <see cref="Uri"/> for the blob storage resource, including the path to the blob container where the backup resides.
408
+
/// This would be the exact value that is returned as the result of a <see cref="KeyVaultBackupOperation"/>.
409
+
/// An example <paramref name="folderUri" /> may look like the following: https://contoso.blob.core.windows.net/backup/mhsm-contoso-2020090117323313.
410
+
/// </param>
411
+
/// <param name="sasToken">Optional Shared Access Signature (SAS) token to authorize access to the blob. If null, Managed Identity will be used to authenticate instead.</param>
412
+
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
413
+
/// <exception cref="ArgumentNullException"><paramref name="folderUri"/> or <paramref name="sasToken"/> are <c>null</c>.</exception>
414
+
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
415
+
/// <returns>A <see cref="KeyVaultRestoreOperation"/> representing the result of the asynchronous operation.</returns>
/// Initiate a pre-restore check on a Key Vault. This operation checks if it is possible to restore the entire collection of keys from a Key Vault.
451
+
/// </summary>
452
+
/// <param name="folderUri">
453
+
/// The <see cref="Uri"/> for the blob storage resource, including the path to the blob container where the backup resides.
454
+
/// This would be the exact value that is returned as the result of a <see cref="KeyVaultBackupOperation"/>.
455
+
/// An example <paramref name="folderUri" /> path may look like the following: https://contoso.blob.core.windows.net/backup/mhsm-contoso-2020090117323313.
456
+
/// </param>
457
+
/// <param name="sasToken">Optional Shared Access Signature (SAS) token to authorize access to the blob. If null, Managed Identity will be used to authenticate instead.</param>
458
+
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
459
+
/// <exception cref="ArgumentNullException"><paramref name="folderUri"/> or <paramref name="sasToken"/> are <c>null</c>.</exception>
460
+
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
461
+
/// <returns>A <see cref="KeyVaultRestoreOperation"/> to wait on this long-running operation.</returns>
/// Initiates a pre-backup check on the Key Vault. This operation checks if it is possible to back up the entire collection of keys from a Key Vault.
541
+
/// </summary>
542
+
/// <param name="blobStorageUri">The <see cref="Uri"/> for the blob storage resource.</param>
543
+
/// <param name="sasToken">Optional Shared Access Signature (SAS) token to authorize access to the blob. If null, Managed Identity will be used to authenticate instead.</param>
544
+
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
545
+
/// <exception cref="ArgumentNullException"><paramref name="blobStorageUri"/> or <paramref name="sasToken"/> is null.</exception>
546
+
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
547
+
/// <returns>A <see cref="KeyVaultBackupOperation"/> representing the result of the asynchronous operation.</returns>
/// Initiates a pre-backup check on the Key Vault. This operation checks if it is possible to back up the entire collection of keys from a Key Vault.
581
+
/// </summary>
582
+
/// <param name="blobStorageUri">The <see cref="Uri"/> for the blob storage resource.</param>
583
+
/// <param name="sasToken">Optional Shared Access Signature (SAS) token to authorize access to the blob. If null, Managed Identity will be used to authenticate instead.</param>
584
+
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
585
+
/// <exception cref="ArgumentNullException"><paramref name="blobStorageUri"/> or <paramref name="sasToken"/> is null.</exception>
586
+
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
587
+
/// <returns>A <see cref="KeyVaultBackupOperation"/> representing the result of the operation.</returns>
0 commit comments