Share via

StandbyContainerGroupPools interface

  • Reference
Package:
@azure/arm-standbypool

Interface representing a StandbyContainerGroupPools.

Methods

beginCreateOrUpdate(string, string, StandbyContainerGroupPoolResource, StandbyContainerGroupPoolsCreateOrUpdateOptionalParams)

Create a StandbyContainerGroupPoolResource
beginCreateOrUpdateAndWait(string, string, StandbyContainerGroupPoolResource, StandbyContainerGroupPoolsCreateOrUpdateOptionalParams)

Create a StandbyContainerGroupPoolResource
beginDelete(string, string, StandbyContainerGroupPoolsDeleteOptionalParams)

Delete a StandbyContainerGroupPoolResource
beginDeleteAndWait(string, string, StandbyContainerGroupPoolsDeleteOptionalParams)

Delete a StandbyContainerGroupPoolResource
get(string, string, StandbyContainerGroupPoolsGetOptionalParams)

Get a StandbyContainerGroupPoolResource
listByResourceGroup(string, StandbyContainerGroupPoolsListByResourceGroupOptionalParams)

List StandbyContainerGroupPoolResource resources by resource group
listBySubscription(StandbyContainerGroupPoolsListBySubscriptionOptionalParams)

List StandbyContainerGroupPoolResource resources by subscription ID
update(string, string, StandbyContainerGroupPoolResourceUpdate, StandbyContainerGroupPoolsUpdateOptionalParams)

Update a StandbyContainerGroupPoolResource

Method Details

beginCreateOrUpdate(string, string, StandbyContainerGroupPoolResource, StandbyContainerGroupPoolsCreateOrUpdateOptionalParams)

Create a StandbyContainerGroupPoolResource

function beginCreateOrUpdate(resourceGroupName: string, standbyContainerGroupPoolName: string, resource: StandbyContainerGroupPoolResource, options?: StandbyContainerGroupPoolsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<StandbyContainerGroupPoolResource>, StandbyContainerGroupPoolResource>>

Parameters

resourceGroupName

string

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

standbyContainerGroupPoolName

string

Name of the standby container group pool

resource
StandbyContainerGroupPoolResource

Resource create parameters.

options
StandbyContainerGroupPoolsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, StandbyContainerGroupPoolResource, StandbyContainerGroupPoolsCreateOrUpdateOptionalParams)

Create a StandbyContainerGroupPoolResource

function beginCreateOrUpdateAndWait(resourceGroupName: string, standbyContainerGroupPoolName: string, resource: StandbyContainerGroupPoolResource, options?: StandbyContainerGroupPoolsCreateOrUpdateOptionalParams): Promise<StandbyContainerGroupPoolResource>

Parameters

resourceGroupName

string

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

standbyContainerGroupPoolName

string

Name of the standby container group pool

resource
StandbyContainerGroupPoolResource

Resource create parameters.

options
StandbyContainerGroupPoolsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<StandbyContainerGroupPoolResource>

beginDelete(string, string, StandbyContainerGroupPoolsDeleteOptionalParams)

Delete a StandbyContainerGroupPoolResource

function beginDelete(resourceGroupName: string, standbyContainerGroupPoolName: string, options?: StandbyContainerGroupPoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<StandbyContainerGroupPoolsDeleteHeaders>, StandbyContainerGroupPoolsDeleteHeaders>>

Parameters

resourceGroupName

string

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

standbyContainerGroupPoolName

string

Name of the standby container group pool

options
StandbyContainerGroupPoolsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, StandbyContainerGroupPoolsDeleteOptionalParams)

Delete a StandbyContainerGroupPoolResource

function beginDeleteAndWait(resourceGroupName: string, standbyContainerGroupPoolName: string, options?: StandbyContainerGroupPoolsDeleteOptionalParams): Promise<StandbyContainerGroupPoolsDeleteHeaders>

Parameters

resourceGroupName

string

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

standbyContainerGroupPoolName

string

Name of the standby container group pool

options
StandbyContainerGroupPoolsDeleteOptionalParams

The options parameters.

Returns

Promise<StandbyContainerGroupPoolsDeleteHeaders>

get(string, string, StandbyContainerGroupPoolsGetOptionalParams)

Get a StandbyContainerGroupPoolResource

function get(resourceGroupName: string, standbyContainerGroupPoolName: string, options?: StandbyContainerGroupPoolsGetOptionalParams): Promise<StandbyContainerGroupPoolResource>

Parameters

resourceGroupName

string

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

standbyContainerGroupPoolName

string

Name of the standby container group pool

options
StandbyContainerGroupPoolsGetOptionalParams

The options parameters.

Returns

Promise<StandbyContainerGroupPoolResource>

listByResourceGroup(string, StandbyContainerGroupPoolsListByResourceGroupOptionalParams)

List StandbyContainerGroupPoolResource resources by resource group

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

Parameters

resourceGroupName

string

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

options
StandbyContainerGroupPoolsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<StandbyContainerGroupPoolResource, StandbyContainerGroupPoolResource[], PageSettings>

listBySubscription(StandbyContainerGroupPoolsListBySubscriptionOptionalParams)

List StandbyContainerGroupPoolResource resources by subscription ID

function listBySubscription(options?: StandbyContainerGroupPoolsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<StandbyContainerGroupPoolResource, StandbyContainerGroupPoolResource[], PageSettings>

Parameters

options
StandbyContainerGroupPoolsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<StandbyContainerGroupPoolResource, StandbyContainerGroupPoolResource[], PageSettings>

update(string, string, StandbyContainerGroupPoolResourceUpdate, StandbyContainerGroupPoolsUpdateOptionalParams)

Update a StandbyContainerGroupPoolResource

function update(resourceGroupName: string, standbyContainerGroupPoolName: string, properties: StandbyContainerGroupPoolResourceUpdate, options?: StandbyContainerGroupPoolsUpdateOptionalParams): Promise<StandbyContainerGroupPoolResource>

Parameters

resourceGroupName

string

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

standbyContainerGroupPoolName

string

Name of the standby container group pool

properties
StandbyContainerGroupPoolResourceUpdate

The resource properties to be updated.

options
StandbyContainerGroupPoolsUpdateOptionalParams

The options parameters.

Returns

Promise<StandbyContainerGroupPoolResource>