Microsoft.StandbyPool (stable:2025-03-01)

2025/02/28 • 19 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.StandbyPool/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyContainerGroupPools_ListBySubscription (new)
Description :  List StandbyContainerGroupPoolResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StandbyPool/standbyContainerGroupPools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The StandbyContainerGroupPoolResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies elasticity profile of standby container group pools. ,
Required: True ,
}
{
maxReadyCapacity:
{
Description: Specifies maximum number of standby container groups in the standby pool. ,
Format: int64 ,
Required: True ,
}
integer ,
refillPolicy:
{
Description: Specifies refill policy of the pool. ,
Enum:
{
always: A refill policy that standby pool is automatically refilled to maintain maxReadyCapacity. ,
}
,
Required: False ,
}
enum ,
}
,
containerGroupProperties:
{
Description: Specifies container group properties of standby container group pools. ,
Required: True ,
}
{
containerGroupProfile:
{
Description: Specifies container group profile of standby container groups. ,
Required: True ,
}
{
id:
{
Description: Specifies container group profile id of standby container groups. ,
Format: arm-id ,
Required: True ,
}
string ,
revision:
{
Description: Specifies revision of container group profile. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
subnetIds:
{
Description: Specifies subnet Ids for container group. ,
Required: False ,
}
[
{
id:
{
Description: Specifies ARM resource id of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: Specifies zones of standby container group pools. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyVirtualMachinePools_ListBySubscription (new)
Description :  List StandbyVirtualMachinePoolResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The StandbyVirtualMachinePoolResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies the elasticity profile of the standby virtual machine pools. ,
Required: False ,
}
{
maxReadyCapacity:
{
Description: Specifies the maximum number of virtual machines in the standby virtual machine pool. ,
Format: int64 ,
Required: True ,
}
integer ,
minReadyCapacity:
{
Description: Specifies the desired minimum number of virtual machines in the standby virtual machine pool. MinReadyCapacity cannot exceed MaxReadyCapacity. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
virtualMachineState:
{
Description: Specifies the desired state of virtual machines in the pool. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
attachedVirtualMachineScaleSetId:
{
Description: Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyContainerGroupPools_ListByResourceGroup (new)
Description :  List StandbyContainerGroupPoolResource resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyContainerGroupPools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The StandbyContainerGroupPoolResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies elasticity profile of standby container group pools. ,
Required: True ,
}
{
maxReadyCapacity:
{
Description: Specifies maximum number of standby container groups in the standby pool. ,
Format: int64 ,
Required: True ,
}
integer ,
refillPolicy:
{
Description: Specifies refill policy of the pool. ,
Enum:
{
always: A refill policy that standby pool is automatically refilled to maintain maxReadyCapacity. ,
}
,
Required: False ,
}
enum ,
}
,
containerGroupProperties:
{
Description: Specifies container group properties of standby container group pools. ,
Required: True ,
}
{
containerGroupProfile:
{
Description: Specifies container group profile of standby container groups. ,
Required: True ,
}
{
id:
{
Description: Specifies container group profile id of standby container groups. ,
Format: arm-id ,
Required: True ,
}
string ,
revision:
{
Description: Specifies revision of container group profile. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
subnetIds:
{
Description: Specifies subnet Ids for container group. ,
Required: False ,
}
[
{
id:
{
Description: Specifies ARM resource id of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: Specifies zones of standby container group pools. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyContainerGroupPools_Get (new)
Description :  Get a StandbyContainerGroupPoolResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyContainerGroupPools/{standbyContainerGroupPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
standbyContainerGroupPoolName:
{
Description: Name of the standby container group pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies elasticity profile of standby container group pools. ,
Required: True ,
}
{
maxReadyCapacity:
{
Description: Specifies maximum number of standby container groups in the standby pool. ,
Format: int64 ,
Required: True ,
}
integer ,
refillPolicy:
{
Description: Specifies refill policy of the pool. ,
Enum:
{
always: A refill policy that standby pool is automatically refilled to maintain maxReadyCapacity. ,
}
,
Required: False ,
}
enum ,
}
,
containerGroupProperties:
{
Description: Specifies container group properties of standby container group pools. ,
Required: True ,
}
{
containerGroupProfile:
{
Description: Specifies container group profile of standby container groups. ,
Required: True ,
}
{
id:
{
Description: Specifies container group profile id of standby container groups. ,
Format: arm-id ,
Required: True ,
}
string ,
revision:
{
Description: Specifies revision of container group profile. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
subnetIds:
{
Description: Specifies subnet Ids for container group. ,
Required: False ,
}
[
{
id:
{
Description: Specifies ARM resource id of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: Specifies zones of standby container group pools. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyContainerGroupPools_CreateOrUpdate (new)
Description :  Create a StandbyContainerGroupPoolResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyContainerGroupPools/{standbyContainerGroupPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
standbyContainerGroupPoolName:
{
Description: Name of the standby container group pool ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies elasticity profile of standby container group pools. ,
Required: True ,
}
{
maxReadyCapacity:
{
Description: Specifies maximum number of standby container groups in the standby pool. ,
Format: int64 ,
Required: True ,
}
integer ,
refillPolicy:
{
Description: Specifies refill policy of the pool. ,
Enum:
{
always: A refill policy that standby pool is automatically refilled to maintain maxReadyCapacity. ,
}
,
Required: False ,
}
enum ,
}
,
containerGroupProperties:
{
Description: Specifies container group properties of standby container group pools. ,
Required: True ,
}
{
containerGroupProfile:
{
Description: Specifies container group profile of standby container groups. ,
Required: True ,
}
{
id:
{
Description: Specifies container group profile id of standby container groups. ,
Format: arm-id ,
Required: True ,
}
string ,
revision:
{
Description: Specifies revision of container group profile. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
subnetIds:
{
Description: Specifies subnet Ids for container group. ,
Required: False ,
}
[
{
id:
{
Description: Specifies ARM resource id of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: Specifies zones of standby container group pools. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies elasticity profile of standby container group pools. ,
Required: True ,
}
{
maxReadyCapacity:
{
Description: Specifies maximum number of standby container groups in the standby pool. ,
Format: int64 ,
Required: True ,
}
integer ,
refillPolicy:
{
Description: Specifies refill policy of the pool. ,
Enum:
{
always: A refill policy that standby pool is automatically refilled to maintain maxReadyCapacity. ,
}
,
Required: False ,
}
enum ,
}
,
containerGroupProperties:
{
Description: Specifies container group properties of standby container group pools. ,
Required: True ,
}
{
containerGroupProfile:
{
Description: Specifies container group profile of standby container groups. ,
Required: True ,
}
{
id:
{
Description: Specifies container group profile id of standby container groups. ,
Format: arm-id ,
Required: True ,
}
string ,
revision:
{
Description: Specifies revision of container group profile. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
subnetIds:
{
Description: Specifies subnet Ids for container group. ,
Required: False ,
}
[
{
id:
{
Description: Specifies ARM resource id of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: Specifies zones of standby container group pools. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A StandbyContainerGroupPoolResource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies elasticity profile of standby container group pools. ,
Required: True ,
}
{
maxReadyCapacity:
{
Description: Specifies maximum number of standby container groups in the standby pool. ,
Format: int64 ,
Required: True ,
}
integer ,
refillPolicy:
{
Description: Specifies refill policy of the pool. ,
Enum:
{
always: A refill policy that standby pool is automatically refilled to maintain maxReadyCapacity. ,
}
,
Required: False ,
}
enum ,
}
,
containerGroupProperties:
{
Description: Specifies container group properties of standby container group pools. ,
Required: True ,
}
{
containerGroupProfile:
{
Description: Specifies container group profile of standby container groups. ,
Required: True ,
}
{
id:
{
Description: Specifies container group profile id of standby container groups. ,
Format: arm-id ,
Required: True ,
}
string ,
revision:
{
Description: Specifies revision of container group profile. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
subnetIds:
{
Description: Specifies subnet Ids for container group. ,
Required: False ,
}
[
{
id:
{
Description: Specifies ARM resource id of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: Specifies zones of standby container group pools. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyContainerGroupPools_Update (new)
Description :  Update a StandbyContainerGroupPoolResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyContainerGroupPools/{standbyContainerGroupPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
standbyContainerGroupPoolName:
{
Description: Name of the standby container group pool ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies elasticity profile of standby container group pools. ,
Required: False ,
}
{
maxReadyCapacity:
{
Description: Specifies maximum number of standby container groups in the standby pool. ,
Format: int64 ,
Required: True ,
}
integer ,
refillPolicy:
{
Description: Specifies refill policy of the pool. ,
Enum:
{
always: A refill policy that standby pool is automatically refilled to maintain maxReadyCapacity. ,
}
,
Required: False ,
}
enum ,
}
,
containerGroupProperties:
{
Description: Specifies container group properties of standby container group pools. ,
Required: False ,
}
{
containerGroupProfile:
{
Description: Specifies container group profile of standby container groups. ,
Required: True ,
}
{
id:
{
Description: Specifies container group profile id of standby container groups. ,
Format: arm-id ,
Required: True ,
}
string ,
revision:
{
Description: Specifies revision of container group profile. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
subnetIds:
{
Description: Specifies subnet Ids for container group. ,
Required: False ,
}
[
{
id:
{
Description: Specifies ARM resource id of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: Specifies zones of standby container group pools. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies elasticity profile of standby container group pools. ,
Required: True ,
}
{
maxReadyCapacity:
{
Description: Specifies maximum number of standby container groups in the standby pool. ,
Format: int64 ,
Required: True ,
}
integer ,
refillPolicy:
{
Description: Specifies refill policy of the pool. ,
Enum:
{
always: A refill policy that standby pool is automatically refilled to maintain maxReadyCapacity. ,
}
,
Required: False ,
}
enum ,
}
,
containerGroupProperties:
{
Description: Specifies container group properties of standby container group pools. ,
Required: True ,
}
{
containerGroupProfile:
{
Description: Specifies container group profile of standby container groups. ,
Required: True ,
}
{
id:
{
Description: Specifies container group profile id of standby container groups. ,
Format: arm-id ,
Required: True ,
}
string ,
revision:
{
Description: Specifies revision of container group profile. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
subnetIds:
{
Description: Specifies subnet Ids for container group. ,
Required: False ,
}
[
{
id:
{
Description: Specifies ARM resource id of the subnet. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
zones:
{
Description: Specifies zones of standby container group pools. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyContainerGroupPools_Delete (new)
Description :  Delete a StandbyContainerGroupPoolResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyContainerGroupPools/{standbyContainerGroupPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
standbyContainerGroupPoolName:
{
Description: Name of the standby container group pool ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyContainerGroupPoolRuntimeViews_ListByStandbyPool (new)
Description :  List StandbyContainerGroupPoolRuntimeViewResource resources by StandbyContainerGroupPoolResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyContainerGroupPools/{standbyContainerGroupPoolName}/runtimeViews
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
standbyContainerGroupPoolName:
{
Description: Name of the standby container group pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The StandbyContainerGroupPoolRuntimeViewResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
instanceCountSummary:
{
Description: A list containing the counts of container groups in each possible state, as known by the StandbyPool resource provider. ,
Required: True ,
}
[
{
zone:
{
Description: The zone that the provided counts are in. It will not have a value if zones are not enabled. ,
Format: int64 ,
Required: False ,
}
integer ,
instanceCountsByState:
{
Description: The count of pooled container groups in each state for the given zone. ,
Required: True ,
}
[
{
state:
{
Description: The state that the pooled container groups count is for. ,
Enum:
{
Running: The container group is up and running. ,
Creating: The container group is creating. ,
Deleting: The container group is deleting. ,
}
,
Required: True ,
}
enum ,
count:
{
Description: The count of pooled container groups in the given state. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
]
,
status:
{
Description: Display status of the standby pool ,
Required: False ,
}
{
code:
{
Description: Displays the healthy state of the StandbyPool. ,
Enum:
{
HealthState/healthy: StandbyPool is in healthy state. ,
HealthState/degraded: StandbyPool is in degraded state. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Displays the StandbyPool health state details. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Displays the provisioning state of the standby pool ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
prediction:
{
Description: Displays prediction information of the standby pool ,
Required: False ,
}
{
forecastValues:
{
Description: Displays the forecast information of the standby pool. ,
Required: True ,
}
{
instancesRequestedCount:
{
Description: Displays the predicted count of instances to be requested from the standby pool. ,
Required: True ,
}
[
integer ,
]
,
}
,
forecastStartTime:
{
Description: Displays the UTC timestamp of when the prediction was retrieved for the standby pool. ,
Format: date-time ,
Required: True ,
}
string ,
forecastInfo:
{
Description: Displays additional information for the prediction of the standby pool. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyContainerGroupPoolRuntimeViews_Get (new)
Description :  Get a StandbyContainerGroupPoolRuntimeViewResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyContainerGroupPools/{standbyContainerGroupPoolName}/runtimeViews/{runtimeView}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
standbyContainerGroupPoolName:
{
Description: Name of the standby container group pool ,
Required: True ,
}
string ,
runtimeView:
{
Description: The unique identifier for the runtime view. The input string should be the word 'latest', which will get the latest runtime view of the pool, otherwise the request will fail with NotFound exception. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
instanceCountSummary:
{
Description: A list containing the counts of container groups in each possible state, as known by the StandbyPool resource provider. ,
Required: True ,
}
[
{
zone:
{
Description: The zone that the provided counts are in. It will not have a value if zones are not enabled. ,
Format: int64 ,
Required: False ,
}
integer ,
instanceCountsByState:
{
Description: The count of pooled container groups in each state for the given zone. ,
Required: True ,
}
[
{
state:
{
Description: The state that the pooled container groups count is for. ,
Enum:
{
Running: The container group is up and running. ,
Creating: The container group is creating. ,
Deleting: The container group is deleting. ,
}
,
Required: True ,
}
enum ,
count:
{
Description: The count of pooled container groups in the given state. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
]
,
status:
{
Description: Display status of the standby pool ,
Required: False ,
}
{
code:
{
Description: Displays the healthy state of the StandbyPool. ,
Enum:
{
HealthState/healthy: StandbyPool is in healthy state. ,
HealthState/degraded: StandbyPool is in degraded state. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Displays the StandbyPool health state details. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Displays the provisioning state of the standby pool ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
prediction:
{
Description: Displays prediction information of the standby pool ,
Required: False ,
}
{
forecastValues:
{
Description: Displays the forecast information of the standby pool. ,
Required: True ,
}
{
instancesRequestedCount:
{
Description: Displays the predicted count of instances to be requested from the standby pool. ,
Required: True ,
}
[
integer ,
]
,
}
,
forecastStartTime:
{
Description: Displays the UTC timestamp of when the prediction was retrieved for the standby pool. ,
Format: date-time ,
Required: True ,
}
string ,
forecastInfo:
{
Description: Displays additional information for the prediction of the standby pool. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyVirtualMachinePools_ListByResourceGroup (new)
Description :  List StandbyVirtualMachinePoolResource resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The StandbyVirtualMachinePoolResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies the elasticity profile of the standby virtual machine pools. ,
Required: False ,
}
{
maxReadyCapacity:
{
Description: Specifies the maximum number of virtual machines in the standby virtual machine pool. ,
Format: int64 ,
Required: True ,
}
integer ,
minReadyCapacity:
{
Description: Specifies the desired minimum number of virtual machines in the standby virtual machine pool. MinReadyCapacity cannot exceed MaxReadyCapacity. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
virtualMachineState:
{
Description: Specifies the desired state of virtual machines in the pool. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
attachedVirtualMachineScaleSetId:
{
Description: Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyVirtualMachinePools_Get (new)
Description :  Get a StandbyVirtualMachinePoolResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
standbyVirtualMachinePoolName:
{
Description: Name of the standby virtual machine pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies the elasticity profile of the standby virtual machine pools. ,
Required: False ,
}
{
maxReadyCapacity:
{
Description: Specifies the maximum number of virtual machines in the standby virtual machine pool. ,
Format: int64 ,
Required: True ,
}
integer ,
minReadyCapacity:
{
Description: Specifies the desired minimum number of virtual machines in the standby virtual machine pool. MinReadyCapacity cannot exceed MaxReadyCapacity. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
virtualMachineState:
{
Description: Specifies the desired state of virtual machines in the pool. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
attachedVirtualMachineScaleSetId:
{
Description: Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyVirtualMachinePools_CreateOrUpdate (new)
Description :  Create a StandbyVirtualMachinePoolResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
standbyVirtualMachinePoolName:
{
Description: Name of the standby virtual machine pool ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies the elasticity profile of the standby virtual machine pools. ,
Required: False ,
}
{
maxReadyCapacity:
{
Description: Specifies the maximum number of virtual machines in the standby virtual machine pool. ,
Format: int64 ,
Required: True ,
}
integer ,
minReadyCapacity:
{
Description: Specifies the desired minimum number of virtual machines in the standby virtual machine pool. MinReadyCapacity cannot exceed MaxReadyCapacity. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
virtualMachineState:
{
Description: Specifies the desired state of virtual machines in the pool. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
attachedVirtualMachineScaleSetId:
{
Description: Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies the elasticity profile of the standby virtual machine pools. ,
Required: False ,
}
{
maxReadyCapacity:
{
Description: Specifies the maximum number of virtual machines in the standby virtual machine pool. ,
Format: int64 ,
Required: True ,
}
integer ,
minReadyCapacity:
{
Description: Specifies the desired minimum number of virtual machines in the standby virtual machine pool. MinReadyCapacity cannot exceed MaxReadyCapacity. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
virtualMachineState:
{
Description: Specifies the desired state of virtual machines in the pool. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
attachedVirtualMachineScaleSetId:
{
Description: Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A StandbyVirtualMachinePoolResource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies the elasticity profile of the standby virtual machine pools. ,
Required: False ,
}
{
maxReadyCapacity:
{
Description: Specifies the maximum number of virtual machines in the standby virtual machine pool. ,
Format: int64 ,
Required: True ,
}
integer ,
minReadyCapacity:
{
Description: Specifies the desired minimum number of virtual machines in the standby virtual machine pool. MinReadyCapacity cannot exceed MaxReadyCapacity. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
virtualMachineState:
{
Description: Specifies the desired state of virtual machines in the pool. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
attachedVirtualMachineScaleSetId:
{
Description: Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyVirtualMachinePools_Update (new)
Description :  Update a StandbyVirtualMachinePoolResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
standbyVirtualMachinePoolName:
{
Description: Name of the standby virtual machine pool ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies the elasticity profile of the standby virtual machine pools. ,
Required: False ,
}
{
maxReadyCapacity:
{
Description: Specifies the maximum number of virtual machines in the standby virtual machine pool. ,
Format: int64 ,
Required: True ,
}
integer ,
minReadyCapacity:
{
Description: Specifies the desired minimum number of virtual machines in the standby virtual machine pool. MinReadyCapacity cannot exceed MaxReadyCapacity. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
virtualMachineState:
{
Description: Specifies the desired state of virtual machines in the pool. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
attachedVirtualMachineScaleSetId:
{
Description: Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
elasticityProfile:
{
Description: Specifies the elasticity profile of the standby virtual machine pools. ,
Required: False ,
}
{
maxReadyCapacity:
{
Description: Specifies the maximum number of virtual machines in the standby virtual machine pool. ,
Format: int64 ,
Required: True ,
}
integer ,
minReadyCapacity:
{
Description: Specifies the desired minimum number of virtual machines in the standby virtual machine pool. MinReadyCapacity cannot exceed MaxReadyCapacity. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
virtualMachineState:
{
Description: Specifies the desired state of virtual machines in the pool. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
attachedVirtualMachineScaleSetId:
{
Description: Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyVirtualMachinePools_Delete (new)
Description :  Delete a StandbyVirtualMachinePoolResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
standbyVirtualMachinePoolName:
{
Description: Name of the standby virtual machine pool ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyVirtualMachinePoolRuntimeViews_ListByStandbyPool (new)
Description :  List StandbyVirtualMachinePoolRuntimeViewResource resources by StandbyVirtualMachinePoolResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}/runtimeViews
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
standbyVirtualMachinePoolName:
{
Description: Name of the standby virtual machine pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The StandbyVirtualMachinePoolRuntimeViewResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
instanceCountSummary:
{
Description: A list containing the counts of virtual machines in each possible power state for each zone if enabled, as known by the StandbyPool resource provider. If zones are not enabled on the attached VMSS, the list will contain a single entry without zone values. Note: any resources in the Running state may still be installing extensions / not fully provisioned. ,
Required: True ,
}
[
{
zone:
{
Description: The zone that the provided counts are in. It will not have a value if zones are not enabled on the attached VMSS. ,
Format: int64 ,
Required: False ,
}
integer ,
instanceCountsByState:
{
Description: The count of pooled virtual machines in each state for the given zone. ,
Required: True ,
}
[
{
state:
{
Description: The state that the pooled virtual machines count is for. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
count:
{
Description: The count of pooled virtual machines in the given state. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
]
,
status:
{
Description: Display status of the standby pool ,
Required: False ,
}
{
code:
{
Description: Displays the healthy state of the StandbyPool. ,
Enum:
{
HealthState/healthy: StandbyPool is in healthy state. ,
HealthState/degraded: StandbyPool is in degraded state. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Displays the StandbyPool health state details. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Displays the provisioning state of the standby pool ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
prediction:
{
Description: Displays prediction information of the standby pool ,
Required: False ,
}
{
forecastValues:
{
Description: Displays the forecast information of the standby pool. ,
Required: True ,
}
{
instancesRequestedCount:
{
Description: Displays the predicted count of instances to be requested from the standby pool. ,
Required: True ,
}
[
integer ,
]
,
}
,
forecastStartTime:
{
Description: Displays the UTC timestamp of when the prediction was retrieved for the standby pool. ,
Format: date-time ,
Required: True ,
}
string ,
forecastInfo:
{
Description: Displays additional information for the prediction of the standby pool. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyVirtualMachinePoolRuntimeViews_Get (new)
Description :  Get a StandbyVirtualMachinePoolRuntimeViewResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}/runtimeViews/{runtimeView}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
standbyVirtualMachinePoolName:
{
Description: Name of the standby virtual machine pool ,
Required: True ,
}
string ,
runtimeView:
{
Description: The unique identifier for the runtime view. The input string should be the word 'latest', which will get the latest runtime view of the pool, otherwise the request will fail with NotFound exception. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
instanceCountSummary:
{
Description: A list containing the counts of virtual machines in each possible power state for each zone if enabled, as known by the StandbyPool resource provider. If zones are not enabled on the attached VMSS, the list will contain a single entry without zone values. Note: any resources in the Running state may still be installing extensions / not fully provisioned. ,
Required: True ,
}
[
{
zone:
{
Description: The zone that the provided counts are in. It will not have a value if zones are not enabled on the attached VMSS. ,
Format: int64 ,
Required: False ,
}
integer ,
instanceCountsByState:
{
Description: The count of pooled virtual machines in each state for the given zone. ,
Required: True ,
}
[
{
state:
{
Description: The state that the pooled virtual machines count is for. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
count:
{
Description: The count of pooled virtual machines in the given state. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
]
,
status:
{
Description: Display status of the standby pool ,
Required: False ,
}
{
code:
{
Description: Displays the healthy state of the StandbyPool. ,
Enum:
{
HealthState/healthy: StandbyPool is in healthy state. ,
HealthState/degraded: StandbyPool is in degraded state. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Displays the StandbyPool health state details. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Displays the provisioning state of the standby pool ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
prediction:
{
Description: Displays prediction information of the standby pool ,
Required: False ,
}
{
forecastValues:
{
Description: Displays the forecast information of the standby pool. ,
Required: True ,
}
{
instancesRequestedCount:
{
Description: Displays the predicted count of instances to be requested from the standby pool. ,
Required: True ,
}
[
integer ,
]
,
}
,
forecastStartTime:
{
Description: Displays the UTC timestamp of when the prediction was retrieved for the standby pool. ,
Format: date-time ,
Required: True ,
}
string ,
forecastInfo:
{
Description: Displays additional information for the prediction of the standby pool. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyVirtualMachines_ListByStandbyVirtualMachinePoolResource (new)
Description :  List StandbyVirtualMachineResource resources by StandbyVirtualMachinePoolResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}/standbyVirtualMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
standbyVirtualMachinePoolName:
{
Description: Name of the standby virtual machine pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The StandbyVirtualMachineResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
virtualMachineResourceId:
{
Description: Resource id of the virtual machine. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StandbyVirtualMachines_Get (new)
Description :  Get a StandbyVirtualMachineResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}/standbyVirtualMachines/{standbyVirtualMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
standbyVirtualMachinePoolName:
{
Description: Name of the standby virtual machine pool ,
Required: True ,
}
string ,
standbyVirtualMachineName:
{
Description: Name of the standby virtual machine ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
virtualMachineResourceId:
{
Description: Resource id of the virtual machine. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: Resource is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}