StandbyVirtualMachinePools interface

Package:

@azure/arm-standbypool

Interface representing a StandbyVirtualMachinePools.

Methods

beginCreateOrUpdate(string, string, StandbyVirtualMachinePoolResource, StandbyVirtualMachinePoolsCreateOrUpdateOptionalParams)	Create a StandbyVirtualMachinePoolResource
beginCreateOrUpdateAndWait(string, string, StandbyVirtualMachinePoolResource, StandbyVirtualMachinePoolsCreateOrUpdateOptionalParams)	Create a StandbyVirtualMachinePoolResource
beginDelete(string, string, StandbyVirtualMachinePoolsDeleteOptionalParams)	Delete a StandbyVirtualMachinePoolResource
beginDeleteAndWait(string, string, StandbyVirtualMachinePoolsDeleteOptionalParams)	Delete a StandbyVirtualMachinePoolResource
get(string, string, StandbyVirtualMachinePoolsGetOptionalParams)	Get a StandbyVirtualMachinePoolResource
listByResourceGroup(string, StandbyVirtualMachinePoolsListByResourceGroupOptionalParams)	List StandbyVirtualMachinePoolResource resources by resource group
listBySubscription(StandbyVirtualMachinePoolsListBySubscriptionOptionalParams)	List StandbyVirtualMachinePoolResource resources by subscription ID
update(string, string, StandbyVirtualMachinePoolResourceUpdate, StandbyVirtualMachinePoolsUpdateOptionalParams)	Update a StandbyVirtualMachinePoolResource

Method Details

beginCreateOrUpdate(string, string, StandbyVirtualMachinePoolResource, StandbyVirtualMachinePoolsCreateOrUpdateOptionalParams)

Create a StandbyVirtualMachinePoolResource

function beginCreateOrUpdate(resourceGroupName: string, standbyVirtualMachinePoolName: string, resource: StandbyVirtualMachinePoolResource, options?: StandbyVirtualMachinePoolsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<StandbyVirtualMachinePoolResource>, StandbyVirtualMachinePoolResource>>

Parameters

resourceGroupName

string

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

standbyVirtualMachinePoolName

string

Name of the standby virtual machine pool

resource

StandbyVirtualMachinePoolResource

Resource create parameters.

options

StandbyVirtualMachinePoolsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, StandbyVirtualMachinePoolResource, StandbyVirtualMachinePoolsCreateOrUpdateOptionalParams)

Create a StandbyVirtualMachinePoolResource

function beginCreateOrUpdateAndWait(resourceGroupName: string, standbyVirtualMachinePoolName: string, resource: StandbyVirtualMachinePoolResource, options?: StandbyVirtualMachinePoolsCreateOrUpdateOptionalParams): Promise<StandbyVirtualMachinePoolResource>

Parameters

resourceGroupName

string

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

standbyVirtualMachinePoolName

string

Name of the standby virtual machine pool

resource

StandbyVirtualMachinePoolResource

Resource create parameters.

options

StandbyVirtualMachinePoolsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<StandbyVirtualMachinePoolResource>

beginDelete(string, string, StandbyVirtualMachinePoolsDeleteOptionalParams)

Delete a StandbyVirtualMachinePoolResource

function beginDelete(resourceGroupName: string, standbyVirtualMachinePoolName: string, options?: StandbyVirtualMachinePoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<StandbyVirtualMachinePoolsDeleteHeaders>, StandbyVirtualMachinePoolsDeleteHeaders>>

Parameters

resourceGroupName

string

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

standbyVirtualMachinePoolName

string

Name of the standby virtual machine pool

options

StandbyVirtualMachinePoolsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, StandbyVirtualMachinePoolsDeleteOptionalParams)

Delete a StandbyVirtualMachinePoolResource

function beginDeleteAndWait(resourceGroupName: string, standbyVirtualMachinePoolName: string, options?: StandbyVirtualMachinePoolsDeleteOptionalParams): Promise<StandbyVirtualMachinePoolsDeleteHeaders>

Parameters

resourceGroupName

string

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

standbyVirtualMachinePoolName

string

Name of the standby virtual machine pool

options

StandbyVirtualMachinePoolsDeleteOptionalParams

The options parameters.

Returns

Promise<StandbyVirtualMachinePoolsDeleteHeaders>

get(string, string, StandbyVirtualMachinePoolsGetOptionalParams)

Get a StandbyVirtualMachinePoolResource

function get(resourceGroupName: string, standbyVirtualMachinePoolName: string, options?: StandbyVirtualMachinePoolsGetOptionalParams): Promise<StandbyVirtualMachinePoolResource>

Parameters

resourceGroupName

string

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

standbyVirtualMachinePoolName

string

Name of the standby virtual machine pool

options

StandbyVirtualMachinePoolsGetOptionalParams

The options parameters.

Returns

Promise<StandbyVirtualMachinePoolResource>

listByResourceGroup(string, StandbyVirtualMachinePoolsListByResourceGroupOptionalParams)

List StandbyVirtualMachinePoolResource resources by resource group

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

Parameters

resourceGroupName

string

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

options

StandbyVirtualMachinePoolsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<StandbyVirtualMachinePoolResource, StandbyVirtualMachinePoolResource[], PageSettings>

listBySubscription(StandbyVirtualMachinePoolsListBySubscriptionOptionalParams)

List StandbyVirtualMachinePoolResource resources by subscription ID

function listBySubscription(options?: StandbyVirtualMachinePoolsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<StandbyVirtualMachinePoolResource, StandbyVirtualMachinePoolResource[], PageSettings>

Parameters

options

StandbyVirtualMachinePoolsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<StandbyVirtualMachinePoolResource, StandbyVirtualMachinePoolResource[], PageSettings>

update(string, string, StandbyVirtualMachinePoolResourceUpdate, StandbyVirtualMachinePoolsUpdateOptionalParams)

Update a StandbyVirtualMachinePoolResource

function update(resourceGroupName: string, standbyVirtualMachinePoolName: string, properties: StandbyVirtualMachinePoolResourceUpdate, options?: StandbyVirtualMachinePoolsUpdateOptionalParams): Promise<StandbyVirtualMachinePoolResource>

Parameters

resourceGroupName

string

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

standbyVirtualMachinePoolName

string

Name of the standby virtual machine pool

properties

StandbyVirtualMachinePoolResourceUpdate

The resource properties to be updated.

options

StandbyVirtualMachinePoolsUpdateOptionalParams

The options parameters.

Returns

Promise<StandbyVirtualMachinePoolResource>