@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.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
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.
PoolContainerGroupStateCount	Displays the counts of pooled container groups in each state, as known by the StandbyPool resource provider.
PoolStatus	Displays StandbyPool status.
PoolVirtualMachineStateCount	Displays the counts of pooled virtual machines 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.
StandbyContainerGroupPoolForecastValues	Displays the forecast information of the standby pool.
StandbyContainerGroupPoolPrediction	Displays prediction information of the standby pool.
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.
StandbyVirtualMachinePoolForecastValues	Displays the forecast information of the standby pool.
StandbyVirtualMachinePoolPrediction	Displays prediction information of the standby pool.
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 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: Actions are for internal-only APIs.
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. <xref:KnowncreatedByType> can be used interchangeably with createdByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
HealthStateCode	StandbyPool health state. KnownHealthStateCode can be used interchangeably with HealthStateCode, this enum contains the known values that the service supports. Known values supported by the service HealthState/healthy: StandbyPool is in healthy state. HealthState/degraded: StandbyPool is in degraded state.
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: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
PoolContainerGroupState	The state of the pooled container groups. KnownPoolContainerGroupState can be used interchangeably with PoolContainerGroupState, this enum contains the known values that the service supports. Known values supported by the service Running: The container group is up and running. Creating: The container group is creating. Deleting: The container group is deleting.
PoolVirtualMachineState	The state of the pooled virtual machines. KnownPoolVirtualMachineState can be used interchangeably with PoolVirtualMachineState, this enum contains the known values that the service supports. Known values supported by the service Running: The virtual machine is up and running. Creating: The virtual machine is creating. Starting: The virtual machine is starting. Deleting: The virtual machine is deleting. Deallocated: The virtual machine has released the lease on the underlying hardware and is powered off. Deallocating: The virtual machine is releasing the lease on the underlying hardware and is powered off. Hibernated: The virtual machine has released the lease on the underlying hardware and is powered off. Memory contents of the VM are stored in the OS disk. When started again, applications and processes that were previously running in your VM resume from the state prior to hibernation. Hibernating: The virtual machine is hibernating.
ProvisioningState	Provisioning state KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled. Deleting: Resource is being deleted.
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: A refill policy that standby pool is automatically refilled to maintain maxReadyCapacity.
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: The virtual machine is up and running. Deallocated: The virtual machine has released the lease on the underlying hardware and is powered off. Hibernated: The virtual machine has released the lease on the underlying hardware and is powered off. Memory contents of the VM are stored in the OS disk. When started again, applications and processes that were previously running in your VM resume from the state prior to hibernation.

Enums

@azure/arm-standbypool.KnownVersions

KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownCreatedByType	The kind of entity that created the resource.
KnownHealthStateCode	StandbyPool health state.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownPoolContainerGroupState	The state of the pooled container groups.
KnownPoolVirtualMachineState	The state of the pooled virtual machines.
KnownProvisioningState	Provisioning state
KnownRefillPolicy	Refill policy of standby pool
KnownVirtualMachineState	State of standby virtual machines

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

client

StandbyPoolManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>