Share via

Deployments interface

  • Reference
Package:
@azure/arm-nginx

Interface representing a Deployments.

Methods

beginCreateOrUpdate(string, string, DeploymentsCreateOrUpdateOptionalParams)

Create or update the NGINX deployment
beginCreateOrUpdateAndWait(string, string, DeploymentsCreateOrUpdateOptionalParams)

Create or update the NGINX deployment
beginDelete(string, string, DeploymentsDeleteOptionalParams)

Delete the NGINX deployment resource
beginDeleteAndWait(string, string, DeploymentsDeleteOptionalParams)

Delete the NGINX deployment resource
beginUpdate(string, string, DeploymentsUpdateOptionalParams)

Update the NGINX deployment
beginUpdateAndWait(string, string, DeploymentsUpdateOptionalParams)

Update the NGINX deployment
get(string, string, DeploymentsGetOptionalParams)

Get the NGINX deployment
list(DeploymentsListOptionalParams)

List the NGINX deployments resources
listByResourceGroup(string, DeploymentsListByResourceGroupOptionalParams)

List all NGINX deployments under the specified resource group.

Method Details

beginCreateOrUpdate(string, string, DeploymentsCreateOrUpdateOptionalParams)

Create or update the NGINX deployment

function beginCreateOrUpdate(resourceGroupName: string, deploymentName: string, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NginxDeployment>, NginxDeployment>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

deploymentName

string

The name of targeted NGINX deployment

options
DeploymentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<NginxDeployment>, NginxDeployment>>

beginCreateOrUpdateAndWait(string, string, DeploymentsCreateOrUpdateOptionalParams)

Create or update the NGINX deployment

function beginCreateOrUpdateAndWait(resourceGroupName: string, deploymentName: string, options?: DeploymentsCreateOrUpdateOptionalParams): Promise<NginxDeployment>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

deploymentName

string

The name of targeted NGINX deployment

options
DeploymentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<NginxDeployment>

beginDelete(string, string, DeploymentsDeleteOptionalParams)

Delete the NGINX deployment resource

function beginDelete(resourceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): 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

options
DeploymentsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, DeploymentsDeleteOptionalParams)

Delete the NGINX deployment resource

function beginDeleteAndWait(resourceGroupName: string, deploymentName: string, options?: DeploymentsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

deploymentName

string

The name of targeted NGINX deployment

options
DeploymentsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, DeploymentsUpdateOptionalParams)

Update the NGINX deployment

function beginUpdate(resourceGroupName: string, deploymentName: string, options?: DeploymentsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NginxDeployment>, NginxDeployment>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

deploymentName

string

The name of targeted NGINX deployment

options
DeploymentsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<NginxDeployment>, NginxDeployment>>

beginUpdateAndWait(string, string, DeploymentsUpdateOptionalParams)

Update the NGINX deployment

function beginUpdateAndWait(resourceGroupName: string, deploymentName: string, options?: DeploymentsUpdateOptionalParams): Promise<NginxDeployment>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

deploymentName

string

The name of targeted NGINX deployment

options
DeploymentsUpdateOptionalParams

The options parameters.

Returns

Promise<NginxDeployment>

get(string, string, DeploymentsGetOptionalParams)

Get the NGINX deployment

function get(resourceGroupName: string, deploymentName: string, options?: DeploymentsGetOptionalParams): Promise<NginxDeployment>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

deploymentName

string

The name of targeted NGINX deployment

options
DeploymentsGetOptionalParams

The options parameters.

Returns

Promise<NginxDeployment>

list(DeploymentsListOptionalParams)

List the NGINX deployments resources

function list(options?: DeploymentsListOptionalParams): PagedAsyncIterableIterator<NginxDeployment, NginxDeployment[], PageSettings>

Parameters

options
DeploymentsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NginxDeployment, NginxDeployment[], PageSettings>

listByResourceGroup(string, DeploymentsListByResourceGroupOptionalParams)

List all NGINX deployments under the specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: DeploymentsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<NginxDeployment, NginxDeployment[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options
DeploymentsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NginxDeployment, NginxDeployment[], PageSettings>