VipSwap interface

Interface representing a VipSwap.

Methods

beginCreate(string, string, SwapResource, VipSwapCreateOptionalParams)

Performs vip swap operation on swappable cloud services.

beginCreateAndWait(string, string, SwapResource, VipSwapCreateOptionalParams)

Performs vip swap operation on swappable cloud services.

get(string, string, VipSwapGetOptionalParams)

Gets the SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production

list(string, string, VipSwapListOptionalParams)

Gets the list of SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production

Method Details

beginCreate(string, string, SwapResource, VipSwapCreateOptionalParams)

Performs vip swap operation on swappable cloud services.

function beginCreate(groupName: string, resourceName: string, parameters: SwapResource, options?: VipSwapCreateOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

groupName

string

The name of the resource group.

resourceName

string

The name of the cloud service.

parameters
SwapResource

SwapResource object where slot type should be the target slot after vip swap for the specified cloud service.

options
VipSwapCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, SwapResource, VipSwapCreateOptionalParams)

Performs vip swap operation on swappable cloud services.

function beginCreateAndWait(groupName: string, resourceName: string, parameters: SwapResource, options?: VipSwapCreateOptionalParams): Promise<void>

Parameters

groupName

string

The name of the resource group.

resourceName

string

The name of the cloud service.

parameters
SwapResource

SwapResource object where slot type should be the target slot after vip swap for the specified cloud service.

options
VipSwapCreateOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, VipSwapGetOptionalParams)

Gets the SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production

function get(groupName: string, resourceName: string, options?: VipSwapGetOptionalParams): Promise<SwapResource>

Parameters

groupName

string

The name of the resource group.

resourceName

string

The name of the cloud service.

options
VipSwapGetOptionalParams

The options parameters.

Returns

Promise<SwapResource>

list(string, string, VipSwapListOptionalParams)

Gets the list of SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production

function list(groupName: string, resourceName: string, options?: VipSwapListOptionalParams): Promise<SwapResourceListResult>

Parameters

groupName

string

The name of the resource group.

resourceName

string

The name of the cloud service.

options
VipSwapListOptionalParams

The options parameters.

Returns