We recommend using Azure Native.
Azure v6.28.0 published on Friday, Oct 3, 2025 by Pulumi
azure.storage.getSync
Use this data source to access information about an existing Storage Sync.
Example Usage
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)
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/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
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.Storage.GetSync.Invoke(new()
{
Name = "existingStorageSyncName",
ResourceGroupName = "existingResGroup",
});
return new Dictionary<string, object?>
{
["id"] = example.Apply(getSyncResult => getSyncResult.Id),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.storage.StorageFunctions;
import com.pulumi.azure.storage.inputs.GetSyncArgs;
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) {
final var example = StorageFunctions.getSync(GetSyncArgs.builder()
.name("existingStorageSyncName")
.resourceGroupName("existingResGroup")
.build());
ctx.export("id", example.id());
}
}
variables:
example:
fn::invoke:
function: azure:storage:getSync
arguments:
name: existingStorageSyncName
resourceGroupName: existingResGroup
outputs:
id: ${example.id}
API Providers
This data source uses the following Azure API Providers:
Microsoft.StorageSync
- 2020-03-01
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.
- Resource
Group stringName - The name of the Resource Group where the Storage Sync exists.
- Name string
- The name of this Storage Sync.
- Resource
Group stringName - The name of the Resource Group where the Storage Sync exists.
- name String
- The name of this Storage Sync.
- resource
Group StringName - The name of the Resource Group where the Storage Sync exists.
- name string
- The name of this Storage Sync.
- resource
Group stringName - The name of the Resource Group where the Storage Sync exists.
- name str
- The name of this Storage Sync.
- resource_
group_ strname - The name of the Resource Group where the Storage Sync exists.
- name String
- The name of this Storage Sync.
- resource
Group StringName - 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.
- Incoming
Traffic stringPolicy - Incoming traffic policy.
- Location string
- The Azure Region where the Storage Sync exists.
- Name string
- Resource
Group stringName - Dictionary<string, string>
- A mapping of tags assigned to the Storage Sync.
- Id string
- The provider-assigned unique ID for this managed resource.
- Incoming
Traffic stringPolicy - Incoming traffic policy.
- Location string
- The Azure Region where the Storage Sync exists.
- Name string
- Resource
Group stringName - map[string]string
- A mapping of tags assigned to the Storage Sync.
- id String
- The provider-assigned unique ID for this managed resource.
- incoming
Traffic StringPolicy - Incoming traffic policy.
- location String
- The Azure Region where the Storage Sync exists.
- name String
- resource
Group StringName - Map<String,String>
- A mapping of tags assigned to the Storage Sync.
- id string
- The provider-assigned unique ID for this managed resource.
- incoming
Traffic stringPolicy - Incoming traffic policy.
- location string
- The Azure Region where the Storage Sync exists.
- name string
- resource
Group stringName - {[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_ strpolicy - Incoming traffic policy.
- location str
- The Azure Region where the Storage Sync exists.
- name str
- resource_
group_ strname - Mapping[str, str]
- A mapping of tags assigned to the Storage Sync.
- id String
- The provider-assigned unique ID for this managed resource.
- incoming
Traffic StringPolicy - Incoming traffic policy.
- location String
- The Azure Region where the Storage Sync exists.
- name String
- resource
Group StringName - 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.