SynapseWorkspaceResource.GetSynapseKeyAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.ResourceManager.Synapse

Assembly:

Azure.ResourceManager.Synapse.dll

Package:

Azure.ResourceManager.Synapse v1.2.0

Source:

SynapseWorkspaceResource.cs

Gets a workspace key

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName}
• Operation Id: Keys_Get

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

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

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

Parameters

keyName

String

The name of the workspace key.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<SynapseKeyResource>>

Exceptions

ArgumentNullException

keyName is null.

ArgumentException

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