swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SynchronizationSetting API
schemes:
- https
tags:
- name: SynchronizationSetting
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings/{synchronizationSettingName}
  : get:
      tags:
      - SynchronizationSetting
      summary: Microsoft Azure Get Synchronizationsetting In A Share
      description: Get a synchronizationSetting in a share
      operationId: microsoftAzureSynchronizationsettingsGet
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName'
      - name: shareName
        in: path
        description: The name of the share.
        required: true
        type: string
      - name: synchronizationSettingName
        in: path
        description: The name of the synchronizationSetting.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SynchronizationSetting'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-examples:
        SynchronizationSettings_Get:
          $ref: ./examples/SynchronizationSettings_Get.json
    put:
      tags:
      - SynchronizationSetting
      summary: Microsoft Azure Adds A New Synchronization Setting To An Existing Share
      description: Create a synchronizationSetting
      operationId: microsoftAzureSynchronizationsettingsCreate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName'
      - name: shareName
        in: path
        description: The name of the share to add the synchronization setting to.
        required: true
        type: string
      - name: synchronizationSettingName
        in: path
        description: The name of the synchronizationSetting.
        required: true
        type: string
      - name: synchronizationSetting
        in: body
        description: The new synchronization setting information.
        required: true
        schema:
          $ref: '#/definitions/SynchronizationSetting'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SynchronizationSetting'
        '201':
          description: Success
          schema:
            $ref: '#/definitions/SynchronizationSetting'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-examples:
        SynchronizationSettings_Create:
          $ref: ./examples/SynchronizationSettings_Create.json
    delete:
      tags:
      - SynchronizationSetting
      summary: Microsoft Azure Delete Synchronizationsetting In A Share
      description: Delete a synchronizationSetting in a share
      operationId: microsoftAzureSynchronizationsettingsDelete
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName'
      - name: shareName
        in: path
        description: The name of the share.
        required: true
        type: string
      - name: synchronizationSettingName
        in: path
        description: The name of the synchronizationSetting .
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/OperationResponse'
        '202':
          description: Accepted
        '204':
          description: Success
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-long-running-operation: true
      x-ms-examples:
        SynchronizationSettings_Delete:
          $ref: ./examples/SynchronizationSettings_Delete.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings
  : get:
      tags:
      - SynchronizationSetting
      summary: Microsoft Azure List Synchronizationsettings In A Share
      description: List synchronizationSettings in a share
      operationId: microsoftAzureSynchronizationsettingsListbyshare
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/accountName'
      - name: shareName
        in: path
        description: The name of the share.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - name: $skipToken
        in: query
        description: continuation token
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SynchronizationSettingList'
        default:
          description: An error response received from the Microsoft.DataShare resource provider.
          schema:
            $ref: '#/definitions/DataShareError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        SynchronizationSettings_ListByShare:
          $ref: ./examples/SynchronizationSettings_ListByShare.json
definitions:
  SynchronizationSettingList:
    description: List response for get Synchronization settings
    required:
    - value
    type: object
    properties:
      nextLink:
        description: The Url of next result page.
        type: string
      value:
        description: Collection of items of type DataTransferObjects.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/SynchronizationSetting'
  ProxyDto:
    description: Base data transfer object implementation for proxy resources.
    type: object
    properties:
      id:
        description: The resource id of the azure resource
        type: string
        readOnly: true
      name:
        description: Name of the azure resource
        type: string
        readOnly: true
      type:
        description: Type of the azure resource
        type: string
        readOnly: true
    x-ms-azure-resource: true
  DataShareErrorInfo:
    description: The data share error body model.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Code of the error
        type: string
      details:
        description: Nested details of the error model
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/DataShareErrorInfo'
      message:
        description: Message of the error
        type: string
      target:
        description: Target of the error
        type: string
  SynchronizationSetting:
    description: A Synchronization Setting data transfer object.
    required:
    - kind
    type: object
    allOf:
    - $ref: '#/definitions/ProxyDto'
    properties:
      kind:
        description: Kind of synchronization setting.
        enum:
        - ScheduleBased
        type: string
        x-ms-enum:
          name: synchronizationSettingKind
          modelAsString: true
    discriminator: kind
  DataShareError:
    description: The data share error model.
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/DataShareErrorInfo'
        description: The data share error body
  OperationResponse:
    description: Response for long running operation
    required:
    - status
    type: object
    properties:
      endTime:
        format: date-time
        description: start time
        type: string
      error:
        $ref: '#/definitions/DataShareErrorInfo'
        description: The error property when status is failed.
      startTime:
        format: date-time
        description: start time
        type: string
      status:
        description: Operation state of the long running operation.
        enum:
        - Accepted
        - InProgress
        - TransientFailure
        - Succeeded
        - Failed
        - Canceled
        type: string
        x-ms-enum:
          name: status
          modelAsString: true
parameters:
  resourceGroupName:
    name: resourceGroupName
    in: path
    description: The resource group name.
    required: true
    type: string
    x-ms-parameter-location: method
  accountName:
    name: accountName
    in: path
    description: The name of the share account.
    required: true
    type: string
    x-ms-parameter-location: method
  subscriptionId:
    name: subscriptionId
    in: path
    description: The subscription identifier
    required: true
    type: string
  api-version:
    name: api-version
    in: query
    description: The api version to use.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'