swagger: '2.0' info: title: Microsoft Azure Microsoft Storage Sync description: >- Microsoft Storage Sync Service API. This belongs to Microsoft.StorageSync Resource Provider version: '2022-09-01' x-ms-code-generation-settings: name: StorageSyncManagementClient host: management.azure.com schemes: - https consumes: - application/json produces: - application/json paths: /providers/Microsoft.StorageSync/operations: get: tags: - Operations - ResourceProvider operationId: microsoftAzureOperationsList parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter description: Lists all of the available Storage Sync Rest API operations. x-ms-examples: Operations_List: $ref: ./examples/Operations_List.json responses: '200': description: Array of operations resources in the Resource Provider schema: $ref: '#/definitions/OperationEntityListResult' 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' deprecated: false x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Storagesync Operations /subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/locations/{locationName}/checkNameAvailability: post: tags: - StorageSyncService operationId: microsoftAzureStoragesyncservicesChecknameavailability x-ms-examples: StorageSyncServiceCheckNameAvailability_Available: $ref: ./examples/StorageSyncServiceCheckNameAvailability_Available.json StorageSyncServiceCheckNameAvailability_AlreadyExists: $ref: >- ./examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json description: Check the give namespace name availability. parameters: - name: locationName in: path required: true type: string description: The desired region for the name check. - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - name: parameters in: body required: true schema: $ref: '#/definitions/CheckNameAvailabilityParameters' description: Parameters to check availability of the given namespace name responses: '200': description: check availability returned successfully. schema: $ref: '#/definitions/CheckNameAvailabilityResult' default: description: Error message indicating why the operation failed. schema: $ref: '#/definitions/StorageSyncError' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Storagesync Locations Locationname Checknameavailability ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName} : 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: parameters in: body description: Storage Sync Service resource name. required: true schema: $ref: '#/definitions/StorageSyncServiceCreateParameters' tags: - StorageSyncServices Resource operationId: microsoftAzureStoragesyncservicesCreate description: Create a new StorageSyncService. x-ms-examples: StorageSyncServices_Create: $ref: ./examples/StorageSyncServices_Create.json responses: '200': description: Storage Sync Service object created/updated schema: $ref: '#/definitions/StorageSyncService' '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 get: parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: storageSyncServiceName in: path description: Name of Storage Sync Service resource. required: true type: string - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter tags: - StorageSyncServices Resource operationId: microsoftAzureStoragesyncservicesGet description: Get a given StorageSyncService. x-ms-examples: StorageSyncServices_Get: $ref: ./examples/StorageSyncServices_Get.json responses: '200': description: Storage Sync Service object schema: $ref: '#/definitions/StorageSyncService' 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 patch: 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: parameters in: body description: Storage Sync Service resource. schema: $ref: '#/definitions/StorageSyncServiceUpdateParameters' tags: - StorageSyncServices Resource operationId: microsoftAzureStoragesyncservicesUpdate description: Patch a given StorageSyncService. x-ms-examples: StorageSyncServices_Update: $ref: ./examples/StorageSyncServices_Update.json responses: '200': description: Storage Sync Service object created/updated schema: $ref: '#/definitions/StorageSyncService' 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 Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename 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 tags: - StorageSyncServices Resource operationId: microsoftAzureStoragesyncservicesDelete description: Delete a given StorageSyncService. x-ms-examples: StorageSyncServices_Delete: $ref: ./examples/StorageSyncServices_Delete.json responses: '200': description: Storage Sync Service object was deleted. 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: Storage Sync Service 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 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices: 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 tags: - StorageSyncServices Resource operationId: microsoftAzureStoragesyncservicesListbyresourcegroup description: Get a StorageSyncService list by Resource group name. x-ms-examples: StorageSyncServices_ListByResourceGroup: $ref: ./examples/StorageSyncServices_ListByResourceGroup.json responses: '200': description: >- Array of registered Storage Sync Service resources in the Resource Group schema: $ref: '#/definitions/StorageSyncServiceArray' 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: summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices /subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/storageSyncServices: get: parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter tags: - StorageSyncServices Resource operationId: microsoftAzureStoragesyncservicesListbysubscription description: Get a StorageSyncService list by subscription. x-ms-examples: StorageSyncServices_ListBySubscription: $ref: ./examples/StorageSyncServices_ListBySubscription.json responses: '200': description: >- Array of registered Storage Sync Service resources in the subscription. schema: $ref: '#/definitions/StorageSyncServiceArray' 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: summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Storagesync Storagesyncservices ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateLinkResources : get: tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesListbystoragesyncservice description: >- Gets the private link resources that need to be created for a storage sync service. x-ms-examples: PrivateLinkResources_List: $ref: ./examples/PrivateLinkResources_List.json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageSyncServiceNameParameter' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Successfully retrieved private link resources. schema: $ref: >- ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResourceListResult 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 Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsGet description: >- Gets the specified private endpoint connection associated with the storage sync service. x-ms-examples: PrivateEndpointConnections_Get: $ref: ./examples/PrivateEndpointConnections_Get.json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageSyncServiceNameParameter' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: OK -- Get the private endpoint connection properties successfully. schema: $ref: >- ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/StorageSyncError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Privateendpointconnections Privateendpointconnectionname put: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsCreate description: >- Update the state of specified private endpoint connection associated with the storage sync service. x-ms-examples: PrivateEndpointConnections_Create: $ref: ./examples/PrivateEndpointConnections_Create.json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageSyncServiceNameParameter' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName - name: properties in: body required: true schema: $ref: >- ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. responses: '200': description: >- OK -- Update the private endpoint connection properties successfully. schema: $ref: >- ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection '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 response describing 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 Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsDelete description: >- Deletes the specified private endpoint connection associated with the storage sync service. x-ms-examples: PrivateEndpointConnections_Delete: $ref: ./examples/PrivateEndpointConnections_Delete.json parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageSyncServiceNameParameter' - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: OK -- Delete the private endpoint connection successfully. '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: No Content -- The private endpoint connection does not exist. default: description: Error response describing 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 Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateEndpointConnections : 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 tags: - PrivateEndpointConnection Resource operationId: microsoftAzurePrivateendpointconnectionsListbystoragesyncservice description: Get a PrivateEndpointConnection List. x-ms-examples: PrivateEndpointConnections_ListByStorageSyncService: $ref: ./examples/PrivateEndpointConnections_ListByStorageSyncService.json responses: '200': description: Array of Sync Group resources in Storage Sync Service schema: $ref: >- ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnectionListResult 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: summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups : 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 tags: - SyncGroup Resource operationId: microsoftAzureSyncgroupsListbystoragesyncservice description: Get a SyncGroup List. x-ms-examples: SyncGroups_ListByStorageSyncService: $ref: ./examples/SyncGroups_ListByStorageSyncService.json responses: '200': description: Array of Sync Group resources in Storage Sync Service schema: $ref: '#/definitions/SyncGroupArray' 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: summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName} : 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: parameters in: body description: Sync Group Body required: true schema: $ref: '#/definitions/SyncGroupCreateParameters' tags: - SyncGroup Resource operationId: microsoftAzureSyncgroupsCreate description: Create a new SyncGroup. x-ms-examples: SyncGroups_Create: $ref: ./examples/SyncGroups_Create.json responses: '200': description: Sync Group object schema: $ref: '#/definitions/SyncGroup' 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 Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname 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: - SyncGroup Resource operationId: microsoftAzureSyncgroupsGet description: Get a given SyncGroup. x-ms-examples: SyncGroups_Get: $ref: ./examples/SyncGroups_Get.json responses: '200': description: Sync Group object schema: $ref: '#/definitions/SyncGroup' 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 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 tags: - SyncGroup Resource operationId: microsoftAzureSyncgroupsDelete description: Delete a given SyncGroup. x-ms-examples: SyncGroups_Delete: $ref: ./examples/SyncGroups_Delete.json responses: '200': description: Sync Group object was deleted headers: 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' summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname ? /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: 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: - Actions - Backup Restore - 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: - Actions - Backup Restore - 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: - Actions - Backup Restore - 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: - Actions - Backup Restore - 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: - Actions - Backup Restore - 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: - Actions - Change Detection - 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: - Actions - Backup Restore - 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 ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName} : 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: serverEndpointName in: path description: Name of Server Endpoint object. required: true type: string - name: parameters in: body description: Body of Server Endpoint object. required: true schema: $ref: '#/definitions/ServerEndpointCreateParameters' tags: - ServerEndpoint Resource operationId: microsoftAzureServerendpointsCreate description: Create a new ServerEndpoint. x-ms-examples: ServerEndpoints_Create: $ref: ./examples/ServerEndpoints_Create.json responses: '200': description: Server Endpoint object schema: $ref: '#/definitions/ServerEndpoint' 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 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 Serverendpoints Serverendpointname patch: 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: serverEndpointName in: path description: Name of Server Endpoint object. required: true type: string - name: parameters in: body description: Any of the properties applicable in PUT request. schema: $ref: '#/definitions/ServerEndpointUpdateParameters' tags: - ServerEndpoint Resource operationId: microsoftAzureServerendpointsUpdate description: Patch a given ServerEndpoint. x-ms-examples: ServerEndpoints_Update: $ref: ./examples/ServerEndpoints_Update.json responses: '200': description: Server Endpoint object schema: $ref: '#/definitions/ServerEndpoint' 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 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 Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Serverendpoints Serverendpointname 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: serverEndpointName in: path description: Name of Server Endpoint object. required: true type: string tags: - ServerEndpoint Resource operationId: microsoftAzureServerendpointsGet description: Get a ServerEndpoint. x-ms-examples: ServerEndpoints_Get: $ref: ./examples/ServerEndpoints_Get.json responses: '200': description: Server Endpoint object schema: $ref: '#/definitions/ServerEndpoint' 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 Serverendpoints Serverendpointname 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: serverEndpointName in: path description: Name of Server Endpoint object. required: true type: string tags: - ServerEndpoint Resource operationId: microsoftAzureServerendpointsDelete description: Delete a given ServerEndpoint. x-ms-examples: ServerEndpoints_Delete: $ref: ./examples/ServerEndpoints_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: 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 Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Serverendpoints Serverendpointname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints : 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: - ServerEndpoint Resource operationId: microsoftAzureServerendpointsListbysyncgroup description: Get a ServerEndpoint list. x-ms-examples: ServerEndpoints_ListBySyncGroup: $ref: ./examples/ServerEndpoints_ListBySyncGroup.json responses: '200': description: Array of Server Endpoint resources in Sync Group schema: $ref: '#/definitions/ServerEndpointArray' 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-pageable: nextLinkName: summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Syncgroups Syncgroupname Serverendpoints ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}/recallAction : 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: serverEndpointName in: path description: Name of Server Endpoint object. required: true type: string - name: parameters in: body description: Body of Recall Action object. required: true schema: $ref: '#/definitions/RecallActionParameters' tags: - Actions - ServerEndpoint Resource operationId: microsoftAzureServerendpointsRecallaction description: Recall a server endpoint. x-ms-examples: ServerEndpoints_recallAction: $ref: ./examples/ServerEndpoints_Recall.json responses: '200': description: Server Endpoint object 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: 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 Serverendpoints Serverendpointname Recallaction ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers : 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 tags: - RegisteredServer Resource operationId: microsoftAzureRegisteredserversListbystoragesyncservice description: Get a given registered server list. x-ms-examples: RegisteredServers_ListByStorageSyncService: $ref: ./examples/RegisteredServers_ListByStorageSyncService.json responses: '200': description: Array of Registered Server resources in Storage Sync Service schema: $ref: '#/definitions/RegisteredServerArray' 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: summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Registeredservers ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId} : 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: serverId in: path description: GUID identifying the on-premises server. required: true type: string tags: - RegisteredServer Resource operationId: microsoftAzureRegisteredserversGet description: Get a given registered server. x-ms-examples: RegisteredServers_Get: $ref: ./examples/RegisteredServers_Get.json responses: '200': description: Registered Server resources in Sync Group schema: $ref: '#/definitions/RegisteredServer' 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 Registeredservers Serverid 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: serverId in: path description: GUID identifying the on-premises server. required: true type: string - name: parameters in: body description: Body of Registered Server object. required: true schema: $ref: '#/definitions/RegisteredServerCreateParameters' tags: - RegisteredServer Resource operationId: microsoftAzureRegisteredserversCreate description: Add a new registered server. x-ms-examples: RegisteredServers_Create: $ref: ./examples/RegisteredServers_Create.json responses: '200': description: Registered Server resources in Sync Group schema: $ref: '#/definitions/RegisteredServer' 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 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 Registeredservers Serverid patch: 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: serverId in: path description: GUID identifying the on-premises server. required: true type: string - name: parameters in: body description: Body of Registered Server object. required: true schema: $ref: '#/definitions/RegisteredServerUpdateParameters' tags: - RegisteredServer Resource operationId: microsoftAzureRegisteredserversUpdate description: Update registered server. x-ms-examples: RegisteredServers_Update: $ref: ./examples/RegisteredServers_Update.json responses: '200': description: Registered Server resources in Sync Group schema: $ref: '#/definitions/RegisteredServer' 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 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: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Registeredservers Serverid 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: serverId in: path description: GUID identifying the on-premises server. required: true type: string tags: - RegisteredServer Resource operationId: microsoftAzureRegisteredserversDelete description: Delete the given registered server. x-ms-examples: RegisteredServers_Delete: $ref: ./examples/RegisteredServers_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: 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 '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 Registeredservers Serverid ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}/triggerRollover : 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: serverId in: path description: Server Id required: true type: string - name: parameters in: body description: Body of Trigger Rollover request. required: true schema: $ref: '#/definitions/TriggerRolloverRequest' tags: - Actions - RegisteredServer Resource operationId: microsoftAzureRegisteredserversTriggerrollover description: Triggers Server certificate rollover. x-ms-examples: RegisteredServers_triggerRollover: $ref: ./examples/RegisteredServers_TriggerRollover.json responses: '200': description: Trigger Rollover success status 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: 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 Registeredservers Serverid Triggerrollover ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows : 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 tags: - Workflow Resource operationId: microsoftAzureWorkflowsListbystoragesyncservice description: Get a Workflow List x-ms-examples: Workflows_ListByStorageSyncService: $ref: ./examples/Workflows_ListByStorageSyncService.json responses: '200': description: Array of Workflow resources in Storage Sync Service schema: $ref: '#/definitions/WorkflowArray' 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: summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagesync Storagesyncservices Storagesyncservicename Workflows ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId} : 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: workflowId in: path description: workflow Id required: true type: string tags: - Workflow Resource operationId: microsoftAzureWorkflowsGet description: Get Workflows resource x-ms-examples: Workflows_Get: $ref: ./examples/Workflows_Get.json responses: '200': description: Workflow object schema: $ref: '#/definitions/Workflow' 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 Workflows Workflowid ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}/abort : 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: workflowId in: path description: workflow Id required: true type: string tags: - Actions - Workflow Resource operationId: microsoftAzureWorkflowsAbort description: Abort the given workflow. x-ms-examples: Workflows_Abort: $ref: ./examples/Workflows_Abort.json responses: '200': description: success 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 Workflows Workflowid Abort ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/locations/{locationName}/workflows/{workflowId}/operations/{operationId} : 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: locationName in: path required: true type: string description: The desired region to obtain information from. - name: workflowId in: path description: workflow Id required: true type: string - name: operationId in: path description: operation Id required: true type: string tags: - Operation Status operationId: microsoftAzureOperationstatusGet description: Get Operation status x-ms-examples: OperationStatus_Get: $ref: ./examples/OperationStatus_Get.json responses: '200': description: Operation Status schema: $ref: '#/definitions/OperationStatus' 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 Locations Locationname Workflows Workflowid Operations Operationid /subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/locations/{locationName}/operations/{operationId}: get: parameters: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: locationName in: path required: true type: string description: The desired region to obtain information from. - name: operationId in: path description: operation Id required: true type: string tags: - Operation Status operationId: microsoftAzureLocationoperationstatus description: Get Operation status x-ms-examples: LocationOperationStatus: $ref: ./examples/LocationOperationStatus_Get.json responses: '200': description: Operation Status schema: $ref: '#/definitions/LocationOperationStatus' 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 Providers Microsoft Storagesync Locations Locationname Operations Operationid 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. 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. SubscriptionState: type: object description: Subscription State object. properties: state: type: string description: State of Azure Subscription enum: - Registered - Unregistered - Warned - Suspended - Deleted x-ms-enum: name: Reason modelAsString: true istransitioning: type: boolean description: Is Transitioning readOnly: true properties: x-ms-client-flatten: true $ref: '#/definitions/SubscriptionStateProperties' description: Subscription state properties. StorageSyncService: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/StorageSyncServiceProperties' description: Storage Sync Service properties. identity: $ref: >- ../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity description: >- managed identities for the Storage Sync service to interact with other Azure services without maintaining any secrets or credentials in code. description: Storage Sync Service object. allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource SyncGroup: type: object description: Sync Group object. allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/SyncGroupProperties' description: SyncGroup properties. 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. 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. RecallActionParameters: type: object properties: pattern: type: string description: Pattern of the files. recallPath: type: string description: Recall path. description: The parameters used when calling recall action on server endpoint. StorageSyncServiceCreateParameters: type: object properties: identity: description: >- managed identities for the Storage Sync to interact with other Azure services without maintaining any secrets or credentials in code. $ref: >- ../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity properties: x-ms-client-flatten: true $ref: '#/definitions/StorageSyncServiceCreateParametersProperties' description: The parameters used to create the storage sync service. required: - location description: The parameters used when creating a storage sync service. allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource SyncGroupCreateParameters: type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/SyncGroupCreateParametersProperties' description: The parameters used to create the sync group description: The parameters used when creating a sync group. SyncGroupCreateParametersProperties: type: object description: Sync Group Create Properties object. properties: {} 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. StorageSyncServiceCreateParametersProperties: type: object description: StorageSyncService Properties object. properties: incomingTrafficPolicy: $ref: '#/definitions/IncomingTrafficPolicy' description: Incoming Traffic Policy useIdentity: type: boolean description: >- Use Identity authorization when customer have finished setup RBAC permissions. 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 ServerEndpointCreateParameters: type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ServerEndpointCreateParametersProperties' description: The parameters used to create the server endpoint. description: The parameters used when creating a server endpoint. ServerEndpointCreateParametersProperties: type: object description: ServerEndpoint Properties object. properties: serverLocalPath: $ref: '#/definitions/PhysicalPath' description: Server Local path. cloudTiering: $ref: '#/definitions/FeatureStatus' description: Cloud Tiering. volumeFreeSpacePercent: type: integer format: int32 minimum: 0 maximum: 100 description: >- Level of free space to be maintained by Cloud Tiering if it is enabled. default: 20 tierFilesOlderThanDays: type: integer format: int32 minimum: 0 maximum: 2147483647 description: Tier files older than days. default: 0 friendlyName: type: string description: Friendly Name serverResourceId: $ref: '#/definitions/ResourceId' description: Server Resource Id. offlineDataTransfer: $ref: '#/definitions/FeatureStatus' description: Offline data transfer offlineDataTransferShareName: type: string description: Offline data transfer share name initialDownloadPolicy: $ref: '#/definitions/InitialDownloadPolicy' description: Policy for how namespace and files are recalled during FastDr. localCacheMode: $ref: '#/definitions/LocalCacheMode' description: >- Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. initialUploadPolicy: $ref: '#/definitions/InitialUploadPolicy' description: Policy for how the initial upload sync session is performed. TriggerRolloverRequest: type: object description: Trigger Rollover Request. properties: serverCertificate: type: string description: Certificate Data RegisteredServerCreateParameters: type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/RegisteredServerCreateParametersProperties' description: The parameters used to create the registered server. description: The parameters used when creating a registered server. RegisteredServerUpdateParameters: type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/RegisteredServerUpdateProperties' description: The parameters used to update the registered server. description: The parameters used when updating a registered server. RegisteredServerCreateParametersProperties: type: object description: RegisteredServer Create Properties object. properties: serverCertificate: type: string description: Registered Server Certificate agentVersion: type: string description: Registered Server Agent Version serverOSVersion: type: string description: Registered Server OS Version lastHeartBeat: type: string description: Registered Server last heart beat serverRole: type: string description: Registered Server serverRole clusterId: type: string description: Registered Server clusterId clusterName: type: string description: Registered Server clusterName serverId: type: string description: Registered Server serverId friendlyName: type: string description: Friendly Name applicationId: type: string description: Server ServicePrincipal Id identity: type: boolean description: Apply server with newly discovered ApplicationId if available. RegisteredServerUpdateProperties: type: object description: RegisteredServer Update Properties object. properties: identity: type: boolean description: Apply server with newly discovered ApplicationId if available. ServerEndpointUpdateParameters: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ServerEndpointUpdateProperties' description: The properties of the server endpoint. description: Parameters for updating an Server Endpoint. ServerEndpoint: type: object description: Server Endpoint object. allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ServerEndpointProperties' description: Server Endpoint properties. RegisteredServer: type: object description: Registered Server resource. allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/RegisteredServerProperties' description: RegisteredServer properties. ResourcesMoveInfo: type: object description: Resource Move Info. properties: targetResourceGroup: type: string description: Target resource group. resources: type: array description: Collection of Resources. items: $ref: '#/definitions/ResourceId' x-ms-identifiers: [] Workflow: type: object description: Workflow resource. allOf: - $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: x-ms-client-flatten: true $ref: '#/definitions/WorkflowProperties' description: Workflow properties. OperationEntityListResult: description: The list of storage sync operations. type: object properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of operations. type: array items: $ref: '#/definitions/OperationEntity' x-ms-identifiers: - name OperationEntity: description: The operation supported by storage sync. type: object properties: name: description: 'Operation name: {provider}/{resource}/{operation}.' type: string display: $ref: '#/definitions/OperationDisplayInfo' description: The operation supported by storage sync. origin: type: string description: The origin. properties: $ref: '#/definitions/OperationProperties' description: Properties of the operations resource. OperationDisplayInfo: description: The operation supported by storage sync. type: object properties: description: description: The description of the operation. type: string operation: description: The action that users can perform, based on their permission level. type: string provider: description: 'Service provider: Microsoft StorageSync.' type: string resource: description: Resource on which the operation is performed. type: string OperationDisplayResource: type: object description: Operation Display Resource object. properties: provider: type: string description: Operation Display Resource Provider. resource: type: string description: Operation Display Resource. operation: type: string description: Operation Display Resource Operation. description: type: string description: Operation Display Resource Description. OperationProperties: type: object description: Properties of the operations resource. properties: serviceSpecification: $ref: '#/definitions/OperationResourceServiceSpecification' description: Service specification for the operations resource. OperationResourceServiceSpecification: type: object description: Service specification. properties: metricSpecifications: type: array items: $ref: '#/definitions/OperationResourceMetricSpecification' x-ms-identifiers: - name description: List of metric specifications. OperationResourceMetricSpecification: type: object description: Operation Display Resource object. properties: name: type: string description: Name of the metric. displayName: type: string description: Display name for the metric. displayDescription: type: string description: Display description for the metric. unit: type: string description: Unit for the metric. aggregationType: type: string description: Aggregation type for the metric. supportedAggregationTypes: description: Supported aggregation types for the metric. type: array items: type: string x-ms-identifiers: [] fillGapWithZero: type: boolean description: Fill gaps in the metric with zero. lockAggregationType: type: string description: Lock Aggregation type for the metric. dimensions: type: array items: $ref: '#/definitions/OperationResourceMetricSpecificationDimension' x-ms-identifiers: - name description: Dimensions for the metric specification. OperationResourceMetricSpecificationDimension: type: object description: OperationResourceMetricSpecificationDimension object. properties: name: type: string description: Name of the dimension. displayName: type: string description: Display name of the dimensions. toBeExportedForShoebox: type: boolean description: Indicates metric should be exported for Shoebox. CheckNameAvailabilityParameters: type: object properties: name: type: string description: The name to check for availability type: type: string enum: - Microsoft.StorageSync/storageSyncServices x-ms-enum: name: Type modelAsString: false description: >- The resource type. Must be set to Microsoft.StorageSync/storageSyncServices required: - name - type description: Parameters for a check name availability request. CheckNameAvailabilityResult: type: object properties: nameAvailable: readOnly: true type: boolean description: >- Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used. reason: readOnly: true type: string enum: - Invalid - AlreadyExists x-ms-enum: name: NameAvailabilityReason modelAsString: false description: >- Gets the reason that a Storage Sync Service name could not be used. The Reason element is only returned if NameAvailable is false. message: readOnly: true type: string description: Gets an error message explaining the Reason value in more detail. description: The CheckNameAvailability operation response. 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 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. PostBackupResponse: type: object description: Post Backup Response properties: backupMetadata: x-ms-client-flatten: true $ref: '#/definitions/PostBackupResponseProperties' description: Post Backup Response Properties RestoreFileSpec: type: object description: Restore file spec. properties: path: type: string description: Restore file spec path isdir: type: boolean description: Restore file spec isdir StorageSyncServiceArray: type: object description: Array of StorageSyncServices properties: value: type: array description: Collection of StorageSyncServices. items: $ref: '#/definitions/StorageSyncService' x-ms-identifiers: - id SyncGroupArray: type: object description: Array of SyncGroup properties: value: type: array description: Collection of SyncGroup. items: $ref: '#/definitions/SyncGroup' x-ms-identifiers: - id CloudEndpointArray: type: object description: Array of CloudEndpoint properties: value: type: array description: Collection of CloudEndpoint. items: $ref: '#/definitions/CloudEndpoint' x-ms-identifiers: - id ServerEndpointArray: description: Array of ServerEndpoint type: object properties: value: type: array description: Collection of ServerEndpoint. items: $ref: '#/definitions/ServerEndpoint' x-ms-identifiers: - id RegisteredServerArray: description: Array of RegisteredServer type: object properties: value: type: array description: Collection of Registered Server. items: $ref: '#/definitions/RegisteredServer' x-ms-identifiers: - id WorkflowArray: description: Array of Workflow type: object properties: value: type: array description: Collection of workflow items. items: $ref: '#/definitions/Workflow' x-ms-identifiers: - id SubscriptionStateProperties: type: object description: Subscription State properties. PostBackupResponseProperties: type: object description: Post Backup Response Properties object. properties: cloudEndpointName: type: string description: cloud endpoint Name. readOnly: true StorageSyncServiceUpdateParameters: type: object properties: tags: type: object additionalProperties: type: string description: The user-specified tags associated with the storage sync service. identity: description: >- managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. $ref: >- ../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity properties: x-ms-client-flatten: true $ref: '#/definitions/StorageSyncServiceUpdateProperties' description: The properties of the server endpoint. description: Parameters for updating an Storage sync service. StorageSyncServiceUpdateProperties: type: object description: StorageSyncService Properties object. properties: incomingTrafficPolicy: $ref: '#/definitions/IncomingTrafficPolicy' description: Incoming Traffic Policy useIdentity: type: boolean description: >- Use Identity authorization when customer have finished setup RBAC permissions. StorageSyncServiceProperties: type: object description: Storage Sync Service Properties object. properties: incomingTrafficPolicy: $ref: '#/definitions/IncomingTrafficPolicy' description: Incoming Traffic Policy storageSyncServiceStatus: type: integer format: int32 description: Storage Sync service status. readOnly: true storageSyncServiceUid: type: string description: Storage Sync service Uid readOnly: true provisioningState: readOnly: true type: string description: StorageSyncService Provisioning State useIdentity: readOnly: true type: boolean description: >- Use Identity authorization when customer have finished setup RBAC permissions. lastWorkflowId: readOnly: true type: string description: StorageSyncService lastWorkflowId lastOperationName: readOnly: true type: string description: Resource Last Operation Name privateEndpointConnections: readOnly: true type: array items: $ref: >- ../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection x-ms-identifiers: - properties/privateEndpoint/id description: >- List of private endpoint connection associated with the specified storage sync service WorkflowProperties: type: object description: Workflow Properties object. properties: lastStepName: type: string description: last step name status: $ref: '#/definitions/WorkflowStatus' description: workflow status. operation: $ref: '#/definitions/OperationDirection' description: operation direction. steps: type: string description: workflow steps lastOperationId: type: string description: workflow last operation identifier. commandName: type: string description: workflow command name. readOnly: true createdTimestamp: type: string format: date-time description: workflow created timestamp. readOnly: true lastStatusTimestamp: type: string format: date-time description: workflow last status timestamp. readOnly: true SyncGroupProperties: type: object description: SyncGroup Properties object. properties: uniqueId: type: string description: Unique Id readOnly: true syncGroupStatus: type: string description: Sync group status readOnly: true RegisteredServerProperties: type: object description: RegisteredServer Properties object. properties: serverCertificate: type: string description: Registered Server Certificate agentVersion: type: string description: Registered Server Agent Version agentVersionStatus: $ref: '#/definitions/RegisteredServerAgentVersionStatus' description: Registered Server Agent Version Status readOnly: true agentVersionExpirationDate: type: string format: date-time description: Registered Server Agent Version Expiration Date readOnly: true serverOSVersion: type: string description: Registered Server OS Version serverManagementErrorCode: type: integer format: int32 description: Registered Server Management Error Code lastHeartBeat: type: string description: Registered Server last heart beat provisioningState: type: string description: Registered Server Provisioning State serverRole: type: string description: Registered Server serverRole clusterId: type: string description: Registered Server clusterId clusterName: type: string description: Registered Server clusterName serverId: type: string description: Registered Server serverId storageSyncServiceUid: type: string description: Registered Server storageSyncServiceUid lastWorkflowId: type: string description: Registered Server lastWorkflowId lastOperationName: type: string description: Resource Last Operation Name discoveryEndpointUri: type: string description: Resource discoveryEndpointUri resourceLocation: type: string description: Resource Location serviceLocation: type: string description: Service Location friendlyName: type: string description: Friendly Name managementEndpointUri: type: string description: Management Endpoint Uri monitoringEndpointUri: type: string description: Telemetry Endpoint Uri monitoringConfiguration: type: string description: Monitoring Configuration serverName: type: string description: Server name readOnly: true applicationId: type: string description: Server Application Id identity: type: boolean description: Apply server with newly discovered ApplicationId if available. readOnly: true latestApplicationId: type: string description: >- Latest Server Application Id discovered from the server. It is not yet applied. activeAuthType: $ref: '#/definitions/ServerAuthType' description: Server auth type. readOnly: true 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 ServerEndpointUpdateProperties: type: object description: ServerEndpoint Update Properties object. properties: cloudTiering: $ref: '#/definitions/FeatureStatus' description: Cloud Tiering. volumeFreeSpacePercent: type: integer format: int32 minimum: 0 maximum: 100 description: >- Level of free space to be maintained by Cloud Tiering if it is enabled. tierFilesOlderThanDays: type: integer format: int32 minimum: 0 maximum: 2147483647 description: Tier files older than days. offlineDataTransfer: $ref: '#/definitions/FeatureStatus' description: Offline data transfer offlineDataTransferShareName: type: string description: Offline data transfer share name localCacheMode: $ref: '#/definitions/LocalCacheMode' description: >- Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. ServerEndpointProperties: type: object description: ServerEndpoint Properties object. properties: serverLocalPath: $ref: '#/definitions/PhysicalPath' description: Server Local path. cloudTiering: $ref: '#/definitions/FeatureStatus' description: Cloud Tiering. volumeFreeSpacePercent: type: integer format: int32 minimum: 0 maximum: 100 description: >- Level of free space to be maintained by Cloud Tiering if it is enabled. tierFilesOlderThanDays: type: integer format: int32 minimum: 0 maximum: 2147483647 description: Tier files older than days. friendlyName: type: string description: Friendly Name serverResourceId: $ref: '#/definitions/ResourceId' description: Server Resource Id. provisioningState: readOnly: true type: string description: ServerEndpoint Provisioning State lastWorkflowId: type: string description: ServerEndpoint lastWorkflowId readOnly: true lastOperationName: type: string description: Resource Last Operation Name readOnly: true syncStatus: $ref: '#/definitions/ServerEndpointSyncStatus' description: Server Endpoint sync status readOnly: true offlineDataTransfer: $ref: '#/definitions/FeatureStatus' description: Offline data transfer offlineDataTransferStorageAccountResourceId: type: string description: Offline data transfer storage account resource ID readOnly: true offlineDataTransferStorageAccountTenantId: type: string description: Offline data transfer storage account tenant ID readOnly: true offlineDataTransferShareName: type: string description: Offline data transfer share name cloudTieringStatus: $ref: '#/definitions/ServerEndpointCloudTieringStatus' description: Cloud tiering status. Only populated if cloud tiering is enabled. readOnly: true recallStatus: $ref: '#/definitions/ServerEndpointRecallStatus' description: Recall status. Only populated if cloud tiering is enabled. readOnly: true initialDownloadPolicy: $ref: '#/definitions/InitialDownloadPolicy' description: Policy for how namespace and files are recalled during FastDr. localCacheMode: $ref: '#/definitions/LocalCacheMode' description: >- Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. initialUploadPolicy: $ref: '#/definitions/InitialUploadPolicy' description: Policy for how the initial upload sync session is performed. serverName: type: string description: Server name readOnly: true serverEndpointProvisioningStatus: $ref: '#/definitions/ServerEndpointProvisioningStatus' description: Server Endpoint provisioning status ServerEndpointSyncStatus: type: object description: Server Endpoint sync status properties: downloadHealth: $ref: '#/definitions/ServerEndpointHealthState' description: Download Health Status. readOnly: true uploadHealth: $ref: '#/definitions/ServerEndpointHealthState' description: Upload Health Status. readOnly: true combinedHealth: $ref: '#/definitions/ServerEndpointHealthState' description: Combined Health Status. readOnly: true syncActivity: $ref: '#/definitions/ServerEndpointSyncActivityState' description: Sync activity readOnly: true totalPersistentFilesNotSyncingCount: type: integer format: int64 minimum: 0 description: >- Total count of persistent files not syncing (combined upload + download). readOnly: true lastUpdatedTimestamp: type: string format: date-time description: Last Updated Timestamp readOnly: true uploadStatus: $ref: '#/definitions/ServerEndpointSyncSessionStatus' description: Upload Status readOnly: true downloadStatus: $ref: '#/definitions/ServerEndpointSyncSessionStatus' description: Download Status readOnly: true uploadActivity: $ref: '#/definitions/ServerEndpointSyncActivityStatus' description: Upload sync activity readOnly: true downloadActivity: $ref: '#/definitions/ServerEndpointSyncActivityStatus' description: Download sync activity readOnly: true offlineDataTransferStatus: $ref: '#/definitions/ServerEndpointOfflineDataTransferState' description: Offline Data Transfer State readOnly: true backgroundDataDownloadActivity: $ref: '#/definitions/ServerEndpointBackgroundDataDownloadActivity' description: Background data download activity readOnly: true ServerEndpointSyncSessionStatus: type: object description: Sync Session status object. properties: lastSyncResult: type: integer format: int32 description: Last sync result (HResult) readOnly: true lastSyncTimestamp: type: string format: date-time description: Last sync timestamp readOnly: true lastSyncSuccessTimestamp: type: string format: date-time description: Last sync success timestamp readOnly: true lastSyncPerItemErrorCount: type: integer format: int64 minimum: 0 description: Last sync per item error count. readOnly: true persistentFilesNotSyncingCount: type: integer format: int64 minimum: 0 description: Count of persistent files not syncing. readOnly: true transientFilesNotSyncingCount: type: integer format: int64 minimum: 0 description: Count of transient files not syncing. readOnly: true filesNotSyncingErrors: type: array items: $ref: '#/definitions/ServerEndpointFilesNotSyncingError' x-ms-identifiers: - errorCode description: Array of per-item errors coming from the last sync session. readOnly: true lastSyncMode: $ref: '#/definitions/ServerEndpointSyncMode' description: Sync mode readOnly: true ServerEndpointSyncActivityStatus: type: object description: Sync Session status object. properties: timestamp: type: string format: date-time description: Timestamp when properties were updated readOnly: true perItemErrorCount: type: integer format: int64 minimum: 0 description: Per item error count readOnly: true appliedItemCount: type: integer format: int64 minimum: 0 description: Applied item count. readOnly: true totalItemCount: type: integer format: int64 minimum: 0 description: Total item count (if available) readOnly: true appliedBytes: type: integer format: int64 minimum: 0 description: Applied bytes readOnly: true totalBytes: type: integer format: int64 minimum: 0 description: Total bytes (if available) readOnly: true syncMode: $ref: '#/definitions/ServerEndpointSyncMode' description: Sync mode readOnly: true sessionMinutesRemaining: type: integer format: int32 minimum: 0 description: Session minutes remaining (if available) readOnly: true ServerEndpointFilesNotSyncingError: type: object description: Files not syncing error object properties: errorCode: type: integer format: int32 description: Error code (HResult) readOnly: true persistentCount: type: integer format: int64 minimum: 0 description: Count of persistent files not syncing with the specified error code readOnly: true transientCount: type: integer format: int64 minimum: 0 description: Count of transient files not syncing with the specified error code readOnly: true ServerEndpointBackgroundDataDownloadActivity: type: object description: Background data download activity object properties: timestamp: type: string format: date-time description: Timestamp when properties were updated readOnly: true startedTimestamp: type: string format: date-time description: Timestamp when the operation started readOnly: true percentProgress: type: integer format: int32 minimum: 0 maximum: 100 description: Progress percentage readOnly: true downloadedBytes: type: integer format: int64 minimum: 0 description: Running count of bytes downloaded readOnly: true ServerEndpointSyncMode: type: string description: Sync mode for the server endpoint. enum: - Regular - NamespaceDownload - InitialUpload - SnapshotUpload - InitialFullDownload x-ms-enum: name: ServerEndpointSyncMode modelAsString: true PhysicalPath: type: string description: Server folder used for data synchronization ResourceId: type: string description: Arm resource identifier. TagsObject: type: object description: Tags object. FeatureStatus: type: string description: Type of the Feature Status enum: - 'on' - 'off' x-ms-enum: name: FeatureStatus modelAsString: true ServerAuthType: type: string description: Type of the Server Auth type enum: - Certificate - ManagedIdentity x-ms-enum: name: ServerAuthType modelAsString: true IncomingTrafficPolicy: type: string description: Type of the Incoming Traffic Policy enum: - AllowAllTraffic - AllowVirtualNetworksOnly x-ms-enum: name: IncomingTrafficPolicy modelAsString: true LocalCacheMode: type: string description: >- Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. enum: - DownloadNewAndModifiedFiles - UpdateLocallyCachedFiles default: UpdateLocallyCachedFiles x-ms-enum: name: LocalCacheMode modelAsString: true InitialDownloadPolicy: type: string description: Policy for how namespace and files are recalled during FastDr enum: - NamespaceOnly - NamespaceThenModifiedFiles - AvoidTieredFiles default: NamespaceThenModifiedFiles x-ms-enum: name: InitialDownloadPolicy modelAsString: true InitialUploadPolicy: type: string description: Policy for how the initial upload sync session is performed. enum: - ServerAuthoritative - Merge default: Merge x-ms-enum: name: InitialUploadPolicy modelAsString: true ServerEndpointHealthState: type: string description: Type of the server endpoint health state enum: - Unavailable - Healthy - Error x-ms-enum: name: ServerEndpointHealthState modelAsString: true CloudTieringLowDiskModeState: type: string description: Type of the cloud tiering low disk mode state enum: - Enabled - Disabled x-ms-enum: name: CloudTieringLowDiskModeState modelAsString: true ServerEndpointSyncActivityState: type: string description: Type of the sync activity state enum: - Upload - Download - UploadAndDownload x-ms-enum: name: ServerEndpointSyncActivityState modelAsString: true ServerEndpointOfflineDataTransferState: type: string description: Type of the Health state enum: - InProgress - Stopping - NotRunning - Complete x-ms-enum: name: ServerEndpointOfflineDataTransferState modelAsString: true WorkflowStatus: type: string description: Type of the Workflow Status enum: - active - expired - succeeded - aborted - failed x-ms-enum: name: WorkflowStatus modelAsString: true OperationDirection: type: string description: Type of the Operation Direction enum: - do - undo - cancel x-ms-enum: name: OperationDirection modelAsString: true ProgressType: type: string description: Type of the ProgressType enum: - none - initialize - download - upload - recall x-ms-enum: name: ProgressType modelAsString: true OperationStatus: type: object properties: name: readOnly: true type: string description: Operation Id status: readOnly: true type: string description: Operation status startTime: readOnly: true type: string format: date-time description: Start time of the operation endTime: readOnly: true type: string format: date-time description: End time of the operation error: readOnly: true $ref: '#/definitions/StorageSyncApiError' description: Error details. description: Operation status object LocationOperationStatus: type: object properties: id: readOnly: true type: string description: Operation resource Id name: readOnly: true type: string description: Operation Id status: readOnly: true type: string description: Operation status startTime: readOnly: true type: string format: date-time description: Start time of the operation endTime: readOnly: true type: string format: date-time description: End time of the operation error: readOnly: true $ref: '#/definitions/StorageSyncApiError' description: Error details. percentComplete: readOnly: true type: integer format: int32 description: Percent complete. description: Operation status object ServerEndpointCloudTieringStatus: type: object description: Server endpoint cloud tiering status object. properties: lastUpdatedTimestamp: type: string format: date-time description: Last updated timestamp readOnly: true health: $ref: '#/definitions/ServerEndpointHealthState' description: Cloud tiering health state. readOnly: true healthLastUpdatedTimestamp: type: string format: date-time description: The last updated timestamp of health state readOnly: true lastCloudTieringResult: type: integer format: int32 description: Last cloud tiering result (HResult) readOnly: true lastSuccessTimestamp: type: string format: date-time description: Last cloud tiering success timestamp readOnly: true spaceSavings: $ref: '#/definitions/CloudTieringSpaceSavings' description: Information regarding how much local space cloud tiering is saving. readOnly: true cachePerformance: $ref: '#/definitions/CloudTieringCachePerformance' description: >- Information regarding how well the local cache on the server is performing. readOnly: true filesNotTiering: $ref: '#/definitions/CloudTieringFilesNotTiering' description: Information regarding files that failed to be tiered readOnly: true volumeFreeSpacePolicyStatus: $ref: '#/definitions/CloudTieringVolumeFreeSpacePolicyStatus' description: Status of the volume free space policy readOnly: true datePolicyStatus: $ref: '#/definitions/CloudTieringDatePolicyStatus' description: Status of the date policy readOnly: true lowDiskMode: $ref: '#/definitions/CloudTieringLowDiskMode' description: Information regarding the low disk mode state readOnly: true CloudTieringSpaceSavings: type: object description: Server endpoint cloud tiering status object. properties: lastUpdatedTimestamp: type: string format: date-time description: Last updated timestamp readOnly: true volumeSizeBytes: type: integer format: int64 description: Volume size readOnly: true minimum: 0 totalSizeCloudBytes: type: integer format: int64 description: Total size of content in the azure file share readOnly: true minimum: 0 cachedSizeBytes: type: integer format: int64 description: Cached content size on the server readOnly: true minimum: 0 spaceSavingsPercent: type: integer format: int32 description: Percentage of cached size over total size readOnly: true minimum: 0 maximum: 100 spaceSavingsBytes: type: integer format: int64 description: Count of bytes saved on the server readOnly: true minimum: 0 CloudTieringCachePerformance: type: object description: Server endpoint cloud tiering status object. properties: lastUpdatedTimestamp: type: string format: date-time description: Last updated timestamp readOnly: true cacheHitBytes: type: integer format: int64 description: Count of bytes that were served from the local server readOnly: true minimum: 0 cacheMissBytes: type: integer format: int64 description: Count of bytes that were served from the cloud readOnly: true minimum: 0 cacheHitBytesPercent: type: integer format: int32 description: >- Percentage of total bytes (hit + miss) that were served from the local server readOnly: true minimum: 0 maximum: 100 CloudTieringFilesNotTiering: type: object description: Server endpoint cloud tiering status object. properties: lastUpdatedTimestamp: type: string format: date-time description: Last updated timestamp readOnly: true totalFileCount: type: integer format: int64 description: Last cloud tiering result (HResult) readOnly: true minimum: 0 errors: type: array items: $ref: '#/definitions/FilesNotTieringError' x-ms-identifiers: - errorCode description: Array of tiering errors readOnly: true FilesNotTieringError: type: object description: Files not tiering error object properties: errorCode: type: integer format: int32 description: Error code (HResult) readOnly: true fileCount: type: integer format: int64 minimum: 0 description: Count of files with this error readOnly: true CloudTieringVolumeFreeSpacePolicyStatus: type: object description: Status of the volume free space policy properties: lastUpdatedTimestamp: type: string format: date-time description: Last updated timestamp readOnly: true effectiveVolumeFreeSpacePolicy: type: integer format: int32 description: >- In the case where multiple server endpoints are present in a volume, an effective free space policy is applied. readOnly: true minimum: 0 maximum: 100 currentVolumeFreeSpacePercent: type: integer format: int32 description: Current volume free space percentage. readOnly: true minimum: 0 maximum: 100 CloudTieringDatePolicyStatus: type: object description: Status of the date policy properties: lastUpdatedTimestamp: type: string format: date-time description: Last updated timestamp readOnly: true tieredFilesMostRecentAccessTimestamp: type: string format: date-time description: Most recent access time of tiered files readOnly: true CloudTieringLowDiskMode: type: object description: Information regarding the low disk mode state properties: lastUpdatedTimestamp: type: string format: date-time description: Last updated timestamp readOnly: true state: $ref: '#/definitions/CloudTieringLowDiskModeState' description: Low disk mode state readOnly: true ServerEndpointRecallStatus: type: object description: Server endpoint recall status object. properties: lastUpdatedTimestamp: type: string format: date-time description: Last updated timestamp readOnly: true totalRecallErrorsCount: type: integer format: int64 minimum: 0 description: Total count of recall errors. readOnly: true recallErrors: type: array items: $ref: '#/definitions/ServerEndpointRecallError' x-ms-identifiers: - errorCode description: Array of recall errors readOnly: true ServerEndpointRecallError: type: object description: Server endpoint recall error object properties: errorCode: type: integer format: int32 description: Error code (HResult) readOnly: true count: type: integer format: int64 minimum: 0 description: Count of occurences of the error readOnly: true RegisteredServerAgentVersionStatus: type: string description: Type of the registered server agent version status enum: - Ok - NearExpiry - Expired - Blocked x-ms-enum: name: RegisteredServerAgentVersionStatus modelAsString: true ServerEndpointProvisioningStatus: type: object description: Server endpoint provisioning status information properties: provisioningStatus: $ref: '#/definitions/ServerProvisioningStatus' description: Server Endpoint provisioning status readOnly: true provisioningType: type: string description: Server Endpoint provisioning type readOnly: true provisioningStepStatuses: type: array description: >- Provisioning Step status information for each step in the provisioning process items: $ref: '#/definitions/ServerEndpointProvisioningStepStatus' x-ms-identifiers: - name readOnly: true ServerProvisioningStatus: type: string description: Server provisioning status enum: - NotStarted - InProgress - Ready_SyncNotFunctional - Ready_SyncFunctional - Error x-ms-enum: name: ServerProvisioningStatus modelAsString: true ServerEndpointProvisioningStepStatus: type: object description: Server endpoint provisioning step status object. properties: name: type: string description: Name of the provisioning step readOnly: true status: type: string description: Status of the provisioning step readOnly: true startTime: type: string format: date-time description: Start time of the provisioning step readOnly: true minutesLeft: type: integer format: int32 description: Estimated completion time of the provisioning step in minutes readOnly: true progressPercentage: type: integer format: int32 description: Estimated progress percentage readOnly: true endTime: type: string format: date-time description: End time of the provisioning step readOnly: true errorCode: type: integer format: int32 description: Error code (HResult) for the provisioning step readOnly: true additionalInformation: type: object additionalProperties: type: string description: Additional information for the provisioning step readOnly: 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 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 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 CloudEndpointChangeEnumerationActivityState: type: string description: State of change enumeration activity enum: - InitialEnumerationInProgress - EnumerationInProgress x-ms-enum: name: CloudEndpointChangeEnumerationActivityState modelAsString: true 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 parameters: StorageSyncServiceNameParameter: name: storageSyncServiceName in: path required: true type: string description: >- The name of the storage sync service name within the specified resource group. x-ms-parameter-location: method securityDefinitions: azure_auth: type: oauth2 authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize flow: implicit description: Azure Active Directory OAuth2 Flow scopes: user_impersonation: impersonate your user account security: - azure_auth: - user_impersonation tags: - name: Actions - name: Backup Restore - name: Change Detection - name: CloudEndpoint Resource - name: Operation Status - name: Operations - name: PrivateEndpointConnection Resource - name: PrivateEndpointConnections - name: PrivateLinkResources - name: RegisteredServer Resource - name: ResourceProvider - name: ServerEndpoint Resource - name: StorageSyncService - name: StorageSyncServices Resource - name: SyncGroup Resource - name: Workflow Resource