Rollouts interface

Package:

@azure/arm-deploymentmanager

Interface representing a Rollouts.

Methods

beginCreateOrUpdate(string, string, RolloutsCreateOrUpdateOptionalParams)	This is an asynchronous operation and can be polled to completion using the location header returned by this operation.
beginCreateOrUpdateAndWait(string, string, RolloutsCreateOrUpdateOptionalParams)	This is an asynchronous operation and can be polled to completion using the location header returned by this operation.
cancel(string, string, RolloutsCancelOptionalParams)	Only running rollouts can be canceled.
delete(string, string, RolloutsDeleteOptionalParams)	Only rollouts in terminal state can be deleted.
get(string, string, RolloutsGetOptionalParams)	Gets detailed information of a rollout.
list(string, RolloutsListOptionalParams)	Lists the rollouts in a resource group.
restart(string, string, RolloutsRestartOptionalParams)	Only failed rollouts can be restarted.

Method Details

beginCreateOrUpdate(string, string, RolloutsCreateOrUpdateOptionalParams)

This is an asynchronous operation and can be polled to completion using the location header returned by this operation.

function beginCreateOrUpdate(resourceGroupName: string, rolloutName: string, options?: RolloutsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<RolloutsCreateOrUpdateResponse>, RolloutsCreateOrUpdateResponse>>

Parameters

resourceGroupName

string

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

rolloutName

string

The rollout name.

options

RolloutsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<RolloutsCreateOrUpdateResponse>, RolloutsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait(string, string, RolloutsCreateOrUpdateOptionalParams)

This is an asynchronous operation and can be polled to completion using the location header returned by this operation.

function beginCreateOrUpdateAndWait(resourceGroupName: string, rolloutName: string, options?: RolloutsCreateOrUpdateOptionalParams): Promise<RolloutsCreateOrUpdateResponse>

Parameters

resourceGroupName

string

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

rolloutName

string

The rollout name.

options

RolloutsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<RolloutsCreateOrUpdateResponse>

cancel(string, string, RolloutsCancelOptionalParams)

Only running rollouts can be canceled.

function cancel(resourceGroupName: string, rolloutName: string, options?: RolloutsCancelOptionalParams): Promise<Rollout>

Parameters

resourceGroupName

string

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

rolloutName

string

The rollout name.

options

RolloutsCancelOptionalParams

The options parameters.

Returns

Promise<Rollout>

delete(string, string, RolloutsDeleteOptionalParams)

Only rollouts in terminal state can be deleted.

function delete(resourceGroupName: string, rolloutName: string, options?: RolloutsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

rolloutName

string

The rollout name.

options

RolloutsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, RolloutsGetOptionalParams)

Gets detailed information of a rollout.

function get(resourceGroupName: string, rolloutName: string, options?: RolloutsGetOptionalParams): Promise<Rollout>

Parameters

resourceGroupName

string

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

rolloutName

string

The rollout name.

options

RolloutsGetOptionalParams

The options parameters.

Returns

Promise<Rollout>

list(string, RolloutsListOptionalParams)

Lists the rollouts in a resource group.

function list(resourceGroupName: string, options?: RolloutsListOptionalParams): Promise<RolloutsListResponse>

Parameters

resourceGroupName

string

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

options

RolloutsListOptionalParams

The options parameters.

Returns

Promise<RolloutsListResponse>

restart(string, string, RolloutsRestartOptionalParams)

Only failed rollouts can be restarted.

function restart(resourceGroupName: string, rolloutName: string, options?: RolloutsRestartOptionalParams): Promise<Rollout>

Parameters

resourceGroupName

string

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

rolloutName

string

The rollout name.

options

RolloutsRestartOptionalParams

The options parameters.

Returns

Promise<Rollout>