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

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.

    Example Usage

    using Pulumi;
    using Azure = Pulumi.Azure;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var example = Output.Create(Azure.Storage.GetSync.InvokeAsync(new Azure.Storage.GetSyncArgs
            {
                Name = "existingStorageSyncName",
                ResourceGroupName = "existingResGroup",
            }));
            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.LookupSync(ctx, &storage.LookupSyncArgs{
    			Name:              "existingStorageSyncName",
    			ResourceGroupName: "existingResGroup",
    		}, 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.getSync({
        name: "existingStorageSyncName",
        resourceGroupName: "existingResGroup",
    });
    export const id = example.then(example => example.id);
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.storage.get_sync(name="existingStorageSyncName",
        resource_group_name="existingResGroup")
    pulumi.export("id", example.id)
    

    Example coming soon!

    Using getSync

    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 getSync(args: GetSyncArgs, opts?: InvokeOptions): Promise<GetSyncResult>
    function getSyncOutput(args: GetSyncOutputArgs, opts?: InvokeOptions): Output<GetSyncResult>
    def get_sync(name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSyncResult
    def get_sync_output(name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetSyncResult]
    func LookupSync(ctx *Context, args *LookupSyncArgs, opts ...InvokeOption) (*LookupSyncResult, error)
    func LookupSyncOutput(ctx *Context, args *LookupSyncOutputArgs, opts ...InvokeOption) LookupSyncResultOutput

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

    public static class GetSync 
    {
        public static Task<GetSyncResult> InvokeAsync(GetSyncArgs args, InvokeOptions? opts = null)
        public static Output<GetSyncResult> Invoke(GetSyncInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSyncResult> getSync(GetSyncArgs args, InvokeOptions options)
    public static Output<GetSyncResult> getSync(GetSyncArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure:storage/getSync:getSync
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of this Storage Sync.
    ResourceGroupName string
    The name of the Resource Group where the Storage Sync exists.
    Name string
    The name of this Storage Sync.
    ResourceGroupName string
    The name of the Resource Group where the Storage Sync exists.
    name String
    The name of this Storage Sync.
    resourceGroupName String
    The name of the Resource Group where the Storage Sync exists.
    name string
    The name of this Storage Sync.
    resourceGroupName string
    The name of the Resource Group where the Storage Sync exists.
    name str
    The name of this Storage Sync.
    resource_group_name str
    The name of the Resource Group where the Storage Sync exists.
    name String
    The name of this Storage Sync.
    resourceGroupName String
    The name of the Resource Group where the Storage Sync exists.

    getSync Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    IncomingTrafficPolicy string
    Incoming traffic policy.
    Location string
    The Azure Region where the Storage Sync exists.
    Name string
    ResourceGroupName string
    Tags Dictionary<string, string>
    A mapping of tags assigned to the Storage Sync.
    Id string
    The provider-assigned unique ID for this managed resource.
    IncomingTrafficPolicy string
    Incoming traffic policy.
    Location string
    The Azure Region where the Storage Sync exists.
    Name string
    ResourceGroupName string
    Tags map[string]string
    A mapping of tags assigned to the Storage Sync.
    id String
    The provider-assigned unique ID for this managed resource.
    incomingTrafficPolicy String
    Incoming traffic policy.
    location String
    The Azure Region where the Storage Sync exists.
    name String
    resourceGroupName String
    tags Map<String,String>
    A mapping of tags assigned to the Storage Sync.
    id string
    The provider-assigned unique ID for this managed resource.
    incomingTrafficPolicy string
    Incoming traffic policy.
    location string
    The Azure Region where the Storage Sync exists.
    name string
    resourceGroupName string
    tags {[key: string]: string}
    A mapping of tags assigned to the Storage Sync.
    id str
    The provider-assigned unique ID for this managed resource.
    incoming_traffic_policy str
    Incoming traffic policy.
    location str
    The Azure Region where the Storage Sync exists.
    name str
    resource_group_name str
    tags Mapping[str, str]
    A mapping of tags assigned to the Storage Sync.
    id String
    The provider-assigned unique ID for this managed resource.
    incomingTrafficPolicy String
    Incoming traffic policy.
    location String
    The Azure Region where the Storage Sync exists.
    name String
    resourceGroupName String
    tags Map<String>
    A mapping of tags assigned to the Storage Sync.

    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.