Microsoft.StorageSync storageSyncServices/registeredServers 2019-10-01
Bicep resource definition
The storageSyncServices/registeredServers resource type can be deployed to:
- Resource groups - See resource group deployment commands
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@2019-10-01' = {
name: 'string'
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) |
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 registered server. | 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:
- Resource groups - See resource group deployment commands
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": "2019-10-01",
"name": "string",
"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 | '2019-10-01' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
properties | The parameters used to create the registered server. | 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@2019-10-01"
name = "string"
parent_id = "string"
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@2019-10-01" |
name | The resource name | string (required) |
parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: storageSyncServices |
properties | The parameters used to create the registered server. | 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 |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for