SecretClient.GetPropertiesOfSecretVersions(String, CancellationToken) Method

  • Reference

Definition

Namespace:
Azure.Security.KeyVault.Secrets
Assembly:
Azure.Security.KeyVault.Secrets.dll
Package:
Azure.Security.KeyVault.Secrets v4.7.0
Package:
Azure.Security.KeyVault.Secrets v4.6.0-beta.2
Source:
SecretClient.cs
Source:
SecretClient.cs

Lists the properties of all enabled and disabled versions of the specified secret. You can use the returned Name and Version in subsequent calls to GetSecret(String, String, CancellationToken).

public virtual Azure.Pageable<Azure.Security.KeyVault.Secrets.SecretProperties> GetPropertiesOfSecretVersions (string name, System.Threading.CancellationToken cancellationToken = default);
abstract member GetPropertiesOfSecretVersions : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Security.KeyVault.Secrets.SecretProperties>
override this.GetPropertiesOfSecretVersions : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Security.KeyVault.Secrets.SecretProperties>
Public Overridable Function GetPropertiesOfSecretVersions (name As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of SecretProperties)

Parameters

name
String

The name of the secret.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Pageable<SecretProperties>

Exceptions

ArgumentException

name is an empty string.

ArgumentNullException

name is null.

RequestFailedException

The server returned an error. See Message for details returned from the server.

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.

Managed secrets may also be listed. They contain the certificate and private key for certificates stored in Key Vault.

Applies to