swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector FileShares API
schemes:
- https
tags:
- name: FileShares
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/shares
  : get:
      tags:
      - FileShares
      description: Retrieves all the file shares in a file server.
      operationId: microsoftAzureFilesharesListbyfileserver
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: fileServerName
        in: path
        description: The file server name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The collection of file shares.
          schema:
            $ref: '#/definitions/FileShareList'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        FileSharesListByFileServer:
          $ref: ./examples/FileSharesListByFileServer.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Fileservers Fileservername Shares
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/shares/{shareName}
  : get:
      tags:
      - FileShares
      description: Returns the properties of the specified file share name.
      operationId: microsoftAzureFilesharesGet
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: fileServerName
        in: path
        description: The file server name.
        required: true
        type: string
      - name: shareName
        in: path
        description: The file share name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The file share.
          schema:
            $ref: '#/definitions/FileShare'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      deprecated: false
      x-ms-examples:
        FileSharesGet:
          $ref: ./examples/FileSharesGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Fileservers Fileservername Shares Sharename
    put:
      tags:
      - FileShares
      description: Creates or updates the file share.
      operationId: microsoftAzureFilesharesCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: fileServerName
        in: path
        description: The file server name.
        required: true
        type: string
      - name: shareName
        in: path
        description: The file share name.
        required: true
        type: string
      - name: fileShare
        in: body
        description: The file share.
        required: true
        schema:
          $ref: '#/definitions/FileShare'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the file share.
          schema:
            $ref: '#/definitions/FileShare'
        '202':
          description: Accepted the request to create or update the file share.
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        FileSharesCreateOrUpdate:
          $ref: ./examples/FileSharesCreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Fileservers Fileservername Shares Sharename
    delete:
      tags:
      - FileShares
      description: Deletes the file share.
      operationId: microsoftAzureFilesharesDelete
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: fileServerName
        in: path
        description: The file server name.
        required: true
        type: string
      - name: shareName
        in: path
        description: The file share Name
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '202':
          description: Accepted the request to delete the file share.
        '204':
          description: Successfully deleted the file share.
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        FileSharesDelete:
          $ref: ./examples/FileSharesDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Fileservers Fileservername Shares Sharename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/shares/{shareName}/metrics
  : get:
      tags:
      - FileShares
      description: Gets the file share metrics
      operationId: microsoftAzureFilesharesListmetrics
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: fileServerName
        in: path
        description: The file server name.
        required: true
        type: string
      - name: shareName
        in: path
        description: The file share name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - name: $filter
        in: query
        description: OData Filter options
        required: false
        type: string
      responses:
        '200':
          description: The collection of metrics.
          schema:
            $ref: '#/definitions/MetricList'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      deprecated: false
      x-ms-odata: '#/definitions/MetricFilter'
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        FileSharesListMetrics:
          $ref: ./examples/FileSharesListMetrics.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Fileservers Fileservername Shares Sharename Metrics
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/shares/{shareName}/metricsDefinitions
  : get:
      tags:
      - FileShares
      description: Retrieves metric definitions of all metrics aggregated at the file share.
      operationId: microsoftAzureFilesharesListmetricdefinition
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: fileServerName
        in: path
        description: The file server name.
        required: true
        type: string
      - name: shareName
        in: path
        description: The file share name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The collection of metric definitions.
          schema:
            $ref: '#/definitions/MetricDefinitionList'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        FileSharesListMetricDefinition:
          $ref: ./examples/FileSharesListMetricDefinition.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Fileservers Fileservername Shares Sharename Metricsdefinitions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/shares
  : get:
      tags:
      - FileShares
      description: Retrieves all the file shares in a device.
      operationId: microsoftAzureFilesharesListbydevice
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The collection of file shares.
          schema:
            $ref: '#/definitions/FileShareList'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        FileSharesListByDevice:
          $ref: ./examples/FileSharesListByDevice.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Shares
