1. Packages
  2. Azure Classic
  3. API Docs
  4. storage
  5. getSyncGroup

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    Use this data source to access information about an existing Storage Sync Group.

    Example Usage

    using Pulumi;
    using Azure = Pulumi.Azure;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var example = Output.Create(Azure.Storage.GetSyncGroup.InvokeAsync(new Azure.Storage.GetSyncGroupArgs
            {
                Name = "existing-ss-group",
                StorageSyncId = "existing-ss-id",
            }));
            this.Id = example.Apply(example => example.Id);
        }
    
        [Output("id")]
        public Output<string> Id { get; set; }
    }
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/storage"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := storage.LookupSyncGroup(ctx, &storage.LookupSyncGroupArgs{
    			Name:          "existing-ss-group",
    			StorageSyncId: "existing-ss-id",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("id", example.Id)
    		return nil
    	})
    }
    

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.storage.getSyncGroup({
        name: "existing-ss-group",
        storageSyncId: "existing-ss-id",
    });
    export const id = example.then(example => example.id);
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.storage.get_sync_group(name="existing-ss-group",
        storage_sync_id="existing-ss-id")
    pulumi.export("id", example.id)
    

    Example coming soon!

    Using getSyncGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSyncGroup(args: GetSyncGroupArgs, opts?: InvokeOptions): Promise<GetSyncGroupResult>
    function getSyncGroupOutput(args: GetSyncGroupOutputArgs, opts?: InvokeOptions): Output<GetSyncGroupResult>
    def get_sync_group(name: Optional[str] = None,
                       storage_sync_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetSyncGroupResult
    def get_sync_group_output(name: Optional[pulumi.Input[str]] = None,
                       storage_sync_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetSyncGroupResult]
    func LookupSyncGroup(ctx *Context, args *LookupSyncGroupArgs, opts ...InvokeOption) (*LookupSyncGroupResult, error)
    func LookupSyncGroupOutput(ctx *Context, args *LookupSyncGroupOutputArgs, opts ...InvokeOption) LookupSyncGroupResultOutput

    > Note: This function is named LookupSyncGroup in the Go SDK.

    public static class GetSyncGroup 
    {
        public static Task<GetSyncGroupResult> InvokeAsync(GetSyncGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetSyncGroupResult> Invoke(GetSyncGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSyncGroupResult> getSyncGroup(GetSyncGroupArgs args, InvokeOptions options)
    public static Output<GetSyncGroupResult> getSyncGroup(GetSyncGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure:storage/getSyncGroup:getSyncGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of this Storage Sync Group.
    StorageSyncId string
    The resource ID of the Storage Sync where this Storage Sync Group is.
    Name string
    The name of this Storage Sync Group.
    StorageSyncId string
    The resource ID of the Storage Sync where this Storage Sync Group is.
    name String
    The name of this Storage Sync Group.
    storageSyncId String
    The resource ID of the Storage Sync where this Storage Sync Group is.
    name string
    The name of this Storage Sync Group.
    storageSyncId string
    The resource ID of the Storage Sync where this Storage Sync Group is.
    name str
    The name of this Storage Sync Group.
    storage_sync_id str
    The resource ID of the Storage Sync where this Storage Sync Group is.
    name String
    The name of this Storage Sync Group.
    storageSyncId String
    The resource ID of the Storage Sync where this Storage Sync Group is.

    getSyncGroup Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    StorageSyncId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    StorageSyncId string
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    storageSyncId String
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    storageSyncId string
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    storage_sync_id str
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    storageSyncId String

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.