1. Packages
  2. Azure Native
  3. API Docs
  4. storagesync
  5. SyncGroup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.storagesync.SyncGroup

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Sync Group object.

Uses Azure REST API version 2022-09-01. In version 2.x of the Azure Native provider, it used API version 2022-06-01.

Other available API versions: 2022-06-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native storagesync [ApiVersion]. See the version guide for details.

Example Usage

SyncGroups_Create

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

return await Deployment.RunAsync(() => 
{
    var syncGroup = new AzureNative.StorageSync.SyncGroup("syncGroup", new()
    {
        ResourceGroupName = "SampleResourceGroup_1",
        StorageSyncServiceName = "SampleStorageSyncService_1",
        SyncGroupName = "SampleSyncGroup_1",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagesync.NewSyncGroup(ctx, "syncGroup", &storagesync.SyncGroupArgs{
			ResourceGroupName:      pulumi.String("SampleResourceGroup_1"),
			StorageSyncServiceName: pulumi.String("SampleStorageSyncService_1"),
			SyncGroupName:          pulumi.String("SampleSyncGroup_1"),
		})
		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.storagesync.SyncGroup;
import com.pulumi.azurenative.storagesync.SyncGroupArgs;
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 syncGroup = new SyncGroup("syncGroup", SyncGroupArgs.builder()
            .resourceGroupName("SampleResourceGroup_1")
            .storageSyncServiceName("SampleStorageSyncService_1")
            .syncGroupName("SampleSyncGroup_1")
            .build());

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

const syncGroup = new azure_native.storagesync.SyncGroup("syncGroup", {
    resourceGroupName: "SampleResourceGroup_1",
    storageSyncServiceName: "SampleStorageSyncService_1",
    syncGroupName: "SampleSyncGroup_1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

sync_group = azure_native.storagesync.SyncGroup("syncGroup",
    resource_group_name="SampleResourceGroup_1",
    storage_sync_service_name="SampleStorageSyncService_1",
    sync_group_name="SampleSyncGroup_1")
Copy
resources:
  syncGroup:
    type: azure-native:storagesync:SyncGroup
    properties:
      resourceGroupName: SampleResourceGroup_1
      storageSyncServiceName: SampleStorageSyncService_1
      syncGroupName: SampleSyncGroup_1
Copy

Create SyncGroup Resource

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

Constructor syntax

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

@overload
def SyncGroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              resource_group_name: Optional[str] = None,
              storage_sync_service_name: Optional[str] = None,
              sync_group_name: Optional[str] = None)
func NewSyncGroup(ctx *Context, name string, args SyncGroupArgs, opts ...ResourceOption) (*SyncGroup, error)
public SyncGroup(string name, SyncGroupArgs args, CustomResourceOptions? opts = null)
public SyncGroup(String name, SyncGroupArgs args)
public SyncGroup(String name, SyncGroupArgs args, CustomResourceOptions options)
type: azure-native:storagesync:SyncGroup
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. SyncGroupArgs
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. SyncGroupArgs
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. SyncGroupArgs
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. SyncGroupArgs
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. SyncGroupArgs
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 azure_nativeSyncGroupResource = new AzureNative.StorageSync.SyncGroup("azure-nativeSyncGroupResource", new()
{
    ResourceGroupName = "string",
    StorageSyncServiceName = "string",
    SyncGroupName = "string",
});
Copy
example, err := storagesync.NewSyncGroup(ctx, "azure-nativeSyncGroupResource", &storagesync.SyncGroupArgs{
	ResourceGroupName:      pulumi.String("string"),
	StorageSyncServiceName: pulumi.String("string"),
	SyncGroupName:          pulumi.String("string"),
})
Copy
var azure_nativeSyncGroupResource = new SyncGroup("azure-nativeSyncGroupResource", SyncGroupArgs.builder()
    .resourceGroupName("string")
    .storageSyncServiceName("string")
    .syncGroupName("string")
    .build());
Copy
azure_native_sync_group_resource = azure_native.storagesync.SyncGroup("azure-nativeSyncGroupResource",
    resource_group_name="string",
    storage_sync_service_name="string",
    sync_group_name="string")
Copy
const azure_nativeSyncGroupResource = new azure_native.storagesync.SyncGroup("azure-nativeSyncGroupResource", {
    resourceGroupName: "string",
    storageSyncServiceName: "string",
    syncGroupName: "string",
});
Copy
type: azure-native:storagesync:SyncGroup
properties:
    resourceGroupName: string
    storageSyncServiceName: string
    syncGroupName: string
Copy

SyncGroup 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 SyncGroup resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
StorageSyncServiceName
This property is required.
Changes to this property will trigger replacement.
string
Name of Storage Sync Service resource.
SyncGroupName Changes to this property will trigger replacement. string
Name of Sync Group resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
StorageSyncServiceName
This property is required.
Changes to this property will trigger replacement.
string
Name of Storage Sync Service resource.
SyncGroupName Changes to this property will trigger replacement. string
Name of Sync Group resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
storageSyncServiceName
This property is required.
Changes to this property will trigger replacement.
String
Name of Storage Sync Service resource.
syncGroupName Changes to this property will trigger replacement. String
Name of Sync Group resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
storageSyncServiceName
This property is required.
Changes to this property will trigger replacement.
string
Name of Storage Sync Service resource.
syncGroupName Changes to this property will trigger replacement. string
Name of Sync Group resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
storage_sync_service_name
This property is required.
Changes to this property will trigger replacement.
str
Name of Storage Sync Service resource.
sync_group_name Changes to this property will trigger replacement. str
Name of Sync Group resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
storageSyncServiceName
This property is required.
Changes to this property will trigger replacement.
String
Name of Storage Sync Service resource.
syncGroupName Changes to this property will trigger replacement. String
Name of Sync Group resource.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
SyncGroupStatus string
Sync group status
SystemData Pulumi.AzureNative.StorageSync.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UniqueId string
Unique Id
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
SyncGroupStatus string
Sync group status
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UniqueId string
Unique Id
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
syncGroupStatus String
Sync group status
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uniqueId String
Unique Id
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
syncGroupStatus string
Sync group status
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uniqueId string
Unique Id
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
sync_group_status str
Sync group status
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
unique_id str
Unique Id
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
syncGroupStatus String
Sync group status
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uniqueId String
Unique Id

Supporting Types

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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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:storagesync:SyncGroup SampleSyncGroup_1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName} 
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi