@azure/arm-standbypool package

Classes

StandbyPoolManagementClient

Interfaces

ContainerGroupInstanceCountSummary

Displays the counts of container groups in each state, as known by the StandbyPool resource provider.

ContainerGroupProfile

Details of the ContainerGroupProfile.

ContainerGroupProperties

Details of the ContainerGroupProperties.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for and operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PoolResourceStateCount

Displays the counts of pooled resources in each state, as known by the StandbyPool resource provider.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

RestorePollerOptions
StandbyContainerGroupPoolElasticityProfile

Specifies the elasticity profile of the standby container group pools.

StandbyContainerGroupPoolResource

A StandbyContainerGroupPoolResource.

StandbyContainerGroupPoolResourceProperties

Details of the StandbyContainerGroupPool.

StandbyContainerGroupPoolResourceUpdate

The type used for update operations of the StandbyContainerGroupPoolResource.

StandbyContainerGroupPoolResourceUpdateProperties

The updatable properties of the StandbyContainerGroupPoolResource.

StandbyContainerGroupPoolRuntimeViewResource

Contains information about a standby container group pool as last known by the StandbyPool resource provider.

StandbyContainerGroupPoolRuntimeViewResourceProperties

Contains information about a standby pool as last known by the StandbyPool resource provider.

StandbyContainerGroupPoolRuntimeViewsGetOptionalParams

Optional parameters.

StandbyContainerGroupPoolRuntimeViewsListByStandbyPoolOptionalParams

Optional parameters.

StandbyContainerGroupPoolRuntimeViewsOperations

Interface representing a StandbyContainerGroupPoolRuntimeViews operations.

StandbyContainerGroupPoolsCreateOrUpdateOptionalParams

Optional parameters.

StandbyContainerGroupPoolsDeleteOptionalParams

Optional parameters.

StandbyContainerGroupPoolsGetOptionalParams

Optional parameters.

StandbyContainerGroupPoolsListByResourceGroupOptionalParams

Optional parameters.

StandbyContainerGroupPoolsListBySubscriptionOptionalParams

Optional parameters.

StandbyContainerGroupPoolsOperations

Interface representing a StandbyContainerGroupPools operations.

StandbyContainerGroupPoolsUpdateOptionalParams

Optional parameters.

StandbyPoolManagementClientOptionalParams

Optional parameters for the client.

StandbyVirtualMachinePoolElasticityProfile

Details of the elasticity profile.

StandbyVirtualMachinePoolResource

A StandbyVirtualMachinePoolResource.

StandbyVirtualMachinePoolResourceProperties

Details of the StandbyVirtualMachinePool.

StandbyVirtualMachinePoolResourceUpdate

The type used for update operations of the StandbyVirtualMachinePoolResource.

StandbyVirtualMachinePoolResourceUpdateProperties

The updatable properties of the StandbyVirtualMachinePoolResource.

StandbyVirtualMachinePoolRuntimeViewResource

Contains information about a standby virtual machine pool as last known by the StandbyPool resource provider.

StandbyVirtualMachinePoolRuntimeViewResourceProperties

Contains information about a standby pool as last known by the StandbyPool resource provider.

StandbyVirtualMachinePoolRuntimeViewsGetOptionalParams

Optional parameters.

StandbyVirtualMachinePoolRuntimeViewsListByStandbyPoolOptionalParams

Optional parameters.

StandbyVirtualMachinePoolRuntimeViewsOperations

Interface representing a StandbyVirtualMachinePoolRuntimeViews operations.

StandbyVirtualMachinePoolsCreateOrUpdateOptionalParams

Optional parameters.

StandbyVirtualMachinePoolsDeleteOptionalParams

Optional parameters.

StandbyVirtualMachinePoolsGetOptionalParams

Optional parameters.

StandbyVirtualMachinePoolsListByResourceGroupOptionalParams

Optional parameters.

StandbyVirtualMachinePoolsListBySubscriptionOptionalParams

Optional parameters.

StandbyVirtualMachinePoolsOperations

Interface representing a StandbyVirtualMachinePools operations.

StandbyVirtualMachinePoolsUpdateOptionalParams

Optional parameters.

StandbyVirtualMachineResource

Concrete proxy resource types can be created by aliasing this type using a specific property type.

StandbyVirtualMachineResourceProperties

Details of the StandbyVirtualMachine.

StandbyVirtualMachinesGetOptionalParams

Optional parameters.

StandbyVirtualMachinesListByStandbyVirtualMachinePoolResourceOptionalParams

Optional parameters.

StandbyVirtualMachinesOperations

Interface representing a StandbyVirtualMachines operations.

Subnet

Subnet of container group

SystemData

Metadata pertaining to creation and last modification of the resource.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

VirtualMachineInstanceCountSummary

Contains the counts of VMs in each power state in a given zone, fault domain, as known by the StandbyPool resource provider. Note: any updates to pool resources outside of StandbyPoolRP (i.e deleting a VM through portal) are not reflected here. Note: any resources in the Running state may still be installing extensions / not fully provisioned.

Type Aliases

ActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user
system
user,system

ProvisioningState

Alias for ProvisioningState

RefillPolicy

Refill policy of standby pool
KnownRefillPolicy can be used interchangeably with RefillPolicy, this enum contains the known values that the service supports.

Known values supported by the service

always

VirtualMachineState

State of standby virtual machines
KnownVirtualMachineState can be used interchangeably with VirtualMachineState, this enum contains the known values that the service supports.

Known values supported by the service

Running
Deallocated

Enums

KnownActionType

Known values of ActionType that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownRefillPolicy

Known values of RefillPolicy that the service accepts.

KnownVirtualMachineState

Known values of VirtualMachineState that the service accepts.

Functions

restorePoller<TResponse, TResult>(StandbyPoolManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(StandbyPoolManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: StandbyPoolManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>