SynapseKeyCollection.GetIfExistsAsync(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.ResourceManager.Synapse

Assembly:: Azure.ResourceManager.Synapse.dll

Package:: Azure.ResourceManager.Synapse v1.2.0

Source:: SynapseKeyCollection.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.Synapse/workspaces/{workspaceName}/keys/{keyName}
Operation Id: Keys_Get

public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Synapse.SynapseKeyResource>> GetIfExistsAsync (string keyName, System.Threading.CancellationToken cancellationToken = default);

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

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

Parameters

keyName: String

The name of the workspace key.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<SynapseKeyResource>>

Exceptions

ArgumentException

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

ArgumentNullException

keyName is null.

Applies to

Share via