@azure/arm-standbypool package

Classes

StandbyPoolManagementClient

Interfaces

ContainerGroupProfile	Details of the ContainerGroupProfile.
ContainerGroupProfileUpdate	Details of the ContainerGroupProfile.
ContainerGroupProperties	Details of the ContainerGroupProperties.
ContainerGroupPropertiesUpdate	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. (This also follows the OData error response format.).
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for this particular operation.
OperationListResult	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
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
StandbyContainerGroupPoolElasticityProfile	Specifies the elasticity profile of the standby container group pools.
StandbyContainerGroupPoolElasticityProfileUpdate	Specifies the elasticity profile of the standby container group pools.
StandbyContainerGroupPoolResource	A StandbyContainerGroupPoolResource.
StandbyContainerGroupPoolResourceListResult	The response of a StandbyContainerGroupPoolResource list operation.
StandbyContainerGroupPoolResourceProperties	Details of the StandbyContainerGroupPool.
StandbyContainerGroupPoolResourceUpdate	The type used for update operations of the StandbyContainerGroupPoolResource.
StandbyContainerGroupPoolResourceUpdateProperties	The updatable properties of the StandbyContainerGroupPoolResource.
StandbyContainerGroupPools	Interface representing a StandbyContainerGroupPools.
StandbyContainerGroupPoolsCreateOrUpdateHeaders	Defines headers for StandbyContainerGroupPools_createOrUpdate operation.
StandbyContainerGroupPoolsCreateOrUpdateOptionalParams	Optional parameters.
StandbyContainerGroupPoolsDeleteHeaders	Defines headers for StandbyContainerGroupPools_delete operation.
StandbyContainerGroupPoolsDeleteOptionalParams	Optional parameters.
StandbyContainerGroupPoolsGetOptionalParams	Optional parameters.
StandbyContainerGroupPoolsListByResourceGroupNextOptionalParams	Optional parameters.
StandbyContainerGroupPoolsListByResourceGroupOptionalParams	Optional parameters.
StandbyContainerGroupPoolsListBySubscriptionNextOptionalParams	Optional parameters.
StandbyContainerGroupPoolsListBySubscriptionOptionalParams	Optional parameters.
StandbyContainerGroupPoolsUpdateOptionalParams	Optional parameters.
StandbyPoolManagementClientOptionalParams	Optional parameters.
StandbyVirtualMachinePoolElasticityProfile	Details of the elasticity profile.
StandbyVirtualMachinePoolElasticityProfileUpdate	Details of the elasticity profile.
StandbyVirtualMachinePoolResource	A StandbyVirtualMachinePoolResource.
StandbyVirtualMachinePoolResourceListResult	The response of a StandbyVirtualMachinePoolResource list operation.
StandbyVirtualMachinePoolResourceProperties	Details of the StandbyVirtualMachinePool.
StandbyVirtualMachinePoolResourceUpdate	The type used for update operations of the StandbyVirtualMachinePoolResource.
StandbyVirtualMachinePoolResourceUpdateProperties	The updatable properties of the StandbyVirtualMachinePoolResource.
StandbyVirtualMachinePools	Interface representing a StandbyVirtualMachinePools.
StandbyVirtualMachinePoolsCreateOrUpdateHeaders	Defines headers for StandbyVirtualMachinePools_createOrUpdate operation.
StandbyVirtualMachinePoolsCreateOrUpdateOptionalParams	Optional parameters.
StandbyVirtualMachinePoolsDeleteHeaders	Defines headers for StandbyVirtualMachinePools_delete operation.
StandbyVirtualMachinePoolsDeleteOptionalParams	Optional parameters.
StandbyVirtualMachinePoolsGetOptionalParams	Optional parameters.
StandbyVirtualMachinePoolsListByResourceGroupNextOptionalParams	Optional parameters.
StandbyVirtualMachinePoolsListByResourceGroupOptionalParams	Optional parameters.
StandbyVirtualMachinePoolsListBySubscriptionNextOptionalParams	Optional parameters.
StandbyVirtualMachinePoolsListBySubscriptionOptionalParams	Optional parameters.
StandbyVirtualMachinePoolsUpdateOptionalParams	Optional parameters.
StandbyVirtualMachineResource	Concrete proxy resource types can be created by aliasing this type using a specific property type.
StandbyVirtualMachineResourceListResult	The response of a StandbyVirtualMachineResource list operation.
StandbyVirtualMachineResourceProperties	Details of the StandbyVirtualMachine.
StandbyVirtualMachines	Interface representing a StandbyVirtualMachines.
StandbyVirtualMachinesGetOptionalParams	Optional parameters.
StandbyVirtualMachinesListByStandbyVirtualMachinePoolResourceNextOptionalParams	Optional parameters.
StandbyVirtualMachinesListByStandbyVirtualMachinePoolResourceOptionalParams	Optional parameters.
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'

Type Aliases

ActionType	Defines values for ActionType. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal
CreatedByType	Defines values for CreatedByType. 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
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
Origin	Defines values for Origin. 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	Defines values for ProvisioningState. 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	Defines values for RefillPolicy. 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.
StandbyContainerGroupPoolsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
StandbyContainerGroupPoolsDeleteResponse	Contains response data for the delete operation.
StandbyContainerGroupPoolsGetResponse	Contains response data for the get operation.
StandbyContainerGroupPoolsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
StandbyContainerGroupPoolsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
StandbyContainerGroupPoolsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
StandbyContainerGroupPoolsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
StandbyContainerGroupPoolsUpdateResponse	Contains response data for the update operation.
StandbyVirtualMachinePoolsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
StandbyVirtualMachinePoolsDeleteResponse	Contains response data for the delete operation.
StandbyVirtualMachinePoolsGetResponse	Contains response data for the get operation.
StandbyVirtualMachinePoolsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
StandbyVirtualMachinePoolsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
StandbyVirtualMachinePoolsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
StandbyVirtualMachinePoolsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
StandbyVirtualMachinePoolsUpdateResponse	Contains response data for the update operation.
StandbyVirtualMachinesGetResponse	Contains response data for the get operation.
StandbyVirtualMachinesListByStandbyVirtualMachinePoolResourceNextResponse	Contains response data for the listByStandbyVirtualMachinePoolResourceNext operation.
StandbyVirtualMachinesListByStandbyVirtualMachinePoolResourceResponse	Contains response data for the listByStandbyVirtualMachinePoolResource operation.
VirtualMachineState	Defines values for VirtualMachineState. 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.

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

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.