Share via


NginxDeploymentResource.GetNginxConfigurationAsync Method

Definition

Get the NGINX configuration of given NGINX deployment

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

Parameters

configurationName
String

The name of configuration, only 'default' is supported value due to the singleton of NGINX conf.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

configurationName is null.

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

Applies to