swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector StandbyVirtualMachinePools API
schemes:
- https
tags:
- name: StandbyVirtualMachinePools
paths:
  /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/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
definitions:
  StandbyVirtualMachinePoolElasticityProfile:
    type: object
    description: Details of the elasticity profile.
    properties:
      maxReadyCapacity:
        type: integer
        format: int64
        description: Specifies the maximum number of virtual machines in the standby virtual machine pool.
        minimum: 0
        maximum: 2000
    required:
    - maxReadyCapacity
  VirtualMachineState:
    type: string
    description: State of standby virtual machines
    enum:
    - Running
    - Deallocated
    x-ms-enum:
      name: VirtualMachineState
      modelAsString: true
      values:
      - name: Running
        value: Running
        description: The virtual machine is up and running.
      - name: Deallocated
        value: Deallocated
        description: The virtual machine has released the lease on the underlying hardware and is powered off.
  StandbyVirtualMachinePoolResourceUpdateProperties:
    type: object
    description: The updatable properties of the StandbyVirtualMachinePoolResource.
    properties:
      elasticityProfile:
        $ref: '#/definitions/StandbyVirtualMachinePoolElasticityProfileUpdate'
        description: Specifies the elasticity profile of the standby virtual machine pools.
      virtualMachineState:
        $ref: '#/definitions/VirtualMachineState'
        description: Specifies the desired state of virtual machines in the pool.
        x-ms-identifiers:
        - vmState
      attachedVirtualMachineScaleSetId:
        type: string
        format: arm-id
        description: Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
        x-ms-arm-id-details:
          allowedResources:
          - type: Microsoft.Compute/virtualMachineScaleSet
  StandbyVirtualMachinePoolResourceProperties:
    type: object
    description: Details of the StandbyVirtualMachinePool.
    properties:
      elasticityProfile:
        $ref: '#/definitions/StandbyVirtualMachinePoolElasticityProfile'
        description: Specifies the elasticity profile of the standby virtual machine pools.
      virtualMachineState:
        $ref: '#/definitions/VirtualMachineState'
        description: Specifies the desired state of virtual machines in the pool.
        x-ms-identifiers:
        - vmState
      attachedVirtualMachineScaleSetId:
        type: string
        format: arm-id
        description: Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
        x-ms-arm-id-details:
          allowedResources:
          - type: Microsoft.Compute/virtualMachineScaleSet
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
    required:
    - virtualMachineState
  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
  StandbyVirtualMachinePoolResourceUpdate:
    type: object
    description: The type used for update operations of the StandbyVirtualMachinePoolResource.
    properties:
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/StandbyVirtualMachinePoolResourceUpdateProperties'
        x-ms-client-flatten: true
  StandbyVirtualMachinePoolResource:
    type: object
    description: A StandbyVirtualMachinePoolResource.
    properties:
      properties:
        $ref: '#/definitions/StandbyVirtualMachinePoolResourceProperties'
        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
  StandbyVirtualMachinePoolResourceListResult:
    type: object
    description: The response of a StandbyVirtualMachinePoolResource list operation.
    properties:
      value:
        type: array
        description: The StandbyVirtualMachinePoolResource items on this page
        items:
          $ref: '#/definitions/StandbyVirtualMachinePoolResource'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  StandbyVirtualMachinePoolElasticityProfileUpdate:
    type: object
    description: Details of the elasticity profile.
    properties:
      maxReadyCapacity:
        type: integer
        format: int64
        description: Specifies the maximum number of virtual machines in the standby virtual machine pool.
        minimum: 0
        maximum: 2000
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'