Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. sql
  5. getSyncGroup
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.sql.getSyncGroup

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a sync group. Azure REST API version: 2021-11-01.

Other available API versions: 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview.

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(database_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   server_name: Optional[str] = None,
                   sync_group_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetSyncGroupResult
def get_sync_group_output(database_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   server_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:sql:getSyncGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database on which the sync group is hosted.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
SyncGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the sync group.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database on which the sync group is hosted.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
SyncGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the sync group.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database on which the sync group is hosted.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
syncGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the sync group.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database on which the sync group is hosted.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
syncGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the sync group.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database on which the sync group is hosted.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
sync_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the sync group.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database on which the sync group is hosted.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
syncGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the sync group.

getSyncGroup Result

The following output properties are available:

Id string
Resource ID.
LastSyncTime string
Last sync time of the sync group.
Name string
Resource name.
PrivateEndpointName string
Private endpoint name of the sync group if use private link connection is enabled.
SyncState string
Sync state of the sync group.
Type string
Resource type.
ConflictLoggingRetentionInDays int
Conflict logging retention period.
ConflictResolutionPolicy string
Conflict resolution policy of the sync group.
EnableConflictLogging bool
If conflict logging is enabled.
HubDatabaseUserName string
User name for the sync group hub database credential.
Interval int
Sync interval of the sync group.
Schema Pulumi.AzureNative.Sql.Outputs.SyncGroupSchemaResponse
Sync schema of the sync group.
Sku Pulumi.AzureNative.Sql.Outputs.SkuResponse
The name and capacity of the SKU.
SyncDatabaseId string
ARM resource id of the sync database in the sync group.
UsePrivateLinkConnection bool
If use private link connection is enabled.
Id string
Resource ID.
LastSyncTime string
Last sync time of the sync group.
Name string
Resource name.
PrivateEndpointName string
Private endpoint name of the sync group if use private link connection is enabled.
SyncState string
Sync state of the sync group.
Type string
Resource type.
ConflictLoggingRetentionInDays int
Conflict logging retention period.
ConflictResolutionPolicy string
Conflict resolution policy of the sync group.
EnableConflictLogging bool
If conflict logging is enabled.
HubDatabaseUserName string
User name for the sync group hub database credential.
Interval int
Sync interval of the sync group.
Schema SyncGroupSchemaResponse
Sync schema of the sync group.
Sku SkuResponse
The name and capacity of the SKU.
SyncDatabaseId string
ARM resource id of the sync database in the sync group.
UsePrivateLinkConnection bool
If use private link connection is enabled.
id String
Resource ID.
lastSyncTime String
Last sync time of the sync group.
name String
Resource name.
privateEndpointName String
Private endpoint name of the sync group if use private link connection is enabled.
syncState String
Sync state of the sync group.
type String
Resource type.
conflictLoggingRetentionInDays Integer
Conflict logging retention period.
conflictResolutionPolicy String
Conflict resolution policy of the sync group.
enableConflictLogging Boolean
If conflict logging is enabled.
hubDatabaseUserName String
User name for the sync group hub database credential.
interval Integer
Sync interval of the sync group.
schema SyncGroupSchemaResponse
Sync schema of the sync group.
sku SkuResponse
The name and capacity of the SKU.
syncDatabaseId String
ARM resource id of the sync database in the sync group.
usePrivateLinkConnection Boolean
If use private link connection is enabled.
id string
Resource ID.
lastSyncTime string
Last sync time of the sync group.
name string
Resource name.
privateEndpointName string
Private endpoint name of the sync group if use private link connection is enabled.
syncState string
Sync state of the sync group.
type string
Resource type.
conflictLoggingRetentionInDays number
Conflict logging retention period.
conflictResolutionPolicy string
Conflict resolution policy of the sync group.
enableConflictLogging boolean
If conflict logging is enabled.
hubDatabaseUserName string
User name for the sync group hub database credential.
interval number
Sync interval of the sync group.
schema SyncGroupSchemaResponse
Sync schema of the sync group.
sku SkuResponse
The name and capacity of the SKU.
syncDatabaseId string
ARM resource id of the sync database in the sync group.
usePrivateLinkConnection boolean
If use private link connection is enabled.
id str
Resource ID.
last_sync_time str
Last sync time of the sync group.
name str
Resource name.
private_endpoint_name str
Private endpoint name of the sync group if use private link connection is enabled.
sync_state str
Sync state of the sync group.
type str
Resource type.
conflict_logging_retention_in_days int
Conflict logging retention period.
conflict_resolution_policy str
Conflict resolution policy of the sync group.
enable_conflict_logging bool
If conflict logging is enabled.
hub_database_user_name str
User name for the sync group hub database credential.
interval int
Sync interval of the sync group.
schema SyncGroupSchemaResponse
Sync schema of the sync group.
sku SkuResponse
The name and capacity of the SKU.
sync_database_id str
ARM resource id of the sync database in the sync group.
use_private_link_connection bool
If use private link connection is enabled.
id String
Resource ID.
lastSyncTime String
Last sync time of the sync group.
name String
Resource name.
privateEndpointName String
Private endpoint name of the sync group if use private link connection is enabled.
syncState String
Sync state of the sync group.
type String
Resource type.
conflictLoggingRetentionInDays Number
Conflict logging retention period.
conflictResolutionPolicy String
Conflict resolution policy of the sync group.
enableConflictLogging Boolean
If conflict logging is enabled.
hubDatabaseUserName String
User name for the sync group hub database credential.
interval Number
Sync interval of the sync group.
schema Property Map
Sync schema of the sync group.
sku Property Map
The name and capacity of the SKU.
syncDatabaseId String
ARM resource id of the sync database in the sync group.
usePrivateLinkConnection Boolean
If use private link connection is enabled.

Supporting Types

SkuResponse

Name This property is required. string
The name of the SKU, typically, a letter + Number code, e.g. P3.
Capacity int
Capacity of the particular SKU.
Family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string
Size of the particular SKU
Tier string
The tier or edition of the particular SKU, e.g. Basic, Premium.
Name This property is required. string
The name of the SKU, typically, a letter + Number code, e.g. P3.
Capacity int
Capacity of the particular SKU.
Family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string
Size of the particular SKU
Tier string
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. String
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity Integer
Capacity of the particular SKU.
family String
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String
Size of the particular SKU
tier String
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. string
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity number
Capacity of the particular SKU.
family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size string
Size of the particular SKU
tier string
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. str
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity int
Capacity of the particular SKU.
family str
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size str
Size of the particular SKU
tier str
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. String
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity Number
Capacity of the particular SKU.
family String
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String
Size of the particular SKU
tier String
The tier or edition of the particular SKU, e.g. Basic, Premium.

SyncGroupSchemaResponse

MasterSyncMemberName string
Name of master sync member where the schema is from.
Tables List<Pulumi.AzureNative.Sql.Inputs.SyncGroupSchemaTableResponse>
List of tables in sync group schema.
MasterSyncMemberName string
Name of master sync member where the schema is from.
Tables []SyncGroupSchemaTableResponse
List of tables in sync group schema.
masterSyncMemberName String
Name of master sync member where the schema is from.
tables List<SyncGroupSchemaTableResponse>
List of tables in sync group schema.
masterSyncMemberName string
Name of master sync member where the schema is from.
tables SyncGroupSchemaTableResponse[]
List of tables in sync group schema.
master_sync_member_name str
Name of master sync member where the schema is from.
tables Sequence[SyncGroupSchemaTableResponse]
List of tables in sync group schema.
masterSyncMemberName String
Name of master sync member where the schema is from.
tables List<Property Map>
List of tables in sync group schema.

SyncGroupSchemaTableColumnResponse

DataSize string
Data size of the column.
DataType string
Data type of the column.
QuotedName string
Quoted name of sync group table column.
DataSize string
Data size of the column.
DataType string
Data type of the column.
QuotedName string
Quoted name of sync group table column.
dataSize String
Data size of the column.
dataType String
Data type of the column.
quotedName String
Quoted name of sync group table column.
dataSize string
Data size of the column.
dataType string
Data type of the column.
quotedName string
Quoted name of sync group table column.
data_size str
Data size of the column.
data_type str
Data type of the column.
quoted_name str
Quoted name of sync group table column.
dataSize String
Data size of the column.
dataType String
Data type of the column.
quotedName String
Quoted name of sync group table column.

SyncGroupSchemaTableResponse

Columns List<Pulumi.AzureNative.Sql.Inputs.SyncGroupSchemaTableColumnResponse>
List of columns in sync group schema.
QuotedName string
Quoted name of sync group schema table.
Columns []SyncGroupSchemaTableColumnResponse
List of columns in sync group schema.
QuotedName string
Quoted name of sync group schema table.
columns List<SyncGroupSchemaTableColumnResponse>
List of columns in sync group schema.
quotedName String
Quoted name of sync group schema table.
columns SyncGroupSchemaTableColumnResponse[]
List of columns in sync group schema.
quotedName string
Quoted name of sync group schema table.
columns Sequence[SyncGroupSchemaTableColumnResponse]
List of columns in sync group schema.
quoted_name str
Quoted name of sync group schema table.
columns List<Property Map>
List of columns in sync group schema.
quotedName String
Quoted name of sync group schema table.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native