Microsoft.StorageSync (stable:2022-09-01)

2025/09/09 • 34 updated methods

Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "Lists all of the available Storage Sync Rest API operations."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Paged collection of OperationEntity items",
        "old": "The list of storage sync operations."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The OperationEntity items on this page",
            "old": "The list of operations."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link used to get the next page of operations."
          }
        }
      ]
    }
  }
}

⚼ 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-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of OperationEntity items ,
}
{
value:
{
Description: The OperationEntity items on this page ,
Required: True ,
}
[
{
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 ,
properties:
{
Description: Properties of the operations resource. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Service specification for the operations resource. ,
Required: False ,
}
{
metricSpecifications:
{
Description: List of metric specifications. ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name for the metric. ,
Required: False ,
}
string ,
displayDescription:
{
Description: Display description for the metric. ,
Required: False ,
}
string ,
unit:
{
Description: Unit for the metric. ,
Required: False ,
}
string ,
aggregationType:
{
Description: Aggregation type for the metric. ,
Required: False ,
}
string ,
supportedAggregationTypes:
{
Description: Supported aggregation types for the metric. ,
Required: False ,
}
[
string ,
]
,
fillGapWithZero:
{
Description: Fill gaps in the metric with zero. ,
Required: False ,
}
boolean ,
lockAggregationType:
{
Description: Lock Aggregation type for the metric. ,
Required: False ,
}
string ,
dimensions:
{
Description: Dimensions for the metric specification. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dimension. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the dimensions. ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: Indicates metric should be exported for Shoebox. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_CheckNameAvailability (updated)
Description :  Check the give namespace name availability.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageSyncServices_CheckNameAvailability",
  "$parameters": [
    {
      "#name": "parameters",
      "Description": {
        "new": "The request body",
        "old": "Parameters to check availability of the given namespace name"
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/locations/{locationName}/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
locationName:
{
Description: The desired region for the name check. ,
Required: True ,
}
string ,
parameters:
{
Description: The request body ,
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 ,
}

⚐ 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_ListBySubscription (updated)
Description :  Get a StorageSyncService list by subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageSyncServices_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "identity",
              "Description": {
                "new": "The managed service identities assigned to this resource.",
                "old": "managed identities for the Storage Sync service to interact with other Azure services without maintaining any secrets or credentials in code."
              }
            }
          ]
        },
        "@added_1640b54d0ecf46cf813f71c2afdbb002": {
          "#name": "nextLink",
          "Description": "The URL to get the next set of results.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
}
,
$schema:
{
Description: Array of StorageSyncServices ,
}
{
value:
{
Description: Collection of StorageSyncServices. ,
Required: False ,
}
[
{
properties:
{
Description: Storage Sync Service properties. ,
Required: False ,
}
{
incomingTrafficPolicy:
{
Description: Incoming Traffic Policy ,
Enum:
{
AllowAllTraffic: No description available. ,
AllowVirtualNetworksOnly: No description available. ,
}
,
Required: False ,
}
enum ,
storageSyncServiceStatus:
{
Description: Storage Sync service status. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSyncServiceUid:
{
Description: Storage Sync service Uid ,
Required: False ,
}
string ,
provisioningState:
{
Description: StorageSyncService Provisioning State ,
Required: False ,
}
string ,
useIdentity:
{
Description: Use Identity authorization when customer have finished setup RBAC permissions. ,
Required: False ,
}
boolean ,
lastWorkflowId:
{
Description: StorageSyncService lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified storage sync service ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_ListByResourceGroup (updated)
Description :  Get a StorageSyncService list by Resource group name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageSyncServices_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "identity",
              "Description": {
                "new": "The managed service identities assigned to this resource.",
                "old": "managed identities for the Storage Sync service to interact with other Azure services without maintaining any secrets or credentials in code."
              }
            }
          ]
        },
        "@added_1f1ffdb30bbd4638bfd7ec0cb898b370": {
          "#name": "nextLink",
          "Description": "The URL to get the next set of results.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
}
,
$schema:
{
Description: Array of StorageSyncServices ,
}
{
value:
{
Description: Collection of StorageSyncServices. ,
Required: False ,
}
[
{
properties:
{
Description: Storage Sync Service properties. ,
Required: False ,
}
{
incomingTrafficPolicy:
{
Description: Incoming Traffic Policy ,
Enum:
{
AllowAllTraffic: No description available. ,
AllowVirtualNetworksOnly: No description available. ,
}
,
Required: False ,
}
enum ,
storageSyncServiceStatus:
{
Description: Storage Sync service status. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSyncServiceUid:
{
Description: Storage Sync service Uid ,
Required: False ,
}
string ,
provisioningState:
{
Description: StorageSyncService Provisioning State ,
Required: False ,
}
string ,
useIdentity:
{
Description: Use Identity authorization when customer have finished setup RBAC permissions. ,
Required: False ,
}
boolean ,
lastWorkflowId:
{
Description: StorageSyncService lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified storage sync service ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_Get (updated)
Description :  Get a given StorageSyncService.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageSyncServices_Get",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "managed identities for the Storage Sync service to interact with other Azure services without maintaining any secrets or credentials in code."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
}
,
$schema:
{
Description: Storage Sync Service object. ,
}
{
properties:
{
Description: Storage Sync Service properties. ,
Required: False ,
}
{
incomingTrafficPolicy:
{
Description: Incoming Traffic Policy ,
Enum:
{
AllowAllTraffic: No description available. ,
AllowVirtualNetworksOnly: No description available. ,
}
,
Required: False ,
}
enum ,
storageSyncServiceStatus:
{
Description: Storage Sync service status. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSyncServiceUid:
{
Description: Storage Sync service Uid ,
Required: False ,
}
string ,
provisioningState:
{
Description: StorageSyncService Provisioning State ,
Required: False ,
}
string ,
useIdentity:
{
Description: Use Identity authorization when customer have finished setup RBAC permissions. ,
Required: False ,
}
boolean ,
lastWorkflowId:
{
Description: StorageSyncService lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified storage sync service ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_Create (updated)
Description :  Create a new StorageSyncService.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageSyncServices_Create",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "managed identities for the Storage Sync service to interact with other Azure services without maintaining any secrets or credentials in code."
          }
        }
      ]
    },
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Retry After"
        },
        "Type": {
          "new": "integer",
          "old": "string"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
parameters:
{
Description: Storage Sync Service resource name. ,
Required: True ,
}
{
identity:
{
Description: managed identities for the Storage Sync to interact with other Azure services without maintaining any secrets or credentials in code. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The parameters used to create the storage sync service. ,
Required: False ,
}
{
incomingTrafficPolicy:
{
Description: Incoming Traffic Policy ,
Enum:
{
AllowAllTraffic: No description available. ,
AllowVirtualNetworksOnly: No description available. ,
}
,
Required: False ,
}
enum ,
useIdentity:
{
Description: Use Identity authorization when customer have finished setup RBAC permissions. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Storage Sync Service properties. ,
Required: False ,
}
{
incomingTrafficPolicy:
{
Description: Incoming Traffic Policy ,
Enum:
{
AllowAllTraffic: No description available. ,
AllowVirtualNetworksOnly: No description available. ,
}
,
Required: False ,
}
enum ,
storageSyncServiceStatus:
{
Description: Storage Sync service status. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSyncServiceUid:
{
Description: Storage Sync service Uid ,
Required: False ,
}
string ,
provisioningState:
{
Description: StorageSyncService Provisioning State ,
Required: False ,
}
string ,
useIdentity:
{
Description: Use Identity authorization when customer have finished setup RBAC permissions. ,
Required: False ,
}
boolean ,
lastWorkflowId:
{
Description: StorageSyncService lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified storage sync service ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_Update (updated)
Description :  Patch a given StorageSyncService.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageSyncServices_Update",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "identity",
          "Description": {
            "new": "The managed service identities assigned to this resource.",
            "old": "managed identities for the Storage Sync service to interact with other Azure services without maintaining any secrets or credentials in code."
          }
        }
      ]
    },
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Retry After"
        },
        "Type": {
          "new": "integer",
          "old": "string"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
parameters:
{
Description: Storage Sync Service resource. ,
Required: False ,
}
{
tags:
{
Description: The user-specified tags associated with the storage sync service. ,
Required: False ,
}
object ,
identity:
{
Description: managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of the server endpoint. ,
Required: False ,
}
{
incomingTrafficPolicy:
{
Description: Incoming Traffic Policy ,
Enum:
{
AllowAllTraffic: No description available. ,
AllowVirtualNetworksOnly: No description available. ,
}
,
Required: False ,
}
enum ,
useIdentity:
{
Description: Use Identity authorization when customer have finished setup RBAC permissions. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
}
,
$schema:
{
Description: Storage Sync Service object. ,
}
{
properties:
{
Description: Storage Sync Service properties. ,
Required: False ,
}
{
incomingTrafficPolicy:
{
Description: Incoming Traffic Policy ,
Enum:
{
AllowAllTraffic: No description available. ,
AllowVirtualNetworksOnly: No description available. ,
}
,
Required: False ,
}
enum ,
storageSyncServiceStatus:
{
Description: Storage Sync service status. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSyncServiceUid:
{
Description: Storage Sync service Uid ,
Required: False ,
}
string ,
provisioningState:
{
Description: StorageSyncService Provisioning State ,
Required: False ,
}
string ,
useIdentity:
{
Description: Use Identity authorization when customer have finished setup RBAC permissions. ,
Required: False ,
}
boolean ,
lastWorkflowId:
{
Description: StorageSyncService lastWorkflowId ,
Required: False ,
}
string ,
lastOperationName:
{
Description: Resource Last Operation Name ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified storage sync service ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
StorageSyncServices_Delete (updated)
Description :  Delete a given StorageSyncService.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StorageSyncServices_Delete",
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Retry After"
        },
        "Type": {
          "new": "integer",
          "old": "string"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
}

⚐ Response (200)

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

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
PrivateEndpointConnections_ListByStorageSyncService (updated)
Description :  Get a PrivateEndpointConnection List.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_ListByStorageSyncService",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of private endpoint connections associated with the specified resource.",
            "old": "Array of private endpoint connections."
          }
        },
        {
          "@added_1793e2e4262b48d49ad67a864c3224af": {
            "#name": "nextLink",
            "Description": "The URL to get the next set of results.",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateEndpointConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
}
,
$schema:
{
Description: List of private endpoint connections associated with the specified resource. ,
}
{
value:
{
Description: List of private endpoint connections associated with the specified resource. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
PrivateEndpointConnections_Get (updated)
Description :  Gets the specified private endpoint connection associated with the storage sync service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Get",
  "$parameters": [
    {
      "#name": "storageSyncServiceName",
      "Description": {
        "new": "Name of Storage Sync Service resource.",
        "old": "The name of the storage sync service name within the specified resource group."
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
PrivateEndpointConnections_Create (updated)
Description :  Update the state of specified private endpoint connection associated with the storage sync service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Create",
  "$parameters": [
    {
      "#name": "storageSyncServiceName",
      "Description": {
        "new": "Name of Storage Sync Service resource.",
        "old": "The name of the storage sync service name within the specified resource group."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Retry After"
        },
        "Type": {
          "new": "integer",
          "old": "string"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
PrivateEndpointConnections_Delete (updated)
Description :  Deletes the specified private endpoint connection associated with the storage sync service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Delete",
  "$parameters": [
    {
      "#name": "storageSyncServiceName",
      "Description": {
        "new": "Name of Storage Sync Service resource.",
        "old": "The name of the storage sync service name within the specified resource group."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Retry After"
        },
        "Type": {
          "new": "integer",
          "old": "string"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
PrivateLinkResources_ListByStorageSyncService (updated)
Description :  Gets the private link resources that need to be created for a storage sync service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateLinkResources_ListByStorageSyncService",
  "$parameters": [
    {
      "#name": "storageSyncServiceName",
      "Description": {
        "new": "Name of Storage Sync Service resource.",
        "old": "The name of the storage sync service name within the specified resource group."
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
RegisteredServers_ListByStorageSyncService (updated)
Description :  Get a given registered server list.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RegisteredServers_ListByStorageSyncService",
  "$responses": {
    "200": {
      "$properties": {
        "@added_b92db40443ef4840985058ccb097e12e": {
          "#name": "nextLink",
          "Description": "The URL to get the next set of results.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
agentVersionStatus:
{
Description: Registered Server Agent Version Status ,
Enum:
{
Ok: No description available. ,
NearExpiry: No description available. ,
Expired: No description available. ,
Blocked: No description available. ,
}
,
Required: False ,
}
enum ,
agentVersionExpirationDate:
{
Description: Registered Server Agent Version Expiration Date ,
Format: date-time ,
Required: False ,
}
string ,
serverOSVersion:
{
Description: Registered Server OS Version ,
Required: False ,
}
string ,
serverManagementErrorCode:
{
Description: Registered Server Management Error Code ,
Format: int32 ,
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 ,
monitoringEndpointUri:
{
Description: Telemetry Endpoint Uri ,
Required: False ,
}
string ,
monitoringConfiguration:
{
Description: Monitoring Configuration ,
Required: False ,
}
string ,
serverName:
{
Description: Server name ,
Required: False ,
}
string ,
applicationId:
{
Description: Server Application Id ,
Required: False ,
}
string ,
identity:
{
Description: Apply server with newly discovered ApplicationId if available. ,
Required: False ,
}
boolean ,
latestApplicationId:
{
Description: Latest Server Application Id discovered from the server. It is not yet applied. ,
Required: False ,
}
string ,
activeAuthType:
{
Description: Server auth type. ,
Enum:
{
Certificate: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
RegisteredServers_Create (updated)
Description :  Add a new registered server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RegisteredServers_Create",
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "@added_51e03719c9f847088ded7a4a5ede24f9": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
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 ,
applicationId:
{
Description: Server ServicePrincipal Id ,
Required: False ,
}
string ,
identity:
{
Description: Apply server with newly discovered ApplicationId if available. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
agentVersionStatus:
{
Description: Registered Server Agent Version Status ,
Enum:
{
Ok: No description available. ,
NearExpiry: No description available. ,
Expired: No description available. ,
Blocked: No description available. ,
}
,
Required: False ,
}
enum ,
agentVersionExpirationDate:
{
Description: Registered Server Agent Version Expiration Date ,
Format: date-time ,
Required: False ,
}
string ,
serverOSVersion:
{
Description: Registered Server OS Version ,
Required: False ,
}
string ,
serverManagementErrorCode:
{
Description: Registered Server Management Error Code ,
Format: int32 ,
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 ,
monitoringEndpointUri:
{
Description: Telemetry Endpoint Uri ,
Required: False ,
}
string ,
monitoringConfiguration:
{
Description: Monitoring Configuration ,
Required: False ,
}
string ,
serverName:
{
Description: Server name ,
Required: False ,
}
string ,
applicationId:
{
Description: Server Application Id ,
Required: False ,
}
string ,
identity:
{
Description: Apply server with newly discovered ApplicationId if available. ,
Required: False ,
}
boolean ,
latestApplicationId:
{
Description: Latest Server Application Id discovered from the server. It is not yet applied. ,
Required: False ,
}
string ,
activeAuthType:
{
Description: Server auth type. ,
Enum:
{
Certificate: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
RegisteredServers_Update (updated)
Description :  Update registered server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RegisteredServers_Update",
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "@added_fca735da18e541abb3fc0001bb8eb31e": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
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 update the registered server. ,
Required: False ,
}
{
identity:
{
Description: Apply server with newly discovered ApplicationId if available. ,
Required: False ,
}
boolean ,
applicationId:
{
Description: Apply server with new ServicePrincipal Id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
agentVersionStatus:
{
Description: Registered Server Agent Version Status ,
Enum:
{
Ok: No description available. ,
NearExpiry: No description available. ,
Expired: No description available. ,
Blocked: No description available. ,
}
,
Required: False ,
}
enum ,
agentVersionExpirationDate:
{
Description: Registered Server Agent Version Expiration Date ,
Format: date-time ,
Required: False ,
}
string ,
serverOSVersion:
{
Description: Registered Server OS Version ,
Required: False ,
}
string ,
serverManagementErrorCode:
{
Description: Registered Server Management Error Code ,
Format: int32 ,
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 ,
monitoringEndpointUri:
{
Description: Telemetry Endpoint Uri ,
Required: False ,
}
string ,
monitoringConfiguration:
{
Description: Monitoring Configuration ,
Required: False ,
}
string ,
serverName:
{
Description: Server name ,
Required: False ,
}
string ,
applicationId:
{
Description: Server Application Id ,
Required: False ,
}
string ,
identity:
{
Description: Apply server with newly discovered ApplicationId if available. ,
Required: False ,
}
boolean ,
latestApplicationId:
{
Description: Latest Server Application Id discovered from the server. It is not yet applied. ,
Required: False ,
}
string ,
activeAuthType:
{
Description: Server auth type. ,
Enum:
{
Certificate: No description available. ,
ManagedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RegisteredServers_Delete (updated)
Description :  Delete the given registered server.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RegisteredServers_Delete",
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "@added_8f0708e28623495386f45186b246a654": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
serverId:
{
Description: GUID identifying the on-premises server. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
RegisteredServers_triggerRollover (updated)
Description :  Triggers Server certificate rollover.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RegisteredServers_triggerRollover",
  "$parameters": [
    {
      "#name": "serverId",
      "Description": {
        "new": "GUID identifying the on-premises server.",
        "old": "Server Id"
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "@added_41b2e3b11c2c4674a3abaf0bbb4776fd": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}/triggerRollover
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
serverId:
{
Description: GUID identifying the on-premises server. ,
Required: True ,
}
string ,
parameters:
{
Description: Body of Trigger Rollover request. ,
Required: True ,
}
{
serverCertificate:
{
Description: Certificate Data ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
SyncGroups_ListByStorageSyncService (updated)
Description :  Get a SyncGroup List.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SyncGroups_ListByStorageSyncService",
  "$responses": {
    "200": {
      "$properties": {
        "@added_4aa3f5e8b3a247509a51257f7ef6124f": {
          "#name": "nextLink",
          "Description": "The URL to get the next set of results.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
SyncGroups_Create (updated)
Description :  Create a new SyncGroup.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SyncGroups_Create",
  "$parameters": {
    "parameters": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "string",
            "old": "object"
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
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 ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_ListBySyncGroup (updated)
Description :  Get a CloudEndpoint List.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CloudEndpoints_ListBySyncGroup",
  "$responses": {
    "200": {
      "$properties": {
        "@added_31aa8e0839894b80955cabd71ae4b41a": {
          "#name": "nextLink",
          "Description": "The URL to get the next set of results.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
azureFileShareName:
{
Description: Azure file 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 ,
changeEnumerationStatus:
{
Description: Cloud endpoint change enumeration status ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastEnumerationStatus:
{
Description: Status of last completed change enumeration ,
Required: False ,
}
{
startedTimestamp:
{
Description: Timestamp when change enumeration started ,
Format: date-time ,
Required: False ,
}
string ,
completedTimestamp:
{
Description: Timestamp when change enumeration completed ,
Format: date-time ,
Required: False ,
}
string ,
namespaceFilesCount:
{
Description: Count of files in the namespace ,
Format: int64 ,
Required: False ,
}
integer ,
namespaceDirectoriesCount:
{
Description: Count of directories in the namespace ,
Format: int64 ,
Required: False ,
}
integer ,
namespaceSizeBytes:
{
Description: Namespace size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
nextRunTimestamp:
{
Description: Timestamp of when change enumeration is expected to run again ,
Format: date-time ,
Required: False ,
}
string ,
}
,
activity:
{
Description: Change enumeration activity ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
operationState:
{
Description: Change enumeration operation state ,
Enum:
{
InitialEnumerationInProgress: No description available. ,
EnumerationInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: When non-zero, indicates an issue that is delaying change enumeration ,
Format: int32 ,
Required: False ,
}
integer ,
startedTimestamp:
{
Description: Timestamp when change enumeration started ,
Format: date-time ,
Required: False ,
}
string ,
processedFilesCount:
{
Description: Count of files processed ,
Format: int64 ,
Required: False ,
}
integer ,
processedDirectoriesCount:
{
Description: Count of directories processed ,
Format: int64 ,
Required: False ,
}
integer ,
totalFilesCount:
{
Description: Total count of files enumerated ,
Format: int64 ,
Required: False ,
}
integer ,
totalDirectoriesCount:
{
Description: Total count of directories enumerated ,
Format: int64 ,
Required: False ,
}
integer ,
totalSizeBytes:
{
Description: Total enumerated size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
progressPercent:
{
Description: Progress percentage for change enumeration run, excluding processing of deletes ,
Format: int32 ,
Required: False ,
}
integer ,
minutesRemaining:
{
Description: Estimate of time remaining for the enumeration run ,
Format: int32 ,
Required: False ,
}
integer ,
totalCountsState:
{
Description: Change enumeration total counts state ,
Enum:
{
Calculating: No description available. ,
Final: No description available. ,
}
,
Required: False ,
}
enum ,
deletesProgressPercent:
{
Description: Progress percentage for processing deletes. This is done separately from the rest of the enumeration run ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_Create (updated)
Description :  Create a new CloudEndpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CloudEndpoints_Create",
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Retry After"
        },
        "Type": {
          "new": "integer",
          "old": "string"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
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 ,
azureFileShareName:
{
Description: Azure file share name ,
Required: False ,
}
string ,
storageAccountTenantId:
{
Description: Storage Account Tenant Id ,
Required: False ,
}
string ,
friendlyName:
{
Description: Friendly Name ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
}
,
$schema:
{
Description: Cloud Endpoint object. ,
}
{
properties:
{
Description: Cloud Endpoint properties. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Storage Account Resource Id ,
Required: False ,
}
string ,
azureFileShareName:
{
Description: Azure file 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 ,
changeEnumerationStatus:
{
Description: Cloud endpoint change enumeration status ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
lastEnumerationStatus:
{
Description: Status of last completed change enumeration ,
Required: False ,
}
{
startedTimestamp:
{
Description: Timestamp when change enumeration started ,
Format: date-time ,
Required: False ,
}
string ,
completedTimestamp:
{
Description: Timestamp when change enumeration completed ,
Format: date-time ,
Required: False ,
}
string ,
namespaceFilesCount:
{
Description: Count of files in the namespace ,
Format: int64 ,
Required: False ,
}
integer ,
namespaceDirectoriesCount:
{
Description: Count of directories in the namespace ,
Format: int64 ,
Required: False ,
}
integer ,
namespaceSizeBytes:
{
Description: Namespace size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
nextRunTimestamp:
{
Description: Timestamp of when change enumeration is expected to run again ,
Format: date-time ,
Required: False ,
}
string ,
}
,
activity:
{
Description: Change enumeration activity ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
operationState:
{
Description: Change enumeration operation state ,
Enum:
{
InitialEnumerationInProgress: No description available. ,
EnumerationInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: When non-zero, indicates an issue that is delaying change enumeration ,
Format: int32 ,
Required: False ,
}
integer ,
startedTimestamp:
{
Description: Timestamp when change enumeration started ,
Format: date-time ,
Required: False ,
}
string ,
processedFilesCount:
{
Description: Count of files processed ,
Format: int64 ,
Required: False ,
}
integer ,
processedDirectoriesCount:
{
Description: Count of directories processed ,
Format: int64 ,
Required: False ,
}
integer ,
totalFilesCount:
{
Description: Total count of files enumerated ,
Format: int64 ,
Required: False ,
}
integer ,
totalDirectoriesCount:
{
Description: Total count of directories enumerated ,
Format: int64 ,
Required: False ,
}
integer ,
totalSizeBytes:
{
Description: Total enumerated size in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
progressPercent:
{
Description: Progress percentage for change enumeration run, excluding processing of deletes ,
Format: int32 ,
Required: False ,
}
integer ,
minutesRemaining:
{
Description: Estimate of time remaining for the enumeration run ,
Format: int32 ,
Required: False ,
}
integer ,
totalCountsState:
{
Description: Change enumeration total counts state ,
Enum:
{
Calculating: No description available. ,
Final: No description available. ,
}
,
Required: False ,
}
enum ,
deletesProgressPercent:
{
Description: Progress percentage for processing deletes. This is done separately from the rest of the enumeration run ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_Delete (updated)
Description :  Delete a given CloudEndpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CloudEndpoints_Delete",
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Retry After"
        },
        "Type": {
          "new": "integer",
          "old": "string"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_PostBackup (updated)
Description :  Post Backup a given CloudEndpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CloudEndpoints_PostBackup",
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "@added_599deaa041ce470daf8b38e6b016a535": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postbackup
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
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-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_PostRestore (updated)
Description :  Post Restore a given CloudEndpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CloudEndpoints_PostRestore",
  "$parameters": {
    "parameters": {
      "$properties": {
        "restoreFileSpec": {
          "Description": {
            "new": "Restore file spec.",
            "old": "Post Restore restore file spec items array."
          }
        }
      }
    }
  },
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "@added_77a02179b2ec4b83b37c580a45c6c9de": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postrestore
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
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: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_PreBackup (updated)
Description :  Pre Backup a given CloudEndpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CloudEndpoints_PreBackup",
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "@added_ef53b5cd4ef240928b961223b3d78384": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prebackup
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
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-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_PreRestore (updated)
Description :  Pre Restore a given CloudEndpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CloudEndpoints_PreRestore",
  "$parameters": {
    "parameters": {
      "$properties": {
        "restoreFileSpec": {
          "Description": {
            "new": "Restore file spec.",
            "old": "Pre Restore restore file spec items array."
          }
        }
      }
    }
  },
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "@added_68ac079f45bb479d9893ece8f06c7d0a": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prerestore
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
CloudEndpoints_TriggerChangeDetection (updated)
Description :  Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CloudEndpoints_TriggerChangeDetection",
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "@added_b8e3d5f704c64e70904a1c94f92c0127": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/triggerChangeDetection
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
cloudEndpointName:
{
Description: Name of Cloud Endpoint object. ,
Required: True ,
}
string ,
parameters:
{
Description: Trigger Change Detection Action parameters. ,
Required: True ,
}
{
directoryPath:
{
Description: Relative path to a directory Azure File share for which change detection is to be performed. ,
Required: False ,
}
string ,
changeDetectionMode:
{
Description: Change Detection Mode. Applies to a directory specified in directoryPath parameter. ,
Enum:
{
Default: No description available. ,
Recursive: No description available. ,
}
,
Required: False ,
}
enum ,
paths:
{
Description: Array of relative paths on the Azure File share to be included in the change detection. Can be files and directories. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_ListBySyncGroup (updated)
Description :  Get a ServerEndpoint list.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServerEndpoints_ListBySyncGroup",
  "$responses": {
    "200": {
      "$properties": {
        "@added_f0a846df57ad4cb29f638ecc809885e1": {
          "#name": "nextLink",
          "Description": "The URL to get the next set of results.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
location:
{
Description: Operation Status Location URI ,
}
string ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Format: int32 ,
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 sync status ,
Required: False ,
}
{
downloadHealth:
{
Description: Download Health Status. ,
Enum:
{
Unavailable: No description available. ,
Healthy: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
uploadHealth:
{
Description: Upload Health Status. ,
Enum:
{
Unavailable: No description available. ,
Healthy: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
combinedHealth:
{
Description: Combined Health Status. ,
Enum:
{
Unavailable: No description available. ,
Healthy: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
syncActivity:
{
Description: Sync activity ,
Enum:
{
Upload: No description available. ,
Download: No description available. ,
UploadAndDownload: No description available. ,
}
,
Required: False ,
}
enum ,
totalPersistentFilesNotSyncingCount:
{
Description: Total count of persistent files not syncing (combined upload + download). ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedTimestamp:
{
Description: Last Updated Timestamp ,
Format: date-time ,
Required: False ,
}
string ,
uploadStatus:
{
Description: Upload Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync result (HResult) ,
Format: int32 ,
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. ,
Format: int64 ,
Required: False ,
}
integer ,
persistentFilesNotSyncingCount:
{
Description: Count of persistent files not syncing. ,
Format: int64 ,
Required: False ,
}
integer ,
transientFilesNotSyncingCount:
{
Description: Count of transient files not syncing. ,
Format: int64 ,
Required: False ,
}
integer ,
filesNotSyncingErrors:
{
Description: Array of per-item errors coming from the last sync session. ,
Required: False ,
}
[
{
errorCode:
{
Description: Error code (HResult) ,
Format: int32 ,
Required: False ,
}
integer ,
persistentCount:
{
Description: Count of persistent files not syncing with the specified error code ,
Format: int64 ,
Required: False ,
}
integer ,
transientCount:
{
Description: Count of transient files not syncing with the specified error code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
lastSyncMode:
{
Description: Sync mode ,
Enum:
{
Regular: No description available. ,
NamespaceDownload: No description available. ,
InitialUpload: No description available. ,
SnapshotUpload: No description available. ,
InitialFullDownload: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: Download Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync result (HResult) ,
Format: int32 ,
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. ,
Format: int64 ,
Required: False ,
}
integer ,
persistentFilesNotSyncingCount:
{
Description: Count of persistent files not syncing. ,
Format: int64 ,
Required: False ,
}
integer ,
transientFilesNotSyncingCount:
{
Description: Count of transient files not syncing. ,
Format: int64 ,
Required: False ,
}
integer ,
filesNotSyncingErrors:
{
Description: Array of per-item errors coming from the last sync session. ,
Required: False ,
}
[
{
errorCode:
{
Description: Error code (HResult) ,
Format: int32 ,
Required: False ,
}
integer ,
persistentCount:
{
Description: Count of persistent files not syncing with the specified error code ,
Format: int64 ,
Required: False ,
}
integer ,
transientCount:
{
Description: Count of transient files not syncing with the specified error code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
lastSyncMode:
{
Description: Sync mode ,
Enum:
{
Regular: No description available. ,
NamespaceDownload: No description available. ,
InitialUpload: No description available. ,
SnapshotUpload: No description available. ,
InitialFullDownload: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
uploadActivity:
{
Description: Upload sync activity ,
Required: False ,
}
{
timestamp:
{
Description: Timestamp when properties were updated ,
Format: date-time ,
Required: False ,
}
string ,
perItemErrorCount:
{
Description: Per item error count ,
Format: int64 ,
Required: False ,
}
integer ,
appliedItemCount:
{
Description: Applied item count. ,
Format: int64 ,
Required: False ,
}
integer ,
totalItemCount:
{
Description: Total item count (if available) ,
Format: int64 ,
Required: False ,
}
integer ,
appliedBytes:
{
Description: Applied bytes ,
Format: int64 ,
Required: False ,
}
integer ,
totalBytes:
{
Description: Total bytes (if available) ,
Format: int64 ,
Required: False ,
}
integer ,
syncMode:
{
Description: Sync mode ,
Enum:
{
Regular: No description available. ,
NamespaceDownload: No description available. ,
InitialUpload: No description available. ,
SnapshotUpload: No description available. ,
InitialFullDownload: No description available. ,
}
,
Required: False ,
}
enum ,
sessionMinutesRemaining:
{
Description: Session minutes remaining (if available) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
downloadActivity:
{
Description: Download sync activity ,
Required: False ,
}
{
timestamp:
{
Description: Timestamp when properties were updated ,
Format: date-time ,
Required: False ,
}
string ,
perItemErrorCount:
{
Description: Per item error count ,
Format: int64 ,
Required: False ,
}
integer ,
appliedItemCount:
{
Description: Applied item count. ,
Format: int64 ,
Required: False ,
}
integer ,
totalItemCount:
{
Description: Total item count (if available) ,
Format: int64 ,
Required: False ,
}
integer ,
appliedBytes:
{
Description: Applied bytes ,
Format: int64 ,
Required: False ,
}
integer ,
totalBytes:
{
Description: Total bytes (if available) ,
Format: int64 ,
Required: False ,
}
integer ,
syncMode:
{
Description: Sync mode ,
Enum:
{
Regular: No description available. ,
NamespaceDownload: No description available. ,
InitialUpload: No description available. ,
SnapshotUpload: No description available. ,
InitialFullDownload: No description available. ,
}
,
Required: False ,
}
enum ,
sessionMinutesRemaining:
{
Description: Session minutes remaining (if available) ,
Format: int32 ,
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 ,
backgroundDataDownloadActivity:
{
Description: Background data download activity ,
Required: False ,
}
{
timestamp:
{
Description: Timestamp when properties were updated ,
Format: date-time ,
Required: False ,
}
string ,
startedTimestamp:
{
Description: Timestamp when the operation started ,
Format: date-time ,
Required: False ,
}
string ,
percentProgress:
{
Description: Progress percentage ,
Format: int32 ,
Required: False ,
}
integer ,
downloadedBytes:
{
Description: Running count of bytes downloaded ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
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 ,
cloudTieringStatus:
{
Description: Cloud tiering status. Only populated if cloud tiering is enabled. ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
health:
{
Description: Cloud tiering health state. ,
Enum:
{
Unavailable: No description available. ,
Healthy: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
healthLastUpdatedTimestamp:
{
Description: The last updated timestamp of health state ,
Format: date-time ,
Required: False ,
}
string ,
lastCloudTieringResult:
{
Description: Last cloud tiering result (HResult) ,
Format: int32 ,
Required: False ,
}
integer ,
lastSuccessTimestamp:
{
Description: Last cloud tiering success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
spaceSavings:
{
Description: Information regarding how much local space cloud tiering is saving. ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
volumeSizeBytes:
{
Description: Volume size ,
Format: int64 ,
Required: False ,
}
integer ,
totalSizeCloudBytes:
{
Description: Total size of content in the azure file share ,
Format: int64 ,
Required: False ,
}
integer ,
cachedSizeBytes:
{
Description: Cached content size on the server ,
Format: int64 ,
Required: False ,
}
integer ,
spaceSavingsPercent:
{
Description: Percentage of cached size over total size ,
Format: int32 ,
Required: False ,
}
integer ,
spaceSavingsBytes:
{
Description: Count of bytes saved on the server ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
cachePerformance:
{
Description: Information regarding how well the local cache on the server is performing. ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
cacheHitBytes:
{
Description: Count of bytes that were served from the local server ,
Format: int64 ,
Required: False ,
}
integer ,
cacheMissBytes:
{
Description: Count of bytes that were served from the cloud ,
Format: int64 ,
Required: False ,
}
integer ,
cacheHitBytesPercent:
{
Description: Percentage of total bytes (hit + miss) that were served from the local server ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
filesNotTiering:
{
Description: Information regarding files that failed to be tiered ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
totalFileCount:
{
Description: Last cloud tiering result (HResult) ,
Format: int64 ,
Required: False ,
}
integer ,
errors:
{
Description: Array of tiering errors ,
Required: False ,
}
[
{
errorCode:
{
Description: Error code (HResult) ,
Format: int32 ,
Required: False ,
}
integer ,
fileCount:
{
Description: Count of files with this error ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
volumeFreeSpacePolicyStatus:
{
Description: Status of the volume free space policy ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
effectiveVolumeFreeSpacePolicy:
{
Description: In the case where multiple server endpoints are present in a volume, an effective free space policy is applied. ,
Format: int32 ,
Required: False ,
}
integer ,
currentVolumeFreeSpacePercent:
{
Description: Current volume free space percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
datePolicyStatus:
{
Description: Status of the date policy ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
tieredFilesMostRecentAccessTimestamp:
{
Description: Most recent access time of tiered files ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lowDiskMode:
{
Description: Information regarding the low disk mode state ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Low disk mode state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
recallStatus:
{
Description: Recall status. Only populated if cloud tiering is enabled. ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
totalRecallErrorsCount:
{
Description: Total count of recall errors. ,
Format: int64 ,
Required: False ,
}
integer ,
recallErrors:
{
Description: Array of recall errors ,
Required: False ,
}
[
{
errorCode:
{
Description: Error code (HResult) ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count of occurences of the error ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
initialDownloadPolicy:
{
Description: Policy for how namespace and files are recalled during FastDr. ,
Enum:
{
NamespaceOnly: No description available. ,
NamespaceThenModifiedFiles: No description available. ,
AvoidTieredFiles: No description available. ,
}
,
Required: False ,
}
enum ,
localCacheMode:
{
Description: Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. ,
Enum:
{
DownloadNewAndModifiedFiles: No description available. ,
UpdateLocallyCachedFiles: No description available. ,
}
,
Required: False ,
}
enum ,
initialUploadPolicy:
{
Description: Policy for how the initial upload sync session is performed. ,
Enum:
{
ServerAuthoritative: No description available. ,
Merge: No description available. ,
}
,
Required: False ,
}
enum ,
serverName:
{
Description: Server name ,
Required: False ,
}
string ,
serverEndpointProvisioningStatus:
{
Description: Server Endpoint provisioning status ,
Required: False ,
}
{
provisioningStatus:
{
Description: Server Endpoint provisioning status ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Ready_SyncNotFunctional: No description available. ,
Ready_SyncFunctional: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningType:
{
Description: Server Endpoint provisioning type ,
Required: False ,
}
string ,
provisioningStepStatuses:
{
Description: Provisioning Step status information for each step in the provisioning process ,
Required: False ,
}
[
{
name:
{
Description: Name of the provisioning step ,
Required: False ,
}
string ,
status:
{
Description: Status of the provisioning step ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the provisioning step ,
Format: date-time ,
Required: False ,
}
string ,
minutesLeft:
{
Description: Estimated completion time of the provisioning step in minutes ,
Format: int32 ,
Required: False ,
}
integer ,
progressPercentage:
{
Description: Estimated progress percentage ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of the provisioning step ,
Format: date-time ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code (HResult) for the provisioning step ,
Format: int32 ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: Additional information for the provisioning step ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_Create (updated)
Description :  Create a new ServerEndpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServerEndpoints_Create",
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "@added_2e19aeed2c6a414aaf71f66496f015bb": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Format: int32 ,
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 ,
initialDownloadPolicy:
{
Description: Policy for how namespace and files are recalled during FastDr. ,
Enum:
{
NamespaceOnly: No description available. ,
NamespaceThenModifiedFiles: No description available. ,
AvoidTieredFiles: No description available. ,
}
,
Required: False ,
}
enum ,
localCacheMode:
{
Description: Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. ,
Enum:
{
DownloadNewAndModifiedFiles: No description available. ,
UpdateLocallyCachedFiles: No description available. ,
}
,
Required: False ,
}
enum ,
initialUploadPolicy:
{
Description: Policy for how the initial upload sync session is performed. ,
Enum:
{
ServerAuthoritative: No description available. ,
Merge: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Format: int32 ,
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 sync status ,
Required: False ,
}
{
downloadHealth:
{
Description: Download Health Status. ,
Enum:
{
Unavailable: No description available. ,
Healthy: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
uploadHealth:
{
Description: Upload Health Status. ,
Enum:
{
Unavailable: No description available. ,
Healthy: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
combinedHealth:
{
Description: Combined Health Status. ,
Enum:
{
Unavailable: No description available. ,
Healthy: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
syncActivity:
{
Description: Sync activity ,
Enum:
{
Upload: No description available. ,
Download: No description available. ,
UploadAndDownload: No description available. ,
}
,
Required: False ,
}
enum ,
totalPersistentFilesNotSyncingCount:
{
Description: Total count of persistent files not syncing (combined upload + download). ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedTimestamp:
{
Description: Last Updated Timestamp ,
Format: date-time ,
Required: False ,
}
string ,
uploadStatus:
{
Description: Upload Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync result (HResult) ,
Format: int32 ,
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. ,
Format: int64 ,
Required: False ,
}
integer ,
persistentFilesNotSyncingCount:
{
Description: Count of persistent files not syncing. ,
Format: int64 ,
Required: False ,
}
integer ,
transientFilesNotSyncingCount:
{
Description: Count of transient files not syncing. ,
Format: int64 ,
Required: False ,
}
integer ,
filesNotSyncingErrors:
{
Description: Array of per-item errors coming from the last sync session. ,
Required: False ,
}
[
{
errorCode:
{
Description: Error code (HResult) ,
Format: int32 ,
Required: False ,
}
integer ,
persistentCount:
{
Description: Count of persistent files not syncing with the specified error code ,
Format: int64 ,
Required: False ,
}
integer ,
transientCount:
{
Description: Count of transient files not syncing with the specified error code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
lastSyncMode:
{
Description: Sync mode ,
Enum:
{
Regular: No description available. ,
NamespaceDownload: No description available. ,
InitialUpload: No description available. ,
SnapshotUpload: No description available. ,
InitialFullDownload: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: Download Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync result (HResult) ,
Format: int32 ,
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. ,
Format: int64 ,
Required: False ,
}
integer ,
persistentFilesNotSyncingCount:
{
Description: Count of persistent files not syncing. ,
Format: int64 ,
Required: False ,
}
integer ,
transientFilesNotSyncingCount:
{
Description: Count of transient files not syncing. ,
Format: int64 ,
Required: False ,
}
integer ,
filesNotSyncingErrors:
{
Description: Array of per-item errors coming from the last sync session. ,
Required: False ,
}
[
{
errorCode:
{
Description: Error code (HResult) ,
Format: int32 ,
Required: False ,
}
integer ,
persistentCount:
{
Description: Count of persistent files not syncing with the specified error code ,
Format: int64 ,
Required: False ,
}
integer ,
transientCount:
{
Description: Count of transient files not syncing with the specified error code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
lastSyncMode:
{
Description: Sync mode ,
Enum:
{
Regular: No description available. ,
NamespaceDownload: No description available. ,
InitialUpload: No description available. ,
SnapshotUpload: No description available. ,
InitialFullDownload: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
uploadActivity:
{
Description: Upload sync activity ,
Required: False ,
}
{
timestamp:
{
Description: Timestamp when properties were updated ,
Format: date-time ,
Required: False ,
}
string ,
perItemErrorCount:
{
Description: Per item error count ,
Format: int64 ,
Required: False ,
}
integer ,
appliedItemCount:
{
Description: Applied item count. ,
Format: int64 ,
Required: False ,
}
integer ,
totalItemCount:
{
Description: Total item count (if available) ,
Format: int64 ,
Required: False ,
}
integer ,
appliedBytes:
{
Description: Applied bytes ,
Format: int64 ,
Required: False ,
}
integer ,
totalBytes:
{
Description: Total bytes (if available) ,
Format: int64 ,
Required: False ,
}
integer ,
syncMode:
{
Description: Sync mode ,
Enum:
{
Regular: No description available. ,
NamespaceDownload: No description available. ,
InitialUpload: No description available. ,
SnapshotUpload: No description available. ,
InitialFullDownload: No description available. ,
}
,
Required: False ,
}
enum ,
sessionMinutesRemaining:
{
Description: Session minutes remaining (if available) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
downloadActivity:
{
Description: Download sync activity ,
Required: False ,
}
{
timestamp:
{
Description: Timestamp when properties were updated ,
Format: date-time ,
Required: False ,
}
string ,
perItemErrorCount:
{
Description: Per item error count ,
Format: int64 ,
Required: False ,
}
integer ,
appliedItemCount:
{
Description: Applied item count. ,
Format: int64 ,
Required: False ,
}
integer ,
totalItemCount:
{
Description: Total item count (if available) ,
Format: int64 ,
Required: False ,
}
integer ,
appliedBytes:
{
Description: Applied bytes ,
Format: int64 ,
Required: False ,
}
integer ,
totalBytes:
{
Description: Total bytes (if available) ,
Format: int64 ,
Required: False ,
}
integer ,
syncMode:
{
Description: Sync mode ,
Enum:
{
Regular: No description available. ,
NamespaceDownload: No description available. ,
InitialUpload: No description available. ,
SnapshotUpload: No description available. ,
InitialFullDownload: No description available. ,
}
,
Required: False ,
}
enum ,
sessionMinutesRemaining:
{
Description: Session minutes remaining (if available) ,
Format: int32 ,
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 ,
backgroundDataDownloadActivity:
{
Description: Background data download activity ,
Required: False ,
}
{
timestamp:
{
Description: Timestamp when properties were updated ,
Format: date-time ,
Required: False ,
}
string ,
startedTimestamp:
{
Description: Timestamp when the operation started ,
Format: date-time ,
Required: False ,
}
string ,
percentProgress:
{
Description: Progress percentage ,
Format: int32 ,
Required: False ,
}
integer ,
downloadedBytes:
{
Description: Running count of bytes downloaded ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
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 ,
cloudTieringStatus:
{
Description: Cloud tiering status. Only populated if cloud tiering is enabled. ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
health:
{
Description: Cloud tiering health state. ,
Enum:
{
Unavailable: No description available. ,
Healthy: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
healthLastUpdatedTimestamp:
{
Description: The last updated timestamp of health state ,
Format: date-time ,
Required: False ,
}
string ,
lastCloudTieringResult:
{
Description: Last cloud tiering result (HResult) ,
Format: int32 ,
Required: False ,
}
integer ,
lastSuccessTimestamp:
{
Description: Last cloud tiering success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
spaceSavings:
{
Description: Information regarding how much local space cloud tiering is saving. ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
volumeSizeBytes:
{
Description: Volume size ,
Format: int64 ,
Required: False ,
}
integer ,
totalSizeCloudBytes:
{
Description: Total size of content in the azure file share ,
Format: int64 ,
Required: False ,
}
integer ,
cachedSizeBytes:
{
Description: Cached content size on the server ,
Format: int64 ,
Required: False ,
}
integer ,
spaceSavingsPercent:
{
Description: Percentage of cached size over total size ,
Format: int32 ,
Required: False ,
}
integer ,
spaceSavingsBytes:
{
Description: Count of bytes saved on the server ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
cachePerformance:
{
Description: Information regarding how well the local cache on the server is performing. ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
cacheHitBytes:
{
Description: Count of bytes that were served from the local server ,
Format: int64 ,
Required: False ,
}
integer ,
cacheMissBytes:
{
Description: Count of bytes that were served from the cloud ,
Format: int64 ,
Required: False ,
}
integer ,
cacheHitBytesPercent:
{
Description: Percentage of total bytes (hit + miss) that were served from the local server ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
filesNotTiering:
{
Description: Information regarding files that failed to be tiered ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
totalFileCount:
{
Description: Last cloud tiering result (HResult) ,
Format: int64 ,
Required: False ,
}
integer ,
errors:
{
Description: Array of tiering errors ,
Required: False ,
}
[
{
errorCode:
{
Description: Error code (HResult) ,
Format: int32 ,
Required: False ,
}
integer ,
fileCount:
{
Description: Count of files with this error ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
volumeFreeSpacePolicyStatus:
{
Description: Status of the volume free space policy ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
effectiveVolumeFreeSpacePolicy:
{
Description: In the case where multiple server endpoints are present in a volume, an effective free space policy is applied. ,
Format: int32 ,
Required: False ,
}
integer ,
currentVolumeFreeSpacePercent:
{
Description: Current volume free space percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
datePolicyStatus:
{
Description: Status of the date policy ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
tieredFilesMostRecentAccessTimestamp:
{
Description: Most recent access time of tiered files ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lowDiskMode:
{
Description: Information regarding the low disk mode state ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Low disk mode state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
recallStatus:
{
Description: Recall status. Only populated if cloud tiering is enabled. ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
totalRecallErrorsCount:
{
Description: Total count of recall errors. ,
Format: int64 ,
Required: False ,
}
integer ,
recallErrors:
{
Description: Array of recall errors ,
Required: False ,
}
[
{
errorCode:
{
Description: Error code (HResult) ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count of occurences of the error ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
initialDownloadPolicy:
{
Description: Policy for how namespace and files are recalled during FastDr. ,
Enum:
{
NamespaceOnly: No description available. ,
NamespaceThenModifiedFiles: No description available. ,
AvoidTieredFiles: No description available. ,
}
,
Required: False ,
}
enum ,
localCacheMode:
{
Description: Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. ,
Enum:
{
DownloadNewAndModifiedFiles: No description available. ,
UpdateLocallyCachedFiles: No description available. ,
}
,
Required: False ,
}
enum ,
initialUploadPolicy:
{
Description: Policy for how the initial upload sync session is performed. ,
Enum:
{
ServerAuthoritative: No description available. ,
Merge: No description available. ,
}
,
Required: False ,
}
enum ,
serverName:
{
Description: Server name ,
Required: False ,
}
string ,
serverEndpointProvisioningStatus:
{
Description: Server Endpoint provisioning status ,
Required: False ,
}
{
provisioningStatus:
{
Description: Server Endpoint provisioning status ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Ready_SyncNotFunctional: No description available. ,
Ready_SyncFunctional: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningType:
{
Description: Server Endpoint provisioning type ,
Required: False ,
}
string ,
provisioningStepStatuses:
{
Description: Provisioning Step status information for each step in the provisioning process ,
Required: False ,
}
[
{
name:
{
Description: Name of the provisioning step ,
Required: False ,
}
string ,
status:
{
Description: Status of the provisioning step ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the provisioning step ,
Format: date-time ,
Required: False ,
}
string ,
minutesLeft:
{
Description: Estimated completion time of the provisioning step in minutes ,
Format: int32 ,
Required: False ,
}
integer ,
progressPercentage:
{
Description: Estimated progress percentage ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of the provisioning step ,
Format: date-time ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code (HResult) for the provisioning step ,
Format: int32 ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: Additional information for the provisioning step ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_Update (updated)
Description :  Patch a given ServerEndpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServerEndpoints_Update",
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "Operation Status Location URI"
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "@added_bdfa064977ac4851957895524e66a3af": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Format: int32 ,
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 ,
localCacheMode:
{
Description: Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. ,
Enum:
{
DownloadNewAndModifiedFiles: No description available. ,
UpdateLocallyCachedFiles: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
tierFilesOlderThanDays:
{
Description: Tier files older than days. ,
Format: int32 ,
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 sync status ,
Required: False ,
}
{
downloadHealth:
{
Description: Download Health Status. ,
Enum:
{
Unavailable: No description available. ,
Healthy: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
uploadHealth:
{
Description: Upload Health Status. ,
Enum:
{
Unavailable: No description available. ,
Healthy: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
combinedHealth:
{
Description: Combined Health Status. ,
Enum:
{
Unavailable: No description available. ,
Healthy: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
syncActivity:
{
Description: Sync activity ,
Enum:
{
Upload: No description available. ,
Download: No description available. ,
UploadAndDownload: No description available. ,
}
,
Required: False ,
}
enum ,
totalPersistentFilesNotSyncingCount:
{
Description: Total count of persistent files not syncing (combined upload + download). ,
Format: int64 ,
Required: False ,
}
integer ,
lastUpdatedTimestamp:
{
Description: Last Updated Timestamp ,
Format: date-time ,
Required: False ,
}
string ,
uploadStatus:
{
Description: Upload Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync result (HResult) ,
Format: int32 ,
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. ,
Format: int64 ,
Required: False ,
}
integer ,
persistentFilesNotSyncingCount:
{
Description: Count of persistent files not syncing. ,
Format: int64 ,
Required: False ,
}
integer ,
transientFilesNotSyncingCount:
{
Description: Count of transient files not syncing. ,
Format: int64 ,
Required: False ,
}
integer ,
filesNotSyncingErrors:
{
Description: Array of per-item errors coming from the last sync session. ,
Required: False ,
}
[
{
errorCode:
{
Description: Error code (HResult) ,
Format: int32 ,
Required: False ,
}
integer ,
persistentCount:
{
Description: Count of persistent files not syncing with the specified error code ,
Format: int64 ,
Required: False ,
}
integer ,
transientCount:
{
Description: Count of transient files not syncing with the specified error code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
lastSyncMode:
{
Description: Sync mode ,
Enum:
{
Regular: No description available. ,
NamespaceDownload: No description available. ,
InitialUpload: No description available. ,
SnapshotUpload: No description available. ,
InitialFullDownload: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
downloadStatus:
{
Description: Download Status ,
Required: False ,
}
{
lastSyncResult:
{
Description: Last sync result (HResult) ,
Format: int32 ,
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. ,
Format: int64 ,
Required: False ,
}
integer ,
persistentFilesNotSyncingCount:
{
Description: Count of persistent files not syncing. ,
Format: int64 ,
Required: False ,
}
integer ,
transientFilesNotSyncingCount:
{
Description: Count of transient files not syncing. ,
Format: int64 ,
Required: False ,
}
integer ,
filesNotSyncingErrors:
{
Description: Array of per-item errors coming from the last sync session. ,
Required: False ,
}
[
{
errorCode:
{
Description: Error code (HResult) ,
Format: int32 ,
Required: False ,
}
integer ,
persistentCount:
{
Description: Count of persistent files not syncing with the specified error code ,
Format: int64 ,
Required: False ,
}
integer ,
transientCount:
{
Description: Count of transient files not syncing with the specified error code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
lastSyncMode:
{
Description: Sync mode ,
Enum:
{
Regular: No description available. ,
NamespaceDownload: No description available. ,
InitialUpload: No description available. ,
SnapshotUpload: No description available. ,
InitialFullDownload: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
uploadActivity:
{
Description: Upload sync activity ,
Required: False ,
}
{
timestamp:
{
Description: Timestamp when properties were updated ,
Format: date-time ,
Required: False ,
}
string ,
perItemErrorCount:
{
Description: Per item error count ,
Format: int64 ,
Required: False ,
}
integer ,
appliedItemCount:
{
Description: Applied item count. ,
Format: int64 ,
Required: False ,
}
integer ,
totalItemCount:
{
Description: Total item count (if available) ,
Format: int64 ,
Required: False ,
}
integer ,
appliedBytes:
{
Description: Applied bytes ,
Format: int64 ,
Required: False ,
}
integer ,
totalBytes:
{
Description: Total bytes (if available) ,
Format: int64 ,
Required: False ,
}
integer ,
syncMode:
{
Description: Sync mode ,
Enum:
{
Regular: No description available. ,
NamespaceDownload: No description available. ,
InitialUpload: No description available. ,
SnapshotUpload: No description available. ,
InitialFullDownload: No description available. ,
}
,
Required: False ,
}
enum ,
sessionMinutesRemaining:
{
Description: Session minutes remaining (if available) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
downloadActivity:
{
Description: Download sync activity ,
Required: False ,
}
{
timestamp:
{
Description: Timestamp when properties were updated ,
Format: date-time ,
Required: False ,
}
string ,
perItemErrorCount:
{
Description: Per item error count ,
Format: int64 ,
Required: False ,
}
integer ,
appliedItemCount:
{
Description: Applied item count. ,
Format: int64 ,
Required: False ,
}
integer ,
totalItemCount:
{
Description: Total item count (if available) ,
Format: int64 ,
Required: False ,
}
integer ,
appliedBytes:
{
Description: Applied bytes ,
Format: int64 ,
Required: False ,
}
integer ,
totalBytes:
{
Description: Total bytes (if available) ,
Format: int64 ,
Required: False ,
}
integer ,
syncMode:
{
Description: Sync mode ,
Enum:
{
Regular: No description available. ,
NamespaceDownload: No description available. ,
InitialUpload: No description available. ,
SnapshotUpload: No description available. ,
InitialFullDownload: No description available. ,
}
,
Required: False ,
}
enum ,
sessionMinutesRemaining:
{
Description: Session minutes remaining (if available) ,
Format: int32 ,
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 ,
backgroundDataDownloadActivity:
{
Description: Background data download activity ,
Required: False ,
}
{
timestamp:
{
Description: Timestamp when properties were updated ,
Format: date-time ,
Required: False ,
}
string ,
startedTimestamp:
{
Description: Timestamp when the operation started ,
Format: date-time ,
Required: False ,
}
string ,
percentProgress:
{
Description: Progress percentage ,
Format: int32 ,
Required: False ,
}
integer ,
downloadedBytes:
{
Description: Running count of bytes downloaded ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
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 ,
cloudTieringStatus:
{
Description: Cloud tiering status. Only populated if cloud tiering is enabled. ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
health:
{
Description: Cloud tiering health state. ,
Enum:
{
Unavailable: No description available. ,
Healthy: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
healthLastUpdatedTimestamp:
{
Description: The last updated timestamp of health state ,
Format: date-time ,
Required: False ,
}
string ,
lastCloudTieringResult:
{
Description: Last cloud tiering result (HResult) ,
Format: int32 ,
Required: False ,
}
integer ,
lastSuccessTimestamp:
{
Description: Last cloud tiering success timestamp ,
Format: date-time ,
Required: False ,
}
string ,
spaceSavings:
{
Description: Information regarding how much local space cloud tiering is saving. ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
volumeSizeBytes:
{
Description: Volume size ,
Format: int64 ,
Required: False ,
}
integer ,
totalSizeCloudBytes:
{
Description: Total size of content in the azure file share ,
Format: int64 ,
Required: False ,
}
integer ,
cachedSizeBytes:
{
Description: Cached content size on the server ,
Format: int64 ,
Required: False ,
}
integer ,
spaceSavingsPercent:
{
Description: Percentage of cached size over total size ,
Format: int32 ,
Required: False ,
}
integer ,
spaceSavingsBytes:
{
Description: Count of bytes saved on the server ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
cachePerformance:
{
Description: Information regarding how well the local cache on the server is performing. ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
cacheHitBytes:
{
Description: Count of bytes that were served from the local server ,
Format: int64 ,
Required: False ,
}
integer ,
cacheMissBytes:
{
Description: Count of bytes that were served from the cloud ,
Format: int64 ,
Required: False ,
}
integer ,
cacheHitBytesPercent:
{
Description: Percentage of total bytes (hit + miss) that were served from the local server ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
filesNotTiering:
{
Description: Information regarding files that failed to be tiered ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
totalFileCount:
{
Description: Last cloud tiering result (HResult) ,
Format: int64 ,
Required: False ,
}
integer ,
errors:
{
Description: Array of tiering errors ,
Required: False ,
}
[
{
errorCode:
{
Description: Error code (HResult) ,
Format: int32 ,
Required: False ,
}
integer ,
fileCount:
{
Description: Count of files with this error ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
volumeFreeSpacePolicyStatus:
{
Description: Status of the volume free space policy ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
effectiveVolumeFreeSpacePolicy:
{
Description: In the case where multiple server endpoints are present in a volume, an effective free space policy is applied. ,
Format: int32 ,
Required: False ,
}
integer ,
currentVolumeFreeSpacePercent:
{
Description: Current volume free space percentage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
datePolicyStatus:
{
Description: Status of the date policy ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
tieredFilesMostRecentAccessTimestamp:
{
Description: Most recent access time of tiered files ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lowDiskMode:
{
Description: Information regarding the low disk mode state ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Low disk mode state ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
recallStatus:
{
Description: Recall status. Only populated if cloud tiering is enabled. ,
Required: False ,
}
{
lastUpdatedTimestamp:
{
Description: Last updated timestamp ,
Format: date-time ,
Required: False ,
}
string ,
totalRecallErrorsCount:
{
Description: Total count of recall errors. ,
Format: int64 ,
Required: False ,
}
integer ,
recallErrors:
{
Description: Array of recall errors ,
Required: False ,
}
[
{
errorCode:
{
Description: Error code (HResult) ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Count of occurences of the error ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
initialDownloadPolicy:
{
Description: Policy for how namespace and files are recalled during FastDr. ,
Enum:
{
NamespaceOnly: No description available. ,
NamespaceThenModifiedFiles: No description available. ,
AvoidTieredFiles: No description available. ,
}
,
Required: False ,
}
enum ,
localCacheMode:
{
Description: Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. ,
Enum:
{
DownloadNewAndModifiedFiles: No description available. ,
UpdateLocallyCachedFiles: No description available. ,
}
,
Required: False ,
}
enum ,
initialUploadPolicy:
{
Description: Policy for how the initial upload sync session is performed. ,
Enum:
{
ServerAuthoritative: No description available. ,
Merge: No description available. ,
}
,
Required: False ,
}
enum ,
serverName:
{
Description: Server name ,
Required: False ,
}
string ,
serverEndpointProvisioningStatus:
{
Description: Server Endpoint provisioning status ,
Required: False ,
}
{
provisioningStatus:
{
Description: Server Endpoint provisioning status ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Ready_SyncNotFunctional: No description available. ,
Ready_SyncFunctional: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningType:
{
Description: Server Endpoint provisioning type ,
Required: False ,
}
string ,
provisioningStepStatuses:
{
Description: Provisioning Step status information for each step in the provisioning process ,
Required: False ,
}
[
{
name:
{
Description: Name of the provisioning step ,
Required: False ,
}
string ,
status:
{
Description: Status of the provisioning step ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the provisioning step ,
Format: date-time ,
Required: False ,
}
string ,
minutesLeft:
{
Description: Estimated completion time of the provisioning step in minutes ,
Format: int32 ,
Required: False ,
}
integer ,
progressPercentage:
{
Description: Estimated progress percentage ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of the provisioning step ,
Format: date-time ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code (HResult) for the provisioning step ,
Format: int32 ,
Required: False ,
}
integer ,
additionalInformation:
{
Description: Additional information for the provisioning step ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_Delete (updated)
Description :  Delete a given ServerEndpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServerEndpoints_Delete",
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "@added_4aca9ce456e84ed59d52231a62fac4db": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
syncGroupName:
{
Description: Name of Sync Group resource. ,
Required: True ,
}
string ,
serverEndpointName:
{
Description: Name of Server Endpoint object. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
ServerEndpoints_recallAction (updated)
Description :  Recall a server endpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServerEndpoints_recallAction",
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Operation Status Location URI"
        }
      },
      {
        "@added_dafa5dd5fda24c2b81d0814eb7962963": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}/recallAction
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
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-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: request id. ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}
Workflows_ListByStorageSyncService (updated)
Description :  Get a Workflow List
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workflows_ListByStorageSyncService",
  "$responses": {
    "200": {
      "$properties": {
        "@added_c8ccb1ce277d44fc9f7a2fa6efb50188": {
          "#name": "nextLink",
          "Description": "The URL to get the next set of results.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id:
{
Description: correlation request id. ,
}
string ,
x-ms-request-id:
{
Description: 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 ,
commandName:
{
Description: workflow command name. ,
Required: False ,
}
string ,
createdTimestamp:
{
Description: workflow created timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastStatusTimestamp:
{
Description: workflow last status timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
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 ,
requestUri:
{
Description: Request URI of the given entry. ,
Required: False ,
}
string ,
exceptionType:
{
Description: Exception type of the given entry. ,
Required: False ,
}
string ,
httpMethod:
{
Description: HTTP method of the given entry. ,
Required: False ,
}
string ,
hashedMessage:
{
Description: Hashed message of the given entry. ,
Required: False ,
}
string ,
httpErrorCode:
{
Description: HTTP error code of the given entry. ,
Required: False ,
}
string ,
}
,
innererror:
{
Description: Inner error details of the given entry. ,
Required: False ,
}
{
callStack:
{
Description: Call stack of the error. ,
Required: False ,
}
string ,
message:
{
Description: Error message of the error. ,
Required: False ,
}
string ,
innerException:
{
Description: Exception of the inner error. ,
Required: False ,
}
string ,
innerExceptionCallStack:
{
Description: Call stack of the inner error. ,
Required: False ,
}
string ,
}
,
}
,
}