Microsoft.StorageSync storageSyncServices/syncGroups/serverEndpoints 2018-10-01

  • Article

Bicep resource definition

The storageSyncServices/syncGroups/serverEndpoints 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/syncGroups/serverEndpoints resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2018-10-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    cloudTiering: 'string'
    friendlyName: 'string'
    offlineDataTransfer: 'string'
    offlineDataTransferShareName: 'string'
    serverLocalPath: 'string'
    serverResourceId: 'string'
    tierFilesOlderThanDays: int
    volumeFreeSpacePercent: int
  }
}

Property values

storageSyncServices/syncGroups/serverEndpoints

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: syncGroups
properties The parameters used to create the server endpoint. ServerEndpointCreateParametersPropertiesOrServerEndp...

ServerEndpointCreateParametersPropertiesOrServerEndp...

Name Description Value
cloudTiering Cloud Tiering. 'off'
'on'
friendlyName Friendly Name string
offlineDataTransfer Offline data transfer 'off'
'on'
offlineDataTransferShareName Offline data transfer share name string
serverLocalPath Server Local path. string
serverResourceId Server Resource Id. string
tierFilesOlderThanDays Tier files older than days. int
volumeFreeSpacePercent Level of free space to be maintained by Cloud Tiering if it is enabled. int

ARM template resource definition

The storageSyncServices/syncGroups/serverEndpoints 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/syncGroups/serverEndpoints resource, add the following JSON to your template.

{
  "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints",
  "apiVersion": "2018-10-01",
  "name": "string",
  "properties": {
    "cloudTiering": "string",
    "friendlyName": "string",
    "offlineDataTransfer": "string",
    "offlineDataTransferShareName": "string",
    "serverLocalPath": "string",
    "serverResourceId": "string",
    "tierFilesOlderThanDays": "int",
    "volumeFreeSpacePercent": "int"
  }
}

Property values

storageSyncServices/syncGroups/serverEndpoints

Name Description Value
type The resource type 'Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints'
apiVersion The resource api version '2018-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 server endpoint. ServerEndpointCreateParametersPropertiesOrServerEndp...

ServerEndpointCreateParametersPropertiesOrServerEndp...

Name Description Value
cloudTiering Cloud Tiering. 'off'
'on'
friendlyName Friendly Name string
offlineDataTransfer Offline data transfer 'off'
'on'
offlineDataTransferShareName Offline data transfer share name string
serverLocalPath Server Local path. string
serverResourceId Server Resource Id. string
tierFilesOlderThanDays Tier files older than days. int
volumeFreeSpacePercent Level of free space to be maintained by Cloud Tiering if it is enabled. int

Terraform (AzAPI provider) resource definition

The storageSyncServices/syncGroups/serverEndpoints 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/syncGroups/serverEndpoints resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2018-10-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      cloudTiering = "string"
      friendlyName = "string"
      offlineDataTransfer = "string"
      offlineDataTransferShareName = "string"
      serverLocalPath = "string"
      serverResourceId = "string"
      tierFilesOlderThanDays = int
      volumeFreeSpacePercent = int
    }
  })
}

Property values

storageSyncServices/syncGroups/serverEndpoints

Name Description Value
type The resource type "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints@2018-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: syncGroups
properties The parameters used to create the server endpoint. ServerEndpointCreateParametersPropertiesOrServerEndp...

ServerEndpointCreateParametersPropertiesOrServerEndp...

Name Description Value
cloudTiering Cloud Tiering. "off"
"on"
friendlyName Friendly Name string
offlineDataTransfer Offline data transfer "off"
"on"
offlineDataTransferShareName Offline data transfer share name string
serverLocalPath Server Local path. string
serverResourceId Server Resource Id. string
tierFilesOlderThanDays Tier files older than days. int
volumeFreeSpacePercent Level of free space to be maintained by Cloud Tiering if it is enabled. int