Share via


StandbyVirtualMachinePools interface

Interface representing a StandbyVirtualMachinePools.

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.

Returns

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.

Returns

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

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

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

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.

Returns

listBySubscription(StandbyVirtualMachinePoolsListBySubscriptionOptionalParams)

List StandbyVirtualMachinePoolResource resources by subscription ID

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

Parameters

Returns

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