UpdateRuns interface

Package:

@azure/arm-containerservicefleet

Interface representing a UpdateRuns.

Methods

beginCreateOrUpdate(string, string, string, UpdateRun, UpdateRunsCreateOrUpdateOptionalParams)	Create a UpdateRun
beginCreateOrUpdateAndWait(string, string, string, UpdateRun, UpdateRunsCreateOrUpdateOptionalParams)	Create a UpdateRun
beginDelete(string, string, string, UpdateRunsDeleteOptionalParams)	Delete a UpdateRun
beginDeleteAndWait(string, string, string, UpdateRunsDeleteOptionalParams)	Delete a UpdateRun
beginSkip(string, string, string, SkipProperties, UpdateRunsSkipOptionalParams)	Skips one or a combination of member/group/stage/afterStageWait(s) of an update run.
beginSkipAndWait(string, string, string, SkipProperties, UpdateRunsSkipOptionalParams)	Skips one or a combination of member/group/stage/afterStageWait(s) of an update run.
beginStart(string, string, string, UpdateRunsStartOptionalParams)	Starts an UpdateRun.
beginStartAndWait(string, string, string, UpdateRunsStartOptionalParams)	Starts an UpdateRun.
beginStop(string, string, string, UpdateRunsStopOptionalParams)	Stops an UpdateRun.
beginStopAndWait(string, string, string, UpdateRunsStopOptionalParams)	Stops an UpdateRun.
get(string, string, string, UpdateRunsGetOptionalParams)	Get a UpdateRun
listByFleet(string, string, UpdateRunsListByFleetOptionalParams)	List UpdateRun resources by Fleet

Method Details

beginCreateOrUpdate(string, string, string, UpdateRun, UpdateRunsCreateOrUpdateOptionalParams)

Create a UpdateRun

function beginCreateOrUpdate(resourceGroupName: string, fleetName: string, updateRunName: string, resource: UpdateRun, options?: UpdateRunsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<UpdateRun>, UpdateRun>>

Parameters

resourceGroupName

string

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

fleetName

string

The name of the Fleet resource.

updateRunName

string

The name of the UpdateRun resource.

resource

UpdateRun

Resource create parameters.

options

UpdateRunsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, UpdateRun, UpdateRunsCreateOrUpdateOptionalParams)

Create a UpdateRun

function beginCreateOrUpdateAndWait(resourceGroupName: string, fleetName: string, updateRunName: string, resource: UpdateRun, options?: UpdateRunsCreateOrUpdateOptionalParams): Promise<UpdateRun>

Parameters

resourceGroupName

string

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

fleetName

string

The name of the Fleet resource.

updateRunName

string

The name of the UpdateRun resource.

resource

UpdateRun

Resource create parameters.

options

UpdateRunsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<UpdateRun>

beginDelete(string, string, string, UpdateRunsDeleteOptionalParams)

Delete a UpdateRun

function beginDelete(resourceGroupName: string, fleetName: string, updateRunName: string, options?: UpdateRunsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

fleetName

string

The name of the Fleet resource.

updateRunName

string

The name of the UpdateRun resource.

options

UpdateRunsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, UpdateRunsDeleteOptionalParams)

Delete a UpdateRun

