/// <summary>
/// Lists the properties of all enabled and disabled versions of the specified secret. You can use the returned <see cref="SecretProperties.Name"/> and <see cref="SecretProperties.Version"/> in subsequent calls to <see cref="GetSecret"/>.
/// </summary>
/// <remarks>
/// <para>
/// The full secret identifier and attributes are provided in the response. No
/// values are returned for the secrets. This operations requires the
/// secrets/list permission.
/// </para>
/// <para>
/// Managed secrets may also be listed. They contain the certificate and private key for certificates stored in Key Vault.
/// </para>
/// </remarks>
/// <param name="name">The name of the secret.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
/// <exception cref="ArgumentException"><paramref name="name"/> is an empty string.</exception>
/// <exception cref="ArgumentNullException"><paramref name="name"/> is null.</exception>
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
public virtual Pageable <SecretProperties> GetPropertiesOfSecretVersions(string name, CancellationToken cancellationToken = default)
{
Argument.AssertNotNullOrEmpty(name, nameof(name));
Uri firstPageUri = _pipeline.CreateFirstPageUri($"{SecretsPath}{name}/versions");
return(PageResponseEnumerator.CreateEnumerable(nextLink => _pipeline.GetPage(firstPageUri, nextLink, () => new SecretProperties(), "SecretClient.GetPropertiesOfSecretVersions", cancellationToken)));
}
/// <summary>
/// List all versions of the specified secret.
/// </summary>
/// <remarks>
/// The full secret identifier and attributes are provided in the response. No
/// values are returned for the secrets. This operations requires the
/// secrets/list permission.
/// </remarks>
/// <param name="name">The name of the secret.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
public virtual Pageable <SecretProperties> GetPropertiesOfSecretVersions(string name, CancellationToken cancellationToken = default)
{
Argument.AssertNotNullOrEmpty(name, nameof(name));
Uri firstPageUri = new Uri(VaultUri, $"{SecretsPath}{name}/versions?api-version={_pipeline.ApiVersion}");
return(PageResponseEnumerator.CreateEnumerable(nextLink => _pipeline.GetPage(firstPageUri, nextLink, () => new SecretProperties(), "Azure.Security.KeyVault.Secrets.SecretClient.GetPropertiesOfSecretVersions", cancellationToken)));
}
/// <summary>
/// List all versions of the specified secret.
/// </summary>
/// <remarks>
/// The full secret identifier and attributes are provided in the response. No
/// values are returned for the secrets. This operations requires the
/// secrets/list permission.
/// </remarks>
/// <param name="name">The name of the secret.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
public virtual IEnumerable <Response <SecretBase> > GetSecretVersions(string name, CancellationToken cancellationToken = default)
{
if (string.IsNullOrEmpty(name))
{
throw new ArgumentException($"{nameof(name)} must not be null or empty", nameof(name));
}
Uri firstPageUri = new Uri(_vaultUri, $"{SecretsPath}{name}/versions?api-version={ApiVersion}");
return(PageResponseEnumerator.CreateEnumerable(nextLink => GetPage(firstPageUri, nextLink, () => new SecretBase(), cancellationToken)));
}
public virtual IEnumerable <Response <KeyBase> > GetKeyVersions(string name, CancellationToken cancellationToken = default)
{
if (string.IsNullOrEmpty(name))
{
throw new ArgumentException($"{nameof(name)} can't be empty or null");
}
Uri firstPageUri = CreateFirstPageUri($"{KeysPath}{name}/versions");
return(PageResponseEnumerator.CreateEnumerable(nextLink => GetPage(firstPageUri, nextLink, () => new KeyBase(), cancellationToken)));
}
public virtual Pageable <int> GetPageableValidScopes()
{
return(PageResponseEnumerator.CreateEnumerable(s =>
{
CreateAndFireScope(nameof(GetPageableValidScopes));
if (s == null)
{
return Page <int> .FromValues(new[] { 1, 2, 3 }, "1", new MockResponse(200));
}
return Page <int> .FromValues(new[] { 4, 5, 6 }, null, new MockResponse(200));
}));
}
public void EnumerateSyncPages()
{
var enumerable = PageResponseEnumerator.CreateEnumerable(s =>
s == null ?
Page <int> .FromValues(new[] { 1, 2, 3 }, "next", new MockResponse(200)):
Page <int> .FromValues(new[] { 4, 5, 6 }, null, new MockResponse(200)));
Assert.AreEqual(new[] { 1, 2, 3, 4, 5, 6 }, enumerable.ToArray());
int pageCount = 0;
foreach (var page in enumerable.AsPages())
{
Assert.AreEqual(3, page.Values.Count);
pageCount++;
}
Assert.AreEqual(2, pageCount);
}
/// <summary>
/// Lists deleted secrets for the specified vault.
/// </summary>
/// <remarks>
/// The Get Deleted Secrets operation returns the secrets that have been
/// deleted for a vault enabled for soft-delete. This operation requires the
/// secrets/list permission.
/// </remarks>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
public virtual Pageable <DeletedSecret> GetDeletedSecrets(CancellationToken cancellationToken = default)
{
Uri firstPageUri = new Uri(VaultUri, DeletedSecretsPath + $"?api-version={_pipeline.ApiVersion}");
return(PageResponseEnumerator.CreateEnumerable(nextLink => _pipeline.GetPage(firstPageUri, nextLink, () => new DeletedSecret(), "Azure.Security.KeyVault.Secrets.SecretClient.GetDeletedSecrets", cancellationToken)));
}
/// <summary>
/// Lists the properties of all secrets in the specified vault. You can use the returned <see cref="SecretProperties.Name"/> in subsequent calls to <see cref="GetSecret"/>.
/// </summary>
/// <remarks>
/// The Get Secrets operation is applicable to the entire vault. However, only
/// the base secret identifier and its attributes are provided in the response.
/// Individual secret versions are not listed in the response. This operation
/// requires the secrets/list permission.
/// </remarks>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
public virtual Pageable <SecretProperties> GetPropertiesOfSecrets(CancellationToken cancellationToken = default)
{
Uri firstPageUri = new Uri(VaultUri, SecretsPath + $"?api-version={_pipeline.ApiVersion}");
return(PageResponseEnumerator.CreateEnumerable(nextLink => _pipeline.GetPage(firstPageUri, nextLink, () => new SecretProperties(), "SecretClient.GetPropertiesOfSecrets", cancellationToken)));
}
/// <summary>
/// Lists deleted secrets for the specified vault.
/// </summary>
/// <remarks>
/// The Get Deleted Secrets operation returns the secrets that have been
/// deleted for a vault enabled for soft-delete. This operation requires the
/// secrets/list permission.
/// </remarks>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
public virtual IEnumerable <Response <DeletedSecret> > GetDeletedSecrets(CancellationToken cancellationToken = default)
{
Uri firstPageUri = new Uri(_vaultUri, DeletedSecretsPath + $"?api-version={ApiVersion}");
return(PageResponseEnumerator.CreateEnumerable(nextLink => GetPage(firstPageUri, nextLink, () => new DeletedSecret(), cancellationToken)));
}
public virtual IEnumerable <Response <DeletedKey> > GetDeletedKeys(CancellationToken cancellationToken = default)
{
Uri firstPageUri = CreateFirstPageUri(DeletedKeysPath);
return(PageResponseEnumerator.CreateEnumerable(nextLink => GetPage(firstPageUri, nextLink, () => new DeletedKey(), cancellationToken)));
}
/// <summary>
/// Retrieves the different revisions of specific <see cref="ConfigurationSetting"/> that satisfies the options of the <see cref="SettingSelector"/>
/// </summary>
/// <param name="selector">Set of options for selecting <see cref="ConfigurationSetting"/> from the configuration store.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
public virtual IEnumerable <Response <ConfigurationSetting> > GetRevisions(SettingSelector selector, CancellationToken cancellationToken = default)
{
return(PageResponseEnumerator.CreateEnumerable(nextLink => GetRevisionsPage(selector, nextLink, cancellationToken)));
}
/// <summary>
/// List secrets in a specified key vault.
/// </summary>
/// <remarks>
/// The Get Secrets operation is applicable to the entire vault. However, only
/// the base secret identifier and its attributes are provided in the response.
/// Individual secret versions are not listed in the response. This operation
/// requires the secrets/list permission.
/// </remarks>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
public virtual IEnumerable <Response <SecretBase> > GetSecrets(CancellationToken cancellationToken = default)
{
Uri firstPageUri = new Uri(_vaultUri, SecretsPath + $"?api-version={ApiVersion}");
return(PageResponseEnumerator.CreateEnumerable(nextLink => GetPage(firstPageUri, nextLink, () => new SecretBase(), "Azure.Security.KeyVault.Secrets.SecretClient.GetSecrets", cancellationToken)));
}
/// <summary> Return list of jobs. </summary>
public virtual Pageable <JobDetails> GetJobs(CancellationToken cancellationToken = default)
{
return(PageResponseEnumerator.CreateEnumerable(cont => ToPage(string.IsNullOrEmpty(cont) ? _jobs.List() : _jobs.ListNextPage(cont))));
}
/// <summary> Get quota status. </summary>
/// <param name="cancellationToken"> The cancellation token to use. </param>
public virtual Pageable <QuantumJobQuota> GetQuotas(CancellationToken cancellationToken = default)
{
return(PageResponseEnumerator.CreateEnumerable(cont => ToPage(string.IsNullOrEmpty(cont) ? _quotas.List() : _quotas.ListNextPage(cont))));
}
/// <summary> Get provider status. </summary>
/// <param name="cancellationToken"> The cancellation token to use. </param>
public virtual Pageable <ProviderStatus> GetProviderStatus(CancellationToken cancellationToken = default)
{
return(PageResponseEnumerator.CreateEnumerable(cont => ToPage(string.IsNullOrEmpty(cont) ? _providers.GetStatus() : _providers.GetStatusNextPage(cont))));
}
/// <summary>
/// Lists deleted secrets for the specified vault.
/// </summary>
/// <remarks>
/// The Get Deleted Secrets operation returns the secrets that have been
/// deleted for a vault enabled for soft-delete. This operation requires the
/// secrets/list permission.
/// </remarks>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
/// <exception cref="RequestFailedException">The server returned an error. See <see cref="Exception.Message"/> for details returned from the server.</exception>
public virtual Pageable <DeletedSecret> GetDeletedSecrets(CancellationToken cancellationToken = default)
{
Uri firstPageUri = _pipeline.CreateFirstPageUri(DeletedSecretsPath);
return(PageResponseEnumerator.CreateEnumerable(nextLink => _pipeline.GetPage(firstPageUri, nextLink, () => new DeletedSecret(), "SecretClient.GetDeletedSecrets", cancellationToken)));
}