swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Backup Restore API schemes: - https tags: - name: Backup Restore paths: ? /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: - Backup Restore 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: - Backup Restore 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: - Backup Restore 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: - Backup Restore 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: - Backup Restore 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}/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: - Backup Restore 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: 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. 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 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. PostBackupResponseProperties: type: object description: Post Backup Response Properties object. properties: cloudEndpointName: type: string description: cloud endpoint Name. readOnly: true PostBackupResponse: type: object description: Post Backup Response properties: backupMetadata: x-ms-client-flatten: true $ref: '#/definitions/PostBackupResponseProperties' description: Post Backup Response Properties 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. 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 BackupRequest: type: object description: Backup request properties: azureFileShare: type: string description: Azure File Share. x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'