Configurations interface
Interface representing a Configurations.
Methods
| analysis(string, string, string, Configurations |
Analyze an NGINX configuration without applying it to the NGINXaaS deployment |
| begin |
Create or update the NGINX configuration for given NGINX deployment |
| begin |
Create or update the NGINX configuration for given NGINX deployment |
| begin |
Reset the NGINX configuration of given NGINX deployment to default |
| begin |
Reset the NGINX configuration of given NGINX deployment to default |
| get(string, string, string, Configurations |
Get the NGINX configuration of given NGINX deployment |
| list(string, string, Configurations |
List the NGINX configuration of given NGINX deployment. |
Method Details
analysis(string, string, string, ConfigurationsAnalysisOptionalParams)
Analyze an NGINX configuration without applying it to the NGINXaaS deployment
function analysis(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsAnalysisOptionalParams): Promise<AnalysisResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- deploymentName
-
string
The name of targeted NGINX deployment
- configurationName
-
string
The name of configuration, only 'default' is supported value due to the singleton of NGINX conf
The options parameters.
Returns
Promise<AnalysisResult>
beginCreateOrUpdate(string, string, string, ConfigurationsCreateOrUpdateOptionalParams)
Create or update the NGINX configuration for given NGINX deployment
function beginCreateOrUpdate(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NginxConfigurationResponse>, NginxConfigurationResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- deploymentName
-
string
The name of targeted NGINX deployment
- configurationName
-
string
The name of configuration, only 'default' is supported value due to the singleton of NGINX conf
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<NginxConfigurationResponse>, NginxConfigurationResponse>>
beginCreateOrUpdateAndWait(string, string, string, ConfigurationsCreateOrUpdateOptionalParams)
Create or update the NGINX configuration for given NGINX deployment
function beginCreateOrUpdateAndWait(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsCreateOrUpdateOptionalParams): Promise<NginxConfigurationResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- deploymentName
-
string
The name of targeted NGINX deployment
- configurationName
-
string
The name of configuration, only 'default' is supported value due to the singleton of NGINX conf
The options parameters.
Returns
Promise<NginxConfigurationResponse>
beginDelete(string, string, string, ConfigurationsDeleteOptionalParams)
Reset the NGINX configuration of given NGINX deployment to default
function beginDelete(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- deploymentName
-
string
The name of targeted NGINX deployment
- configurationName
-
string
The name of configuration, only 'default' is supported value due to the singleton of NGINX conf
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ConfigurationsDeleteOptionalParams)
Reset the NGINX configuration of given NGINX deployment to default
function beginDeleteAndWait(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- deploymentName
-
string
The name of targeted NGINX deployment
- configurationName
-
string
The name of configuration, only 'default' is supported value due to the singleton of NGINX conf
The options parameters.
Returns
Promise<void>
get(string, string, string, ConfigurationsGetOptionalParams)
Get the NGINX configuration of given NGINX deployment
function get(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsGetOptionalParams): Promise<NginxConfigurationResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- deploymentName
-
string
The name of targeted NGINX deployment
- configurationName
-
string
The name of configuration, only 'default' is supported value due to the singleton of NGINX conf
- options
- ConfigurationsGetOptionalParams
The options parameters.
Returns
Promise<NginxConfigurationResponse>
list(string, string, ConfigurationsListOptionalParams)
List the NGINX configuration of given NGINX deployment.
function list(resourceGroupName: string, deploymentName: string, options?: ConfigurationsListOptionalParams): PagedAsyncIterableIterator<NginxConfigurationResponse, NginxConfigurationResponse[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- deploymentName
-
string
The name of targeted NGINX deployment
- options
- ConfigurationsListOptionalParams
The options parameters.
