swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector VolumeGroups API
  description: APIs for Volume Group operations.
schemes:
- https
tags:
- name: VolumeGroups
  description: APIs for Volume Group operations.
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumeGroups
  : get:
      tags:
      - VolumeGroups
      description: List VolumeGroups.
      operationId: microsoftAzureVolumegroupsListbyelasticsan
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ElasticSanNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK -- Operation completed successfully; retrieved Volume Group List.
          schema:
            $ref: '#/definitions/VolumeGroupList'
        default:
          description: Error from the ElasticSan Resource Provider.
          schema:
            $ref: '#/definitions/Error'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        VolumeGroups_ListByElasticSan_MaximumSet_Gen:
          $ref: ./examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json
        VolumeGroups_ListByElasticSan_MinimumSet_Gen:
          $ref: ./examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Elasticsan Elasticsans Elasticsanname Volumegroups
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}
  : put:
      tags:
      - VolumeGroups
      description: Create a Volume Group.
      operationId: microsoftAzureVolumegroupsCreate
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ElasticSanNameParameter'
      - $ref: '#/parameters/VolumeGroupNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/VolumeGroup'
        description: Volume Group object.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK -- Returned when the create operation is successfully completed.
          schema:
            $ref: '#/definitions/VolumeGroup'
        '202':
          description: Accepted -- Create request accepted; operation will complete asynchronously.
          schema:
            $ref: '#/definitions/VolumeGroup'
        default:
          description: Error from the ElasticSan Resource Provider.
          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:
        VolumeGroups_Create_MaximumSet_Gen:
          $ref: ./examples/VolumeGroups_Create_MaximumSet_Gen.json
        VolumeGroups_Create_MinimumSet_Gen:
          $ref: ./examples/VolumeGroups_Create_MinimumSet_Gen.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Elasticsan Elasticsans Elasticsanname Volumegroups Volumegroupname
    patch:
      tags:
      - VolumeGroups
      description: Update an VolumeGroup.
      operationId: microsoftAzureVolumegroupsUpdate
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ElasticSanNameParameter'
      - $ref: '#/parameters/VolumeGroupNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/VolumeGroupUpdate'
        description: Volume Group object.
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK -- Returned when the update operation is successfully completed.
          schema:
            $ref: '#/definitions/VolumeGroup'
        '202':
          description: Accepted -- Update request accepted; operation will complete asynchronously.
        default:
          description: Error from the ElasticSan Resource Provider.
          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:
        VolumeGroups_Update_MaximumSet_Gen:
          $ref: ./examples/VolumeGroups_Update_MaximumSet_Gen.json
        VolumeGroups_Update_MinimumSet_Gen:
          $ref: ./examples/VolumeGroups_Update_MinimumSet_Gen.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Elasticsan Elasticsans Elasticsanname Volumegroups Volumegroupname
    delete:
      tags:
      - VolumeGroups
      description: Delete an VolumeGroup.
      operationId: microsoftAzureVolumegroupsDelete
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ElasticSanNameParameter'
      - $ref: '#/parameters/VolumeGroupNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK -- Delete operation completed successfully.
        '202':
          description: Accepted -- Delete request accepted; operation will complete asynchronously.
        '204':
          description: NoContent -- Resource does not exist in the subscription.
        default:
          description: Error from the ElasticSan Resource Provider
          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:
        VolumeGroups_Delete_MaximumSet_Gen:
          $ref: ./examples/VolumeGroups_Delete_MaximumSet_Gen.json
        VolumeGroups_Delete_MinimumSet_Gen:
          $ref: ./examples/VolumeGroups_Delete_MinimumSet_Gen.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Elasticsan Elasticsans Elasticsanname Volumegroups Volumegroupname
    get:
      tags:
      - VolumeGroups
      description: Get an VolumeGroups.
      operationId: microsoftAzureVolumegroupsGet
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ElasticSanNameParameter'
      - $ref: '#/parameters/VolumeGroupNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Operation completed successfully; retrieved iSCSI Target.
          schema:
            $ref: '#/definitions/VolumeGroup'
        default:
          description: Error from the ElasticSan Resource Provider.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        VolumeGroups_Get_MaximumSet_Gen:
          $ref: ./examples/VolumeGroups_Get_MaximumSet_Gen.json
        VolumeGroups_Get_MinimumSet_Gen:
          $ref: ./examples/VolumeGroups_Get_MinimumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Elasticsan Elasticsans Elasticsanname Volumegroups Volumegroupname
