Microsoft Azure Shares API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Shares API
tags:
- name: Shares
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares
  : get:
      tags:
      - Shares
      summary: Microsoft Azure Lists All The Shares In A Data Box Edge Data Box Gateway Device
      operationId: microsoftAzureSharesListbydataboxedgedevice
      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/apiVersionParameter'
      responses:
        '200':
          description: The collection of all the shares on the device.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ShareGetAllInDevice:
          $ref: ./examples/ShareGetAllInDevice.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}
  : get:
      tags:
      - Shares
      summary: Microsoft Azure Gets A Share By Name
      operationId: microsoftAzureSharesGet
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The share name.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The share details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Share'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        ShareGet:
          $ref: ./examples/ShareGet.json
      description: Needs a more full description created.
    put:
      tags:
      - Shares
      summary: Microsoft Azure Creates A New Share Or Updates An Existing Share On The Device
      operationId: microsoftAzureSharesCreateorupdate
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The share name.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the share.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Share'
        '202':
          description: Accepted the request to create or update the share.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        SharePut:
          $ref: ./examples/SharePut.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Share'
        description: The share properties.
        required: true
    delete:
      tags:
      - Shares
      description: Deletes the share on the Data Box Edge/Data Box Gateway device.
      operationId: microsoftAzureSharesDelete
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The share name.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the share.
        '202':
          description: Accepted the request to delete the share.
        '204':
          description: The share is already deleted.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        ShareDelete:
          $ref: ./examples/ShareDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Shares Name
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}/refresh
  : post:
      tags:
      - Shares
      summary: Microsoft Azure Refreshes The Share Metadata With The Data From The Cloud
      operationId: microsoftAzureSharesRefresh
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The share name.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully refreshed the share on the device.
        '202':
          description: Accepted the request to refresh the share on the device.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        ShareRefreshPost:
          $ref: ./examples/ShareRefreshPost.json
      description: Needs a more full description created.
