swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector CloudEndpoint Resource API schemes: - https tags: - name: CloudEndpoint Resource paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName} : put: 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: Body of Cloud Endpoint resource. required: true schema: $ref: '#/definitions/CloudEndpointCreateParameters' tags: - CloudEndpoint Resource operationId: microsoftAzureCloudendpointsCreate description: Create a new CloudEndpoint. x-ms-examples: CloudEndpoints_Create: $ref: ./examples/CloudEndpoints_Create.json responses: '200': description: Cloud Endpoint object schema: $ref: '#/definitions/CloudEndpoint' headers: x-ms-request-id: description: request id. type: string x-ms-correlation-request-id: description: correlation request id. type: string '202': description: Asynchronous Operation Status Location headers: Azure-AsyncOperation: description: Operation Status Location URI type: string Location: description: Operation Status Location URI type: string Retry-After: description: Retry After 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 Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Cloudendpoints Cloudendpointname get: 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 tags: - CloudEndpoint Resource operationId: microsoftAzureCloudendpointsGet description: Get a given CloudEndpoint. x-ms-examples: CloudEndpoints_Get: $ref: ./examples/CloudEndpoints_Get.json responses: '200': description: Cloud Endpoint object schema: $ref: '#/definitions/CloudEndpoint' headers: 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' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Cloudendpoints Cloudendpointname delete: 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 tags: - CloudEndpoint Resource operationId: microsoftAzureCloudendpointsDelete description: Delete a given CloudEndpoint. x-ms-examples: CloudEndpoints_Delete: $ref: ./examples/CloudEndpoints_Delete.json responses: '200': description: Ok headers: x-ms-request-id: description: request id. type: string x-ms-correlation-request-id: description: correlation request id. type: string '202': description: Asynchronous Operation Status Location headers: Azure-AsyncOperation: description: Operation Status Location URI type: string Location: description: Operation Status Location URI type: string Retry-After: description: Retry After type: string x-ms-request-id: description: Request id type: string x-ms-correlation-request-id: description: correlation request id type: string '204': description: Resource doesn't exist default: description: Error message indicating why the operation failed. schema: $ref: '#/definitions/StorageSyncError' x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Cloudendpoints Cloudendpointname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints : get: 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 tags: - CloudEndpoint Resource operationId: microsoftAzureCloudendpointsListbysyncgroup description: Get a CloudEndpoint List. x-ms-examples: CloudEndpoints_ListBySyncGroup: $ref: ./examples/CloudEndpoints_ListBySyncGroup.json responses: '200': description: Array of Cloud Endpoint resources in Sync Group schema: $ref: '#/definitions/CloudEndpointArray' headers: 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-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Cloudendpoints ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prebackup : 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: Body of Backup request. required: true schema: $ref: '#/definitions/BackupRequest' tags: - CloudEndpoint Resource operationId: microsoftAzureCloudendpointsPrebackup description: Pre Backup a given CloudEndpoint. x-ms-examples: CloudEndpoints_PreBackup: $ref: ./examples/CloudEndpoints_PreBackup.json responses: '200': description: Ok 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 '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 Prebackup ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postbackup : 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: Body of Backup request. required: true schema: $ref: '#/definitions/BackupRequest' tags: - CloudEndpoint Resource operationId: microsoftAzureCloudendpointsPostbackup description: Post Backup a given CloudEndpoint. x-ms-examples: CloudEndpoints_PostBackup: $ref: ./examples/CloudEndpoints_PostBackup.json responses: '200': description: Ok schema: $ref: '#/definitions/PostBackupResponse' 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 '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 Postbackup ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prerestore : 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: Body of Cloud Endpoint object. required: true schema: $ref: '#/definitions/PreRestoreRequest' tags: - CloudEndpoint Resource operationId: microsoftAzureCloudendpointsPrerestore description: Pre Restore a given CloudEndpoint. x-ms-examples: CloudEndpoints_PreRestore: $ref: ./examples/CloudEndpoints_PreRestore.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 Prerestore ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/restoreheartbeat : 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 tags: - CloudEndpoint Resource operationId: microsoftAzureCloudendpointsRestoreheartbeat description: Restore Heartbeat a given CloudEndpoint. x-ms-examples: CloudEndpoints_restoreheartbeat: $ref: ./examples/CloudEndpoints_RestoreHeatbeat.json responses: '200': description: Restore Heartbeat Operation has ran successfully. headers: 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' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Cloudendpoints Cloudendpointname Restoreheartbeat ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postrestore : 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: Body of Cloud Endpoint object. required: true schema: $ref: '#/definitions/PostRestoreRequest' tags: - CloudEndpoint Resource operationId: microsoftAzureCloudendpointsPostrestore description: Post Restore a given CloudEndpoint. x-ms-examples: CloudEndpoints_PostRestore: $ref: ./examples/CloudEndpoints_PostRestore.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 Postrestore ? /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: - CloudEndpoint Resource 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 ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/afsShareMetadataCertificatePublicKeys : get: 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 tags: - CloudEndpoint Resource operationId: microsoftAzureCloudendpointsAfssharemetadatacertificatepublickeys description: Get the AFS file share metadata signing certificate public keys. x-ms-examples: CloudEndpoints_AfsShareMetadataCertificatePublicKeys: $ref: ./examples/CloudEndpoints_AfsShareMetadataCertificatePublicKeys.json responses: '200': description: AFS file share metadata signing certificate public keys. schema: $ref: '#/definitions/CloudEndpointAfsShareMetadataCertificatePublicKeys' headers: 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' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Cloudendpoints Cloudendpointname Afssharemetadatacertificatepublickeys definitions: CloudEndpointChangeEnumerationTotalCountsState: type: string description: State of the total counts of change enumeration activity enum: - Calculating - Final x-ms-enum: name: CloudEndpointChangeEnumerationTotalCountsState modelAsString: true CloudEndpointAfsShareMetadataCertificatePublicKeys: type: object description: Cloud endpoint AFS file share metadata signing certificate public keys. properties: firstKey: type: string description: The first public key. readOnly: true secondKey: type: string description: The second public key. readOnly: true 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. CloudEndpointCreateParameters: type: object allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/CloudEndpointCreateParametersProperties' description: The parameters used to create the cloud endpoint. description: The parameters used when creating a cloud endpoint. CloudEndpointCreateParametersProperties: type: object description: CloudEndpoint Properties object. properties: storageAccountResourceId: type: string description: Storage Account Resource Id azureFileShareName: type: string description: Azure file share name storageAccountTenantId: type: string description: Storage Account Tenant Id friendlyName: type: string description: Friendly Name CloudEndpointLastChangeEnumerationStatus: type: object description: Cloud endpoint change enumeration status object properties: startedTimestamp: type: string format: date-time description: Timestamp when change enumeration started readOnly: true completedTimestamp: type: string format: date-time description: Timestamp when change enumeration completed readOnly: true namespaceFilesCount: type: integer format: int64 minimum: 0 description: Count of files in the namespace readOnly: true namespaceDirectoriesCount: type: integer format: int64 minimum: 0 description: Count of directories in the namespace readOnly: true namespaceSizeBytes: type: integer format: int64 minimum: 0 description: Namespace size in bytes readOnly: true nextRunTimestamp: type: string format: date-time description: Timestamp of when change enumeration is expected to run again readOnly: true 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. 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. CloudEndpointProperties: type: object description: CloudEndpoint Properties object. properties: storageAccountResourceId: type: string description: Storage Account Resource Id azureFileShareName: type: string description: Azure file share name storageAccountTenantId: type: string description: Storage Account Tenant Id partnershipId: type: string description: Partnership Id friendlyName: type: string description: Friendly Name backupEnabled: type: string description: Backup Enabled readOnly: true provisioningState: type: string description: CloudEndpoint Provisioning State lastWorkflowId: type: string description: CloudEndpoint lastWorkflowId lastOperationName: type: string description: Resource Last Operation Name changeEnumerationStatus: $ref: '#/definitions/CloudEndpointChangeEnumerationStatus' description: Cloud endpoint change enumeration status readOnly: true CloudEndpointChangeEnumerationActivityState: type: string description: State of change enumeration activity enum: - InitialEnumerationInProgress - EnumerationInProgress x-ms-enum: name: CloudEndpointChangeEnumerationActivityState modelAsString: true CloudEndpointChangeEnumerationStatus: type: object description: Cloud endpoint change enumeration status object properties: lastUpdatedTimestamp: type: string format: date-time description: Last updated timestamp readOnly: true lastEnumerationStatus: $ref: '#/definitions/CloudEndpointLastChangeEnumerationStatus' description: Status of last completed change enumeration readOnly: true activity: $ref: '#/definitions/CloudEndpointChangeEnumerationActivity' description: Change enumeration activity readOnly: true CloudEndpointChangeEnumerationActivity: type: object description: Cloud endpoint change enumeration activity object properties: lastUpdatedTimestamp: type: string format: date-time description: Last updated timestamp readOnly: true operationState: $ref: '#/definitions/CloudEndpointChangeEnumerationActivityState' description: Change enumeration operation state readOnly: true statusCode: type: integer format: int32 description: When non-zero, indicates an issue that is delaying change enumeration readOnly: true startedTimestamp: type: string format: date-time description: Timestamp when change enumeration started readOnly: true processedFilesCount: type: integer format: int64 minimum: 0 description: Count of files processed readOnly: true processedDirectoriesCount: type: integer format: int64 minimum: 0 description: Count of directories processed readOnly: true totalFilesCount: type: integer format: int64 minimum: 0 description: Total count of files enumerated readOnly: true totalDirectoriesCount: type: integer format: int64 minimum: 0 description: Total count of directories enumerated readOnly: true totalSizeBytes: type: integer format: int64 minimum: 0 description: Total enumerated size in bytes readOnly: true progressPercent: type: integer format: int32 minimum: 0 maximum: 100 description: Progress percentage for change enumeration run, excluding processing of deletes readOnly: true minutesRemaining: type: integer format: int32 minimum: 0 description: Estimate of time remaining for the enumeration run readOnly: true totalCountsState: $ref: '#/definitions/CloudEndpointChangeEnumerationTotalCountsState' description: Change enumeration total counts state readOnly: true deletesProgressPercent: type: integer format: int32 minimum: 0 maximum: 100 description: Progress percentage for processing deletes. This is done separately from the rest of the enumeration run readOnly: true CloudEndpoint: type: object description: Cloud Endpoint object. allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/CloudEndpointProperties' description: Cloud Endpoint properties. PostBackupResponse: type: object description: Post Backup Response properties: backupMetadata: x-ms-client-flatten: true $ref: '#/definitions/PostBackupResponseProperties' description: Post Backup Response Properties PostRestoreRequest: type: object description: Post Restore Request properties: partition: type: string description: Post Restore partition. replicaGroup: type: string description: Post Restore replica group. requestId: type: string description: Post Restore request id. azureFileShareUri: type: string description: Post Restore Azure file share uri. status: type: string description: Post Restore Azure status. sourceAzureFileShareUri: type: string description: Post Restore Azure source azure file share uri. failedFileList: type: string description: Post Restore Azure failed file list. restoreFileSpec: type: array description: Post Restore restore file spec array. items: $ref: '#/definitions/RestoreFileSpec' description: Post Restore restore file spec items array. x-ms-identifiers: - path RestoreFileSpec: type: object description: Restore file spec. properties: path: type: string description: Restore file spec path isdir: type: boolean description: Restore file spec isdir PostBackupResponseProperties: type: object description: Post Backup Response Properties object. properties: cloudEndpointName: type: string description: cloud endpoint Name. readOnly: true 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. 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. PreRestoreRequest: type: object description: Pre Restore request object. properties: partition: type: string description: Pre Restore partition. replicaGroup: type: string description: Pre Restore replica group. requestId: type: string description: Pre Restore request id. azureFileShareUri: type: string description: Pre Restore Azure file share uri. status: type: string description: Pre Restore Azure status. sourceAzureFileShareUri: type: string description: Pre Restore Azure source azure file share uri. backupMetadataPropertyBag: type: string description: Pre Restore backup metadata property bag. restoreFileSpec: type: array description: Pre Restore restore file spec array. items: $ref: '#/definitions/RestoreFileSpec' description: Pre Restore restore file spec items array. x-ms-identifiers: - path pauseWaitForSyncDrainTimePeriodInSeconds: type: integer format: int32 description: Pre Restore pause wait for sync drain time period in seconds. BackupRequest: type: object description: Backup request properties: azureFileShare: type: string description: Azure File Share. CloudEndpointArray: type: object description: Array of CloudEndpoint properties: value: type: array description: Collection of CloudEndpoint. items: $ref: '#/definitions/CloudEndpoint' x-ms-identifiers: - id x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'