These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
azure-native.sql.getSyncGroup
Explore with Pulumi AI
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
Gets a sync group. API Version: 2020-11-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>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]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-native:sql:getSyncGroup
  arguments:
    # arguments dictionaryThe following arguments are supported:
- DatabaseName string
- The name of the database on which the sync group is hosted.
- ResourceGroup stringName 
- 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 string
- The name of the server.
- SyncGroup stringName 
- The name of the sync group.
- DatabaseName string
- The name of the database on which the sync group is hosted.
- ResourceGroup stringName 
- 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 string
- The name of the server.
- SyncGroup stringName 
- The name of the sync group.
- databaseName String
- The name of the database on which the sync group is hosted.
- resourceGroup StringName 
- 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 String
- The name of the server.
- syncGroup StringName 
- The name of the sync group.
- databaseName string
- The name of the database on which the sync group is hosted.
- resourceGroup stringName 
- 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 string
- The name of the server.
- syncGroup stringName 
- The name of the sync group.
- database_name str
- The name of the database on which the sync group is hosted.
- resource_group_ strname 
- 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 str
- The name of the server.
- sync_group_ strname 
- The name of the sync group.
- databaseName String
- The name of the database on which the sync group is hosted.
- resourceGroup StringName 
- 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 String
- The name of the server.
- syncGroup StringName 
- The name of the sync group.
getSyncGroup Result
The following output properties are available:
- Id string
- Resource ID.
- LastSync stringTime 
- Last sync time of the sync group.
- Name string
- Resource name.
- PrivateEndpoint stringName 
- 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.
- ConflictLogging intRetention In Days 
- Conflict logging retention period.
- ConflictResolution stringPolicy 
- Conflict resolution policy of the sync group.
- EnableConflict boolLogging 
- If conflict logging is enabled.
- HubDatabase stringUser Name 
- User name for the sync group hub database credential.
- Interval int
- Sync interval of the sync group.
- Schema
Pulumi.Azure Native. Sql. Outputs. Sync Group Schema Response 
- Sync schema of the sync group.
- Sku
Pulumi.Azure Native. Sql. Outputs. Sku Response 
- The name and capacity of the SKU.
- SyncDatabase stringId 
- ARM resource id of the sync database in the sync group.
- UsePrivate boolLink Connection 
- If use private link connection is enabled.
- Id string
- Resource ID.
- LastSync stringTime 
- Last sync time of the sync group.
- Name string
- Resource name.
- PrivateEndpoint stringName 
- 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.
- ConflictLogging intRetention In Days 
- Conflict logging retention period.
- ConflictResolution stringPolicy 
- Conflict resolution policy of the sync group.
- EnableConflict boolLogging 
- If conflict logging is enabled.
- HubDatabase stringUser Name 
- User name for the sync group hub database credential.
- Interval int
- Sync interval of the sync group.
- Schema
SyncGroup Schema Response 
- Sync schema of the sync group.
- Sku
SkuResponse 
- The name and capacity of the SKU.
- SyncDatabase stringId 
- ARM resource id of the sync database in the sync group.
- UsePrivate boolLink Connection 
- If use private link connection is enabled.
- id String
- Resource ID.
- lastSync StringTime 
- Last sync time of the sync group.
- name String
- Resource name.
- privateEndpoint StringName 
- 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.
- conflictLogging IntegerRetention In Days 
- Conflict logging retention period.
- conflictResolution StringPolicy 
- Conflict resolution policy of the sync group.
- enableConflict BooleanLogging 
- If conflict logging is enabled.
- hubDatabase StringUser Name 
- User name for the sync group hub database credential.
- interval Integer
- Sync interval of the sync group.
- schema
SyncGroup Schema Response 
- Sync schema of the sync group.
- sku
SkuResponse 
- The name and capacity of the SKU.
- syncDatabase StringId 
- ARM resource id of the sync database in the sync group.
- usePrivate BooleanLink Connection 
- If use private link connection is enabled.
- id string
- Resource ID.
- lastSync stringTime 
- Last sync time of the sync group.
- name string
- Resource name.
- privateEndpoint stringName 
- 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.
- conflictLogging numberRetention In Days 
- Conflict logging retention period.
- conflictResolution stringPolicy 
- Conflict resolution policy of the sync group.
- enableConflict booleanLogging 
- If conflict logging is enabled.
- hubDatabase stringUser Name 
- User name for the sync group hub database credential.
- interval number
- Sync interval of the sync group.
- schema
SyncGroup Schema Response 
- Sync schema of the sync group.
- sku
SkuResponse 
- The name and capacity of the SKU.
- syncDatabase stringId 
- ARM resource id of the sync database in the sync group.
- usePrivate booleanLink Connection 
- If use private link connection is enabled.
- id str
- Resource ID.
- last_sync_ strtime 
- Last sync time of the sync group.
- name str
- Resource name.
- private_endpoint_ strname 
- 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_ intretention_ in_ days 
- Conflict logging retention period.
- conflict_resolution_ strpolicy 
- Conflict resolution policy of the sync group.
- enable_conflict_ boollogging 
- If conflict logging is enabled.
- hub_database_ struser_ name 
- User name for the sync group hub database credential.
- interval int
- Sync interval of the sync group.
- schema
SyncGroup Schema Response 
- Sync schema of the sync group.
- sku
SkuResponse 
- The name and capacity of the SKU.
- sync_database_ strid 
- ARM resource id of the sync database in the sync group.
- use_private_ boollink_ connection 
- If use private link connection is enabled.
- id String
- Resource ID.
- lastSync StringTime 
- Last sync time of the sync group.
- name String
- Resource name.
- privateEndpoint StringName 
- 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.
- conflictLogging NumberRetention In Days 
- Conflict logging retention period.
- conflictResolution StringPolicy 
- Conflict resolution policy of the sync group.
- enableConflict BooleanLogging 
- If conflict logging is enabled.
- hubDatabase StringUser Name 
- 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.
- syncDatabase StringId 
- ARM resource id of the sync database in the sync group.
- usePrivate BooleanLink Connection 
- If use private link connection is enabled.
Supporting Types
SkuResponse 
- Name 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 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 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 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 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 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   
- MasterSync stringMember Name 
- Name of master sync member where the schema is from.
- Tables
List<Pulumi.Azure Native. Sql. Inputs. Sync Group Schema Table Response> 
- List of tables in sync group schema.
- MasterSync stringMember Name 
- Name of master sync member where the schema is from.
- Tables
[]SyncGroup Schema Table Response 
- List of tables in sync group schema.
- masterSync StringMember Name 
- Name of master sync member where the schema is from.
- tables
List<SyncGroup Schema Table Response> 
- List of tables in sync group schema.
- masterSync stringMember Name 
- Name of master sync member where the schema is from.
- tables
SyncGroup Schema Table Response[] 
- List of tables in sync group schema.
- master_sync_ strmember_ name 
- Name of master sync member where the schema is from.
- tables
Sequence[SyncGroup Schema Table Response] 
- List of tables in sync group schema.
- masterSync StringMember Name 
- 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.Azure Native. Sql. Inputs. Sync Group Schema Table Column Response> 
- List of columns in sync group schema.
- QuotedName string
- Quoted name of sync group schema table.
- Columns
[]SyncGroup Schema Table Column Response 
- List of columns in sync group schema.
- QuotedName string
- Quoted name of sync group schema table.
- columns
List<SyncGroup Schema Table Column Response> 
- List of columns in sync group schema.
- quotedName String
- Quoted name of sync group schema table.
- columns
SyncGroup Schema Table Column Response[] 
- List of columns in sync group schema.
- quotedName string
- Quoted name of sync group schema table.
- columns
Sequence[SyncGroup Schema Table Column Response] 
- 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-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi