NginxDeploymentApiKeyCollection.GetIfExistsAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.Nginx

Assembly:: Azure.ResourceManager.Nginx.dll

Package:: Azure.ResourceManager.Nginx v1.1.0-beta.3

Source:: NginxDeploymentApiKeyCollection.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/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.NullableResponse<Azure.ResourceManager.Nginx.NginxDeploymentApiKeyResource>> GetIfExistsAsync(string apiKeyName, System.Threading.CancellationToken cancellationToken = default);

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

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

Parameters

apiKeyName: String

The resource name of the API key.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<NginxDeploymentApiKeyResource>>

Exceptions

ArgumentException

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

ArgumentNullException

apiKeyName is null.

Applies to

Share via