function beginDeleteAndWait(resourceGroupName: string, fleetName: string, updateRunName: string, options?: UpdateRunsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

fleetName

string

The name of the Fleet resource.

updateRunName

string

The name of the UpdateRun resource.

options

UpdateRunsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginSkip(string, string, string, SkipProperties, UpdateRunsSkipOptionalParams)

Skips one or a combination of member/group/stage/afterStageWait(s) of an update run.

function beginSkip(resourceGroupName: string, fleetName: string, updateRunName: string, body: SkipProperties, options?: UpdateRunsSkipOptionalParams): Promise<SimplePollerLike<OperationState<UpdateRun>, UpdateRun>>

Parameters

resourceGroupName

string

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

fleetName

string

The name of the Fleet resource.

updateRunName

string

The name of the UpdateRun resource.

body

SkipProperties

The content of the action request

options

UpdateRunsSkipOptionalParams

The options parameters.

Returns

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

beginSkipAndWait(string, string, string, SkipProperties, UpdateRunsSkipOptionalParams)

Skips one or a combination of member/group/stage/afterStageWait(s) of an update run.

function beginSkipAndWait(resourceGroupName: string, fleetName: string, updateRunName: string, body: SkipProperties, options?: UpdateRunsSkipOptionalParams): Promise<UpdateRun>

Parameters

resourceGroupName

string

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

fleetName

string

The name of the Fleet resource.

updateRunName

string

The name of the UpdateRun resource.

body

SkipProperties

The content of the action request

options

UpdateRunsSkipOptionalParams

The options parameters.

Returns

Promise<UpdateRun>

beginStart(string, string, string, UpdateRunsStartOptionalParams)

Starts an UpdateRun.

function beginStart(resourceGroupName: string, fleetName: string, updateRunName: string, options?: UpdateRunsStartOptionalParams): Promise<SimplePollerLike<OperationState<UpdateRun>, UpdateRun>>

Parameters

resourceGroupName

string

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

fleetName

string

The name of the Fleet resource.

updateRunName

string

The name of the UpdateRun resource.

options

UpdateRunsStartOptionalParams

The options parameters.

Returns

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

beginStartAndWait(string, string, string, UpdateRunsStartOptionalParams)

Starts an UpdateRun.

function beginStartAndWait(resourceGroupName: string, fleetName: string, updateRunName: string, options?: UpdateRunsStartOptionalParams): Promise<UpdateRun>

Parameters

resourceGroupName

string

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

fleetName

string

The name of the Fleet resource.

updateRunName

string

The name of the UpdateRun resource.

options

UpdateRunsStartOptionalParams

The options parameters.

Returns

Promise<UpdateRun>

beginStop(string, string, string, UpdateRunsStopOptionalParams)

Stops an UpdateRun.

function beginStop(resourceGroupName: string, fleetName: string, updateRunName: string, options?: UpdateRunsStopOptionalParams): Promise<SimplePollerLike<OperationState<UpdateRun>, UpdateRun>>

Parameters

resourceGroupName

string

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

fleetName

string

The name of the Fleet resource.

updateRunName

string

The name of the UpdateRun resource.

options

UpdateRunsStopOptionalParams

The options parameters.

Returns

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

beginStopAndWait(string, string, string, UpdateRunsStopOptionalParams)

Stops an UpdateRun.

function beginStopAndWait(resourceGroupName: string, fleetName: string, updateRunName: string, options?: UpdateRunsStopOptionalParams): Promise<UpdateRun>

Parameters

resourceGroupName

string

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

fleetName

string

The name of the Fleet resource.

updateRunName

string

The name of the UpdateRun resource.

options

UpdateRunsStopOptionalParams

The options parameters.

Returns

Promise<UpdateRun>

get(string, string, string, UpdateRunsGetOptionalParams)

Get a UpdateRun

function get(resourceGroupName: string, fleetName: string, updateRunName: string, options?: UpdateRunsGetOptionalParams): Promise<UpdateRun>

Parameters

resourceGroupName

string

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

fleetName

string

The name of the Fleet resource.

updateRunName

string

The name of the UpdateRun resource.

options

UpdateRunsGetOptionalParams

The options parameters.

Returns

Promise<UpdateRun>

listByFleet(string, string, UpdateRunsListByFleetOptionalParams)

List UpdateRun resources by Fleet

function listByFleet(resourceGroupName: string, fleetName: string, options?: UpdateRunsListByFleetOptionalParams): PagedAsyncIterableIterator<UpdateRun, UpdateRun[], PageSettings>

Parameters

resourceGroupName

string

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

fleetName

string

The name of the Fleet resource.

options

UpdateRunsListByFleetOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<UpdateRun, UpdateRun[], PageSettings>