1. Packages
  2. Azure Native
  3. API Docs
  4. storagesync
  5. getSyncGroup
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native.storagesync.getSyncGroup

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Get a given SyncGroup.

Uses Azure REST API version 2022-06-01.

Other available API versions: 2022-09-01.

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>
Copy
def get_sync_group(resource_group_name: Optional[str] = None,
                   storage_sync_service_name: Optional[str] = None,
                   sync_group_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetSyncGroupResult
def get_sync_group_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                   storage_sync_service_name: Optional[pulumi.Input[str]] = None,
                   sync_group_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetSyncGroupResult]
Copy
func LookupSyncGroup(ctx *Context, args *LookupSyncGroupArgs, opts ...InvokeOption) (*LookupSyncGroupResult, error)
func LookupSyncGroupOutput(ctx *Context, args *LookupSyncGroupOutputArgs, opts ...InvokeOption) LookupSyncGroupResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetSyncGroupResult> getSyncGroup(GetSyncGroupArgs args, InvokeOptions options)
public static Output<GetSyncGroupResult> getSyncGroup(GetSyncGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:storagesync:getSyncGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

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
This property is required.
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
This property is required.
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
This property is required.
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
This property is required.
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
This property is required.
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
This property is required.
Changes to this property will trigger replacement.
String
Name of Sync Group resource.

getSyncGroup Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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

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.

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 v1 docs if using the v1 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi