| | | 1 | | // Copyright (c) Microsoft Corporation. All rights reserved. |
| | | 2 | | // Licensed under the MIT License. |
| | | 3 | | |
| | | 4 | | using System; |
| | | 5 | | using System.Threading; |
| | | 6 | | using System.Threading.Tasks; |
| | | 7 | | using Azure.Core; |
| | | 8 | | using Azure.Security.KeyVault.Administration.Models; |
| | | 9 | | |
| | | 10 | | namespace Azure.Security.KeyVault.Administration |
| | | 11 | | { |
| | | 12 | | /// <summary> |
| | | 13 | | /// A long-running operation for <see cref="KeyVaultBackupClient.StartBackup(Uri, string, CancellationToken)"/> or < |
| | | 14 | | /// </summary> |
| | | 15 | | public class BackupOperation : Operation<Uri> |
| | | 16 | | { |
| | | 17 | | /// <summary> |
| | | 18 | | /// The number of seconds recommended by the service to delay before checking on completion status. |
| | | 19 | | /// </summary> |
| | | 20 | | private readonly int? _retryAfterSeconds; |
| | | 21 | | private readonly KeyVaultBackupClient _client; |
| | | 22 | | private Response _response; |
| | | 23 | | private FullBackupDetailsInternal _value; |
| | | 24 | | private readonly string _id; |
| | | 25 | | |
| | | 26 | | /// <summary> |
| | | 27 | | /// Creates an instance of a BackupOperation from a previously started operation. <see cref="UpdateStatus(Cancel |
| | | 28 | | /// <see cref="WaitForCompletionAsync(CancellationToken)"/>, or <see cref="WaitForCompletionAsync(TimeSpan, Can |
| | | 29 | | /// to re-populate the details of this operation. |
| | | 30 | | /// </summary> |
| | | 31 | | /// <param name="id">The <see cref="Id" /> from a previous <see cref="BackupOperation" />.</param> |
| | | 32 | | /// <param name="client">An instance of <see cref="KeyVaultBackupClient" />.</param> |
| | | 33 | | /// <exception cref="ArgumentNullException"><paramref name="id"/> or <paramref name="client"/> is null.</excepti |
| | 0 | 34 | | public BackupOperation(string id, KeyVaultBackupClient client) |
| | | 35 | | { |
| | 0 | 36 | | Argument.AssertNotNull(id, nameof(id)); |
| | 0 | 37 | | Argument.AssertNotNull(client, nameof(client)); |
| | | 38 | | |
| | 0 | 39 | | _client = client; |
| | 0 | 40 | | _id = id; |
| | 0 | 41 | | } |
| | | 42 | | |
| | | 43 | | /// <summary> |
| | | 44 | | /// Initializes a new instance of a BackupOperation. |
| | | 45 | | /// </summary> |
| | | 46 | | /// <param name="client">An instance of <see cref="KeyVaultBackupClient" />.</param> |
| | | 47 | | /// <param name="response">The <see cref="ResponseWithHeaders{T, THeaders}" /> returned from <see cref="KeyVault |
| | 4 | 48 | | internal BackupOperation(KeyVaultBackupClient client, ResponseWithHeaders<ServiceFullBackupHeaders> response) |
| | | 49 | | { |
| | 4 | 50 | | _client = client; |
| | 4 | 51 | | _response = response; |
| | 4 | 52 | | _retryAfterSeconds = response.Headers.RetryAfter; |
| | 4 | 53 | | _id = response.Headers.JobId() ?? throw new InvalidOperationException("The response does not contain an Id") |
| | 4 | 54 | | } |
| | | 55 | | |
| | | 56 | | /// <summary> |
| | | 57 | | /// Initializes a new instance of a BackupOperation for mocking purposes. |
| | | 58 | | /// </summary> |
| | | 59 | | /// <param name="value">The <see cref="FullBackupDetailsInternal" /> that will be returned from <see cref="Value |
| | | 60 | | /// <param name="response">The <see cref="Response" /> that will be returned from <see cref="GetRawResponse" />. |
| | | 61 | | /// <param name="client">An instance of <see cref="KeyVaultBackupClient" />.</param> |
| | 0 | 62 | | internal BackupOperation(FullBackupDetailsInternal value, Response response, KeyVaultBackupClient client) |
| | | 63 | | { |
| | 0 | 64 | | Argument.AssertNotNull(value, nameof(value)); |
| | 0 | 65 | | Argument.AssertNotNull(response, nameof(response)); |
| | 0 | 66 | | Argument.AssertNotNull(client, nameof(client)); |
| | | 67 | | |
| | 0 | 68 | | _response = response; |
| | 0 | 69 | | _value = value; |
| | 0 | 70 | | _id = value.JobId; |
| | 0 | 71 | | _client = client; |
| | 0 | 72 | | } |
| | | 73 | | |
| | | 74 | | /// <summary> |
| | | 75 | | /// The start time of the restore operation. |
| | | 76 | | /// </summary> |
| | 0 | 77 | | public DateTimeOffset? StartTime => _value?.StartTime; |
| | | 78 | | |
| | | 79 | | /// <summary> |
| | | 80 | | /// The end time of the restore operation. |
| | | 81 | | /// </summary> |
| | 32 | 82 | | public DateTimeOffset? EndTime => _value?.EndTime; |
| | | 83 | | |
| | | 84 | | /// <inheritdoc/> |
| | 10 | 85 | | public override string Id => _id; |
| | | 86 | | |
| | | 87 | | /// <summary> |
| | | 88 | | /// Gets the <see cref="FullBackupDetailsInternal"/> of the backup operation. |
| | | 89 | | /// You should await <see cref="WaitForCompletionAsync(CancellationToken)"/> before attempting to use a key in t |
| | | 90 | | /// </summary> |
| | | 91 | | public override Uri Value |
| | | 92 | | { |
| | | 93 | | get |
| | | 94 | | { |
| | | 95 | | #pragma warning disable CA1065 // Do not raise exceptions in unexpected locations |
| | 4 | 96 | | if (!HasCompleted) |
| | | 97 | | { |
| | 0 | 98 | | throw new InvalidOperationException("The operation is not complete."); |
| | | 99 | | } |
| | 4 | 100 | | if (EndTime.HasValue && _value.Error != null) |
| | | 101 | | { |
| | 0 | 102 | | throw new RequestFailedException($"{_value.Error.Message}\nInnerError: {_value.Error.InnerError}\nCo |
| | | 103 | | } |
| | | 104 | | #pragma warning restore CA1065 // Do not raise exceptions in unexpected locations |
| | 4 | 105 | | return new Uri(_value.AzureStorageBlobContainerUri); |
| | | 106 | | } |
| | | 107 | | } |
| | | 108 | | |
| | | 109 | | /// <inheritdoc/> |
| | 28 | 110 | | public override bool HasCompleted => EndTime.HasValue; |
| | | 111 | | |
| | | 112 | | /// <inheritdoc/> |
| | 4 | 113 | | public override bool HasValue => _response != null && _value?.Error == null && HasCompleted; |
| | | 114 | | |
| | | 115 | | /// <inheritdoc/> |
| | 14 | 116 | | public override Response GetRawResponse() => _response; |
| | | 117 | | |
| | | 118 | | /// <inheritdoc/> |
| | | 119 | | public override Response UpdateStatus(CancellationToken cancellationToken = default) |
| | | 120 | | { |
| | 0 | 121 | | if (!HasCompleted) |
| | | 122 | | { |
| | 0 | 123 | | Response<FullBackupDetailsInternal> response = _client.GetBackupDetails(Id, cancellationToken); |
| | 0 | 124 | | _value = response.Value; |
| | 0 | 125 | | _response = response.GetRawResponse(); |
| | | 126 | | } |
| | | 127 | | |
| | 0 | 128 | | return GetRawResponse(); |
| | | 129 | | } |
| | | 130 | | |
| | | 131 | | /// <inheritdoc/> |
| | | 132 | | public override async ValueTask<Response> UpdateStatusAsync(CancellationToken cancellationToken = default) |
| | | 133 | | { |
| | 10 | 134 | | if (!HasCompleted) |
| | | 135 | | { |
| | 10 | 136 | | Response<FullBackupDetailsInternal> response = await _client.GetBackupDetailsAsync(Id, cancellationToken |
| | 10 | 137 | | _value = response.Value; |
| | 10 | 138 | | _response = response.GetRawResponse(); |
| | | 139 | | } |
| | | 140 | | |
| | 10 | 141 | | return GetRawResponse(); |
| | 10 | 142 | | } |
| | | 143 | | |
| | | 144 | | /// <inheritdoc/> |
| | | 145 | | public override ValueTask<Response<Uri>> WaitForCompletionAsync(CancellationToken cancellationToken = default) = |
| | 4 | 146 | | _retryAfterSeconds.HasValue ? this.DefaultWaitForCompletionAsync(TimeSpan.FromSeconds(_retryAfterSeconds.Val |
| | 4 | 147 | | this.DefaultWaitForCompletionAsync(cancellationToken); |
| | | 148 | | |
| | | 149 | | /// <inheritdoc/> |
| | | 150 | | public override ValueTask<Response<Uri>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken canc |
| | 0 | 151 | | this.DefaultWaitForCompletionAsync(pollingInterval, cancellationToken); |
| | | 152 | | } |
| | | 153 | | } |