swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Change Detection API
schemes:
- https
tags:
- name: Change Detection
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/triggerChangeDetection
  : post:
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: storageSyncServiceName
        in: path
        description: Name of Storage Sync Service resource.
        required: true
        type: string
      - name: syncGroupName
        in: path
        description: Name of Sync Group resource.
        required: true
        type: string
      - name: cloudEndpointName
        in: path
        description: Name of Cloud Endpoint object.
        required: true
        type: string
      - name: parameters
        in: body
        description: Trigger Change Detection Action parameters.
        required: true
        schema:
          $ref: '#/definitions/TriggerChangeDetectionParameters'
      tags:
      - Change Detection
      operationId: microsoftAzureCloudendpointsTriggerchangedetection
      description: Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.
      x-ms-examples:
        CloudEndpoints_TriggerChangeDetection:
          $ref: ./examples/CloudEndpoints_TriggerChangeDetection.json
      responses:
        '200':
          description: Ok
        '202':
          description: Asynchronous Operation Status Location
          headers:
            Location:
              description: Operation Status Location URI
              type: string
            x-ms-request-id:
              description: request id.
              type: string
            x-ms-correlation-request-id:
              description: correlation request id.
              type: string
        default:
          description: Error message indicating why the operation failed.
          schema:
            $ref: '#/definitions/StorageSyncError'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Cloudendpoints Cloudendpointname Triggerchangedetection
definitions:
  StorageSyncError:
    type: object
    description: Error type
    properties:
      error:
        $ref: '#/definitions/StorageSyncApiError'
        description: Error details of the given entry.
      innererror:
        $ref: '#/definitions/StorageSyncApiError'
        description: Error details of the given entry.
  TriggerChangeDetectionParameters:
    type: object
    properties:
      directoryPath:
        type: string
        description: Relative path to a directory Azure File share for which change detection is to be performed.
      changeDetectionMode:
        type: string
        description: Change Detection Mode. Applies to a directory specified in directoryPath parameter.
        enum:
        - Default
        - Recursive
        x-ms-enum:
          name: changeDetectionMode
          modelAsString: true
      paths:
        type: array
        items:
          type: string
        x-ms-identifiers: []
        description: Array of relative paths on the Azure File share to be included in the change detection. Can be files and directories.
    description: The parameters used when calling trigger change detection action on cloud endpoint.
  StorageSyncApiError:
    type: object
    description: Error type
    properties:
      code:
        type: string
        description: Error code of the given entry.
      message:
        type: string
        description: Error message of the given entry.
      target:
        type: string
        description: Target of the given error entry.
      details:
        $ref: '#/definitions/StorageSyncErrorDetails'
        description: Error details of the given entry.
      innererror:
        $ref: '#/definitions/StorageSyncInnerErrorDetails'
        description: Inner error details of the given entry.
  StorageSyncErrorDetails:
    type: object
    description: Error Details object.
    properties:
      code:
        type: string
        description: Error code of the given entry.
      message:
        type: string
        description: Error message of the given entry.
      target:
        type: string
        description: Target of the given entry.
      requestUri:
        type: string
        description: Request URI of the given entry.
      exceptionType:
        type: string
        description: Exception type of the given entry.
      httpMethod:
        type: string
        description: HTTP method of the given entry.
      hashedMessage:
        type: string
        description: Hashed message of the given entry.
      httpErrorCode:
        type: string
        description: HTTP error code of the given entry.
  StorageSyncInnerErrorDetails:
    type: object
    description: Error Details object.
    properties:
      callStack:
        type: string
        description: Call stack of the error.
      message:
        type: string
        description: Error message of the error.
      innerException:
        type: string
        description: Exception of the inner error.
      innerExceptionCallStack:
        type: string
        description: Call stack of the inner error.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'