swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector StorageClass API
schemes:
- https
tags:
- name: StorageClass
paths:
  /{resourceUri}/providers/Microsoft.KubernetesRuntime/storageClasses:
    get:
      operationId: microsoftAzureStorageclassList
      tags:
      - StorageClass
      description: List StorageClassResource resources by parent
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/StorageClassResourceListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        StorageClass_List_0:
          $ref: ./examples/StorageClass_List.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Resourceuri Providers Microsoft Kubernetesruntime Storageclasses
  /{resourceUri}/providers/Microsoft.KubernetesRuntime/storageClasses/{storageClassName}:
    get:
      operationId: microsoftAzureStorageclassGet
      tags:
      - StorageClass
      description: Get a StorageClassResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter'
      - name: storageClassName
        in: path
        description: The name of the the storage class
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/StorageClassResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        StorageClass_Get_0:
          $ref: ./examples/StorageClass_Get.json
      summary: Microsoft Azure Get Resourceuri Providers Microsoft Kubernetesruntime Storageclasses Storageclassname
    put:
      operationId: microsoftAzureStorageclassCreateorupdate
      tags:
      - StorageClass
      description: Create a StorageClassResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter'
      - name: storageClassName
        in: path
        description: The name of the the storage class
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/StorageClassResource'
      responses:
        '200':
          description: Resource 'StorageClassResource' update operation succeeded
          schema:
            $ref: '#/definitions/StorageClassResource'
        '201':
          description: Resource 'StorageClassResource' create operation succeeded
          schema:
            $ref: '#/definitions/StorageClassResource'
          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:
        StorageClass_CreateOrUpdate_0:
          $ref: ./examples/StorageClass_CreateOrUpdate.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Resourceuri Providers Microsoft Kubernetesruntime Storageclasses Storageclassname
    patch:
      operationId: microsoftAzureStorageclassUpdate
      tags:
      - StorageClass
      description: Update a StorageClassResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter'
      - name: storageClassName
        in: path
        description: The name of the the storage class
        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/StorageClassResourceUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/StorageClassResource'
        '202':
          description: Resource update request 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.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        StorageClass_Update_0:
          $ref: ./examples/StorageClass_Update.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Resourceuri Providers Microsoft Kubernetesruntime Storageclasses Storageclassname
    delete:
      operationId: microsoftAzureStorageclassDelete
      tags:
      - StorageClass
      description: Delete a StorageClassResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter'
      - name: storageClassName
        in: path
        description: The name of the the storage class
        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:
        StorageClass_Delete_0:
          $ref: ./examples/StorageClass_Delete.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Resourceuri Providers Microsoft Kubernetesruntime Storageclasses Storageclassname
