Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getSyncMember
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.getSyncMember

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets a sync member.

    Uses Azure REST API version 2023-08-01.

    Other available API versions: 2015-05-01-preview, 2019-06-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

    Using getSyncMember

    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 getSyncMember(args: GetSyncMemberArgs, opts?: InvokeOptions): Promise<GetSyncMemberResult>
function getSyncMemberOutput(args: GetSyncMemberOutputArgs, opts?: InvokeOptions): Output<GetSyncMemberResult>
    def get_sync_member(database_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    server_name: Optional[str] = None,
                    sync_group_name: Optional[str] = None,
                    sync_member_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetSyncMemberResult
def get_sync_member_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,
                    sync_member_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetSyncMemberResult]
    func LookupSyncMember(ctx *Context, args *LookupSyncMemberArgs, opts ...InvokeOption) (*LookupSyncMemberResult, error)
func LookupSyncMemberOutput(ctx *Context, args *LookupSyncMemberOutputArgs, opts ...InvokeOption) LookupSyncMemberResultOutput

    > Note: This function is named LookupSyncMember in the Go SDK.

    public static class GetSyncMember 
{
    public static Task<GetSyncMemberResult> InvokeAsync(GetSyncMemberArgs args, InvokeOptions? opts = null)
    public static Output<GetSyncMemberResult> Invoke(GetSyncMemberInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSyncMemberResult> getSyncMember(GetSyncMemberArgs args, InvokeOptions options)
public static Output<GetSyncMemberResult> getSyncMember(GetSyncMemberArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:sql:getSyncMember
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DatabaseName string
    The name of the database on which the sync group is hosted.
    ResourceGroupName 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 string
    The name of the server.
    SyncGroupName string
    The name of the sync group on which the sync member is hosted.
    SyncMemberName string
    The name of the sync member.
    DatabaseName string
    The name of the database on which the sync group is hosted.
    ResourceGroupName 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 string
    The name of the server.
    SyncGroupName string
    The name of the sync group on which the sync member is hosted.
    SyncMemberName string
    The name of the sync member.
    databaseName String
    The name of the database on which the sync group is hosted.
    resourceGroupName 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 String
    The name of the server.
    syncGroupName String
    The name of the sync group on which the sync member is hosted.
    syncMemberName String
    The name of the sync member.
    databaseName string
    The name of the database on which the sync group is hosted.
    resourceGroupName 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 string
    The name of the server.
    syncGroupName string
    The name of the sync group on which the sync member is hosted.
    syncMemberName string
    The name of the sync member.
    database_name str
    The name of the database on which the sync group is hosted.
    resource_group_name 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 str
    The name of the server.
    sync_group_name str
    The name of the sync group on which the sync member is hosted.
    sync_member_name str
    The name of the sync member.
    databaseName String
    The name of the database on which the sync group is hosted.
    resourceGroupName 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 String
    The name of the server.
    syncGroupName String
    The name of the sync group on which the sync member is hosted.
    syncMemberName String
    The name of the sync member.

    getSyncMember Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource ID.
    Name string
    Resource name.
    PrivateEndpointName string
    Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
    SyncState string
    Sync state of the sync member.
    Type string
    Resource type.
    DatabaseName string
    Database name of the member database in the sync member.
    DatabaseType string
    Database type of the sync member.
    ServerName string
    Server name of the member database in the sync member
    SqlServerDatabaseId string
    SQL Server database id of the sync member.
    SyncAgentId string
    ARM resource id of the sync agent in the sync member.
    SyncDirection string
    Sync direction of the sync member.
    SyncMemberAzureDatabaseResourceId string
    ARM resource id of the sync member logical database, for sync members in Azure.
    UsePrivateLinkConnection bool
    Whether to use private link connection.
    UserName string
    User name of the member database in the sync member.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource ID.
    Name string
    Resource name.
    PrivateEndpointName string
    Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
    SyncState string
    Sync state of the sync member.
    Type string
    Resource type.
    DatabaseName string
    Database name of the member database in the sync member.
    DatabaseType string
    Database type of the sync member.
    ServerName string
    Server name of the member database in the sync member
    SqlServerDatabaseId string
    SQL Server database id of the sync member.
    SyncAgentId string
    ARM resource id of the sync agent in the sync member.
    SyncDirection string
    Sync direction of the sync member.
    SyncMemberAzureDatabaseResourceId string
    ARM resource id of the sync member logical database, for sync members in Azure.
    UsePrivateLinkConnection bool
    Whether to use private link connection.
    UserName string
    User name of the member database in the sync member.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource ID.
    name String
    Resource name.
    privateEndpointName String
    Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
    syncState String
    Sync state of the sync member.
    type String
    Resource type.
    databaseName String
    Database name of the member database in the sync member.
    databaseType String
    Database type of the sync member.
    serverName String
    Server name of the member database in the sync member
    sqlServerDatabaseId String
    SQL Server database id of the sync member.
    syncAgentId String
    ARM resource id of the sync agent in the sync member.
    syncDirection String
    Sync direction of the sync member.
    syncMemberAzureDatabaseResourceId String
    ARM resource id of the sync member logical database, for sync members in Azure.
    usePrivateLinkConnection Boolean
    Whether to use private link connection.
    userName String
    User name of the member database in the sync member.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Resource ID.
    name string
    Resource name.
    privateEndpointName string
    Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
    syncState string
    Sync state of the sync member.
    type string
    Resource type.
    databaseName string
    Database name of the member database in the sync member.
    databaseType string
    Database type of the sync member.
    serverName string
    Server name of the member database in the sync member
    sqlServerDatabaseId string
    SQL Server database id of the sync member.
    syncAgentId string
    ARM resource id of the sync agent in the sync member.
    syncDirection string
    Sync direction of the sync member.
    syncMemberAzureDatabaseResourceId string
    ARM resource id of the sync member logical database, for sync members in Azure.
    usePrivateLinkConnection boolean
    Whether to use private link connection.
    userName string
    User name of the member database in the sync member.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Resource ID.
    name str
    Resource name.
    private_endpoint_name str
    Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
    sync_state str
    Sync state of the sync member.
    type str
    Resource type.
    database_name str
    Database name of the member database in the sync member.
    database_type str
    Database type of the sync member.
    server_name str
    Server name of the member database in the sync member
    sql_server_database_id str
    SQL Server database id of the sync member.
    sync_agent_id str
    ARM resource id of the sync agent in the sync member.
    sync_direction str
    Sync direction of the sync member.
    sync_member_azure_database_resource_id str
    ARM resource id of the sync member logical database, for sync members in Azure.
    use_private_link_connection bool
    Whether to use private link connection.
    user_name str
    User name of the member database in the sync member.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource ID.
    name String
    Resource name.
    privateEndpointName String
    Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
    syncState String
    Sync state of the sync member.
    type String
    Resource type.
    databaseName String
    Database name of the member database in the sync member.
    databaseType String
    Database type of the sync member.
    serverName String
    Server name of the member database in the sync member
    sqlServerDatabaseId String
    SQL Server database id of the sync member.
    syncAgentId String
    ARM resource id of the sync agent in the sync member.
    syncDirection String
    Sync direction of the sync member.
    syncMemberAzureDatabaseResourceId String
    ARM resource id of the sync member logical database, for sync members in Azure.
    usePrivateLinkConnection Boolean
    Whether to use private link connection.
    userName String
    User name of the member database in the sync member.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native