Microsoft.StandbyPool (preview:2024-03-01)

2025/01/10 • 2 updated methods

StandbyVirtualMachinePoolRuntimeViews_ListByStandbyPool (updated)
Description :  List StandbyVirtualMachinePoolRuntimeViewResource resources by StandbyVirtualMachinePoolResource
Reference :  Link ¶

⚶ Changes

{
  "#id": "StandbyVirtualMachinePoolRuntimeViews_ListByStandbyPool",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "instanceCountSummary",
                "Description": {
                  "new": "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.",
                  "old": "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.\nIf zones are not enabled on the attached VMSS, the list will contain a single entry with null zone values.\nNote: any updates to pool resources outside of StandbyPoolRP (i.e deleting a VM through portal) are not reflected here.\nNote: any resources in the Running state may still be installing extensions / not fully provisioned."
                },
                "$items": {
                  "Description": {
                    "new": "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.",
                    "old": "Contains the counts of VMs in each power state in a given zone, fault domain, as known by the StandbyPool resource provider.\nNote: any updates to pool resources outside of StandbyPoolRP (i.e deleting a VM through portal) are not reflected here.\nNote: any resources in the Running state may still be installing extensions / not fully provisioned."
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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. This is null if zones are not enabled on the attached VMSS. ,
Format: int64 ,
Required: False ,
}
integer ,
instanceCountsByState:
{
Description: The count of pooled resources in each state for the given zone. ,
Required: True ,
}
[
{
state:
{
Description: The state that the pooled resources count is for. ,
Required: True ,
}
string ,
count:
{
Description: The count of pooled resources in the given state. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
]
,
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 ,
}
,
}
,
]
,
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 (updated)
Description :  Get a StandbyVirtualMachinePoolRuntimeViewResource
Reference :  Link ¶

⚶ Changes

{
  "#id": "StandbyVirtualMachinePoolRuntimeViews_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "instanceCountSummary",
            "Description": {
              "new": "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.",
              "old": "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.\nIf zones are not enabled on the attached VMSS, the list will contain a single entry with null zone values.\nNote: any updates to pool resources outside of StandbyPoolRP (i.e deleting a VM through portal) are not reflected here.\nNote: any resources in the Running state may still be installing extensions / not fully provisioned."
            },
            "$items": {
              "Description": {
                "new": "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.",
                "old": "Contains the counts of VMs in each power state in a given zone, fault domain, as known by the StandbyPool resource provider.\nNote: any updates to pool resources outside of StandbyPoolRP (i.e deleting a VM through portal) are not reflected here.\nNote: any resources in the Running state may still be installing extensions / not fully provisioned."
              }
            }
          }
        ]
      }
    }
  }
}

⚼ 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. This is null if zones are not enabled on the attached VMSS. ,
Format: int64 ,
Required: False ,
}
integer ,
instanceCountsByState:
{
Description: The count of pooled resources in each state for the given zone. ,
Required: True ,
}
[
{
state:
{
Description: The state that the pooled resources count is for. ,
Required: True ,
}
string ,
count:
{
Description: The count of pooled resources in the given state. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
]
,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}