definitions:
  ErrorResponse:
    type: object
    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'
        x-ms-identifiers: []
        description: The error details.
      additionalInfo:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/ErrorAdditionalInfo'
        x-ms-identifiers: []
        description: The error additional info.
    description: The resource management error response.
  VolumeGroupList:
    type: object
    required:
    - value
    description: List of Volume Groups
    additionalProperties: false
    properties:
      value:
        description: An array of Volume Groups objects.
        type: array
        items:
          $ref: '#/definitions/VolumeGroup'
      nextLink:
        description: URI to fetch the next section of the paginated response.
        type: string
        readOnly: true
  VirtualNetworkRule:
    type: object
    properties:
      id:
        type: string
        x-ms-client-name: VirtualNetworkResourceId
        description: 'Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.'
      action:
        type: string
        enum:
        - Allow
        x-ms-enum:
          name: Action
          modelAsString: false
        default: Allow
        description: The action of virtual network rule.
      state:
        type: string
        readOnly: true
        enum:
        - provisioning
        - deprovisioning
        - succeeded
        - failed
        - networkSourceDeleted
        x-ms-enum:
          name: State
          modelAsString: false
        description: Gets the state of virtual network rule.
    required:
    - id
    description: Virtual Network rule.
  StorageTargetType:
    type: string
    enum:
    - Iscsi
    - None
    x-ms-enum:
      name: StorageTargetType
      modelAsString: true
    description: Storage Target type.
  Resource:
    type: object
    properties:
      id:
        type: string
        description: Azure resource identifier.
        readOnly: true
      name:
        type: string
        description: Azure resource name.
        readOnly: true
      type:
        type: string
        description: Azure resource type.
        readOnly: true
      tags:
        type: object
        description: Azure resource tags.
        additionalProperties:
          type: string
    description: The resource model definition.
    x-ms-azure-resource: true
  VolumeGroupUpdateProperties:
    type: object
    description: VolumeGroup response properties.
    properties:
      protocolType:
        description: Type of storage target
        $ref: '#/definitions/StorageTargetType'
      encryption:
        description: Type of encryption
        $ref: '#/definitions/EncryptionType'
      networkAcls:
        $ref: '#/definitions/NetworkRuleSet'
        description: A collection of rules governing the accessibility from specific network locations.
        x-ms-mutability:
        - create
        - read
  NetworkRuleSet:
    type: object
    properties:
      virtualNetworkRules:
        type: array
        items:
          $ref: '#/definitions/VirtualNetworkRule'
        description: The list of virtual network rules.
    description: A set of rules governing the network accessibility.
  VolumeGroupProperties:
    type: object
    description: VolumeGroup response properties.
    properties:
      provisioningState:
        description: State of the operation on the resource.
        $ref: '#/definitions/ProvisioningState'
      protocolType:
        description: Type of storage target
        $ref: '#/definitions/StorageTargetType'
      encryption:
        description: Type of encryption
        $ref: '#/definitions/EncryptionType'
      networkAcls:
        $ref: '#/definitions/NetworkRuleSet'
        description: A collection of rules governing the accessibility from specific network locations.
        x-ms-mutability:
        - create
        - read
  VolumeGroup:
    type: object
    description: Response for Volume Group request.
    properties:
      properties:
        x-ms-client-flatten: true
        description: Properties of VolumeGroup.
        $ref: '#/definitions/VolumeGroupProperties'
      systemData:
        description: Resource metadata required by ARM RPC
        readOnly: true
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
    allOf:
    - $ref: '#/definitions/Resource'
  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
  VolumeGroupUpdate:
    type: object
    description: Volume Group request.
    properties:
      properties:
        x-ms-client-flatten: true
        description: Properties of VolumeGroup.
        $ref: '#/definitions/VolumeGroupUpdateProperties'
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags.
  EncryptionType:
    type: string
    description: The type of key used to encrypt the data of the disk.
    enum:
    - EncryptionAtRestWithPlatformKey
    x-ms-enum:
      name: EncryptionType
      modelAsString: true
      values:
      - value: EncryptionAtRestWithPlatformKey
        description: Volume is encrypted at rest with Platform managed key. It is the default encryption type.
  Error:
    type: object
    description: The resource management error response.
    properties:
      error:
        description: RP error response.
        $ref: '#/definitions/ErrorResponse'
  ErrorAdditionalInfo:
    description: The resource management error additional info.
    type: object
    x-ms-identifiers: []
    properties:
      type:
        readOnly: true
        type: string
        description: The additional info type.
      info:
        readOnly: true
        type: object
        description: The additional info.
parameters:
  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
  VolumeGroupNameParameter:
    name: volumeGroupName
    type: string
    required: true
    in: path
    description: The name of the VolumeGroup.
    pattern: ^[A-Za-z0-9]+((-|_)[a-z0-9A-Z]+)*$
    minLength: 3
    maxLength: 63
    x-ms-parameter-location: method
  ElasticSanNameParameter:
    name: elasticSanName
    in: path
    required: true
    type: string
    description: The name of the ElasticSan.
    pattern: ^[A-Za-z0-9]+((-|_)[a-z0-9A-Z]+)*$
    minLength: 3
    maxLength: 24
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'