definitions:
  MetricDefinition:
    description: Monitoring metric definition represents the metadata of the metrics.
    required:
    - name
    - unit
    - primaryAggregationType
    - resourceId
    - metricAvailabilities
    - dimensions
    - type
    type: object
    properties:
      name:
        $ref: '#/definitions/MetricName'
        description: The metric name
      unit:
        description: The metric unit
        enum:
        - Bytes
        - BytesPerSecond
        - Count
        - CountPerSecond
        - Percent
        - Seconds
        type: string
        x-ms-enum:
          name: MetricUnit
          modelAsString: false
      primaryAggregationType:
        description: The metric aggregation type
        enum:
        - Average
        - Last
        - Maximum
        - Minimum
        - None
        - Total
        type: string
        x-ms-enum:
          name: MetricAggregationType
          modelAsString: false
      resourceId:
        description: The metric source id
        type: string
      metricAvailabilities:
        description: The available metric granularities
        type: array
        items:
          $ref: '#/definitions/MetricAvailablity'
        x-ms-identifiers:
        - timeGrain
      dimensions:
        description: The supported dimensions
        type: array
        items:
          $ref: '#/definitions/MetricDimension'
        x-ms-identifiers:
        - name
      type:
        description: The metric definition type
        type: string
  MetricDefinitionList:
    description: List of metric definition
    required:
    - value
    type: object
    properties:
      value:
        description: The list of metric definition
        type: array
        items:
          $ref: '#/definitions/MetricDefinition'
        x-ms-identifiers:
        - name
  FileShare:
    description: The File Share.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel'
    properties:
      properties:
        $ref: '#/definitions/FileShareProperties'
        description: The properties.
        x-ms-client-flatten: true
  MetricDimension:
    description: Metric dimension
    required:
    - name
    - value
    type: object
    properties:
      name:
        description: Metric dimension name
        type: string
      value:
        description: Metric dimension values
        type: string
  BaseModel:
    description: Base class for models
    type: object
    properties:
      id:
        description: The identifier.
        type: string
        readOnly: true
      name:
        description: The name.
        type: string
        readOnly: true
      type:
        description: The type.
        type: string
        readOnly: true
  FileShareProperties:
    description: The File Share.
    required:
    - shareStatus
    - dataPolicy
    - adminUser
    - provisionedCapacityInBytes
    - monitoringStatus
    type: object
    properties:
      description:
        description: Description for file share
        type: string
      shareStatus:
        description: The Share Status
        enum:
        - Online
        - Offline
        type: string
        x-ms-enum:
          name: ShareStatus
          modelAsString: false
      dataPolicy:
        description: The data policy
        enum:
        - Invalid
        - Local
        - Tiered
        - Cloud
        type: string
        x-ms-enum:
          name: DataPolicy
          modelAsString: false
      adminUser:
        description: 'The user/group who will have full permission in this share. Active directory email address. Example: xyz@contoso.com or Contoso\xyz.'
        type: string
      provisionedCapacityInBytes:
        format: int64
        description: The total provisioned capacity in Bytes
        type: integer
      usedCapacityInBytes:
        format: int64
        description: The used capacity in Bytes.
        type: integer
        readOnly: true
      localUsedCapacityInBytes:
        format: int64
        description: The local used capacity in Bytes.
        type: integer
        readOnly: true
      monitoringStatus:
        description: The monitoring status
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: MonitoringStatus
          modelAsString: false
  Item:
    required:
    - key
    - value
    type: object
    properties:
      key:
        type: string
      value:
        type: string
  MetricData:
    description: The metric data.
    required:
    - timeStamp
    - sum
    - count
    - average
    - minimum
    - maximum
    type: object
    properties:
      timeStamp:
        format: date-time
        description: The time when the metric data is fetched
        type: string
      sum:
        format: double
        description: The sum of all the samples available in the given instance of time for the specific metric data
        type: number
      count:
        format: int32
        description: The count of samples of the metric data available for the given instance
        type: integer
      average:
        format: double
        description: The average of all sample for the given instance
        type: number
      minimum:
        format: double
        description: The minimum of all samples available
        type: number
      maximum:
        format: double
        description: The maximum of all samples available
        type: number
  Metrics:
    description: Monitoring metric
    required:
    - resourceId
    - startTime
    - endTime
    - timeGrain
    - primaryAggregation
    - name
    - dimensions
    - unit
    - type
    - values
    type: object
    properties:
      resourceId:
        description: The id of metric source
        type: string
      startTime:
        format: date-time
        description: The metric start time
        type: string
      endTime:
        format: date-time
        description: The metric end time
        type: string
      timeGrain:
        description: The time grain, time grain indicates frequency of the metric data
        type: string
      primaryAggregation:
        description: The metric aggregation type
        enum:
        - Average
        - Last
        - Maximum
        - Minimum
        - None
        - Total
        type: string
        x-ms-enum:
          name: MetricAggregationType
          modelAsString: false
      name:
        $ref: '#/definitions/MetricName'
        description: The name of the metrics
      dimensions:
        description: The Metric dimension which indicates the source of the metric
        type: array
        items:
          $ref: '#/definitions/MetricDimension'
        x-ms-identifiers:
        - name
      unit:
        description: The unit of the metric data
        enum:
        - Bytes
        - BytesPerSecond
        - Count
        - CountPerSecond
        - Percent
        - Seconds
        type: string
        x-ms-enum:
          name: MetricUnit
          modelAsString: false
      type:
        description: The Type of the metric data
        type: string
      values:
        description: The metric data
        type: array
        items:
          $ref: '#/definitions/MetricData'
        x-ms-identifiers:
        - timeStamp
  Message:
    type: object
    properties:
      language:
        type: string
      value:
        type: string
  MetricAvailablity:
    description: Metric availability specifies the time grain (aggregation interval or frequency) and the retention period for that time grain
    required:
    - timeGrain
    - retention
    type: object
    properties:
      timeGrain:
        description: The time grain, specifies the aggregation interval for the metric.
        type: string
      retention:
        description: The retention period for the metric at the specified timegrain
        type: string
  MetricList:
    description: Collection of metrics
    required:
    - value
    type: object
    properties:
      value:
        description: The value.
        type: array
        items:
          $ref: '#/definitions/Metrics'
        x-ms-identifiers: []
  Error:
    required:
    - errorCode
    - message
    type: object
    properties:
      errorCode:
        type: string
      message:
        $ref: '#/definitions/Message'
      values:
        type: array
        items:
          $ref: '#/definitions/Item'
        x-ms-identifiers:
        - key
  MetricName:
    description: The name of the metric
    required:
    - value
    - localizedValue
    type: object
    properties:
      value:
        description: Name of the metric
        type: string
      localizedValue:
        description: Localized name of the metric
        type: string
  FileShareList:
    description: Collection of file shares
    required:
    - value
    type: object
    properties:
      value:
        description: The value.
        type: array
        items:
          $ref: '#/definitions/FileShare'
parameters:
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: The resource group name
    required: true
    type: string
    x-ms-parameter-location: method
  managerNameParameter:
    name: managerName
    in: path
    description: The manager name
    required: true
    type: string
    maxLength: 50
    minLength: 2
    x-ms-parameter-location: method
  apiVersionParameter:
    name: api-version
    in: query
    description: The api version
    required: true
    type: string
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The subscription id
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'