Microsoft Azure File Servers API

openapi: 3.2.0
info:
  version: '2016-10-01'
  title: Microsoft Azure StorSimpleManagementClient File Servers API
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: File Servers
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers
  : get:
      tags:
      - File Servers
      description: Retrieves all the file servers in a device.
      operationId: microsoftAzureFileserversListbydevice
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The collection of file servers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileServerList'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        FileServersListByDevice:
          $ref: ./examples/FileServersListByDevice.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}
  : get:
      tags:
      - File Servers
      description: Returns the properties of the specified file server name.
      operationId: microsoftAzureFileserversGet
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        schema:
          type: string
      - name: fileServerName
        in: path
        description: The file server name.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The file server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileServer'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
      x-ms-examples:
        FileServersGet:
          $ref: ./examples/FileServersGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - File Servers
      description: Creates or updates the file server.
      operationId: microsoftAzureFileserversCreateorupdate
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        schema:
          type: string
      - name: fileServerName
        in: path
        description: The file server name.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the file server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileServer'
        '202':
          description: Accepted the request to create or update the file server.
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        FileServersCreateOrUpdate:
          $ref: ./examples/FileServersCreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileServer'
        description: The file server.
        required: true
    delete:
      tags:
      - File Servers
      description: Deletes the file server.
      operationId: microsoftAzureFileserversDelete
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        schema:
          type: string
      - name: fileServerName
        in: path
        description: The file server name.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '202':
          description: Accepted the request to delete the file server.
        '204':
          description: Successfully deleted the file server.
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        FileServersDelete:
          $ref: ./examples/FileServersDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/backup
  : post:
      tags:
      - File Servers
      description: Backup the file server now.
      operationId: microsoftAzureFileserversBackupnow
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        schema:
          type: string
      - name: fileServerName
        in: path
        description: The file server name.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '202':
          description: Accepted the request to backup the file server.
        '204':
          description: Successfully completed backup of the file server.
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        FileServersBackupNow:
          $ref: ./examples/FileServersBackupNow.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/metrics
  : get:
      tags:
      - File Servers
      description: Gets the file server metrics.
      operationId: microsoftAzureFileserversListmetrics
      parameters:
      - name: deviceName
        in: path
        description: The name of the device.
        required: true
        schema:
          type: string
      - name: fileServerName
        in: path
        description: The name of the file server name.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      - name: $filter
        in: query
        description: OData Filter options
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The collection of metrics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricList'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
      x-ms-odata: '#/definitions/MetricFilter'
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        FileServersListMetrics:
          $ref: ./examples/FileServersListMetrics.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/fileservers/{fileServerName}/metricsDefinitions
  : get:
      tags:
      - File Servers
      description: Retrieves metric definitions of all metrics aggregated at the file server.
      operationId: microsoftAzureFileserversListmetricdefinition
      parameters:
      - name: deviceName
        in: path
        description: The name of the device.
        required: true
        schema:
          type: string
      - name: fileServerName
        in: path
        description: The name of the file server.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The collection of metric definitions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricDefinitionList'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        FileServersListMetricDefinition:
          $ref: ./examples/FileServersListMetricDefinition.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/fileservers
  : get:
      tags:
      - File Servers
      description: Retrieves all the file servers in a manager.
      operationId: microsoftAzureFileserversListbymanager
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The collection of file servers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileServerList'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        FileServersListByManager:
          $ref: ./examples/FileServersListByManager.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
components:
  parameters:
    subscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The subscription id
      required: true
      schema:
        type: string
    resourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The resource group name
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    managerNameParameter:
      name: managerName
      in: path
      description: The manager name
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 50
        minLength: 2
    apiVersionParameter:
      name: api-version
      in: query
      description: The api version
      required: true
      schema:
        type: string
  schemas:
    MetricList:
      description: Collection of metrics
      required:
      - value
      type: object
      properties:
        value:
          description: The value.
          type: array
          items:
            $ref: '#/components/schemas/Metrics'
          x-ms-identifiers: []
    Item:
      required:
      - key
      - value
      type: object
      properties:
        key:
          type: string
        value:
          type: string
    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: '#/components/schemas/MetricName'
          description: The name of the metrics
        dimensions:
          description: The Metric dimension which indicates the source of the metric
          type: array
          items:
            $ref: '#/components/schemas/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: '#/components/schemas/MetricData'
          x-ms-identifiers:
          - timeStamp
    FileServerProperties:
      description: The file server properties.
      required:
      - domainName
      - storageDomainId
      - backupScheduleGroupId
      type: object
      properties:
        domainName:
          description: Domain of the file server
          type: string
        storageDomainId:
          description: The storage domain id.
          type: string
        backupScheduleGroupId:
          description: The backup policy id.
          type: string
        description:
          description: The description of the file server
          type: string
    FileServerList:
      description: Collection of file servers
      required:
      - value
      type: object
      properties:
        value:
          description: The value.
          type: array
          items:
            $ref: '#/components/schemas/FileServer'
    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
    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
    Error:
      required:
      - errorCode
      - message
      type: object
      properties:
        errorCode:
          type: string
        message:
          $ref: '#/components/schemas/Message'
        values:
          type: array
          items:
            $ref: '#/components/schemas/Item'
          x-ms-identifiers:
          - key
    MetricDefinition:
      description: Monitoring metric definition represents the metadata of the metrics.
      required:
      - name
      - unit
      - primaryAggregationType
      - resourceId
      - metricAvailabilities
      - dimensions
      - type
      type: object
      properties:
        name:
          $ref: '#/components/schemas/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: '#/components/schemas/MetricAvailablity'
          x-ms-identifiers:
          - timeGrain
        dimensions:
          description: The supported dimensions
          type: array
          items:
            $ref: '#/components/schemas/MetricDimension'
          x-ms-identifiers:
          - name
        type:
          description: The metric definition type
          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
    Message:
      type: object
      properties:
        language:
          type: string
        value:
          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
    FileServer:
      description: The file server.
      required:
      - properties
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseModel'
      properties:
        properties:
          $ref: '#/components/schemas/FileServerProperties'
          description: The properties.
          x-ms-client-flatten: true
    MetricDefinitionList:
      description: List of metric definition
      required:
      - value
      type: object
      properties:
        value:
          description: The list of metric definition
          type: array
          items:
            $ref: '#/components/schemas/MetricDefinition'
          x-ms-identifiers:
          - name
    MetricDimension:
      description: Metric dimension
      required:
      - name
      - value
      type: object
      properties:
        name:
          description: Metric dimension name
          type: string
        value:
          description: Metric dimension values
          type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow