Share via


NginxDeploymentResource.GetNginxDeploymentApiKeyAsync Method

Definition

Get the specified API Key of the given Nginx deployment

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/apiKeys/{apiKeyName}
  • Operation Id: ApiKeys_Get
  • Default Api Version: 2024-11-01-preview
  • Resource: NginxDeploymentApiKeyResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Nginx.NginxDeploymentApiKeyResource>> GetNginxDeploymentApiKeyAsync(string apiKeyName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetNginxDeploymentApiKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Nginx.NginxDeploymentApiKeyResource>>
override this.GetNginxDeploymentApiKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Nginx.NginxDeploymentApiKeyResource>>
Public Overridable Function GetNginxDeploymentApiKeyAsync (apiKeyName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of NginxDeploymentApiKeyResource))

Parameters

apiKeyName
String

The resource name of the API key.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

apiKeyName is null.

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

Applies to