definitions:
  AccessMode:
    type: string
    description: Storage Class Access Mode
    enum:
    - ReadWriteOnce
    - ReadWriteMany
    x-ms-enum:
      name: AccessMode
      modelAsString: true
      values:
      - name: ReadWriteOnce
        value: ReadWriteOnce
        description: Read Write Once (RWO) access mode
      - name: ReadWriteMany
        value: ReadWriteMany
        description: Read Write Many (RWX) access mode
  PerformanceTier:
    type: string
    description: Performance tier of a storage class
    enum:
    - Undefined
    - Basic
    - Standard
    - Premium
    - Ultra
    x-ms-enum:
      name: PerformanceTier
      modelAsString: true
      values:
      - name: Undefined
        value: Undefined
        description: Undefined Performance Tier
      - name: Basic
        value: Basic
        description: Basic Performance Tier
      - name: Standard
        value: Standard
        description: Standard Performance Tier
      - name: Premium
        value: Premium
        description: Premium Performance Tier
      - name: Ultra
        value: Ultra
        description: Ultra Performance Tier
  StorageClassResourceListResult:
    type: object
    description: The response of a StorageClassResource list operation.
    properties:
      value:
        type: array
        description: The StorageClassResource items on this page
        items:
          $ref: '#/definitions/StorageClassResource'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  DataResilienceTier:
    type: string
    description: Data resilience tier of a storage class
    enum:
    - NotDataResilient
    - DataResilient
    x-ms-enum:
      name: DataResilienceTier
      modelAsString: true
      values:
      - name: NotDataResilient
        value: NotDataResilient
        description: Not data resilient
      - name: DataResilient
        value: DataResilient
        description: Data resilient
  StorageClassResource:
    type: object
    description: A StorageClass resource for an Arc connected cluster (Microsoft.Kubernetes/connectedClusters)
    properties:
      properties:
        $ref: '#/definitions/StorageClassProperties'
        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/ProxyResource
  NfsDirectoryActionOnVolumeDeletion:
    type: string
    description: The action to take when a NFS volume is deleted
    enum:
    - Delete
    - Retain
    x-ms-enum:
      name: NfsDirectoryActionOnVolumeDeletion
      modelAsString: true
      values:
      - name: Delete
        value: Delete
        description: When the volume is deleted, delete the directory
      - name: Retain
        value: Retain
        description: When the volume is deleted, retain the directory
  StorageClassProperties:
    type: object
    description: Details of the StorageClass StorageClass.
    properties:
      allowVolumeExpansion:
        $ref: '#/definitions/VolumeExpansion'
        description: Volume can be expanded or not
      mountOptions:
        type: array
        description: Additional mount options
        items:
          type: string
      provisioner:
        type: string
        description: Provisioner name
        x-ms-mutability:
        - read
        - create
      volumeBindingMode:
        $ref: '#/definitions/VolumeBindingMode'
        description: 'Binding mode of volumes: Immediate, WaitForFirstConsumer'
        x-ms-mutability:
        - read
        - create
      accessModes:
        type: array
        description: 'The access mode: [ReadWriteOnce, ReadWriteMany] or [ReadWriteOnce]'
        items:
          $ref: '#/definitions/AccessMode'
      dataResilience:
        $ref: '#/definitions/DataResilienceTier'
        description: Allow single data node failure
      failoverSpeed:
        $ref: '#/definitions/FailoverTier'
        description: 'Failover speed: NA, Slow, Fast'
      limitations:
        type: array
        description: Limitations of the storage class
        items:
          type: string
      performance:
        $ref: '#/definitions/PerformanceTier'
        description: Performance tier
      priority:
        type: integer
        format: int64
        description: 'Selection priority when multiple storage classes meet the criteria. 0: Highest, -1: Never use'
      typeProperties:
        $ref: '#/definitions/StorageClassTypeProperties'
        description: Properties of the StorageClass
        x-ms-mutability:
        - read
        - create
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: Resource provision state
        readOnly: true
    required:
    - typeProperties
  ProvisioningState:
    type: string
    description: The status of the current operation.
    enum:
    - Succeeded
    - Failed
    - Canceled
    - Provisioning
    - Updating
    - Deleting
    - Accepted
    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: Provisioning
        value: Provisioning
        description: Initial provisioning in progress
      - name: Updating
        value: Updating
        description: Update in progress
      - name: Deleting
        value: Deleting
        description: Deletion in progress
      - name: Accepted
        value: Accepted
        description: Change accepted for processing
    readOnly: true
  FailoverTier:
    type: string
    description: Failover tier of a storage class
    enum:
    - NotAvailable
    - Slow
    - Fast
    - Super
    x-ms-enum:
      name: FailoverTier
      modelAsString: true
      values:
      - name: NotAvailable
        value: NotAvailable
        description: Not available Failover Tier
      - name: Slow
        value: Slow
        description: Slow Failover Tier
      - name: Fast
        value: Fast
        description: Fast Failover Tier
      - name: Super
        value: Super
        description: Super Failover Tier
  StorageClassTypePropertiesUpdate:
    type: object
    description: The model for update a storageClass
    properties:
      backingStorageClassName:
        type: string
        description: The backing storageclass used to create new storageclass
      azureStorageAccountName:
        type: string
        description: Azure Storage Account Name
      azureStorageAccountKey:
        type: string
        format: password
        description: Azure Storage Account Key
        x-ms-secret: true
      server:
        type: string
        description: NFS Server
      share:
        type: string
        description: NFS share
      subDir:
        type: string
        description: Sub directory under share. If the sub directory doesn't exist, driver will create it
      mountPermissions:
        type: string
        description: Mounted folder permissions. Default is 0. If set as non-zero, driver will perform `chmod` after mount
      onDelete:
        $ref: '#/definitions/NfsDirectoryActionOnVolumeDeletion'
        description: The action to take when a NFS volume is deleted. Default is Delete
      source:
        type: string
        description: SMB Source
      username:
        type: string
        description: Server username
      password:
        type: string
        format: password
        description: Server password
        x-ms-secret: true
      domain:
        type: string
        description: Server domain
  VolumeBindingMode:
    type: string
    description: Storage class volume binding mode
    enum:
    - Immediate
    - WaitForFirstConsumer
    x-ms-enum:
      name: VolumeBindingMode
      modelAsString: true
      values:
      - name: Immediate
        value: Immediate
        description: Immediate binding mode
      - name: WaitForFirstConsumer
        value: WaitForFirstConsumer
        description: Wait for first consumer binding mode
  VolumeExpansion:
    type: string
    description: Ability to expand volumes of a storage class
    enum:
    - Allow
    - Disallow
    x-ms-enum:
      name: VolumeExpansion
      modelAsString: true
      values:
      - name: Allow
        value: Allow
        description: Allow volume expansion
      - name: Disallow
        value: Disallow
        description: Disallow volume expansion
  SCType:
    type: string
    description: Type of a storage class
    enum:
    - Native
    - RWX
    - Blob
    - NFS
    - SMB
    x-ms-enum:
      name: SCType
      modelAsString: true
      values:
      - name: Native
        value: Native
        description: Native storage class
      - name: RWX
        value: RWX
        description: RWX storage class
      - name: Blob
        value: Blob
        description: Blob storage class
      - name: NFS
        value: NFS
        description: NFS storage class
      - name: SMB
        value: SMB
        description: SMB storage class
  StorageClassPropertiesUpdate:
    type: object
    description: The model for updating storageClass properties
    properties:
      allowVolumeExpansion:
        $ref: '#/definitions/VolumeExpansion'
        description: Volume can be expanded or not
      mountOptions:
        type: array
        description: Additional mount options
        items:
          type: string
      accessModes:
        type: array
        description: 'The access mode: [ReadWriteOnce, ReadWriteMany] or [ReadWriteOnce]'
        items:
          $ref: '#/definitions/AccessMode'
      dataResilience:
        $ref: '#/definitions/DataResilienceTier'
        description: Allow single data node failure
      failoverSpeed:
        $ref: '#/definitions/FailoverTier'
        description: 'Failover speed: NA, Slow, Fast'
      limitations:
        type: array
        description: Limitations of the storage class
        items:
          type: string
      performance:
        $ref: '#/definitions/PerformanceTier'
        description: Performance tier
      priority:
        type: integer
        format: int64
        description: 'Selection priority when multiple storage classes meet the criteria. 0: Highest, -1: Never use'
      typeProperties:
        $ref: '#/definitions/StorageClassTypePropertiesUpdate'
        description: New storage class type of storageClass
  StorageClassTypeProperties:
    type: object
    description: The properties of storage class of the StorageClass
    properties:
      type:
        $ref: '#/definitions/SCType'
        description: Type of the storage class.
    discriminator: type
    required:
    - type
  StorageClassResourceUpdate:
    type: object
    description: The model for updating a storageClass
    properties:
      properties:
        $ref: '#/definitions/StorageClassPropertiesUpdate'
        description: The properties of StorageClass
parameters:
  Azure.ResourceManager.ResourceUriParameter:
    name: resourceUri
    in: path
    description: The fully qualified Azure Resource manager identifier of the resource.
    required: true
    type: string
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'