Microsoft Azure VolumeQuotaRules API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector VolumeQuotaRules API
schemes:
- https
tags:
- name: VolumeQuotaRules
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules
  : get:
      tags:
      - VolumeQuotaRules
      operationId: microsoftAzureVolumequotarulesListbyvolume
      summary: Microsoft Azure Get All Quota Rules For A Volume
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      description: List all quota rules associated with the volume
      x-ms-pageable:
        nextLinkName: null
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/volumeQuotaRulesList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        VolumeQuotaRules_List:
          $ref: examples/VolumeQuotaRules_List.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}
  : get:
      tags:
      - VolumeQuotaRules
      operationId: microsoftAzureVolumequotarulesGet
      summary: Microsoft Azure Describe A Quota Rule
      description: Get details of the specified quota rule
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: '#/parameters/VolumeQuotaRuleName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/volumeQuotaRule'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        VolumeQuotaRules_Get:
          $ref: examples/VolumeQuotaRules_Get.json
    put:
      tags:
      - VolumeQuotaRules
      operationId: microsoftAzureVolumequotarulesCreate
      summary: Microsoft Azure Create A Quota Rule
      description: Create the specified quota rule within the given volume
      parameters:
      - name: body
        description: Quota rule object supplied in the body of the operation.
        in: body
        required: true
        schema:
          $ref: '#/definitions/volumeQuotaRule'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: '#/parameters/VolumeQuotaRuleName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK - VolumeQuotaRule updated
          schema:
            $ref: '#/definitions/volumeQuotaRule'
        '201':
          description: Quota rule Created
          schema:
            $ref: '#/definitions/volumeQuotaRule'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        VolumeQuotaRules_Create:
          $ref: examples/VolumeQuotaRules_Create.json
    patch:
      tags:
      - VolumeQuotaRules
      operationId: microsoftAzureVolumequotarulesUpdate
      summary: Microsoft Azure Update A Quota Rule
      description: Patch a quota rule
      parameters:
      - name: body
        description: Quota rule object supplied in the body of the operation.
        in: body
        required: true
        schema:
          $ref: '#/definitions/volumeQuotaRulePatch'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: '#/parameters/VolumeQuotaRuleName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/volumeQuotaRule'
        '202':
          description: Accepted -- Update request accepted; operation will complete asynchronously
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        VolumeQuotaRules_Update:
          $ref: examples/VolumeQuotaRules_Update.json
    delete:
      tags:
      - VolumeQuotaRules
      operationId: microsoftAzureVolumequotarulesDelete
      summary: Microsoft Azure Delete A Quota Rule
      description: Delete quota rule
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AccountName'
      - $ref: '#/parameters/PoolName'
      - $ref: '#/parameters/VolumeName'
      - $ref: '#/parameters/VolumeQuotaRuleName'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
        '202':
          description: Accepted -- Delete request accepted; operation will complete asynchronously
        '204':
          description: NoContent -- Resource does not exist.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        VolumeQuotaRules_Delete:
          $ref: examples/VolumeQuotaRules_Delete.json
definitions:
  netappProvisioningState:
    readOnly: true
    type: string
    description: Gets the status of the VolumeQuotaRule at the time the operation was called.
    enum:
    - Accepted
    - Creating
    - Patching
    - Deleting
    - Moving
    - Failed
    - Succeeded
    x-ms-enum:
      name: ProvisioningState
      modelAsString: false
  volumeQuotaRulesList:
    description: List of Volume Quota Rules
    type: object
    properties:
      value:
        description: A list of Volume Quota Rules
        type: array
        items:
          $ref: '#/definitions/volumeQuotaRule'
  resourceTags:
    type: object
    additionalProperties:
      type: string
    description: Tags are a list of key-value pairs that describe the resource
  volumeQuotaRulesProperties:
    description: Volume Quota Rule properties
    type: object
    properties:
      provisioningState:
        $ref: '#/definitions/netappProvisioningState'
      quotaSizeInKiBs:
        type: integer
        description: Size of quota
        format: int64
        example: '100006'
      quotaType:
        title: quotaType
        type: string
        description: Type of quota
        x-ms-mutability:
        - read
        - create
        enum:
        - DefaultUserQuota
        - DefaultGroupQuota
        - IndividualUserQuota
        - IndividualGroupQuota
        x-ms-enum:
          name: type
          modelAsString: true
          values:
          - value: DefaultUserQuota
            description: Default user quota
          - value: DefaultGroupQuota
            description: Default group quota
          - value: IndividualUserQuota
            description: Individual user quota
          - value: IndividualGroupQuota
            description: Individual group quota
        example: DefaultUserQuota
      quotaTarget:
        type: string
        description: UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running <wmic useraccount where name='user-name' get sid>
        x-ms-mutability:
        - read
        - create
  volumeQuotaRulePatch:
    description: Patchable Quota Rule of a Volume
    type: object
    properties:
      tags:
        description: Resource tags
        $ref: '#/definitions/resourceTags'
      properties:
        description: Volume Quota Rule Properties
        $ref: '#/definitions/volumeQuotaRulesProperties'
        x-ms-client-flatten: true
  volumeQuotaRule:
    description: Quota Rule of a Volume
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
    properties:
      properties:
        description: Volume Quota Rule Properties
        $ref: '#/definitions/volumeQuotaRulesProperties'
        x-ms-client-flatten: true
parameters:
  AccountName:
    name: accountName
    type: string
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$
    in: path
    required: true
    description: The name of the NetApp account
    x-ms-parameter-location: method
  PoolName:
    name: poolName
    type: string
    in: path
    required: true
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$
    minLength: 1
    maxLength: 64
    description: The name of the capacity pool
    x-ms-parameter-location: method
  VolumeQuotaRuleName:
    name: volumeQuotaRuleName
    type: string
    in: path
    required: true
    description: The name of volume quota rule
    x-ms-parameter-location: method
  VolumeName:
    name: volumeName
    type: string
    in: path
    required: true
    pattern: ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$
    minLength: 1
    maxLength: 64
    description: The name of the volume
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'