Microsoft.StorageSync storageSyncServices/syncGroups/serverEndpoints

• Latest
• 2022-09-01
• 2022-06-01
• 2020-09-01
• 2020-03-01
• 2019-10-01
• 2019-06-01
• 2019-03-01
• 2019-02-01
• 2018-10-01
• 2018-07-01
• 2018-04-02
• 2017-06-05-preview

Bicep resource definition

The storageSyncServices/syncGroups/serverEndpoints resource type can be deployed with operations that target:

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

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

Property Values

Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints

Name	Description	Value
name	The resource name	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/syncGroups
properties	The parameters used to create the server endpoint.	ServerEndpointCreateParametersPropertiesOrServerEndpointProperties

ServerEndpointCreateParametersPropertiesOrServerEndpointProperties

Name	Description	Value
cloudTiering	Cloud Tiering.	'off' 'on'
friendlyName	Friendly Name	string
initialDownloadPolicy	Policy for how namespace and files are recalled during FastDr.	'AvoidTieredFiles' 'NamespaceOnly' 'NamespaceThenModifiedFiles'
initialUploadPolicy	Policy for how the initial upload sync session is performed.	'Merge' 'ServerAuthoritative'
localCacheMode	Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access.	'DownloadNewAndModifiedFiles' 'UpdateLocallyCachedFiles'
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 Constraints: Min value = 0 Max value = 2147483647
volumeFreeSpacePercent	Level of free space to be maintained by Cloud Tiering if it is enabled.	int Constraints: Min value = 0 Max value = 100

ARM template resource definition

The storageSyncServices/syncGroups/serverEndpoints resource type can be deployed with operations that target:

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

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

Property Values

Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints

Name	Description	Value
apiVersion	The api version	'2022-09-01'
name	The resource name	string (required)
properties	The parameters used to create the server endpoint.	ServerEndpointCreateParametersPropertiesOrServerEndpointProperties
type	The resource type	'Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints'

ServerEndpointCreateParametersPropertiesOrServerEndpointProperties

Name	Description	Value
cloudTiering	Cloud Tiering.	'off' 'on'
friendlyName	Friendly Name	string
initialDownloadPolicy	Policy for how namespace and files are recalled during FastDr.	'AvoidTieredFiles' 'NamespaceOnly' 'NamespaceThenModifiedFiles'
initialUploadPolicy	Policy for how the initial upload sync session is performed.	'Merge' 'ServerAuthoritative'
localCacheMode	Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access.	'DownloadNewAndModifiedFiles' 'UpdateLocallyCachedFiles'
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 Constraints: Min value = 0 Max value = 2147483647
volumeFreeSpacePercent	Level of free space to be maintained by Cloud Tiering if it is enabled.	int Constraints: Min value = 0 Max value = 100

Usage Examples

Terraform (AzAPI provider) resource definition

The storageSyncServices/syncGroups/serverEndpoints resource type can be deployed with operations that target:

• 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@2022-09-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      cloudTiering = "string"
      friendlyName = "string"
      initialDownloadPolicy = "string"
      initialUploadPolicy = "string"
      localCacheMode = "string"
      offlineDataTransfer = "string"
      offlineDataTransferShareName = "string"
      serverLocalPath = "string"
      serverResourceId = "string"
      tierFilesOlderThanDays = int
      volumeFreeSpacePercent = int
    }
  }
}

Property Values

Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints

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

ServerEndpointCreateParametersPropertiesOrServerEndpointProperties

Name	Description	Value
cloudTiering	Cloud Tiering.	'off' 'on'
friendlyName	Friendly Name	string
initialDownloadPolicy	Policy for how namespace and files are recalled during FastDr.	'AvoidTieredFiles' 'NamespaceOnly' 'NamespaceThenModifiedFiles'
initialUploadPolicy	Policy for how the initial upload sync session is performed.	'Merge' 'ServerAuthoritative'
localCacheMode	Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access.	'DownloadNewAndModifiedFiles' 'UpdateLocallyCachedFiles'
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 Constraints: Min value = 0 Max value = 2147483647
volumeFreeSpacePercent	Level of free space to be maintained by Cloud Tiering if it is enabled.	int Constraints: Min value = 0 Max value = 100