swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DiskPools API
  description: APIs for Disk pool operations.
schemes:
- https
tags:
- name: DiskPools
  description: APIs for Disk pool operations.
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.StoragePool/diskPools:
    get:
      tags:
      - DiskPools
      operationId: microsoftAzureDiskpoolsListbysubscription
      description: Gets a list of Disk Pools in a subscription
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Operation completed successfully; retrieved diskPools by subscription
          schema:
            $ref: '#/definitions/DiskPoolListResult'
        default:
          description: Error from the RP
          schema:
            $ref: '#/definitions/Error'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List Disk Pools by subscription:
          $ref: ./examples/DiskPools_ListBySubscription.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Storagepool Diskpools
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools:
    get:
      tags:
      - DiskPools
      operationId: microsoftAzureDiskpoolsListbyresourcegroup
      description: Gets a list of DiskPools in a resource group.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Operation completed successfully; retrieved diskPools by resource group
          schema:
            $ref: '#/definitions/DiskPoolListResult'
        default:
          description: Error from the RP
          schema:
            $ref: '#/definitions/Error'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List Disk Pools:
          $ref: ./examples/DiskPools_ListByResourceGroup.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagepool Diskpools
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}
  : put:
      tags:
      - DiskPools
      operationId: microsoftAzureDiskpoolsCreateorupdate
      description: Create or Update Disk pool.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DiskPoolName'
      - $ref: '#/parameters/DiskPoolCreate'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK -- Returned when the create or update operation is successfully completed.
          schema:
            $ref: '#/definitions/DiskPool'
        '201':
          description: Accepted -- Create or update request accepted; operation will complete asynchronously.
          schema:
            $ref: '#/definitions/DiskPool'
        default:
          description: Error from the RP
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Create or Update Disk pool:
          $ref: ./examples/DiskPools_Put.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagepool Diskpools Diskpoolname
    patch:
      tags:
      - DiskPools
      operationId: microsoftAzureDiskpoolsUpdate
      description: Update a Disk pool.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DiskPoolName'
      - $ref: '#/parameters/DiskPoolUpdate'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK -- Returned when the update operation is successfully completed.
          schema:
            $ref: '#/definitions/DiskPool'
        '202':
          description: Accepted -- Update request accepted; operation will complete asynchronously.
        default:
          description: Error from the RP.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Update Disk pool:
          $ref: ./examples/DiskPools_Patch.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagepool Diskpools Diskpoolname
    delete:
      tags:
      - DiskPools
      operationId: microsoftAzureDiskpoolsDelete
      description: Delete a Disk pool.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DiskPoolName'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Delete operation completed successfully.
        '202':
          description: Delete request accepted; operation will complete asynchronously.
        '204':
          description: Resource does not exist in the subscription.
        default:
          description: Error from the RP
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Delete Disk pool:
          $ref: ./examples/DiskPools_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagepool Diskpools Diskpoolname
    get:
      tags:
      - DiskPools
      operationId: microsoftAzureDiskpoolsGet
      description: Get a Disk pool.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DiskPoolName'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Operation completed successfully; retrieved Disk pool.
          schema:
            $ref: '#/definitions/DiskPool'
        default:
          description: Error from the RP.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get Disk pool:
          $ref: ./examples/DiskPools_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagepool Diskpools Diskpoolname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/outboundNetworkDependenciesEndpoints
  : get:
      tags:
      - DiskPools
      operationId: microsoftAzureDiskpoolsListoutboundnetworkdependenciesendpoints
      description: Gets the network endpoints of all outbound dependencies of a Disk Pool
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DiskPoolName'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/OutboundEnvironmentEndpointList'
        default:
          description: Error from the RP
          schema:
            $ref: '#/definitions/Error'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Get Disk Pool outbound network dependencies:
          $ref: ./examples/DiskPools_GetOutboundNetworkDependencies.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagepool Diskpools Diskpoolname Outboundnetworkdependenciesendpoints
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/start
  : post:
      tags:
      - DiskPools
      operationId: microsoftAzureDiskpoolsStart
      description: The operation to start a Disk Pool.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DiskPoolName'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        default:
          description: Error from the RP
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Start Disk Pool:
          $ref: ./examples/DiskPools_Start.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagepool Diskpools Diskpoolname Start
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StoragePool/diskPools/{diskPoolName}/deallocate
  : post:
      tags:
      - DiskPools
      operationId: microsoftAzureDiskpoolsDeallocate
      description: Shuts down the Disk Pool and releases the compute resources. You are not billed for the compute resources that this Disk Pool uses.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/DiskPoolName'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        default:
          description: Error from the RP
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Deallocate Disk Pool:
          $ref: ./examples/DiskPools_Deallocate.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagepool Diskpools Diskpoolname Deallocate
