swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector StandbyContainerGroupPools API
schemes:
- https
tags:
- name: StandbyContainerGroupPools
paths:
  /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}/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
definitions:
  StandbyContainerGroupPoolResourceUpdateProperties:
    type: object
    description: The updatable properties of the StandbyContainerGroupPoolResource.
    properties:
      elasticityProfile:
        $ref: '#/definitions/StandbyContainerGroupPoolElasticityProfileUpdate'
        description: Specifies elasticity profile of standby container group pools.
      containerGroupProperties:
        $ref: '#/definitions/ContainerGroupPropertiesUpdate'
        description: Specifies container group properties of standby container group pools.
  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
  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
  StandbyContainerGroupPoolResourceUpdate:
    type: object
    description: The type used for update operations of the StandbyContainerGroupPoolResource.
    properties:
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/StandbyContainerGroupPoolResourceUpdateProperties'
        x-ms-client-flatten: true
  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
  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
  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'
  Subnet:
    type: object
    description: Subnet of container group
    properties:
      id:
        type: string
        format: arm-id
        description: Specifies ARM resource id of the subnet.
        x-ms-arm-id-details:
          allowedResources:
          - type: Microsoft.Network/virtualNetworks/subnets
    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.
  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.
  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.
  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
  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
  StandbyContainerGroupPoolResourceProperties:
    type: object
    description: Details of the StandbyContainerGroupPool.
    properties:
      elasticityProfile:
        $ref: '#/definitions/StandbyContainerGroupPoolElasticityProfile'
        description: Specifies elasticity profile of standby container group pools.
      containerGroupProperties:
        $ref: '#/definitions/ContainerGroupProperties'
        description: Specifies container group properties of standby container group pools.
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
    required:
    - elasticityProfile
    - containerGroupProperties
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'