Azure Native v1.102.0, May 2 23
Azure Native v1.102.0, May 2 23
azure-native.sql.getSyncGroup
Explore with Pulumi AI
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:sql:getSyncGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Database
Name string The name of the database on which the sync group is hosted.
- Resource
Group 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.
- Server
Name string The name of the server.
- Sync
Group stringName The name of the sync group.
- Database
Name string The name of the database on which the sync group is hosted.
- Resource
Group 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.
- Server
Name string The name of the server.
- Sync
Group stringName The name of the sync group.
- database
Name String The name of the database on which the sync group is hosted.
- resource
Group 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.
- server
Name String The name of the server.
- sync
Group StringName The name of the sync group.
- database
Name string The name of the database on which the sync group is hosted.
- resource
Group 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.
- server
Name string The name of the server.
- sync
Group 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.
- database
Name String The name of the database on which the sync group is hosted.
- resource
Group 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.
- server
Name String The name of the server.
- sync
Group StringName The name of the sync group.
getSyncGroup Result
The following output properties are available:
- Id string
Resource ID.
- Last
Sync stringTime Last sync time of the sync group.
- Name string
Resource name.
- Private
Endpoint stringName Private endpoint name of the sync group if use private link connection is enabled.
- Sync
State string Sync state of the sync group.
- Type string
Resource type.
- Conflict
Logging intRetention In Days Conflict logging retention period.
- Conflict
Resolution stringPolicy Conflict resolution policy of the sync group.
- Enable
Conflict boolLogging If conflict logging is enabled.
- Hub
Database 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.
- Sync
Database stringId 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.
- Last
Sync stringTime Last sync time of the sync group.
- Name string
Resource name.
- Private
Endpoint stringName Private endpoint name of the sync group if use private link connection is enabled.
- Sync
State string Sync state of the sync group.
- Type string
Resource type.
- Conflict
Logging intRetention In Days Conflict logging retention period.
- Conflict
Resolution stringPolicy Conflict resolution policy of the sync group.
- Enable
Conflict boolLogging If conflict logging is enabled.
- Hub
Database stringUser Name User name for the sync group hub database credential.
- Interval int
Sync interval of the sync group.
- Schema
Sync
Group Schema Response Sync schema of the sync group.
- Sku
Sku
Response The name and capacity of the SKU.
- Sync
Database stringId 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.
- last
Sync StringTime Last sync time of the sync group.
- name String
Resource name.
- private
Endpoint StringName Private endpoint name of the sync group if use private link connection is enabled.
- sync
State String Sync state of the sync group.
- type String
Resource type.
- conflict
Logging IntegerRetention In Days Conflict logging retention period.
- conflict
Resolution StringPolicy Conflict resolution policy of the sync group.
- enable
Conflict BooleanLogging If conflict logging is enabled.
- hub
Database StringUser Name User name for the sync group hub database credential.
- interval Integer
Sync interval of the sync group.
- schema
Sync
Group Schema Response Sync schema of the sync group.
- sku
Sku
Response The name and capacity of the SKU.
- sync
Database StringId ARM resource id of the sync database in the sync group.
- use
Private BooleanLink Connection If use private link connection is enabled.
- id string
Resource ID.
- last
Sync stringTime Last sync time of the sync group.
- name string
Resource name.
- private
Endpoint stringName Private endpoint name of the sync group if use private link connection is enabled.
- sync
State string Sync state of the sync group.
- type string
Resource type.
- conflict
Logging numberRetention In Days Conflict logging retention period.
- conflict
Resolution stringPolicy Conflict resolution policy of the sync group.
- enable
Conflict booleanLogging If conflict logging is enabled.
- hub
Database stringUser Name User name for the sync group hub database credential.
- interval number
Sync interval of the sync group.
- schema
Sync
Group Schema Response Sync schema of the sync group.
- sku
Sku
Response The name and capacity of the SKU.
- sync
Database stringId ARM resource id of the sync database in the sync group.
- use
Private 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
Sync
Group Schema Response Sync schema of the sync group.
- sku
Sku
Response 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.
- last
Sync StringTime Last sync time of the sync group.
- name String
Resource name.
- private
Endpoint StringName Private endpoint name of the sync group if use private link connection is enabled.
- sync
State String Sync state of the sync group.
- type String
Resource type.
- conflict
Logging NumberRetention In Days Conflict logging retention period.
- conflict
Resolution StringPolicy Conflict resolution policy of the sync group.
- enable
Conflict BooleanLogging If conflict logging is enabled.
- hub
Database 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.
- sync
Database StringId ARM resource id of the sync database in the sync group.
- use
Private 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
- Master
Sync 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.
- Master
Sync stringMember Name Name of master sync member where the schema is from.
- Tables
[]Sync
Group Schema Table Response List of tables in sync group schema.
- master
Sync StringMember Name Name of master sync member where the schema is from.
- tables
List<Sync
Group Schema Table Response> List of tables in sync group schema.
- master
Sync stringMember Name Name of master sync member where the schema is from.
- tables
Sync
Group 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[Sync
Group Schema Table Response] List of tables in sync group schema.
- master
Sync StringMember Name Name of master sync member where the schema is from.
- tables List<Property Map>
List of tables in sync group schema.
SyncGroupSchemaTableColumnResponse
- Data
Size string Data size of the column.
- Data
Type string Data type of the column.
- Quoted
Name string Quoted name of sync group table column.
- Data
Size string Data size of the column.
- Data
Type string Data type of the column.
- Quoted
Name string Quoted name of sync group table column.
- data
Size String Data size of the column.
- data
Type String Data type of the column.
- quoted
Name String Quoted name of sync group table column.
- data
Size string Data size of the column.
- data
Type string Data type of the column.
- quoted
Name 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.
- data
Size String Data size of the column.
- data
Type String Data type of the column.
- quoted
Name 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.
- Quoted
Name string Quoted name of sync group schema table.
- Columns
[]Sync
Group Schema Table Column Response List of columns in sync group schema.
- Quoted
Name string Quoted name of sync group schema table.
- columns
List<Sync
Group Schema Table Column Response> List of columns in sync group schema.
- quoted
Name String Quoted name of sync group schema table.
- columns
Sync
Group Schema Table Column Response[] List of columns in sync group schema.
- quoted
Name string Quoted name of sync group schema table.
- columns
Sequence[Sync
Group 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.
- quoted
Name String Quoted name of sync group schema table.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0