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-04-02",
  "location": "string",
  "tags": {},
  "properties": {
    "serverLocalPath": "string",
    "cloudTiering": "string",
    "volumeFreeSpacePercent": "integer",
    "friendlyName": "string",
    "serverResourceId": "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-04-02
location string No Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.
tags object No Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.
properties object Yes The parameters used to create the storage sync service. - 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.
friendlyName string No Friendly Name
serverResourceId string No Server Resource Id.