Microsoft.StorageSync storageSyncServices/syncGroups/serverEndpoints template reference

Template format

To create a Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints",
  "apiVersion": "2018-10-01",
  "properties": {
    "serverLocalPath": "string",
    "cloudTiering": "string",
    "volumeFreeSpacePercent": "integer",
    "tierFilesOlderThanDays": "integer",
    "friendlyName": "string",
    "serverResourceId": "string",
    "offlineDataTransfer": "string",
    "offlineDataTransferShareName": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints object

Name Type Required Value
name string Yes Name of Server Endpoint object.
type enum Yes serverEndpoints
-or-
Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints

See Set name and type for child resources.
apiVersion enum Yes 2018-10-01
properties object Yes The parameters used to create the server endpoint. - ServerEndpointCreateParametersProperties object

ServerEndpointCreateParametersProperties object

Name Type Required Value
serverLocalPath string No Server Local path.
cloudTiering enum No Cloud Tiering. - on or off
volumeFreeSpacePercent integer No Level of free space to be maintained by Cloud Tiering if it is enabled.
tierFilesOlderThanDays integer No Tier files older than days.
friendlyName string No Friendly Name
serverResourceId string No Server Resource Id.
offlineDataTransfer enum No Offline data transfer. - on or off
offlineDataTransferShareName string No Offline data transfer share name