Microsoft.StorageSync storageSyncServices/registeredServers 2018-04-02

  • Article

Bicep resource definition

The storageSyncServices/registeredServers resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.StorageSync/storageSyncServices/registeredServers resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.StorageSync/storageSyncServices/registeredServers@2018-04-02' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    agentVersion: 'string'
    clusterId: 'string'
    clusterName: 'string'
    friendlyName: 'string'
    lastHeartBeat: 'string'
    serverCertificate: 'string'
    serverId: 'string'
    serverOSVersion: 'string'
    serverRole: 'string'
  }
}

Property values

storageSyncServices/registeredServers

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
location 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. string
tags 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. Dictionary of tag names and values. See Tags in templates
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: storageSyncServices
properties The parameters used to create the storage sync service. RegisteredServerCreateParametersPropertiesOrRegister...

RegisteredServerCreateParametersPropertiesOrRegister...

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

ARM template resource definition

The storageSyncServices/registeredServers resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

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

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

Property values

storageSyncServices/registeredServers

Name Description Value
type The resource type 'Microsoft.StorageSync/storageSyncServices/registeredServers'
apiVersion The resource api version '2018-04-02'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
location 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. string
tags 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. Dictionary of tag names and values. See Tags in templates
properties The parameters used to create the storage sync service. RegisteredServerCreateParametersPropertiesOrRegister...

RegisteredServerCreateParametersPropertiesOrRegister...

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

Terraform (AzAPI provider) resource definition

The storageSyncServices/registeredServers resource type can be deployed to:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.StorageSync/storageSyncServices/registeredServers resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.StorageSync/storageSyncServices/registeredServers@2018-04-02"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      agentVersion = "string"
      clusterId = "string"
      clusterName = "string"
      friendlyName = "string"
      lastHeartBeat = "string"
      serverCertificate = "string"
      serverId = "string"
      serverOSVersion = "string"
      serverRole = "string"
    }
  })
}

Property values

storageSyncServices/registeredServers

Name Description Value
type The resource type "Microsoft.StorageSync/storageSyncServices/registeredServers@2018-04-02"
name The resource name string (required)
location 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. string
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: storageSyncServices
tags 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. Dictionary of tag names and values.
properties The parameters used to create the storage sync service. RegisteredServerCreateParametersPropertiesOrRegister...

RegisteredServerCreateParametersPropertiesOrRegister...

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