components:
  schemas:
    ShareList:
      description: Collection of all the shares on the Data Box Edge/Gateway device.
      type: object
      properties:
        value:
          description: The list of shares.
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/Share'
          readOnly: true
          x-ms-identifiers: []
        nextLink:
          description: Link to the next set of results.
          type: string
          readOnly: true
    CloudError:
      description: An error response from the service.
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody'
          description: The error details.
      x-ms-external: true
    ShareProperties:
      description: The share properties.
      required:
      - shareStatus
      - monitoringStatus
      - accessProtocol
      type: object
      properties:
        description:
          description: Description for the share.
          type: string
        shareStatus:
          description: Current status of the share.
          enum:
          - Offline
          - Unknown
          - OK
          - Updating
          - NeedsAttention
          type: string
          x-ms-enum:
            name: ShareStatus
            modelAsString: true
        monitoringStatus:
          description: Current monitoring status of the share.
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            name: MonitoringStatus
            modelAsString: true
        azureContainerInfo:
          $ref: '#/components/schemas/AzureContainerInfo'
          description: Azure container mapping for the share.
        accessProtocol:
          description: Access protocol to be used by the share.
          enum:
          - SMB
          - NFS
          type: string
          x-ms-enum:
            name: ShareAccessProtocol
            modelAsString: true
        userAccessRights:
          description: Mapping of users and corresponding access rights on the share (required for SMB protocol).
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/UserAccessRight'
          x-ms-identifiers:
          - userId
        clientAccessRights:
          description: List of IP addresses and corresponding access rights on the share(required for NFS protocol).
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/ClientAccessRight'
          x-ms-identifiers:
          - client
        refreshDetails:
          $ref: '#/components/schemas/RefreshDetails'
          description: Details of the refresh job on this share.
        shareMappings:
          description: Share mount point to the role.
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/MountPointMap'
          x-ms-identifiers:
          - shareId
          readOnly: true
        dataPolicy:
          description: Data policy of the share.
          enum:
          - Cloud
          - Local
          type: string
          x-ms-enum:
            name: DataPolicy
            modelAsString: true
    AzureContainerInfo:
      description: Azure container mapping of the endpoint.
      required:
      - storageAccountCredentialId
      - containerName
      - dataFormat
      type: object
      properties:
        storageAccountCredentialId:
          description: ID of the storage account credential used to access storage.
          type: string
        containerName:
          description: Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).
          type: string
        dataFormat:
          description: Storage format used for the file represented by the share.
          enum:
          - BlockBlob
          - PageBlob
          - AzureFile
          type: string
          x-ms-enum:
            name: AzureContainerDataFormat
            modelAsString: true
    UserAccessRight:
      description: The mapping between a particular user and the access type on the SMB share.
      required:
      - userId
      - accessType
      type: object
      properties:
        userId:
          description: User ID (already existing in the device).
          type: string
        accessType:
          description: Type of access to be allowed for the user.
          enum:
          - Change
          - Read
          - Custom
          type: string
          x-ms-enum:
            name: ShareAccessType
            modelAsString: true
    MountPointMap:
      description: The share mount point.
      required:
      - shareId
      type: object
      properties:
        shareId:
          description: ID of the share mounted to the role VM.
          type: string
        roleId:
          description: ID of the role to which share is mounted.
          type: string
          readOnly: true
        mountPoint:
          description: Mount point for the share.
          type: string
          readOnly: true
        mountType:
          description: Mounting type.
          enum:
          - Volume
          - HostPath
          type: string
          readOnly: true
          x-ms-enum:
            name: MountType
            modelAsString: true
        roleType:
          description: Role type.
          enum:
          - IOT
          - ASA
          - Functions
          - Cognitive
          - MEC
          - CloudEdgeManagement
          - Kubernetes
          type: string
          readOnly: true
          x-ms-enum:
            name: RoleTypes
            modelAsString: true
    Share:
      description: Represents a share on the  Data Box Edge/Gateway device.
      required:
      - properties
      type: object
      allOf:
      - $ref: '#/components/schemas/ARMBaseModel'
      properties:
        properties:
          $ref: '#/components/schemas/ShareProperties'
          description: The share properties.
          x-ms-client-flatten: true
        systemData:
          $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
          description: Metadata pertaining to creation and last modification of Share
          readOnly: true
    ClientAccessRight:
      description: The mapping between a particular client IP and the type of access client has on the NFS share.
      required:
      - client
      - accessPermission
      type: object
      properties:
        client:
          description: IP of the client.
          type: string
        accessPermission:
          description: Type of access to be allowed for the client.
          enum:
          - NoAccess
          - ReadOnly
          - ReadWrite
          type: string
          x-ms-enum:
            name: ClientPermissionType
            modelAsString: true
    ARMBaseModel:
      description: Represents the base class for all object models.
      type: object
      properties:
        id:
          description: The path ID that uniquely identifies the object.
          type: string
          readOnly: true
        name:
          description: The object name.
          type: string
          readOnly: true
        type:
          description: The hierarchical type of the object.
          type: string
          readOnly: true
      x-ms-azure-resource: true
    RefreshDetails:
      description: Fields for tracking refresh job on the share or container.
      type: object
      properties:
        inProgressRefreshJobId:
          description: If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress.
          type: string
        lastCompletedRefreshJobTimeInUTC:
          format: date-time
          description: Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job.
          type: string
        errorManifestFile:
          description: Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job.
          type: string
        lastJob:
          description: Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job.
          type: string
    CloudErrorBody:
      description: An error response from the service.
      type: object
      properties:
        code:
          description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
          type: string
        message:
          description: A message describing the error, intended to be suitable for display in a user interface.
          type: string
        details:
          description: A list of additional details about the error.
          type: array
          items:
            $ref: '#/components/schemas/CloudErrorBody'
          x-ms-identifiers: []
      x-ms-external: true
  parameters:
    apiVersionParameter:
      name: api-version
      in: query
      description: The API version.
      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
    subscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The subscription ID.
      required: true
      schema:
        type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'