definitions:
  AvailabilityZone:
    type: string
    description: Availability zone.
  AdditionalCapability:
    type: string
    description: Special capability that can be set on the Disk Pool.
  Sku:
    type: object
    description: Sku for ARM resource
    required:
    - name
    properties:
      name:
        type: string
        description: Sku name
      tier:
        type: string
        description: Sku tier
  ErrorAdditionalInfo:
    properties:
      type:
        readOnly: true
        type: string
        description: The additional info type.
      info:
        readOnly: true
        type: object
        description: The additional info.
    description: The resource management error additional info.
  DiskPoolCreateProperties:
    type: object
    description: Properties for Disk Pool create or update request.
    required:
    - subnetId
    properties:
      availabilityZones:
        type: array
        description: 'Logical zone for Disk Pool resource; example: ["1"].'
        items:
          $ref: '#/definitions/AvailabilityZone'
      disks:
        type: array
        description: List of Azure Managed Disks to attach to a Disk Pool.
        items:
          $ref: '#/definitions/Disk'
      subnetId:
        type: string
        description: Azure Resource ID of a Subnet for the Disk Pool.
        x-ms-mutability:
        - create
        - read
      additionalCapabilities:
        type: array
        description: List of additional capabilities for a Disk Pool.
        items:
          $ref: '#/definitions/AdditionalCapability'
  DiskPoolListResult:
    type: object
    required:
    - value
    description: List of Disk Pools
    additionalProperties: false
    properties:
      value:
        description: An array of Disk pool objects.
        type: array
        items:
          $ref: '#/definitions/DiskPool'
      nextLink:
        description: URI to fetch the next section of the paginated response.
        type: string
        readOnly: true
  Resource:
    description: ARM resource model definition.
    properties:
      id:
        readOnly: true
        type: string
        description: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
      name:
        readOnly: true
        type: string
        description: The name of the resource
      type:
        readOnly: true
        type: string
        description: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
    x-ms-azure-resource: true
  TrackedResource:
    description: The resource model definition for a ARM tracked top level resource.
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        x-ms-mutability:
        - read
        - create
        - update
        description: Resource tags.
      location:
        type: string
        x-ms-mutability:
        - read
        - create
        description: The geo-location where the resource lives.
    required:
    - location
    allOf:
    - $ref: '#/definitions/Resource'
  EndpointDetail:
    description: Current TCP connectivity information from the App Service Environment to a single endpoint.
    type: object
    properties:
      ipAddress:
        description: An IP Address that Domain Name currently resolves to.
        type: string
      port:
        format: int32
        description: The port an endpoint is connected to.
        type: integer
      latency:
        format: double
        description: The time in milliseconds it takes for a TCP connection to be created from the App Service Environment to this IpAddress at this Port.
        type: number
      isAccessible:
        description: Whether it is possible to create a TCP connection from the App Service Environment to this IpAddress at this Port.
        type: boolean
  EndpointDependency:
    description: A domain name that a service is reached at, including details of the current connection status.
    type: object
    properties:
      domainName:
        description: The domain name of the dependency.
        type: string
      endpointDetails:
        description: The IP Addresses and Ports used when connecting to DomainName.
        type: array
        items:
          $ref: '#/definitions/EndpointDetail'
  DiskPoolUpdate:
    type: object
    description: Request payload for Update Disk Pool request.
    required:
    - properties
    properties:
      properties:
        x-ms-client-flatten: true
        description: Properties for Disk Pool update request.
        $ref: '#/definitions/DiskPoolUpdateProperties'
      tags:
        type: object
        additionalProperties:
          type: string
        x-ms-mutability:
        - read
        - create
        - update
        description: Resource tags.
  DiskPoolCreate:
    type: object
    description: Request payload for create or update Disk Pool request.
    required:
    - properties
    - location
    - sku
    properties:
      sku:
        description: Determines the SKU of the Disk Pool
        type: object
        $ref: '#/definitions/Sku'
      properties:
        x-ms-client-flatten: true
        description: Properties for Disk Pool create request.
        $ref: '#/definitions/DiskPoolCreateProperties'
      tags:
        type: object
        additionalProperties:
          type: string
        x-ms-mutability:
        - read
        - create
        - update
        description: Resource tags.
      location:
        type: string
        x-ms-mutability:
        - read
        - create
        description: The geo-location where the resource lives.
      id:
        readOnly: true
        type: string
        description: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
      name:
        readOnly: true
        type: string
        description: The name of the resource
      type:
        readOnly: true
        type: string
        description: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
    x-ms-azure-resource: true
  Disk:
    type: object
    description: Azure Managed Disk to attach to the Disk Pool.
    required:
    - id
    additionalProperties: false
    properties:
      id:
        type: string
        description: Unique Azure Resource ID of the Managed Disk.
  OutboundEnvironmentEndpoint:
    description: Endpoints accessed for a common purpose that the App Service Environment requires outbound network access to.
    type: object
    properties:
      category:
        description: The type of service accessed by the App Service Environment, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory.
        type: string
      endpoints:
        description: The endpoints that the App Service Environment reaches the service at.
        type: array
        items:
          $ref: '#/definitions/EndpointDependency'
  Error:
    type: object
    description: The resource management error response.
    properties:
      error:
        type: object
        description: RP error response.
        $ref: '#/definitions/ErrorResponse'
  ErrorResponse:
    properties:
      code:
        readOnly: true
        type: string
        description: The error code.
      message:
        readOnly: true
        type: string
        description: The error message.
      target:
        readOnly: true
        type: string
        description: The error target.
      details:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/ErrorResponse'
        description: The error details.
      additionalInfo:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/ErrorAdditionalInfo'
        description: The error additional info.
    description: The resource management error response.
  OperationalStatus:
    type: string
    enum:
    - Invalid
    - Unknown
    - Healthy
    - Unhealthy
    - Updating
    - Running
    - Stopped
    - Stopped (deallocated)
    x-ms-enum:
      name: OperationalStatus
      modelAsString: true
    description: Operational status of the resource.
  OutboundEnvironmentEndpointList:
    description: Collection of Outbound Environment Endpoints
    required:
    - value
    type: object
    properties:
      value:
        description: Collection of resources.
        type: array
        items:
          $ref: '#/definitions/OutboundEnvironmentEndpoint'
      nextLink:
        description: Link to next page of resources.
        type: string
        readOnly: true
  DiskPool:
    type: object
    description: Response for Disk Pool request.
    required:
    - properties
    properties:
      sku:
        description: Determines the SKU of the Disk pool
        $ref: '#/definitions/Sku'
        x-ms-client-flatten: true
      properties:
        x-ms-client-flatten: true
        description: Properties of Disk Pool.
        $ref: '#/definitions/DiskPoolProperties'
      systemData:
        description: Resource metadata required by ARM RPC
        readOnly: true
        $ref: '#/definitions/SystemMetadata'
    allOf:
    - $ref: '#/definitions/TrackedResource'
  ProvisioningState:
    type: string
    enum:
    - Invalid
    - Succeeded
    - Failed
    - Canceled
    - Pending
    - Creating
    - Updating
    - Deleting
    x-ms-enum:
      name: ProvisioningStates
      modelAsString: true
    description: Provisioning state of the iSCSI Target.
    readOnly: true
  SystemMetadata:
    description: Metadata pertaining to creation and last modification of the resource.
    type: object
    readOnly: true
    properties:
      createdBy:
        type: string
        description: The identity that created the resource.
      createdByType:
        type: string
        description: The type of identity that created the resource.
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        x-ms-enum:
          name: createdByType
          modelAsString: true
      createdAt:
        type: string
        format: date-time
        description: The timestamp of resource creation (UTC).
      lastModifiedBy:
        type: string
        description: The identity that last modified the resource.
      lastModifiedByType:
        type: string
        description: The type of identity that last modified the resource.
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        x-ms-enum:
          name: createdByType
          modelAsString: true
      lastModifiedAt:
        type: string
        format: date-time
        description: The type of identity that last modified the resource.
  DiskPoolUpdateProperties:
    type: object
    description: Properties for Disk Pool update request.
    properties:
      disks:
        type: array
        description: List of Azure Managed Disks to attach to a Disk Pool.
        items:
          $ref: '#/definitions/Disk'
  DiskPoolProperties:
    type: object
    description: Disk Pool response properties.
    required:
    - availabilityZones
    - subnetId
    - provisioningState
    - status
    properties:
      provisioningState:
        description: State of the operation on the resource.
        type: string
        $ref: '#/definitions/ProvisioningState'
      availabilityZones:
        type: array
        description: 'Logical zone for Disk Pool resource; example: ["1"].'
        items:
          $ref: '#/definitions/AvailabilityZone'
      status:
        type: string
        $ref: '#/definitions/OperationalStatus'
        description: Operational status of the Disk Pool.
      disks:
        type: array
        description: List of Azure Managed Disks to attach to a Disk Pool.
        items:
          $ref: '#/definitions/Disk'
      subnetId:
        type: string
        description: Azure Resource ID of a Subnet for the Disk Pool.
        x-ms-mutability:
        - create
        - read
      additionalCapabilities:
        type: array
        description: List of additional capabilities for Disk Pool.
        items:
          $ref: '#/definitions/AdditionalCapability'
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to use for this operation.
    minLength: 1
  DiskPoolCreate:
    name: diskPoolCreatePayload
    required: true
    in: body
    description: Request payload for Disk Pool create operation
    schema:
      $ref: '#/definitions/DiskPoolCreate'
    x-ms-parameter-location: method
  DiskPoolUpdate:
    name: diskPoolUpdatePayload
    required: true
    in: body
    description: Request payload for Disk Pool update operation.
    schema:
      $ref: '#/definitions/DiskPoolUpdate'
    x-ms-parameter-location: method
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    description: The name of the resource group. The name is case insensitive.
    pattern: ^[-\w\._]*[0-9A-Za-z]$
    minLength: 1
    maxLength: 90
    x-ms-parameter-location: method
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: The ID of the target subscription.
    minLength: 1
  DiskPoolName:
    name: diskPoolName
    in: path
    required: true
    type: string
    description: The name of the Disk Pool.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'