swagger: '2.0'
info:
  version: 2018-07-30-preview
  title: Microsoft Azure ComputeDiskAdminManagementClient
  description: The Admin Compute Disk Management Client.
host: management.azure.com
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Compute.Admin/locations/{location}/disks:
    get:
      x-ms-examples:
        Returns a list of disks.:
          $ref: ./examples/Disks/List.json
      tags:
        - Disks
      operationId: microsoftAzureDisksList
      description: Returns a list of disks.
      parameters:
        - $ref: >-
            ../2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter
        - $ref: ../2015-12-01-preview/Compute.json#/parameters/LocationParameter
        - $ref: Disks.json#/parameters/UserSubscriptionIdParameter
        - $ref: Disks.json#/parameters/DiskStateParameter
        - $ref: Disks.json#/parameters/SourceSharePathParameter
        - $ref: Disks.json#/parameters/SourceScaleUnitParameter
        - $ref: Disks.json#/parameters/SourceVolumeLabelParameter
        - $ref: Disks.json#/parameters/DiskCountParameter
        - $ref: Disks.json#/parameters/DiskStartParameter
        - $ref: >-
            ../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK -- The list of disks has been returned.
          schema:
            $ref: Disks.json#/definitions/DiskList
        default:
          description: >-
            Common error response for all Azure Resource Manager APIs to return
            error details for failed operations. (This also follows the OData
            error response format.).
          schema:
            $ref: ../2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse
      x-ms-pageable:
        nextLinkName:
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Compute Admin Locations Location Disks
  /subscriptions/{subscriptionId}/providers/Microsoft.Compute.Admin/locations/{location}/disks/{DiskId}:
    get:
      x-ms-examples:
        Returns the requested disk.:
          $ref: ./examples/Disks/Get.json
      tags:
        - Disks
      operationId: microsoftAzureDisksGet
      description: Returns the disk.
      parameters:
        - $ref: >-
            ../2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter
        - $ref: ../2015-12-01-preview/Compute.json#/parameters/LocationParameter
        - $ref: Disks.json#/parameters/DiskIdParameter
        - $ref: >-
            ../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK -- The disk has been returned.
          schema:
            $ref: Disks.json#/definitions/Disk
        default:
          description: >-
            Common error response for all Azure Resource Manager APIs to return
            error details for failed operations. (This also follows the OData
            error response format.).
          schema:
            $ref: ../2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Compute Admin Locations Location Disks Diskid
definitions:
  DiskProperties:
    description: Managed disk properties.
    type: object
    properties:
      diskId:
        description: The disk id.
        type: string
      status:
        description: The disk status.
        $ref: Disks.json#/definitions/DiskState
      sharePath:
        description: The disk share path.
        type: string
      actualSizeGB:
        description: The actual size of disk in GB.
        type: integer
        format: int64
        readOnly: true
      provisionSizeGB:
        description: The provision size of disk in GB.
        type: integer
        format: int64
        readOnly: true
      managedBy:
        description: Compute resource Uri which owns this disk.
        type: string
        readOnly: true
      userResourceId:
        description: The disk resource Uri from user view.
        type: string
        readOnly: true
      diskType:
        description: The type of the disk resource.
        $ref: Disks.json#/definitions/DiskResourceType
        readOnly: true
      diskSku:
        description: the disk sku.
        $ref: Disks.json#/definitions/AccountType
        readOnly: true
  Disk:
    description: Managed Disk.
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: Disks.json#/definitions/DiskProperties
        description: Disk properties.
    allOf:
      - $ref: ../2015-12-01-preview/Compute.json#/definitions/Resource
  DiskList:
    type: object
    description: List of disks.
    properties:
      value:
        description: List of disks.
        type: array
        items:
          $ref: Disks.json#/definitions/Disk
      nextLink:
        description: URI to the next page.
        type: string
  DiskState:
    description: Disk State.
    type: string
    enum:
      - Undefined
      - Unattached
      - Attached
      - Reserved
      - ActiveSAS
      - Unknown
      - All
      - Recommended
      - OfflineMigration
      - OnlineMigration
    x-ms-enum:
      name: DiskState
      modelAsString: true
  DiskResourceType:
    description: Disk resource type.
    type: string
    enum:
      - Undefined
      - Disk
      - Snapshot
      - RestorePoint
      - ManagedBlob
    x-ms-enum:
      name: DiskResourceType
      modelAsString: true
  AccountType:
    description: Disk Sku.
    type: string
    enum:
      - Standard_LRS
      - Standard_ZRS
      - Standard_GRS
      - Standard_RAGRS
      - Premium_LRS
      - StandardSSD_LRS
      - UltraSSD_LRS
    x-ms-enum:
      name: AccountType
      modelAsString: true
parameters:
  UserSubscriptionIdParameter:
    description: User Subscription Id which the resource belongs to.
    name: userSubscriptionId
    type: string
    in: query
    required: false
    x-ms-parameter-location: method
  DiskStateParameter:
    description: The parameters of disk state.
    name: status
    in: query
    required: false
    type: string
    x-ms-parameter-location: method
  SourceSharePathParameter:
    description: The share which the resource belongs to.
    name: sharePath
    in: query
    required: false
    type: string
    x-ms-parameter-location: method
  SourceScaleUnitParameter:
    description: The scale unit which the resource belongs to.
    name: scaleUnit
    in: query
    required: false
    type: string
    x-ms-parameter-location: method
  SourceVolumeLabelParameter:
    description: The volume label of the volume which the resource belongs to.
    name: volumeLabel
    in: query
    required: false
    type: string
    x-ms-parameter-location: method
  DiskCountParameter:
    description: The maximum number of disks to return.
    name: count
    in: query
    type: integer
    format: int32
    required: false
    x-ms-parameter-location: method
  DiskStartParameter:
    description: The start index of disks in query.
    name: start
    in: query
    type: integer
    format: int32
    required: false
    x-ms-parameter-location: method
  DiskIdParameter:
    description: The disk guid as identity.
    name: DiskId
    type: string
    in: path
    required: true
    x-ms-parameter-location: method
securityDefinitions:
  azure_auth:
    type: oauth2
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    flow: implicit
    description: Authorization uses an Azure Active Directory OAuth2 flow.
    scopes:
      user_impersonation: impersonate your user account
security:
  - azure_auth:
      - user_impersonation
tags:
  - name: Disks