Microsoft.StorageSync storageSyncServices/registeredServers template reference

Template format

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

{
  "name": "string",
  "type": "Microsoft.StorageSync/storageSyncServices/registeredServers",
  "apiVersion": "2018-04-02",
  "location": "string",
  "tags": {},
  "properties": {
    "serverCertificate": "string",
    "agentVersion": "string",
    "serverOSVersion": "string",
    "lastHeartBeat": "string",
    "serverRole": "string",
    "clusterId": "string",
    "clusterName": "string",
    "serverId": "string",
    "friendlyName": "string"
  }
}

Property values

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

Microsoft.StorageSync/storageSyncServices/registeredServers object

Name Type Required Value
name string Yes GUID identifying the on-premises server.
type enum Yes registeredServers
-or-
Microsoft.StorageSync/storageSyncServices/registeredServers

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. - RegisteredServerCreateParametersProperties object

RegisteredServerCreateParametersProperties object

Name Type Required Value
serverCertificate string No Registered Server Certificate
agentVersion string No Registered Server Agent Version
serverOSVersion string No Registered Server OS Version
lastHeartBeat string No Registered Server last heart beat
serverRole string No Registered Server serverRole
clusterId string No Registered Server clusterId
clusterName string No Registered Server clusterName
serverId string No Registered Server serverId
friendlyName string No Friendly Name