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": "2019-10-01",
  "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 2019-10-01
properties object Yes The parameters used to create the registered server. - 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