Microsoft.DataShare accounts/shares/synchronizationSettings

• Latest
• 2021-08-01
• 2020-10-01-preview
• 2020-09-01
• 2019-11-01
• 2018-11-01-preview

Bicep resource definition

The accounts/shares/synchronizationSettings 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.DataShare/accounts/shares/synchronizationSettings resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataShare/accounts/shares/synchronizationSettings@2021-08-01' = {
  name: 'string'
  kind: 'string'
  parent: resourceSymbolicName
  // For remaining properties, see accounts/shares/synchronizationSettings objects
}

accounts/shares/synchronizationSettings objects

Set the kind property to specify the type of object.

For ScheduleBased, use:

  kind: 'ScheduleBased'
  properties: {
    recurrenceInterval: 'string'
    synchronizationTime: 'string'
  }

Property values

accounts/shares/synchronizationSettings

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required)
kind	Set the object type	ScheduleBased (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: shares

ScheduledSynchronizationSetting

Name	Description	Value
kind	Kind of synchronization setting.	'ScheduleBased' (required)
properties	Properties of scheduled synchronization	ScheduledSynchronizationSettingProperties (required)

ScheduledSynchronizationSettingProperties

Name	Description	Value
recurrenceInterval	Recurrence Interval	'Day' 'Hour' (required)
synchronizationTime	Synchronization time	string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a data share from a storage account	This template creates a data share from a storage account

ARM template resource definition

The accounts/shares/synchronizationSettings 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.DataShare/accounts/shares/synchronizationSettings resource, add the following JSON to your template.

{
  "type": "Microsoft.DataShare/accounts/shares/synchronizationSettings",
  "apiVersion": "2021-08-01",
  "name": "string",
  "kind": "string",
  // For remaining properties, see accounts/shares/synchronizationSettings objects
}

accounts/shares/synchronizationSettings objects

Set the kind property to specify the type of object.

For ScheduleBased, use:

  "kind": "ScheduleBased",
  "properties": {
    "recurrenceInterval": "string",
    "synchronizationTime": "string"
  }

Property values

accounts/shares/synchronizationSettings

Name	Description	Value
type	The resource type	'Microsoft.DataShare/accounts/shares/synchronizationSettings'
apiVersion	The resource api version	'2021-08-01'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
kind	Set the object type	ScheduleBased (required)

ScheduledSynchronizationSetting

Name	Description	Value
kind	Kind of synchronization setting.	'ScheduleBased' (required)
properties	Properties of scheduled synchronization	ScheduledSynchronizationSettingProperties (required)

ScheduledSynchronizationSettingProperties

Name	Description	Value
recurrenceInterval	Recurrence Interval	'Day' 'Hour' (required)
synchronizationTime	Synchronization time	string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a data share from a storage account	This template creates a data share from a storage account

Terraform (AzAPI provider) resource definition

The accounts/shares/synchronizationSettings 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.DataShare/accounts/shares/synchronizationSettings resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataShare/accounts/shares/synchronizationSettings@2021-08-01"
  name = "string"
  parent_id = "string"
  // For remaining properties, see accounts/shares/synchronizationSettings objects
  body = jsonencode({
    kind = "string"
  })
}

accounts/shares/synchronizationSettings objects

Set the kind property to specify the type of object.

For ScheduleBased, use:

  kind = "ScheduleBased"
  properties = {
    recurrenceInterval = "string"
    synchronizationTime = "string"
  }

Property values

accounts/shares/synchronizationSettings

Name	Description	Value
type	The resource type	"Microsoft.DataShare/accounts/shares/synchronizationSettings@2021-08-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: shares
kind	Set the object type	ScheduleBased (required)

ScheduledSynchronizationSetting

Name	Description	Value
kind	Kind of synchronization setting.	"ScheduleBased" (required)
properties	Properties of scheduled synchronization	ScheduledSynchronizationSettingProperties (required)

ScheduledSynchronizationSettingProperties

Name	Description	Value
recurrenceInterval	Recurrence Interval	"Day" "Hour" (required)
synchronizationTime	Synchronization time	string (required)