Microsoft.StorageSync (stable:2018-10-01)

2025/09/12 • 35 new, 35 deleted methods

Operations_List (new)
Description :  Lists all of the available Storage Sync Rest API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.StorageSync/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: The list of storage sync operations. ,
}
{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The operation supported by storage sync. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The action that users can perform, based on their permission level. ,
Required: False ,
}
string ,
provider:
{
Description: Service provider: Microsoft StorageSync. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The origin. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_CheckNameAvailability (new)
Description :  Check the give namespace name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/locations/{locationName}/checkNameAvailability
{
locationName:
{
Description: The desired region for the name check. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to check availability of the given namespace name ,
Required: True ,
}
{
name:
{
Description: The name to check for availability ,
Required: True ,
}
string ,
type:
{
Description: The resource type. Must be set to Microsoft.StorageSync/storageSyncServices ,
Enum:
{
Microsoft.StorageSync/storageSyncServices: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
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. ,
Required: False ,
}
boolean ,
reason:
{
Description: Gets the reason that a Storage Sync Service name could not be used. The Reason element is only returned if NameAvailable is false. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Gets an error message explaining the Reason value in more detail. ,
Required: False ,
}
string ,
}
StorageSyncServices_Create (new)
Description :  Create a new StorageSyncService.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Storage Sync Service resource name. ,
Required: True ,
}
{
location:
{
Description: Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters. ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Storage Sync Service properties. ,
Required: False ,
}
{
storageSyncServiceStatus:
{
Description: Storage Sync service status. ,
Required: False ,
}
integer ,
storageSyncServiceUid:
{
Description: Storage Sync service Uid ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_Get (new)
Description :  Get a given StorageSyncService.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Storage Sync Service object. ,
}
{
properties:
{
Description: Storage Sync Service properties. ,
Required: False ,
}
{
storageSyncServiceStatus:
{
Description: Storage Sync service status. ,
Required: False ,
}
integer ,
storageSyncServiceUid:
{
Description: Storage Sync service Uid ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_Update (new)
Description :  Patch a given StorageSyncService.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Storage Sync Service resource. ,
Required: False ,
}
{
tags:
{
Description: The user-specified tags associated with the storage sync service. ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the storage sync service. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Storage Sync Service object. ,
}
{
properties:
{
Description: Storage Sync Service properties. ,
Required: False ,
}
{
storageSyncServiceStatus:
{
Description: Storage Sync service status. ,
Required: False ,
}
integer ,
storageSyncServiceUid:
{
Description: Storage Sync service Uid ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_Delete (new)
Description :  Delete a given StorageSyncService.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_ListByResourceGroup (new)
Description :  Get a StorageSyncService list by Resource group name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Array of StorageSyncServices ,
}
{
value:
{
Description: Collection of StorageSyncServices. ,
Required: False ,
}
[
{
properties:
{
Description: Storage Sync Service properties. ,
Required: False ,
}
{
storageSyncServiceStatus:
{
Description: Storage Sync service status. ,
Required: False ,
}
integer ,
storageSyncServiceUid:
{
Description: Storage Sync service Uid ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_ListBySubscription (new)
Description :  Get a StorageSyncService list by subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/storageSyncServices
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Array of StorageSyncServices ,
}
{
value:
{
Description: Collection of StorageSyncServices. ,
Required: False ,
}
[
{
properties:
{
Description: Storage Sync Service properties. ,
Required: False ,
}
{
storageSyncServiceStatus:
{
Description: Storage Sync service status. ,
Required: False ,
}
integer ,
storageSyncServiceUid:
{
Description: Storage Sync service Uid ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
SyncGroups_ListByStorageSyncService (new)
Description :  Get a SyncGroup List.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Array of SyncGroup ,
}
{
value:
{
Description: Collection of SyncGroup. ,
Required: False ,
}
[
{
properties:
{
Description: SyncGroup properties. ,
Required: False ,
}
{
uniqueId:
{
Description: Unique Id ,
Required: False ,
}
string ,
syncGroupStatus:
{
Description: Sync group status ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
SyncGroups_Create (new)
Description :  Create a new SyncGroup.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Sync Group Body ,
Required: True ,
}
{
properties:
{
Description: The parameters used to create the sync group ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Sync Group object. ,
}
{
properties:
{
Description: SyncGroup properties. ,
Required: False ,
}
{
uniqueId:
{
Description: Unique Id ,
Required: False ,
}
string ,
syncGroupStatus:
{
Description: Sync group status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
SyncGroups_Get (new)
Description :  Get a given SyncGroup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Sync Group object. ,
}
{
properties:
{
Description: SyncGroup properties. ,
Required: False ,
}
{
uniqueId:
{
Description: Unique Id ,
Required: False ,
}
string ,
syncGroupStatus:
{
Description: Sync group status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
SyncGroups_Delete (new)
Description :  Delete a given SyncGroup.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: Request id ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_Create (new)
Description :  Create a new CloudEndpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Cloud Endpoint resource. ,
Required: True ,
}
{
properties:
{
Description: The parameters used to create the cloud endpoint. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Storage Account Resource Id ,
Required: False ,
}
string ,
storageAccountShareName:
{
Description: Storage Account Share name ,
Required: False ,
}
string ,
storageAccountTenantId:
{
Description: Storage Account Tenant Id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Cloud Endpoint object. ,
}
{
properties:
{
Description: Cloud Endpoint properties. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Storage Account Resource Id ,
Required: False ,
}
string ,
storageAccountShareName:
{
Description: Storage Account Share name ,
Required: False ,
}
string ,
storageAccountTenantId:
{
Description: Storage Account Tenant Id ,
Required: False ,
}
string ,
partnershipId:
{
Description: Partnership Id ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
backupEnabled:
{
Description: Backup Enabled ,
Required: False ,
}
string ,
provisioningState:
{
Description: CloudEndpoint Provisioning State ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: CloudEndpoint lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Operation Status Location URI ,
}
string ,
location:
{
Description: Operation Status Location URI ,
}
string ,
retry-after:
{
Description: Retry After ,
}
string ,
x-ms-request-id:
{
Description: Request id ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_Get (new)
Description :  Get a given CloudEndpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Cloud Endpoint object. ,
}
{
properties:
{
Description: Cloud Endpoint properties. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Storage Account Resource Id ,
Required: False ,
}
string ,
storageAccountShareName:
{
Description: Storage Account Share name ,
Required: False ,
}
string ,
storageAccountTenantId:
{
Description: Storage Account Tenant Id ,
Required: False ,
}
string ,
partnershipId:
{
Description: Partnership Id ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
backupEnabled:
{
Description: Backup Enabled ,
Required: False ,
}
string ,
provisioningState:
{
Description: CloudEndpoint Provisioning State ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: CloudEndpoint lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_Delete (new)
Description :  Delete a given CloudEndpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Operation Status Location URI ,
}
string ,
location:
{
Description: Operation Status Location URI ,
}
string ,
retry-after:
{
Description: Retry After ,
}
string ,
x-ms-request-id:
{
Description: Request id ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_ListBySyncGroup (new)
Description :  Get a CloudEndpoint List.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Array of CloudEndpoint ,
}
{
value:
{
Description: Collection of CloudEndpoint. ,
Required: False ,
}
[
{
properties:
{
Description: Cloud Endpoint properties. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Storage Account Resource Id ,
Required: False ,
}
string ,
storageAccountShareName:
{
Description: Storage Account Share name ,
Required: False ,
}
string ,
storageAccountTenantId:
{
Description: Storage Account Tenant Id ,
Required: False ,
}
string ,
partnershipId:
{
Description: Partnership Id ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
backupEnabled:
{
Description: Backup Enabled ,
Required: False ,
}
string ,
provisioningState:
{
Description: CloudEndpoint Provisioning State ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: CloudEndpoint lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_PreBackup (new)
Description :  Pre Backup a given CloudEndpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prebackup
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Backup request. ,
Required: True ,
}
{
azureFileShare:
{
Description: Azure File Share. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_PostBackup (new)
Description :  Post Backup a given CloudEndpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postbackup
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Backup request. ,
Required: True ,
}
{
azureFileShare:
{
Description: Azure File Share. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Post Backup Response ,
}
{
backupMetadata:
{
Description: Post Backup Response Properties ,
Required: False ,
}
{
cloudEndpointName:
{
Description: cloud endpoint Name. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_PreRestore (new)
Description :  Pre Restore a given CloudEndpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prerestore
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Cloud Endpoint object. ,
Required: True ,
}
{
partition:
{
Description: Pre Restore partition. ,
Required: False ,
}
string ,
replicaGroup:
{
Description: Pre Restore replica group. ,
Required: False ,
}
string ,
requestId:
{
Description: Pre Restore request id. ,
Required: False ,
}
string ,
azureFileShareUri:
{
Description: Pre Restore Azure file share uri. ,
Required: False ,
}
string ,
status:
{
Description: Pre Restore Azure status. ,
Required: False ,
}
string ,
sourceAzureFileShareUri:
{
Description: Pre Restore Azure source azure file share uri. ,
Required: False ,
}
string ,
backupMetadataPropertyBag:
{
Description: Pre Restore backup metadata property bag. ,
Required: False ,
}
string ,
restoreFileSpec:
{
Description: Pre Restore restore file spec array. ,
Required: False ,
}
[
{
path:
{
Description: Restore file spec path ,
Required: False ,
}
string ,
isdir:
{
Description: Restore file spec isdir ,
Required: False ,
}
boolean ,
}
,
]
,
pauseWaitForSyncDrainTimePeriodInSeconds:
{
Description: Pre Restore pause wait for sync drain time period in seconds. ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_restoreheartbeat (new)
Description :  Restore Heartbeat a given CloudEndpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/restoreheartbeat
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_PostRestore (new)
Description :  Post Restore a given CloudEndpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postrestore
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Cloud Endpoint object. ,
Required: True ,
}
{
partition:
{
Description: Post Restore partition. ,
Required: False ,
}
string ,
replicaGroup:
{
Description: Post Restore replica group. ,
Required: False ,
}
string ,
requestId:
{
Description: Post Restore request id. ,
Required: False ,
}
string ,
azureFileShareUri:
{
Description: Post Restore Azure file share uri. ,
Required: False ,
}
string ,
status:
{
Description: Post Restore Azure status. ,
Required: False ,
}
string ,
sourceAzureFileShareUri:
{
Description: Post Restore Azure source azure file share uri. ,
Required: False ,
}
string ,
failedFileList:
{
Description: Post Restore Azure failed file list. ,
Required: False ,
}
string ,
restoreFileSpec:
{
Description: Post Restore restore file spec array. ,
Required: False ,
}
[
{
path:
{
Description: Restore file spec path ,
Required: False ,
}
string ,
isdir:
{
Description: Restore file spec isdir ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_Create (new)
Description :  Create a new ServerEndpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
serverEndpointName:
{
Description: Name of Server Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Server Endpoint object. ,
Required: True ,
}
{
properties:
{
Description: The parameters used to create the server endpoint. ,
Required: False ,
}
{
serverLocalPath:
{
Description: Server Local path. ,
Required: False ,
}
string ,
cloudTiering:
{
Description: Cloud Tiering. ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
volumeFreeSpacePercent:
{
Description: Level of free space to be maintained by Cloud Tiering if it is enabled. ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Required: False ,
}
integer ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
serverResourceId:
{
Description: Server Resource Id. ,
Required: False ,
}
string ,
offlineDataTransfer:
{
Description: Offline data transfer ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
offlineDataTransferShareName:
{
Description: Offline data transfer share name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Server Endpoint object. ,
}
{
properties:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
serverLocalPath:
{
Description: Server Local path. ,
Required: False ,
}
string ,
cloudTiering:
{
Description: Cloud Tiering. ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
volumeFreeSpacePercent:
{
Description: Level of free space to be maintained by Cloud Tiering if it is enabled. ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Required: False ,
}
integer ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
serverResourceId:
{
Description: Server Resource Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: ServerEndpoint Provisioning State ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: ServerEndpoint lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
syncStatus:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
downloadHealth:
{
Description: Download Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
uploadHealth:
{
Description: Upload Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
combinedHealth:
{
Description: Combined Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Description: Last Updated Timestamp ,
Format: date-time ,
Required: False ,
}
string ,
uploadStatus:
{
Description: Upload Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
downloadStatus:
{
Description: Download Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
currentProgress:
{
Description: Current progress ,
Required: False ,
}
{
progressTimestamp:
{
Description: Progress timestamp ,
Format: date-time ,
Required: False ,
}
string ,
syncDirection:
{
Description: Sync direction. ,
Enum:
{
none: No description available. ,
initialize: No description available. ,
download: No description available. ,
upload: No description available. ,
recall: No description available. ,
}
,
Required: False ,
}
enum ,
perItemErrorCount:
{
Description: Per item error count ,
Required: False ,
}
integer ,
appliedItemCount:
{
Description: Applied item count. ,
Required: False ,
}
integer ,
totalItemCount:
{
Description: Total item count ,
Required: False ,
}
integer ,
appliedBytes:
{
Description: Applied bytes ,
Required: False ,
}
integer ,
totalBytes:
{
Description: Total bytes ,
Required: False ,
}
integer ,
}
,
offlineDataTransferStatus:
{
Description: Offline Data Transfer State ,
Enum:
{
InProgress: No description available. ,
Stopping: No description available. ,
NotRunning: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
offlineDataTransfer:
{
Description: Offline data transfer ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
offlineDataTransferStorageAccountResourceId:
{
Description: Offline data transfer storage account resource ID ,
Required: False ,
}
string ,
offlineDataTransferStorageAccountTenantId:
{
Description: Offline data transfer storage account tenant ID ,
Required: False ,
}
string ,
offlineDataTransferShareName:
{
Description: Offline data transfer share name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Operation Status Location URI ,
}
string ,
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_Update (new)
Description :  Patch a given ServerEndpoint.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
serverEndpointName:
{
Description: Name of Server Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Any of the properties applicable in PUT request. ,
Required: False ,
}
{
properties:
{
Description: The properties of the server endpoint. ,
Required: False ,
}
{
cloudTiering:
{
Description: Cloud Tiering. ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
volumeFreeSpacePercent:
{
Description: Level of free space to be maintained by Cloud Tiering if it is enabled. ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Required: False ,
}
integer ,
offlineDataTransfer:
{
Description: Offline data transfer ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
offlineDataTransferShareName:
{
Description: Offline data transfer share name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Server Endpoint object. ,
}
{
properties:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
serverLocalPath:
{
Description: Server Local path. ,
Required: False ,
}
string ,
cloudTiering:
{
Description: Cloud Tiering. ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
volumeFreeSpacePercent:
{
Description: Level of free space to be maintained by Cloud Tiering if it is enabled. ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Required: False ,
}
integer ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
serverResourceId:
{
Description: Server Resource Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: ServerEndpoint Provisioning State ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: ServerEndpoint lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
syncStatus:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
downloadHealth:
{
Description: Download Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
uploadHealth:
{
Description: Upload Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
combinedHealth:
{
Description: Combined Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Description: Last Updated Timestamp ,
Format: date-time ,
Required: False ,
}
string ,
uploadStatus:
{
Description: Upload Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
downloadStatus:
{
Description: Download Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
currentProgress:
{
Description: Current progress ,
Required: False ,
}
{
progressTimestamp:
{
Description: Progress timestamp ,
Format: date-time ,
Required: False ,
}
string ,
syncDirection:
{
Description: Sync direction. ,
Enum:
{
none: No description available. ,
initialize: No description available. ,
download: No description available. ,
upload: No description available. ,
recall: No description available. ,
}
,
Required: False ,
}
enum ,
perItemErrorCount:
{
Description: Per item error count ,
Required: False ,
}
integer ,
appliedItemCount:
{
Description: Applied item count. ,
Required: False ,
}
integer ,
totalItemCount:
{
Description: Total item count ,
Required: False ,
}
integer ,
appliedBytes:
{
Description: Applied bytes ,
Required: False ,
}
integer ,
totalBytes:
{
Description: Total bytes ,
Required: False ,
}
integer ,
}
,
offlineDataTransferStatus:
{
Description: Offline Data Transfer State ,
Enum:
{
InProgress: No description available. ,
Stopping: No description available. ,
NotRunning: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
offlineDataTransfer:
{
Description: Offline data transfer ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
offlineDataTransferStorageAccountResourceId:
{
Description: Offline data transfer storage account resource ID ,
Required: False ,
}
string ,
offlineDataTransferStorageAccountTenantId:
{
Description: Offline data transfer storage account tenant ID ,
Required: False ,
}
string ,
offlineDataTransferShareName:
{
Description: Offline data transfer share name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Operation Status Location URI ,
}
string ,
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_Get (new)
Description :  Get a ServerEndpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
serverEndpointName:
{
Description: Name of Server Endpoint object. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Server Endpoint object. ,
}
{
properties:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
serverLocalPath:
{
Description: Server Local path. ,
Required: False ,
}
string ,
cloudTiering:
{
Description: Cloud Tiering. ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
volumeFreeSpacePercent:
{
Description: Level of free space to be maintained by Cloud Tiering if it is enabled. ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Required: False ,
}
integer ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
serverResourceId:
{
Description: Server Resource Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: ServerEndpoint Provisioning State ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: ServerEndpoint lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
syncStatus:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
downloadHealth:
{
Description: Download Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
uploadHealth:
{
Description: Upload Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
combinedHealth:
{
Description: Combined Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Description: Last Updated Timestamp ,
Format: date-time ,
Required: False ,
}
string ,
uploadStatus:
{
Description: Upload Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
downloadStatus:
{
Description: Download Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
currentProgress:
{
Description: Current progress ,
Required: False ,
}
{
progressTimestamp:
{
Description: Progress timestamp ,
Format: date-time ,
Required: False ,
}
string ,
syncDirection:
{
Description: Sync direction. ,
Enum:
{
none: No description available. ,
initialize: No description available. ,
download: No description available. ,
upload: No description available. ,
recall: No description available. ,
}
,
Required: False ,
}
enum ,
perItemErrorCount:
{
Description: Per item error count ,
Required: False ,
}
integer ,
appliedItemCount:
{
Description: Applied item count. ,
Required: False ,
}
integer ,
totalItemCount:
{
Description: Total item count ,
Required: False ,
}
integer ,
appliedBytes:
{
Description: Applied bytes ,
Required: False ,
}
integer ,
totalBytes:
{
Description: Total bytes ,
Required: False ,
}
integer ,
}
,
offlineDataTransferStatus:
{
Description: Offline Data Transfer State ,
Enum:
{
InProgress: No description available. ,
Stopping: No description available. ,
NotRunning: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
offlineDataTransfer:
{
Description: Offline data transfer ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
offlineDataTransferStorageAccountResourceId:
{
Description: Offline data transfer storage account resource ID ,
Required: False ,
}
string ,
offlineDataTransferStorageAccountTenantId:
{
Description: Offline data transfer storage account tenant ID ,
Required: False ,
}
string ,
offlineDataTransferShareName:
{
Description: Offline data transfer share name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_Delete (new)
Description :  Delete a given ServerEndpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
serverEndpointName:
{
Description: Name of Server Endpoint object. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_ListBySyncGroup (new)
Description :  Get a ServerEndpoint list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Array of ServerEndpoint ,
}
{
value:
{
Description: Collection of ServerEndpoint. ,
Required: False ,
}
[
{
properties:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
serverLocalPath:
{
Description: Server Local path. ,
Required: False ,
}
string ,
cloudTiering:
{
Description: Cloud Tiering. ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
volumeFreeSpacePercent:
{
Description: Level of free space to be maintained by Cloud Tiering if it is enabled. ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Required: False ,
}
integer ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
serverResourceId:
{
Description: Server Resource Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: ServerEndpoint Provisioning State ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: ServerEndpoint lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
syncStatus:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
downloadHealth:
{
Description: Download Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
uploadHealth:
{
Description: Upload Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
combinedHealth:
{
Description: Combined Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Description: Last Updated Timestamp ,
Format: date-time ,
Required: False ,
}
string ,
uploadStatus:
{
Description: Upload Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
downloadStatus:
{
Description: Download Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
currentProgress:
{
Description: Current progress ,
Required: False ,
}
{
progressTimestamp:
{
Description: Progress timestamp ,
Format: date-time ,
Required: False ,
}
string ,
syncDirection:
{
Description: Sync direction. ,
Enum:
{
none: No description available. ,
initialize: No description available. ,
download: No description available. ,
upload: No description available. ,
recall: No description available. ,
}
,
Required: False ,
}
enum ,
perItemErrorCount:
{
Description: Per item error count ,
Required: False ,
}
integer ,
appliedItemCount:
{
Description: Applied item count. ,
Required: False ,
}
integer ,
totalItemCount:
{
Description: Total item count ,
Required: False ,
}
integer ,
appliedBytes:
{
Description: Applied bytes ,
Required: False ,
}
integer ,
totalBytes:
{
Description: Total bytes ,
Required: False ,
}
integer ,
}
,
offlineDataTransferStatus:
{
Description: Offline Data Transfer State ,
Enum:
{
InProgress: No description available. ,
Stopping: No description available. ,
NotRunning: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
offlineDataTransfer:
{
Description: Offline data transfer ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
offlineDataTransferStorageAccountResourceId:
{
Description: Offline data transfer storage account resource ID ,
Required: False ,
}
string ,
offlineDataTransferStorageAccountTenantId:
{
Description: Offline data transfer storage account tenant ID ,
Required: False ,
}
string ,
offlineDataTransferShareName:
{
Description: Offline data transfer share name ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_recallAction (new)
Description :  Recall a server endpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}/recallAction
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
serverEndpointName:
{
Description: Name of Server Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Recall Action object. ,
Required: True ,
}
{
pattern:
{
Description: Pattern of the files. ,
Required: False ,
}
string ,
recallPath:
{
Description: Recall path. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
RegisteredServers_ListByStorageSyncService (new)
Description :  Get a given registered server list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Array of RegisteredServer ,
}
{
value:
{
Description: Collection of Registered Server. ,
Required: False ,
}
[
{
properties:
{
Description: RegisteredServer properties. ,
Required: False ,
}
{
serverCertificate:
{
Description: Registered Server Certificate ,
Required: False ,
}
string ,
agentVersion:
{
Description: Registered Server Agent Version ,
Required: False ,
}
string ,
serverOSVersion:
{
Description: Registered Server OS Version ,
Required: False ,
}
string ,
serverManagementErrorCode:
{
Description: Registered Server Management Error Code ,
Required: False ,
}
integer ,
lastHeartBeat:
{
Description: Registered Server last heart beat ,
Required: False ,
}
string ,
provisioningState:
{
Description: Registered Server Provisioning State ,
Required: False ,
}
string ,
serverRole:
{
Description: Registered Server serverRole ,
Required: False ,
}
string ,
clusterId:
{
Description: Registered Server clusterId ,
Required: False ,
}
string ,
clusterName:
{
Description: Registered Server clusterName ,
Required: False ,
}
string ,
serverId:
{
Description: Registered Server serverId ,
Required: False ,
}
string ,
storageSyncServiceUid:
{
Description: Registered Server storageSyncServiceUid ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: Registered Server lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
discoveryEndpointUri:
{
Description: Resource discoveryEndpointUri ,
Required: False ,
}
string ,
resourceLocation:
{
Description: Resource Location ,
Required: False ,
}
string ,
serviceLocation:
{
Description: Service Location ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
managementEndpointUri:
{
Description: Management Endpoint Uri ,
Required: False ,
}
string ,
monitoringConfiguration:
{
Description: Monitoring Configuration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
RegisteredServers_Get (new)
Description :  Get a given registered server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
serverId:
{
Description: GUID identifying the on-premises server. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Registered Server resource. ,
}
{
properties:
{
Description: RegisteredServer properties. ,
Required: False ,
}
{
serverCertificate:
{
Description: Registered Server Certificate ,
Required: False ,
}
string ,
agentVersion:
{
Description: Registered Server Agent Version ,
Required: False ,
}
string ,
serverOSVersion:
{
Description: Registered Server OS Version ,
Required: False ,
}
string ,
serverManagementErrorCode:
{
Description: Registered Server Management Error Code ,
Required: False ,
}
integer ,
lastHeartBeat:
{
Description: Registered Server last heart beat ,
Required: False ,
}
string ,
provisioningState:
{
Description: Registered Server Provisioning State ,
Required: False ,
}
string ,
serverRole:
{
Description: Registered Server serverRole ,
Required: False ,
}
string ,
clusterId:
{
Description: Registered Server clusterId ,
Required: False ,
}
string ,
clusterName:
{
Description: Registered Server clusterName ,
Required: False ,
}
string ,
serverId:
{
Description: Registered Server serverId ,
Required: False ,
}
string ,
storageSyncServiceUid:
{
Description: Registered Server storageSyncServiceUid ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: Registered Server lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
discoveryEndpointUri:
{
Description: Resource discoveryEndpointUri ,
Required: False ,
}
string ,
resourceLocation:
{
Description: Resource Location ,
Required: False ,
}
string ,
serviceLocation:
{
Description: Service Location ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
managementEndpointUri:
{
Description: Management Endpoint Uri ,
Required: False ,
}
string ,
monitoringConfiguration:
{
Description: Monitoring Configuration ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
RegisteredServers_Create (new)
Description :  Add a new registered server.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
serverId:
{
Description: GUID identifying the on-premises server. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Registered Server object. ,
Required: True ,
}
{
properties:
{
Description: The parameters used to create the registered server. ,
Required: False ,
}
{
serverCertificate:
{
Description: Registered Server Certificate ,
Required: False ,
}
string ,
agentVersion:
{
Description: Registered Server Agent Version ,
Required: False ,
}
string ,
serverOSVersion:
{
Description: Registered Server OS Version ,
Required: False ,
}
string ,
lastHeartBeat:
{
Description: Registered Server last heart beat ,
Required: False ,
}
string ,
serverRole:
{
Description: Registered Server serverRole ,
Required: False ,
}
string ,
clusterId:
{
Description: Registered Server clusterId ,
Required: False ,
}
string ,
clusterName:
{
Description: Registered Server clusterName ,
Required: False ,
}
string ,
serverId:
{
Description: Registered Server serverId ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Registered Server resource. ,
}
{
properties:
{
Description: RegisteredServer properties. ,
Required: False ,
}
{
serverCertificate:
{
Description: Registered Server Certificate ,
Required: False ,
}
string ,
agentVersion:
{
Description: Registered Server Agent Version ,
Required: False ,
}
string ,
serverOSVersion:
{
Description: Registered Server OS Version ,
Required: False ,
}
string ,
serverManagementErrorCode:
{
Description: Registered Server Management Error Code ,
Required: False ,
}
integer ,
lastHeartBeat:
{
Description: Registered Server last heart beat ,
Required: False ,
}
string ,
provisioningState:
{
Description: Registered Server Provisioning State ,
Required: False ,
}
string ,
serverRole:
{
Description: Registered Server serverRole ,
Required: False ,
}
string ,
clusterId:
{
Description: Registered Server clusterId ,
Required: False ,
}
string ,
clusterName:
{
Description: Registered Server clusterName ,
Required: False ,
}
string ,
serverId:
{
Description: Registered Server serverId ,
Required: False ,
}
string ,
storageSyncServiceUid:
{
Description: Registered Server storageSyncServiceUid ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: Registered Server lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
discoveryEndpointUri:
{
Description: Resource discoveryEndpointUri ,
Required: False ,
}
string ,
resourceLocation:
{
Description: Resource Location ,
Required: False ,
}
string ,
serviceLocation:
{
Description: Service Location ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
managementEndpointUri:
{
Description: Management Endpoint Uri ,
Required: False ,
}
string ,
monitoringConfiguration:
{
Description: Monitoring Configuration ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Operation Status Location URI ,
}
string ,
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
RegisteredServers_Delete (new)
Description :  Delete the given registered server.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
serverId:
{
Description: GUID identifying the on-premises server. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
RegisteredServers_triggerRollover (new)
Description :  Triggers Server certificate rollover.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}/triggerRollover
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
serverId:
{
Description: Server Id ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Trigger Rollover request. ,
Required: True ,
}
{
serverCertificate:
{
Description: Certificate Data ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
Workflows_ListByStorageSyncService (new)
Description :  Get a Workflow List
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Array of Workflow ,
}
{
value:
{
Description: Collection of workflow items. ,
Required: False ,
}
[
{
properties:
{
Description: Workflow properties. ,
Required: False ,
}
{
lastStepName:
{
Description: last step name ,
Required: False ,
}
string ,
status:
{
Description: workflow status. ,
Enum:
{
active: No description available. ,
expired: No description available. ,
succeeded: No description available. ,
aborted: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
operation:
{
Description: operation direction. ,
Enum:
{
do: No description available. ,
undo: No description available. ,
cancel: No description available. ,
}
,
Required: False ,
}
enum ,
steps:
{
Description: workflow steps ,
Required: False ,
}
string ,
lastOperationId:
{
Description: workflow last operation identifier. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
Workflows_Get (new)
Description :  Get Workflows resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
workflowId:
{
Description: workflow Id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Workflow resource. ,
}
{
properties:
{
Description: Workflow properties. ,
Required: False ,
}
{
lastStepName:
{
Description: last step name ,
Required: False ,
}
string ,
status:
{
Description: workflow status. ,
Enum:
{
active: No description available. ,
expired: No description available. ,
succeeded: No description available. ,
aborted: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
operation:
{
Description: operation direction. ,
Enum:
{
do: No description available. ,
undo: No description available. ,
cancel: No description available. ,
}
,
Required: False ,
}
enum ,
steps:
{
Description: workflow steps ,
Required: False ,
}
string ,
lastOperationId:
{
Description: workflow last operation identifier. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
Workflows_Abort (new)
Description :  Abort the given workflow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}/abort
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
workflowId:
{
Description: workflow Id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
Operations_List (removed)
Description :  Lists all of the available Storage Sync Rest API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.StorageSync/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: The list of storage sync operations. ,
}
{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The operation supported by storage sync. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The action that users can perform, based on their permission level. ,
Required: False ,
}
string ,
provider:
{
Description: Service provider: Microsoft StorageSync. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The origin. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_CheckNameAvailability (removed)
Description :  Check the give namespace name availability.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/locations/{locationName}/checkNameAvailability
{
locationName:
{
Description: The desired region for the name check. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to check availability of the given namespace name ,
Required: True ,
}
{
name:
{
Description: The name to check for availability ,
Required: True ,
}
string ,
type:
{
Description: The resource type. Must be set to Microsoft.StorageSync/storageSyncServices ,
Enum:
{
Microsoft.StorageSync/storageSyncServices: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
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. ,
Required: False ,
}
boolean ,
reason:
{
Description: Gets the reason that a Storage Sync Service name could not be used. The Reason element is only returned if NameAvailable is false. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Gets an error message explaining the Reason value in more detail. ,
Required: False ,
}
string ,
}
StorageSyncServices_Create (removed)
Description :  Create a new StorageSyncService.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Storage Sync Service resource name. ,
Required: True ,
}
{
location:
{
Description: Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed. ,
Required: True ,
}
string ,
tags:
{
Description: Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters. ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Storage Sync Service properties. ,
Required: False ,
}
{
storageSyncServiceStatus:
{
Description: Storage Sync service status. ,
Required: False ,
}
integer ,
storageSyncServiceUid:
{
Description: Storage Sync service Uid ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_Get (removed)
Description :  Get a given StorageSyncService.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Storage Sync Service object. ,
}
{
properties:
{
Description: Storage Sync Service properties. ,
Required: False ,
}
{
storageSyncServiceStatus:
{
Description: Storage Sync service status. ,
Required: False ,
}
integer ,
storageSyncServiceUid:
{
Description: Storage Sync service Uid ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_Update (removed)
Description :  Patch a given StorageSyncService.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Storage Sync Service resource. ,
Required: False ,
}
{
tags:
{
Description: The user-specified tags associated with the storage sync service. ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the storage sync service. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Storage Sync Service object. ,
}
{
properties:
{
Description: Storage Sync Service properties. ,
Required: False ,
}
{
storageSyncServiceStatus:
{
Description: Storage Sync service status. ,
Required: False ,
}
integer ,
storageSyncServiceUid:
{
Description: Storage Sync service Uid ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_Delete (removed)
Description :  Delete a given StorageSyncService.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_ListByResourceGroup (removed)
Description :  Get a StorageSyncService list by Resource group name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Array of StorageSyncServices ,
}
{
value:
{
Description: Collection of StorageSyncServices. ,
Required: False ,
}
[
{
properties:
{
Description: Storage Sync Service properties. ,
Required: False ,
}
{
storageSyncServiceStatus:
{
Description: Storage Sync service status. ,
Required: False ,
}
integer ,
storageSyncServiceUid:
{
Description: Storage Sync service Uid ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_ListBySubscription (removed)
Description :  Get a StorageSyncService list by subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/storageSyncServices
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Array of StorageSyncServices ,
}
{
value:
{
Description: Collection of StorageSyncServices. ,
Required: False ,
}
[
{
properties:
{
Description: Storage Sync Service properties. ,
Required: False ,
}
{
storageSyncServiceStatus:
{
Description: Storage Sync service status. ,
Required: False ,
}
integer ,
storageSyncServiceUid:
{
Description: Storage Sync service Uid ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
SyncGroups_ListByStorageSyncService (removed)
Description :  Get a SyncGroup List.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Array of SyncGroup ,
}
{
value:
{
Description: Collection of SyncGroup. ,
Required: False ,
}
[
{
properties:
{
Description: SyncGroup properties. ,
Required: False ,
}
{
uniqueId:
{
Description: Unique Id ,
Required: False ,
}
string ,
syncGroupStatus:
{
Description: Sync group status ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
SyncGroups_Create (removed)
Description :  Create a new SyncGroup.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Sync Group Body ,
Required: True ,
}
{
properties:
{
Description: The parameters used to create the sync group ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Sync Group object. ,
}
{
properties:
{
Description: SyncGroup properties. ,
Required: False ,
}
{
uniqueId:
{
Description: Unique Id ,
Required: False ,
}
string ,
syncGroupStatus:
{
Description: Sync group status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
SyncGroups_Get (removed)
Description :  Get a given SyncGroup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Sync Group object. ,
}
{
properties:
{
Description: SyncGroup properties. ,
Required: False ,
}
{
uniqueId:
{
Description: Unique Id ,
Required: False ,
}
string ,
syncGroupStatus:
{
Description: Sync group status ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
SyncGroups_Delete (removed)
Description :  Delete a given SyncGroup.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: Request id ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_Create (removed)
Description :  Create a new CloudEndpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Cloud Endpoint resource. ,
Required: True ,
}
{
properties:
{
Description: The parameters used to create the cloud endpoint. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Storage Account Resource Id ,
Required: False ,
}
string ,
storageAccountShareName:
{
Description: Storage Account Share name ,
Required: False ,
}
string ,
storageAccountTenantId:
{
Description: Storage Account Tenant Id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Cloud Endpoint object. ,
}
{
properties:
{
Description: Cloud Endpoint properties. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Storage Account Resource Id ,
Required: False ,
}
string ,
storageAccountShareName:
{
Description: Storage Account Share name ,
Required: False ,
}
string ,
storageAccountTenantId:
{
Description: Storage Account Tenant Id ,
Required: False ,
}
string ,
partnershipId:
{
Description: Partnership Id ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
backupEnabled:
{
Description: Backup Enabled ,
Required: False ,
}
string ,
provisioningState:
{
Description: CloudEndpoint Provisioning State ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: CloudEndpoint lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Operation Status Location URI ,
}
string ,
location:
{
Description: Operation Status Location URI ,
}
string ,
retry-after:
{
Description: Retry After ,
}
string ,
x-ms-request-id:
{
Description: Request id ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_Get (removed)
Description :  Get a given CloudEndpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Cloud Endpoint object. ,
}
{
properties:
{
Description: Cloud Endpoint properties. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Storage Account Resource Id ,
Required: False ,
}
string ,
storageAccountShareName:
{
Description: Storage Account Share name ,
Required: False ,
}
string ,
storageAccountTenantId:
{
Description: Storage Account Tenant Id ,
Required: False ,
}
string ,
partnershipId:
{
Description: Partnership Id ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
backupEnabled:
{
Description: Backup Enabled ,
Required: False ,
}
string ,
provisioningState:
{
Description: CloudEndpoint Provisioning State ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: CloudEndpoint lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_Delete (removed)
Description :  Delete a given CloudEndpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Operation Status Location URI ,
}
string ,
location:
{
Description: Operation Status Location URI ,
}
string ,
retry-after:
{
Description: Retry After ,
}
string ,
x-ms-request-id:
{
Description: Request id ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_ListBySyncGroup (removed)
Description :  Get a CloudEndpoint List.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Array of CloudEndpoint ,
}
{
value:
{
Description: Collection of CloudEndpoint. ,
Required: False ,
}
[
{
properties:
{
Description: Cloud Endpoint properties. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Storage Account Resource Id ,
Required: False ,
}
string ,
storageAccountShareName:
{
Description: Storage Account Share name ,
Required: False ,
}
string ,
storageAccountTenantId:
{
Description: Storage Account Tenant Id ,
Required: False ,
}
string ,
partnershipId:
{
Description: Partnership Id ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
backupEnabled:
{
Description: Backup Enabled ,
Required: False ,
}
string ,
provisioningState:
{
Description: CloudEndpoint Provisioning State ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: CloudEndpoint lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_PreBackup (removed)
Description :  Pre Backup a given CloudEndpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prebackup
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Backup request. ,
Required: True ,
}
{
azureFileShare:
{
Description: Azure File Share. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_PostBackup (removed)
Description :  Post Backup a given CloudEndpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postbackup
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Backup request. ,
Required: True ,
}
{
azureFileShare:
{
Description: Azure File Share. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Post Backup Response ,
}
{
backupMetadata:
{
Description: Post Backup Response Properties ,
Required: False ,
}
{
cloudEndpointName:
{
Description: cloud endpoint Name. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_PreRestore (removed)
Description :  Pre Restore a given CloudEndpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prerestore
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Cloud Endpoint object. ,
Required: True ,
}
{
partition:
{
Description: Pre Restore partition. ,
Required: False ,
}
string ,
replicaGroup:
{
Description: Pre Restore replica group. ,
Required: False ,
}
string ,
requestId:
{
Description: Pre Restore request id. ,
Required: False ,
}
string ,
azureFileShareUri:
{
Description: Pre Restore Azure file share uri. ,
Required: False ,
}
string ,
status:
{
Description: Pre Restore Azure status. ,
Required: False ,
}
string ,
sourceAzureFileShareUri:
{
Description: Pre Restore Azure source azure file share uri. ,
Required: False ,
}
string ,
backupMetadataPropertyBag:
{
Description: Pre Restore backup metadata property bag. ,
Required: False ,
}
string ,
restoreFileSpec:
{
Description: Pre Restore restore file spec array. ,
Required: False ,
}
[
{
path:
{
Description: Restore file spec path ,
Required: False ,
}
string ,
isdir:
{
Description: Restore file spec isdir ,
Required: False ,
}
boolean ,
}
,
]
,
pauseWaitForSyncDrainTimePeriodInSeconds:
{
Description: Pre Restore pause wait for sync drain time period in seconds. ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_restoreheartbeat (removed)
Description :  Restore Heartbeat a given CloudEndpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/restoreheartbeat
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_PostRestore (removed)
Description :  Post Restore a given CloudEndpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postrestore
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Cloud Endpoint object. ,
Required: True ,
}
{
partition:
{
Description: Post Restore partition. ,
Required: False ,
}
string ,
replicaGroup:
{
Description: Post Restore replica group. ,
Required: False ,
}
string ,
requestId:
{
Description: Post Restore request id. ,
Required: False ,
}
string ,
azureFileShareUri:
{
Description: Post Restore Azure file share uri. ,
Required: False ,
}
string ,
status:
{
Description: Post Restore Azure status. ,
Required: False ,
}
string ,
sourceAzureFileShareUri:
{
Description: Post Restore Azure source azure file share uri. ,
Required: False ,
}
string ,
failedFileList:
{
Description: Post Restore Azure failed file list. ,
Required: False ,
}
string ,
restoreFileSpec:
{
Description: Post Restore restore file spec array. ,
Required: False ,
}
[
{
path:
{
Description: Restore file spec path ,
Required: False ,
}
string ,
isdir:
{
Description: Restore file spec isdir ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_Create (removed)
Description :  Create a new ServerEndpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
serverEndpointName:
{
Description: Name of Server Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Server Endpoint object. ,
Required: True ,
}
{
properties:
{
Description: The parameters used to create the server endpoint. ,
Required: False ,
}
{
serverLocalPath:
{
Description: Server Local path. ,
Required: False ,
}
string ,
cloudTiering:
{
Description: Cloud Tiering. ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
volumeFreeSpacePercent:
{
Description: Level of free space to be maintained by Cloud Tiering if it is enabled. ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Required: False ,
}
integer ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
serverResourceId:
{
Description: Server Resource Id. ,
Required: False ,
}
string ,
offlineDataTransfer:
{
Description: Offline data transfer ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
offlineDataTransferShareName:
{
Description: Offline data transfer share name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Server Endpoint object. ,
}
{
properties:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
serverLocalPath:
{
Description: Server Local path. ,
Required: False ,
}
string ,
cloudTiering:
{
Description: Cloud Tiering. ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
volumeFreeSpacePercent:
{
Description: Level of free space to be maintained by Cloud Tiering if it is enabled. ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Required: False ,
}
integer ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
serverResourceId:
{
Description: Server Resource Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: ServerEndpoint Provisioning State ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: ServerEndpoint lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
syncStatus:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
downloadHealth:
{
Description: Download Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
uploadHealth:
{
Description: Upload Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
combinedHealth:
{
Description: Combined Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Description: Last Updated Timestamp ,
Format: date-time ,
Required: False ,
}
string ,
uploadStatus:
{
Description: Upload Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
downloadStatus:
{
Description: Download Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
currentProgress:
{
Description: Current progress ,
Required: False ,
}
{
progressTimestamp:
{
Description: Progress timestamp ,
Format: date-time ,
Required: False ,
}
string ,
syncDirection:
{
Description: Sync direction. ,
Enum:
{
none: No description available. ,
initialize: No description available. ,
download: No description available. ,
upload: No description available. ,
recall: No description available. ,
}
,
Required: False ,
}
enum ,
perItemErrorCount:
{
Description: Per item error count ,
Required: False ,
}
integer ,
appliedItemCount:
{
Description: Applied item count. ,
Required: False ,
}
integer ,
totalItemCount:
{
Description: Total item count ,
Required: False ,
}
integer ,
appliedBytes:
{
Description: Applied bytes ,
Required: False ,
}
integer ,
totalBytes:
{
Description: Total bytes ,
Required: False ,
}
integer ,
}
,
offlineDataTransferStatus:
{
Description: Offline Data Transfer State ,
Enum:
{
InProgress: No description available. ,
Stopping: No description available. ,
NotRunning: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
offlineDataTransfer:
{
Description: Offline data transfer ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
offlineDataTransferStorageAccountResourceId:
{
Description: Offline data transfer storage account resource ID ,
Required: False ,
}
string ,
offlineDataTransferStorageAccountTenantId:
{
Description: Offline data transfer storage account tenant ID ,
Required: False ,
}
string ,
offlineDataTransferShareName:
{
Description: Offline data transfer share name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Operation Status Location URI ,
}
string ,
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_Update (removed)
Description :  Patch a given ServerEndpoint.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
serverEndpointName:
{
Description: Name of Server Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Any of the properties applicable in PUT request. ,
Required: False ,
}
{
properties:
{
Description: The properties of the server endpoint. ,
Required: False ,
}
{
cloudTiering:
{
Description: Cloud Tiering. ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
volumeFreeSpacePercent:
{
Description: Level of free space to be maintained by Cloud Tiering if it is enabled. ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Required: False ,
}
integer ,
offlineDataTransfer:
{
Description: Offline data transfer ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
offlineDataTransferShareName:
{
Description: Offline data transfer share name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Server Endpoint object. ,
}
{
properties:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
serverLocalPath:
{
Description: Server Local path. ,
Required: False ,
}
string ,
cloudTiering:
{
Description: Cloud Tiering. ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
volumeFreeSpacePercent:
{
Description: Level of free space to be maintained by Cloud Tiering if it is enabled. ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Required: False ,
}
integer ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
serverResourceId:
{
Description: Server Resource Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: ServerEndpoint Provisioning State ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: ServerEndpoint lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
syncStatus:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
downloadHealth:
{
Description: Download Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
uploadHealth:
{
Description: Upload Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
combinedHealth:
{
Description: Combined Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Description: Last Updated Timestamp ,
Format: date-time ,
Required: False ,
}
string ,
uploadStatus:
{
Description: Upload Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
downloadStatus:
{
Description: Download Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
currentProgress:
{
Description: Current progress ,
Required: False ,
}
{
progressTimestamp:
{
Description: Progress timestamp ,
Format: date-time ,
Required: False ,
}
string ,
syncDirection:
{
Description: Sync direction. ,
Enum:
{
none: No description available. ,
initialize: No description available. ,
download: No description available. ,
upload: No description available. ,
recall: No description available. ,
}
,
Required: False ,
}
enum ,
perItemErrorCount:
{
Description: Per item error count ,
Required: False ,
}
integer ,
appliedItemCount:
{
Description: Applied item count. ,
Required: False ,
}
integer ,
totalItemCount:
{
Description: Total item count ,
Required: False ,
}
integer ,
appliedBytes:
{
Description: Applied bytes ,
Required: False ,
}
integer ,
totalBytes:
{
Description: Total bytes ,
Required: False ,
}
integer ,
}
,
offlineDataTransferStatus:
{
Description: Offline Data Transfer State ,
Enum:
{
InProgress: No description available. ,
Stopping: No description available. ,
NotRunning: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
offlineDataTransfer:
{
Description: Offline data transfer ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
offlineDataTransferStorageAccountResourceId:
{
Description: Offline data transfer storage account resource ID ,
Required: False ,
}
string ,
offlineDataTransferStorageAccountTenantId:
{
Description: Offline data transfer storage account tenant ID ,
Required: False ,
}
string ,
offlineDataTransferShareName:
{
Description: Offline data transfer share name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Operation Status Location URI ,
}
string ,
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_Get (removed)
Description :  Get a ServerEndpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
serverEndpointName:
{
Description: Name of Server Endpoint object. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Server Endpoint object. ,
}
{
properties:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
serverLocalPath:
{
Description: Server Local path. ,
Required: False ,
}
string ,
cloudTiering:
{
Description: Cloud Tiering. ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
volumeFreeSpacePercent:
{
Description: Level of free space to be maintained by Cloud Tiering if it is enabled. ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Required: False ,
}
integer ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
serverResourceId:
{
Description: Server Resource Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: ServerEndpoint Provisioning State ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: ServerEndpoint lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
syncStatus:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
downloadHealth:
{
Description: Download Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
uploadHealth:
{
Description: Upload Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
combinedHealth:
{
Description: Combined Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Description: Last Updated Timestamp ,
Format: date-time ,
Required: False ,
}
string ,
uploadStatus:
{
Description: Upload Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
downloadStatus:
{
Description: Download Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
currentProgress:
{
Description: Current progress ,
Required: False ,
}
{
progressTimestamp:
{
Description: Progress timestamp ,
Format: date-time ,
Required: False ,
}
string ,
syncDirection:
{
Description: Sync direction. ,
Enum:
{
none: No description available. ,
initialize: No description available. ,
download: No description available. ,
upload: No description available. ,
recall: No description available. ,
}
,
Required: False ,
}
enum ,
perItemErrorCount:
{
Description: Per item error count ,
Required: False ,
}
integer ,
appliedItemCount:
{
Description: Applied item count. ,
Required: False ,
}
integer ,
totalItemCount:
{
Description: Total item count ,
Required: False ,
}
integer ,
appliedBytes:
{
Description: Applied bytes ,
Required: False ,
}
integer ,
totalBytes:
{
Description: Total bytes ,
Required: False ,
}
integer ,
}
,
offlineDataTransferStatus:
{
Description: Offline Data Transfer State ,
Enum:
{
InProgress: No description available. ,
Stopping: No description available. ,
NotRunning: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
offlineDataTransfer:
{
Description: Offline data transfer ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
offlineDataTransferStorageAccountResourceId:
{
Description: Offline data transfer storage account resource ID ,
Required: False ,
}
string ,
offlineDataTransferStorageAccountTenantId:
{
Description: Offline data transfer storage account tenant ID ,
Required: False ,
}
string ,
offlineDataTransferShareName:
{
Description: Offline data transfer share name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_Delete (removed)
Description :  Delete a given ServerEndpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
serverEndpointName:
{
Description: Name of Server Endpoint object. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_ListBySyncGroup (removed)
Description :  Get a ServerEndpoint list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Array of ServerEndpoint ,
}
{
value:
{
Description: Collection of ServerEndpoint. ,
Required: False ,
}
[
{
properties:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
serverLocalPath:
{
Description: Server Local path. ,
Required: False ,
}
string ,
cloudTiering:
{
Description: Cloud Tiering. ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
volumeFreeSpacePercent:
{
Description: Level of free space to be maintained by Cloud Tiering if it is enabled. ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Required: False ,
}
integer ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
serverResourceId:
{
Description: Server Resource Id. ,
Required: False ,
}
string ,
provisioningState:
{
Description: ServerEndpoint Provisioning State ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: ServerEndpoint lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
syncStatus:
{
Description: Server Endpoint properties. ,
Required: False ,
}
{
downloadHealth:
{
Description: Download Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
uploadHealth:
{
Description: Upload Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
combinedHealth:
{
Description: Combined Health Status. ,
Enum:
{
Healthy: No description available. ,
Error: No description available. ,
SyncBlockedForRestore: No description available. ,
SyncBlockedForChangeDetectionPostRestore: No description available. ,
NoActivity: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTimestamp:
{
Description: Last Updated Timestamp ,
Format: date-time ,
Required: False ,
}
string ,
uploadStatus:
{
Description: Upload Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
downloadStatus:
{
Description: Download Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync status ,
Required: False ,
}
integer ,
lastSyncTimestamp:
{
Description: Last sync timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncSuccessTimestamp:
{
Description: Last sync success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncPerItemErrorCount:
{
Description: Last sync per item error count. ,
Required: False ,
}
integer ,
}
,
currentProgress:
{
Description: Current progress ,
Required: False ,
}
{
progressTimestamp:
{
Description: Progress timestamp ,
Format: date-time ,
Required: False ,
}
string ,
syncDirection:
{
Description: Sync direction. ,
Enum:
{
none: No description available. ,
initialize: No description available. ,
download: No description available. ,
upload: No description available. ,
recall: No description available. ,
}
,
Required: False ,
}
enum ,
perItemErrorCount:
{
Description: Per item error count ,
Required: False ,
}
integer ,
appliedItemCount:
{
Description: Applied item count. ,
Required: False ,
}
integer ,
totalItemCount:
{
Description: Total item count ,
Required: False ,
}
integer ,
appliedBytes:
{
Description: Applied bytes ,
Required: False ,
}
integer ,
totalBytes:
{
Description: Total bytes ,
Required: False ,
}
integer ,
}
,
offlineDataTransferStatus:
{
Description: Offline Data Transfer State ,
Enum:
{
InProgress: No description available. ,
Stopping: No description available. ,
NotRunning: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
offlineDataTransfer:
{
Description: Offline data transfer ,
Enum:
{
on: No description available. ,
off: No description available. ,
}
,
Required: False ,
}
enum ,
offlineDataTransferStorageAccountResourceId:
{
Description: Offline data transfer storage account resource ID ,
Required: False ,
}
string ,
offlineDataTransferStorageAccountTenantId:
{
Description: Offline data transfer storage account tenant ID ,
Required: False ,
}
string ,
offlineDataTransferShareName:
{
Description: Offline data transfer share name ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_recallAction (removed)
Description :  Recall a server endpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}/recallAction
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
serverEndpointName:
{
Description: Name of Server Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Recall Action object. ,
Required: True ,
}
{
pattern:
{
Description: Pattern of the files. ,
Required: False ,
}
string ,
recallPath:
{
Description: Recall path. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
RegisteredServers_ListByStorageSyncService (removed)
Description :  Get a given registered server list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Array of RegisteredServer ,
}
{
value:
{
Description: Collection of Registered Server. ,
Required: False ,
}
[
{
properties:
{
Description: RegisteredServer properties. ,
Required: False ,
}
{
serverCertificate:
{
Description: Registered Server Certificate ,
Required: False ,
}
string ,
agentVersion:
{
Description: Registered Server Agent Version ,
Required: False ,
}
string ,
serverOSVersion:
{
Description: Registered Server OS Version ,
Required: False ,
}
string ,
serverManagementErrorCode:
{
Description: Registered Server Management Error Code ,
Required: False ,
}
integer ,
lastHeartBeat:
{
Description: Registered Server last heart beat ,
Required: False ,
}
string ,
provisioningState:
{
Description: Registered Server Provisioning State ,
Required: False ,
}
string ,
serverRole:
{
Description: Registered Server serverRole ,
Required: False ,
}
string ,
clusterId:
{
Description: Registered Server clusterId ,
Required: False ,
}
string ,
clusterName:
{
Description: Registered Server clusterName ,
Required: False ,
}
string ,
serverId:
{
Description: Registered Server serverId ,
Required: False ,
}
string ,
storageSyncServiceUid:
{
Description: Registered Server storageSyncServiceUid ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: Registered Server lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
discoveryEndpointUri:
{
Description: Resource discoveryEndpointUri ,
Required: False ,
}
string ,
resourceLocation:
{
Description: Resource Location ,
Required: False ,
}
string ,
serviceLocation:
{
Description: Service Location ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
managementEndpointUri:
{
Description: Management Endpoint Uri ,
Required: False ,
}
string ,
monitoringConfiguration:
{
Description: Monitoring Configuration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
RegisteredServers_Get (removed)
Description :  Get a given registered server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
serverId:
{
Description: GUID identifying the on-premises server. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Registered Server resource. ,
}
{
properties:
{
Description: RegisteredServer properties. ,
Required: False ,
}
{
serverCertificate:
{
Description: Registered Server Certificate ,
Required: False ,
}
string ,
agentVersion:
{
Description: Registered Server Agent Version ,
Required: False ,
}
string ,
serverOSVersion:
{
Description: Registered Server OS Version ,
Required: False ,
}
string ,
serverManagementErrorCode:
{
Description: Registered Server Management Error Code ,
Required: False ,
}
integer ,
lastHeartBeat:
{
Description: Registered Server last heart beat ,
Required: False ,
}
string ,
provisioningState:
{
Description: Registered Server Provisioning State ,
Required: False ,
}
string ,
serverRole:
{
Description: Registered Server serverRole ,
Required: False ,
}
string ,
clusterId:
{
Description: Registered Server clusterId ,
Required: False ,
}
string ,
clusterName:
{
Description: Registered Server clusterName ,
Required: False ,
}
string ,
serverId:
{
Description: Registered Server serverId ,
Required: False ,
}
string ,
storageSyncServiceUid:
{
Description: Registered Server storageSyncServiceUid ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: Registered Server lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
discoveryEndpointUri:
{
Description: Resource discoveryEndpointUri ,
Required: False ,
}
string ,
resourceLocation:
{
Description: Resource Location ,
Required: False ,
}
string ,
serviceLocation:
{
Description: Service Location ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
managementEndpointUri:
{
Description: Management Endpoint Uri ,
Required: False ,
}
string ,
monitoringConfiguration:
{
Description: Monitoring Configuration ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
RegisteredServers_Create (removed)
Description :  Add a new registered server.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
serverId:
{
Description: GUID identifying the on-premises server. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Registered Server object. ,
Required: True ,
}
{
properties:
{
Description: The parameters used to create the registered server. ,
Required: False ,
}
{
serverCertificate:
{
Description: Registered Server Certificate ,
Required: False ,
}
string ,
agentVersion:
{
Description: Registered Server Agent Version ,
Required: False ,
}
string ,
serverOSVersion:
{
Description: Registered Server OS Version ,
Required: False ,
}
string ,
lastHeartBeat:
{
Description: Registered Server last heart beat ,
Required: False ,
}
string ,
serverRole:
{
Description: Registered Server serverRole ,
Required: False ,
}
string ,
clusterId:
{
Description: Registered Server clusterId ,
Required: False ,
}
string ,
clusterName:
{
Description: Registered Server clusterName ,
Required: False ,
}
string ,
serverId:
{
Description: Registered Server serverId ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Registered Server resource. ,
}
{
properties:
{
Description: RegisteredServer properties. ,
Required: False ,
}
{
serverCertificate:
{
Description: Registered Server Certificate ,
Required: False ,
}
string ,
agentVersion:
{
Description: Registered Server Agent Version ,
Required: False ,
}
string ,
serverOSVersion:
{
Description: Registered Server OS Version ,
Required: False ,
}
string ,
serverManagementErrorCode:
{
Description: Registered Server Management Error Code ,
Required: False ,
}
integer ,
lastHeartBeat:
{
Description: Registered Server last heart beat ,
Required: False ,
}
string ,
provisioningState:
{
Description: Registered Server Provisioning State ,
Required: False ,
}
string ,
serverRole:
{
Description: Registered Server serverRole ,
Required: False ,
}
string ,
clusterId:
{
Description: Registered Server clusterId ,
Required: False ,
}
string ,
clusterName:
{
Description: Registered Server clusterName ,
Required: False ,
}
string ,
serverId:
{
Description: Registered Server serverId ,
Required: False ,
}
string ,
storageSyncServiceUid:
{
Description: Registered Server storageSyncServiceUid ,
Required: False ,
}
string ,
lastWorkflowId:
{
Description: Registered Server lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
discoveryEndpointUri:
{
Description: Resource discoveryEndpointUri ,
Required: False ,
}
string ,
resourceLocation:
{
Description: Resource Location ,
Required: False ,
}
string ,
serviceLocation:
{
Description: Service Location ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
managementEndpointUri:
{
Description: Management Endpoint Uri ,
Required: False ,
}
string ,
monitoringConfiguration:
{
Description: Monitoring Configuration ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: Operation Status Location URI ,
}
string ,
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
RegisteredServers_Delete (removed)
Description :  Delete the given registered server.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
serverId:
{
Description: GUID identifying the on-premises server. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
RegisteredServers_triggerRollover (removed)
Description :  Triggers Server certificate rollover.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}/triggerRollover
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
serverId:
{
Description: Server Id ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Trigger Rollover request. ,
Required: True ,
}
{
serverCertificate:
{
Description: Certificate Data ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
Workflows_ListByStorageSyncService (removed)
Description :  Get a Workflow List
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Array of Workflow ,
}
{
value:
{
Description: Collection of workflow items. ,
Required: False ,
}
[
{
properties:
{
Description: Workflow properties. ,
Required: False ,
}
{
lastStepName:
{
Description: last step name ,
Required: False ,
}
string ,
status:
{
Description: workflow status. ,
Enum:
{
active: No description available. ,
expired: No description available. ,
succeeded: No description available. ,
aborted: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
operation:
{
Description: operation direction. ,
Enum:
{
do: No description available. ,
undo: No description available. ,
cancel: No description available. ,
}
,
Required: False ,
}
enum ,
steps:
{
Description: workflow steps ,
Required: False ,
}
string ,
lastOperationId:
{
Description: workflow last operation identifier. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
Workflows_Get (removed)
Description :  Get Workflows resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
workflowId:
{
Description: workflow Id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}
,
$schema:
{
Description: Workflow resource. ,
}
{
properties:
{
Description: Workflow properties. ,
Required: False ,
}
{
lastStepName:
{
Description: last step name ,
Required: False ,
}
string ,
status:
{
Description: workflow status. ,
Enum:
{
active: No description available. ,
expired: No description available. ,
succeeded: No description available. ,
aborted: No description available. ,
failed: No description available. ,
}
,
Required: False ,
}
enum ,
operation:
{
Description: operation direction. ,
Enum:
{
do: No description available. ,
undo: No description available. ,
cancel: No description available. ,
}
,
Required: False ,
}
enum ,
steps:
{
Description: workflow steps ,
Required: False ,
}
string ,
lastOperationId:
{
Description: workflow last operation identifier. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}
Workflows_Abort (removed)
Description :  Abort the given workflow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}/abort
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
storageSyncServiceName:
{
Description: Name of Storage Sync Service resource. ,
Required: True ,
}
string ,
workflowId:
{
Description: workflow Id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
x-ms-request-id:
{
Description: request id. ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
innererror:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given error entry. ,
Required: False ,
}
string ,
details:
{
Description: Error details of the given entry. ,
Required: False ,
}
{
code:
{
Description: Error code of the given entry. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the given entry. ,
Required: False ,
}
string ,
target:
{
Description: Target of the given entry. ,
Required: False ,
}
string ,
}
,
}
,
}