SecretClient.GetPropertiesOfSecrets(CancellationToken) Method

Reference

Definition

Namespace:: Azure.Security.KeyVault.Secrets

Assembly:: Azure.Security.KeyVault.Secrets.dll

Package:: Azure.Security.KeyVault.Secrets v4.6.0

Package:: Azure.Security.KeyVault.Secrets v4.6.0-beta.2

Source:: SecretClient.cs

Source:: SecretClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public virtual Azure.Pageable<Azure.Security.KeyVault.Secrets.SecretProperties> GetPropertiesOfSecrets (System.Threading.CancellationToken cancellationToken = default);

abstract member GetPropertiesOfSecrets : System.Threading.CancellationToken -> Azure.Pageable<Azure.Security.KeyVault.Secrets.SecretProperties>
override this.GetPropertiesOfSecrets : System.Threading.CancellationToken -> Azure.Pageable<Azure.Security.KeyVault.Secrets.SecretProperties>

Public Overridable Function GetPropertiesOfSecrets (Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of SecretProperties)

Parameters

cancellationToken: CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Pageable<SecretProperties>

Exceptions

RequestFailedException

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

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.

Applies to