KeyVaultSecretCollection.GetIfExistsAsync(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.ResourceManager.KeyVault

Assembly:: Azure.ResourceManager.KeyVault.dll

Package:: Azure.ResourceManager.KeyVault v1.2.3

Source:: KeyVaultSecretCollection.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.

Tries to get details for this resource from the service.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
Operation Id: Secrets_Get
Default Api Version: 2023-02-01
Resource: KeyVaultSecretResource

public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.KeyVault.KeyVaultSecretResource>> GetIfExistsAsync (string secretName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.KeyVault.KeyVaultSecretResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.KeyVault.KeyVaultSecretResource>>

Public Overridable Function GetIfExistsAsync (secretName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of KeyVaultSecretResource))

Parameters

secretName: String

The name of the secret.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<KeyVaultSecretResource>>

Exceptions

ArgumentException

secretName is an empty string, and was expected to be non-empty.

ArgumentNullException

secretName is null.

Applies to

Share via