The Microsoft Azure Microsoft Standby Pool is a comprehensive cloud-based service that offers a standby pool of resources to ensure high availability and performance for critical workloads in case of failures or sudden spikes in demand. This solution allows businesses to seamlessly allocate additional resources as needed, reducing downtime and ensuring continuous operations.
swagger: '2.0'
info:
title: Microsoft Azure Microsoft.StandbyPool
version: 2023-12-01-preview
x-typespec-generated:
- emitter: '@azure-tools/typespec-autorest'
schemes:
- https
host: management.azure.com
produces:
- application/json
consumes:
- application/json
security:
- azure_auth:
- user_impersonation
securityDefinitions:
azure_auth:
type: oauth2
description: Azure Active Directory OAuth2 Flow.
flow: implicit
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
scopes:
user_impersonation: impersonate your user account
tags:
- name: Operations
- name: StandbyContainerGroupPools
- name: StandbyVirtualMachinePools
- name: StandbyVirtualMachines
paths:
/providers/Microsoft.StandbyPool/operations:
get:
operationId: microsoftAzureOperationsList
tags:
- Operations
description: List the operations for the provider
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Operations_List:
$ref: ./examples/Operations_List.json
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Providers Microsoft Standbypool Operations
/subscriptions/{subscriptionId}/providers/Microsoft.StandbyPool/standbyContainerGroupPools:
get:
operationId: microsoftAzureStandbycontainergrouppoolsListbysubscription
tags:
- StandbyContainerGroupPools
description: List StandbyContainerGroupPoolResource resources by subscription ID
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StandbyContainerGroupPoolResourceListResult'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
StandbyContainerGroupPools_ListBySubscription:
$ref: ./examples/StandbyContainerGroupPools_ListBySubscription.json
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Standbypool Standbycontainergrouppools
/subscriptions/{subscriptionId}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools:
get:
operationId: microsoftAzureStandbyvirtualmachinepoolsListbysubscription
tags:
- StandbyVirtualMachinePools
description: List StandbyVirtualMachinePoolResource resources by subscription ID
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StandbyVirtualMachinePoolResourceListResult'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
StandbyVirtualMachinePools_ListBySubscription:
$ref: ./examples/StandbyVirtualMachinePools_ListBySubscription.json
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Standbypool Standbyvirtualmachinepools
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyContainerGroupPools
: get:
operationId: microsoftAzureStandbycontainergrouppoolsListbyresourcegroup
tags:
- StandbyContainerGroupPools
description: List StandbyContainerGroupPoolResource resources by resource group
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StandbyContainerGroupPoolResourceListResult'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
StandbyContainerGroupPools_ListByResourceGroup:
$ref: ./examples/StandbyContainerGroupPools_ListByResourceGroup.json
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Standbypool Standbycontainergrouppools
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyContainerGroupPools/{standbyContainerGroupPoolName}
: get:
operationId: microsoftAzureStandbycontainergrouppoolsGet
tags:
- StandbyContainerGroupPools
description: Get a StandbyContainerGroupPoolResource
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: standbyContainerGroupPoolName
in: path
description: Name of the standby container group pool
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StandbyContainerGroupPoolResource'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
StandbyContainerGroupPools_Get:
$ref: ./examples/StandbyContainerGroupPools_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Standbypool Standbycontainergrouppools Standbycontainergrouppoolname
put:
operationId: microsoftAzureStandbycontainergrouppoolsCreateorupdate
tags:
- StandbyContainerGroupPools
description: Create a StandbyContainerGroupPoolResource
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: standbyContainerGroupPoolName
in: path
description: Name of the standby container group pool
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
- name: resource
in: body
description: Resource create parameters.
required: true
schema:
$ref: '#/definitions/StandbyContainerGroupPoolResource'
responses:
'200':
description: >-
Resource 'StandbyContainerGroupPoolResource' update operation
succeeded
schema:
$ref: '#/definitions/StandbyContainerGroupPoolResource'
'201':
description: >-
Resource 'StandbyContainerGroupPoolResource' create operation
succeeded
schema:
$ref: '#/definitions/StandbyContainerGroupPoolResource'
headers:
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
StandbyContainerGroupPools_CreateOrUpdate:
$ref: ./examples/StandbyContainerGroupPools_CreateOrUpdate.json
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Standbypool Standbycontainergrouppools Standbycontainergrouppoolname
patch:
operationId: microsoftAzureStandbycontainergrouppoolsUpdate
tags:
- StandbyContainerGroupPools
description: Update a StandbyContainerGroupPoolResource
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: standbyContainerGroupPoolName
in: path
description: Name of the standby container group pool
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
- name: properties
in: body
description: The resource properties to be updated.
required: true
schema:
$ref: '#/definitions/StandbyContainerGroupPoolResourceUpdate'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StandbyContainerGroupPoolResource'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
StandbyContainerGroupPools_Update:
$ref: ./examples/StandbyContainerGroupPools_Update.json
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Standbypool Standbycontainergrouppools Standbycontainergrouppoolname
delete:
operationId: microsoftAzureStandbycontainergrouppoolsDelete
tags:
- StandbyContainerGroupPools
description: Delete a StandbyContainerGroupPoolResource
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: standbyContainerGroupPoolName
in: path
description: Name of the standby container group pool
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
responses:
'202':
description: Resource deletion accepted.
headers:
Location:
type: string
description: >-
The Location header contains the URL where the status of the
long running operation can be checked.
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
StandbyContainerGroupPools_Delete:
$ref: ./examples/StandbyContainerGroupPools_Delete.json
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Standbypool Standbycontainergrouppools Standbycontainergrouppoolname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools
: get:
operationId: microsoftAzureStandbyvirtualmachinepoolsListbyresourcegroup
tags:
- StandbyVirtualMachinePools
description: List StandbyVirtualMachinePoolResource resources by resource group
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StandbyVirtualMachinePoolResourceListResult'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
StandbyVirtualMachinePools_ListByResourceGroup:
$ref: ./examples/StandbyVirtualMachinePools_ListByResourceGroup.json
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Standbypool Standbyvirtualmachinepools
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}
: get:
operationId: microsoftAzureStandbyvirtualmachinepoolsGet
tags:
- StandbyVirtualMachinePools
description: Get a StandbyVirtualMachinePoolResource
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: standbyVirtualMachinePoolName
in: path
description: Name of the standby virtual machine pool
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StandbyVirtualMachinePoolResource'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
StandbyVirtualMachinePools_Get:
$ref: ./examples/StandbyVirtualMachinePools_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Standbypool Standbyvirtualmachinepools Standbyvirtualmachinepoolname
put:
operationId: microsoftAzureStandbyvirtualmachinepoolsCreateorupdate
tags:
- StandbyVirtualMachinePools
description: Create a StandbyVirtualMachinePoolResource
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: standbyVirtualMachinePoolName
in: path
description: Name of the standby virtual machine pool
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
- name: resource
in: body
description: Resource create parameters.
required: true
schema:
$ref: '#/definitions/StandbyVirtualMachinePoolResource'
responses:
'200':
description: >-
Resource 'StandbyVirtualMachinePoolResource' update operation
succeeded
schema:
$ref: '#/definitions/StandbyVirtualMachinePoolResource'
'201':
description: >-
Resource 'StandbyVirtualMachinePoolResource' create operation
succeeded
schema:
$ref: '#/definitions/StandbyVirtualMachinePoolResource'
headers:
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
StandbyVirtualMachinePools_CreateOrUpdate:
$ref: ./examples/StandbyVirtualMachinePools_CreateOrUpdate.json
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Standbypool Standbyvirtualmachinepools Standbyvirtualmachinepoolname
patch:
operationId: microsoftAzureStandbyvirtualmachinepoolsUpdate
tags:
- StandbyVirtualMachinePools
description: Update a StandbyVirtualMachinePoolResource
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: standbyVirtualMachinePoolName
in: path
description: Name of the standby virtual machine pool
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
- name: properties
in: body
description: The resource properties to be updated.
required: true
schema:
$ref: '#/definitions/StandbyVirtualMachinePoolResourceUpdate'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StandbyVirtualMachinePoolResource'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
StandbyVirtualMachinePools_Update:
$ref: ./examples/StandbyVirtualMachinePools_Update.json
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Standbypool Standbyvirtualmachinepools Standbyvirtualmachinepoolname
delete:
operationId: microsoftAzureStandbyvirtualmachinepoolsDelete
tags:
- StandbyVirtualMachinePools
description: Delete a StandbyVirtualMachinePoolResource
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: standbyVirtualMachinePoolName
in: path
description: Name of the standby virtual machine pool
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
responses:
'202':
description: Resource deletion accepted.
headers:
Location:
type: string
description: >-
The Location header contains the URL where the status of the
long running operation can be checked.
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
StandbyVirtualMachinePools_Delete:
$ref: ./examples/StandbyVirtualMachinePools_Delete.json
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Standbypool Standbyvirtualmachinepools Standbyvirtualmachinepoolname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}/standbyVirtualMachines
: get:
operationId: >-
microsoftAzureStandbyvirtualmachinesListbystandbyvirtualmachinepoolresource
tags:
- StandbyVirtualMachines
description: >-
List StandbyVirtualMachineResource resources by
StandbyVirtualMachinePoolResource
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: standbyVirtualMachinePoolName
in: path
description: Name of the standby virtual machine pool
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StandbyVirtualMachineResourceListResult'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
StandbyVirtualMachines_ListByStandbyVirtualMachinePoolResource:
$ref: >-
./examples/StandbyVirtualMachines_ListByStandbyVirtualMachinePoolResource.json
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Standbypool Standbyvirtualmachinepools Standbyvirtualmachinepoolname Standbyvirtualmachines
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}/standbyVirtualMachines/{standbyVirtualMachineName}
: get:
operationId: microsoftAzureStandbyvirtualmachinesGet
tags:
- StandbyVirtualMachines
description: Get a StandbyVirtualMachineResource
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: standbyVirtualMachinePoolName
in: path
description: Name of the standby virtual machine pool
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
- name: standbyVirtualMachineName
in: path
description: Name of the standby virtual machine
required: true
type: string
pattern: ^[_a-zA-Z0-9-]{3,64}$
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StandbyVirtualMachineResource'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
StandbyVirtualMachines_Get:
$ref: ./examples/StandbyVirtualMachines_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Standbypool Standbyvirtualmachinepools Standbyvirtualmachinepoolname Standbyvirtualmachines Standbyvirtualmachinename
definitions:
ContainerGroupProfile:
type: object
description: Details of the ContainerGroupProfile.
properties:
id:
type: string
format: arm-id
description: Specifies container group profile id of standby container groups.
x-ms-arm-id-details:
allowedResources:
- type: Microsoft.ContainerInstance/containerGroupProfiles
revision:
type: integer
format: int64
description: Specifies revision of container group profile.
required:
- id
ContainerGroupProfileUpdate:
type: object
description: Details of the ContainerGroupProfile.
properties:
id:
type: string
format: arm-id
description: Specifies container group profile id of standby container groups.
x-ms-arm-id-details:
allowedResources:
- type: Microsoft.ContainerInstance/containerGroupProfiles
revision:
type: integer
format: int64
description: Specifies revision of container group profile.
ContainerGroupProperties:
type: object
description: Details of the ContainerGroupProperties.
properties:
containerGroupProfile:
$ref: '#/definitions/ContainerGroupProfile'
description: Specifies container group profile of standby container groups.
subnetIds:
type: array
description: Specifies subnet Ids for container group.
items:
$ref: '#/definitions/Subnet'
required:
- containerGroupProfile
ContainerGroupPropertiesUpdate:
type: object
description: Details of the ContainerGroupProperties.
properties:
containerGroupProfile:
$ref: '#/definitions/ContainerGroupProfileUpdate'
description: Specifies container group profile of standby container groups.
subnetIds:
type: array
description: Specifies subnet Ids for container group.
items:
$ref: '#/definitions/Subnet'
ProvisioningState:
type: string
description: Provisioning state
enum:
- Succeeded
- Failed
- Canceled
- Deleting
x-ms-enum:
name: ProvisioningState
modelAsString: true
values:
- name: Succeeded
value: Succeeded
description: Resource has been created.
- name: Failed
value: Failed
description: Resource creation failed.
- name: Canceled
value: Canceled
description: Resource creation was canceled.
- name: Deleting
value: Deleting
description: Resource is being deleted.
readOnly: true
RefillPolicy:
type: string
description: Refill policy of standby pool
enum:
- always
x-ms-enum:
name: RefillPolicy
modelAsString: true
values:
- name: always
value: always
description: >-
A refill policy that standby pool is automatically refilled to
maintain maxReadyCapacity.
StandbyContainerGroupPoolElasticityProfile:
type: object
description: Specifies the elasticity profile of the standby container group pools.
properties:
maxReadyCapacity:
type: integer
format: int64
description: >-
Specifies maximum number of standby container groups in the standby
pool.
minimum: 0
maximum: 2000
refillPolicy:
$ref: '#/definitions/RefillPolicy'
description: Specifies refill policy of the pool.
required:
- maxReadyCapacity
StandbyContainerGroupPoolElasticityProfileUpdate:
type: object
description: Specifies the elasticity profile of the standby container group pools.
properties:
maxReadyCapacity:
type: integer
format: int64
description: >-
Specifies maximum number of standby container groups in the standby
pool.
minimum: 0
maximum: 2000
refillPolicy:
$ref: '#/definitions/RefillPolicy'
description: Specifies refill policy of the pool.
StandbyContainerGroupPoolResource:
type: object
description: A StandbyContainerGroupPoolResource.
properties:
properties:
$ref: '#/definitions/StandbyContainerGroupPoolResourceProperties'
description: The resource-specific properties for this resource.
x-ms-client-flatten: true
x-ms-mutability:
- read
- create
allOf:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
StandbyContainerGroupPoolResourceListResult:
type: object
description: The response of a StandbyContainerGroupPoolResource list operation.
properties:
value:
type: array
description: The StandbyContainerGroupPoolResource items on this page
items:
$ref: '#/definitions/StandbyContainerGroupPoolResource'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
StandbyContainerGroupPoolResourceProperties:
type: object
description: Details of the StandbyContainerGroupPool.
properties:
elasticityProfile:
$ref: '#/definitions/StandbyContainerGroupPoolElasticityProfile'
description: Specifies elasticity profile of standby container group
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoftstandbypool-openapi-original.yml