1. Packages
  2. Azure Native v2
  3. API Docs
  4. datashare
  5. ScheduledSynchronizationSetting
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.datashare.ScheduledSynchronizationSetting

Explore with Pulumi AI

A type of synchronization setting based on schedule Azure REST API version: 2021-08-01. Prior API version in Azure Native 1.x: 2020-09-01.

Example Usage

SynchronizationSettings_Create

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var scheduledSynchronizationSetting = new AzureNative.DataShare.ScheduledSynchronizationSetting("scheduledSynchronizationSetting", new()
    {
        AccountName = "Account1",
        Kind = "ScheduleBased",
        RecurrenceInterval = AzureNative.DataShare.RecurrenceInterval.Day,
        ResourceGroupName = "SampleResourceGroup",
        ShareName = "Share1",
        SynchronizationSettingName = "Dataset1",
        SynchronizationTime = "2018-11-14T04:47:52.9614956Z",
    });

});
Copy
package main

import (
	datashare "github.com/pulumi/pulumi-azure-native-sdk/datashare/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datashare.NewScheduledSynchronizationSetting(ctx, "scheduledSynchronizationSetting", &datashare.ScheduledSynchronizationSettingArgs{
			AccountName:                pulumi.String("Account1"),
			Kind:                       pulumi.String("ScheduleBased"),
			RecurrenceInterval:         pulumi.String(datashare.RecurrenceIntervalDay),
			ResourceGroupName:          pulumi.String("SampleResourceGroup"),
			ShareName:                  pulumi.String("Share1"),
			SynchronizationSettingName: pulumi.String("Dataset1"),
			SynchronizationTime:        pulumi.String("2018-11-14T04:47:52.9614956Z"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.datashare.ScheduledSynchronizationSetting;
import com.pulumi.azurenative.datashare.ScheduledSynchronizationSettingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var scheduledSynchronizationSetting = new ScheduledSynchronizationSetting("scheduledSynchronizationSetting", ScheduledSynchronizationSettingArgs.builder()
            .accountName("Account1")
            .kind("ScheduleBased")
            .recurrenceInterval("Day")
            .resourceGroupName("SampleResourceGroup")
            .shareName("Share1")
            .synchronizationSettingName("Dataset1")
            .synchronizationTime("2018-11-14T04:47:52.9614956Z")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const scheduledSynchronizationSetting = new azure_native.datashare.ScheduledSynchronizationSetting("scheduledSynchronizationSetting", {
    accountName: "Account1",
    kind: "ScheduleBased",
    recurrenceInterval: azure_native.datashare.RecurrenceInterval.Day,
    resourceGroupName: "SampleResourceGroup",
    shareName: "Share1",
    synchronizationSettingName: "Dataset1",
    synchronizationTime: "2018-11-14T04:47:52.9614956Z",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

scheduled_synchronization_setting = azure_native.datashare.ScheduledSynchronizationSetting("scheduledSynchronizationSetting",
    account_name="Account1",
    kind="ScheduleBased",
    recurrence_interval=azure_native.datashare.RecurrenceInterval.DAY,
    resource_group_name="SampleResourceGroup",
    share_name="Share1",
    synchronization_setting_name="Dataset1",
    synchronization_time="2018-11-14T04:47:52.9614956Z")
Copy
resources:
  scheduledSynchronizationSetting:
    type: azure-native:datashare:ScheduledSynchronizationSetting
    properties:
      accountName: Account1
      kind: ScheduleBased
      recurrenceInterval: Day
      resourceGroupName: SampleResourceGroup
      shareName: Share1
      synchronizationSettingName: Dataset1
      synchronizationTime: 2018-11-14T04:47:52.9614956Z
Copy

Create ScheduledSynchronizationSetting Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ScheduledSynchronizationSetting(name: string, args: ScheduledSynchronizationSettingArgs, opts?: CustomResourceOptions);
@overload
def ScheduledSynchronizationSetting(resource_name: str,
                                    args: ScheduledSynchronizationSettingArgs,
                                    opts: Optional[ResourceOptions] = None)

@overload
def ScheduledSynchronizationSetting(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    account_name: Optional[str] = None,
                                    recurrence_interval: Optional[Union[str, RecurrenceInterval]] = None,
                                    resource_group_name: Optional[str] = None,
                                    share_name: Optional[str] = None,
                                    synchronization_time: Optional[str] = None,
                                    synchronization_setting_name: Optional[str] = None)
func NewScheduledSynchronizationSetting(ctx *Context, name string, args ScheduledSynchronizationSettingArgs, opts ...ResourceOption) (*ScheduledSynchronizationSetting, error)
public ScheduledSynchronizationSetting(string name, ScheduledSynchronizationSettingArgs args, CustomResourceOptions? opts = null)
public ScheduledSynchronizationSetting(String name, ScheduledSynchronizationSettingArgs args)
public ScheduledSynchronizationSetting(String name, ScheduledSynchronizationSettingArgs args, CustomResourceOptions options)
type: azure-native:datashare:ScheduledSynchronizationSetting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ScheduledSynchronizationSettingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ScheduledSynchronizationSettingArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ScheduledSynchronizationSettingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ScheduledSynchronizationSettingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ScheduledSynchronizationSettingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var scheduledSynchronizationSettingResource = new AzureNative.Datashare.ScheduledSynchronizationSetting("scheduledSynchronizationSettingResource", new()
{
    AccountName = "string",
    Kind = "string",
    RecurrenceInterval = "string",
    ResourceGroupName = "string",
    ShareName = "string",
    SynchronizationTime = "string",
    SynchronizationSettingName = "string",
});
Copy
example, err := datashare.NewScheduledSynchronizationSetting(ctx, "scheduledSynchronizationSettingResource", &datashare.ScheduledSynchronizationSettingArgs{
	AccountName:                "string",
	Kind:                       "string",
	RecurrenceInterval:         "string",
	ResourceGroupName:          "string",
	ShareName:                  "string",
	SynchronizationTime:        "string",
	SynchronizationSettingName: "string",
})
Copy
var scheduledSynchronizationSettingResource = new ScheduledSynchronizationSetting("scheduledSynchronizationSettingResource", ScheduledSynchronizationSettingArgs.builder()
    .accountName("string")
    .kind("string")
    .recurrenceInterval("string")
    .resourceGroupName("string")
    .shareName("string")
    .synchronizationTime("string")
    .synchronizationSettingName("string")
    .build());
Copy
scheduled_synchronization_setting_resource = azure_native.datashare.ScheduledSynchronizationSetting("scheduledSynchronizationSettingResource",
    account_name=string,
    kind=string,
    recurrence_interval=string,
    resource_group_name=string,
    share_name=string,
    synchronization_time=string,
    synchronization_setting_name=string)
Copy
const scheduledSynchronizationSettingResource = new azure_native.datashare.ScheduledSynchronizationSetting("scheduledSynchronizationSettingResource", {
    accountName: "string",
    kind: "string",
    recurrenceInterval: "string",
    resourceGroupName: "string",
    shareName: "string",
    synchronizationTime: "string",
    synchronizationSettingName: "string",
});
Copy
type: azure-native:datashare:ScheduledSynchronizationSetting
properties:
    accountName: string
    kind: string
    recurrenceInterval: string
    resourceGroupName: string
    shareName: string
    synchronizationSettingName: string
    synchronizationTime: string
Copy

ScheduledSynchronizationSetting Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ScheduledSynchronizationSetting resource accepts the following input properties:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the share account.
RecurrenceInterval This property is required. string | Pulumi.AzureNative.DataShare.RecurrenceInterval
Recurrence Interval
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
ShareName
This property is required.
Changes to this property will trigger replacement.
string
The name of the share to add the synchronization setting to.
SynchronizationTime This property is required. string
Synchronization time
SynchronizationSettingName Changes to this property will trigger replacement. string
The name of the synchronizationSetting.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the share account.
RecurrenceInterval This property is required. string | RecurrenceInterval
Recurrence Interval
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
ShareName
This property is required.
Changes to this property will trigger replacement.
string
The name of the share to add the synchronization setting to.
SynchronizationTime This property is required. string
Synchronization time
SynchronizationSettingName Changes to this property will trigger replacement. string
The name of the synchronizationSetting.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the share account.
recurrenceInterval This property is required. String | RecurrenceInterval
Recurrence Interval
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
shareName
This property is required.
Changes to this property will trigger replacement.
String
The name of the share to add the synchronization setting to.
synchronizationTime This property is required. String
Synchronization time
synchronizationSettingName Changes to this property will trigger replacement. String
The name of the synchronizationSetting.
accountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the share account.
recurrenceInterval This property is required. string | RecurrenceInterval
Recurrence Interval
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
shareName
This property is required.
Changes to this property will trigger replacement.
string
The name of the share to add the synchronization setting to.
synchronizationTime This property is required. string
Synchronization time
synchronizationSettingName Changes to this property will trigger replacement. string
The name of the synchronizationSetting.
account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the share account.
recurrence_interval This property is required. str | RecurrenceInterval
Recurrence Interval
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name.
share_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the share to add the synchronization setting to.
synchronization_time This property is required. str
Synchronization time
synchronization_setting_name Changes to this property will trigger replacement. str
The name of the synchronizationSetting.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the share account.
recurrenceInterval This property is required. String | "Hour" | "Day"
Recurrence Interval
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
shareName
This property is required.
Changes to this property will trigger replacement.
String
The name of the share to add the synchronization setting to.
synchronizationTime This property is required. String
Synchronization time
synchronizationSettingName Changes to this property will trigger replacement. String
The name of the synchronizationSetting.

Outputs

All input properties are implicitly available as output properties. Additionally, the ScheduledSynchronizationSetting resource produces the following output properties:

CreatedAt string
Time at which the synchronization setting was created.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Name of the azure resource
ProvisioningState string
Gets or sets the provisioning state
SystemData Pulumi.AzureNative.DataShare.Outputs.SystemDataResponse
System Data of the Azure resource.
Type string
Type of the azure resource
UserName string
Name of the user who created the synchronization setting.
CreatedAt string
Time at which the synchronization setting was created.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Name of the azure resource
ProvisioningState string
Gets or sets the provisioning state
SystemData SystemDataResponse
System Data of the Azure resource.
Type string
Type of the azure resource
UserName string
Name of the user who created the synchronization setting.
createdAt String
Time at which the synchronization setting was created.
id String
The provider-assigned unique ID for this managed resource.
name String
Name of the azure resource
provisioningState String
Gets or sets the provisioning state
systemData SystemDataResponse
System Data of the Azure resource.
type String
Type of the azure resource
userName String
Name of the user who created the synchronization setting.
createdAt string
Time at which the synchronization setting was created.
id string
The provider-assigned unique ID for this managed resource.
name string
Name of the azure resource
provisioningState string
Gets or sets the provisioning state
systemData SystemDataResponse
System Data of the Azure resource.
type string
Type of the azure resource
userName string
Name of the user who created the synchronization setting.
created_at str
Time at which the synchronization setting was created.
id str
The provider-assigned unique ID for this managed resource.
name str
Name of the azure resource
provisioning_state str
Gets or sets the provisioning state
system_data SystemDataResponse
System Data of the Azure resource.
type str
Type of the azure resource
user_name str
Name of the user who created the synchronization setting.
createdAt String
Time at which the synchronization setting was created.
id String
The provider-assigned unique ID for this managed resource.
name String
Name of the azure resource
provisioningState String
Gets or sets the provisioning state
systemData Property Map
System Data of the Azure resource.
type String
Type of the azure resource
userName String
Name of the user who created the synchronization setting.

Supporting Types

RecurrenceInterval
, RecurrenceIntervalArgs

Hour
Hour
Day
Day
RecurrenceIntervalHour
Hour
RecurrenceIntervalDay
Day
Hour
Hour
Day
Day
Hour
Hour
Day
Day
HOUR
Hour
DAY
Day
"Hour"
Hour
"Day"
Day

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The type of identity that last modified the resource.
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The type of identity that last modified the resource.
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:datashare:ScheduledSynchronizationSetting SynchronizationSetting1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings/{synchronizationSettingName} 
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0