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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.sql.getReplicationLink
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
Gets a replication link. Azure REST API version: 2023-05-01-preview.
Other available API versions: 2023-08-01-preview, 2024-05-01-preview.
Using getReplicationLink
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 getReplicationLink(args: GetReplicationLinkArgs, opts?: InvokeOptions): Promise<GetReplicationLinkResult>
function getReplicationLinkOutput(args: GetReplicationLinkOutputArgs, opts?: InvokeOptions): Output<GetReplicationLinkResult>def get_replication_link(database_name: Optional[str] = None,
                         link_id: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         server_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetReplicationLinkResult
def get_replication_link_output(database_name: Optional[pulumi.Input[str]] = None,
                         link_id: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         server_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetReplicationLinkResult]func LookupReplicationLink(ctx *Context, args *LookupReplicationLinkArgs, opts ...InvokeOption) (*LookupReplicationLinkResult, error)
func LookupReplicationLinkOutput(ctx *Context, args *LookupReplicationLinkOutputArgs, opts ...InvokeOption) LookupReplicationLinkResultOutput> Note: This function is named LookupReplicationLink in the Go SDK.
public static class GetReplicationLink 
{
    public static Task<GetReplicationLinkResult> InvokeAsync(GetReplicationLinkArgs args, InvokeOptions? opts = null)
    public static Output<GetReplicationLinkResult> Invoke(GetReplicationLinkInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetReplicationLinkResult> getReplicationLink(GetReplicationLinkArgs args, InvokeOptions options)
public static Output<GetReplicationLinkResult> getReplicationLink(GetReplicationLinkArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:sql:getReplicationLink
  arguments:
    # arguments dictionaryThe following arguments are supported:
- DatabaseName string
- The name of the database.
- LinkId string
- The name of the replication link.
- 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.
- DatabaseName string
- The name of the database.
- LinkId string
- The name of the replication link.
- 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.
- databaseName String
- The name of the database.
- linkId String
- The name of the replication link.
- 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.
- databaseName string
- The name of the database.
- linkId string
- The name of the replication link.
- 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.
- database_name str
- The name of the database.
- link_id str
- The name of the replication link.
- 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.
- databaseName String
- The name of the database.
- linkId String
- The name of the replication link.
- 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.
getReplicationLink Result
The following output properties are available:
- Id string
- Resource ID.
- IsTermination boolAllowed 
- Whether the user is currently allowed to terminate the link.
- Name string
- Resource name.
- PartnerDatabase string
- Resource partner database.
- PartnerDatabase stringId 
- Resource partner database Id.
- PartnerLocation string
- Resource partner location.
- PartnerRole string
- Partner replication role.
- PartnerServer string
- Resource partner server.
- PercentComplete int
- Seeding completion percentage for the link.
- ReplicationMode string
- Replication mode.
- ReplicationState string
- Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
- Role string
- Local replication role.
- StartTime string
- Time at which the link was created.
- Type string
- Resource type.
- LinkType string
- Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.
- Id string
- Resource ID.
- IsTermination boolAllowed 
- Whether the user is currently allowed to terminate the link.
- Name string
- Resource name.
- PartnerDatabase string
- Resource partner database.
- PartnerDatabase stringId 
- Resource partner database Id.
- PartnerLocation string
- Resource partner location.
- PartnerRole string
- Partner replication role.
- PartnerServer string
- Resource partner server.
- PercentComplete int
- Seeding completion percentage for the link.
- ReplicationMode string
- Replication mode.
- ReplicationState string
- Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
- Role string
- Local replication role.
- StartTime string
- Time at which the link was created.
- Type string
- Resource type.
- LinkType string
- Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.
- id String
- Resource ID.
- isTermination BooleanAllowed 
- Whether the user is currently allowed to terminate the link.
- name String
- Resource name.
- partnerDatabase String
- Resource partner database.
- partnerDatabase StringId 
- Resource partner database Id.
- partnerLocation String
- Resource partner location.
- partnerRole String
- Partner replication role.
- partnerServer String
- Resource partner server.
- percentComplete Integer
- Seeding completion percentage for the link.
- replicationMode String
- Replication mode.
- replicationState String
- Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
- role String
- Local replication role.
- startTime String
- Time at which the link was created.
- type String
- Resource type.
- linkType String
- Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.
- id string
- Resource ID.
- isTermination booleanAllowed 
- Whether the user is currently allowed to terminate the link.
- name string
- Resource name.
- partnerDatabase string
- Resource partner database.
- partnerDatabase stringId 
- Resource partner database Id.
- partnerLocation string
- Resource partner location.
- partnerRole string
- Partner replication role.
- partnerServer string
- Resource partner server.
- percentComplete number
- Seeding completion percentage for the link.
- replicationMode string
- Replication mode.
- replicationState string
- Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
- role string
- Local replication role.
- startTime string
- Time at which the link was created.
- type string
- Resource type.
- linkType string
- Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.
- id str
- Resource ID.
- is_termination_ boolallowed 
- Whether the user is currently allowed to terminate the link.
- name str
- Resource name.
- partner_database str
- Resource partner database.
- partner_database_ strid 
- Resource partner database Id.
- partner_location str
- Resource partner location.
- partner_role str
- Partner replication role.
- partner_server str
- Resource partner server.
- percent_complete int
- Seeding completion percentage for the link.
- replication_mode str
- Replication mode.
- replication_state str
- Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
- role str
- Local replication role.
- start_time str
- Time at which the link was created.
- type str
- Resource type.
- link_type str
- Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.
- id String
- Resource ID.
- isTermination BooleanAllowed 
- Whether the user is currently allowed to terminate the link.
- name String
- Resource name.
- partnerDatabase String
- Resource partner database.
- partnerDatabase StringId 
- Resource partner database Id.
- partnerLocation String
- Resource partner location.
- partnerRole String
- Partner replication role.
- partnerServer String
- Resource partner server.
- percentComplete Number
- Seeding completion percentage for the link.
- replicationMode String
- Replication mode.
- replicationState String
- Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
- role String
- Local replication role.
- startTime String
- Time at which the link was created.
- type String
- Resource type.
- linkType String
- Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi