azure-native.sql.getReplicationLink
Explore with Pulumi AI
Gets a replication link.
Uses Azure REST API version 2023-08-01.
Other available API versions: 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview, 2024-11-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 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 dictionary
The following arguments are supported:
- Database
Name string - The name of the database.
- Link
Id string - The name of the replication link.
- 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.
- Database
Name string - The name of the database.
- Link
Id string - The name of the replication link.
- 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.
- database
Name String - The name of the database.
- link
Id String - The name of the replication link.
- 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.
- database
Name string - The name of the database.
- link
Id string - The name of the replication link.
- 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.
- 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.
- database
Name String - The name of the database.
- link
Id String - The name of the replication link.
- 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.
getReplicationLink Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Resource ID.
- Is
Termination boolAllowed - Whether the user is currently allowed to terminate the link.
- Name string
- Resource name.
- Partner
Database string - Resource partner database.
- Partner
Database stringId - Resource partner database Id.
- Partner
Location string - Resource partner location.
- Partner
Role string - Partner replication role.
- Partner
Server string - Resource partner server.
- Percent
Complete int - Seeding completion percentage for the link.
- Replication
Mode string - Replication mode.
- Replication
State string - Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
- Role string
- Local replication role.
- Start
Time string - Time at which the link was created.
- Type string
- Resource type.
- Link
Type string - Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Resource ID.
- Is
Termination boolAllowed - Whether the user is currently allowed to terminate the link.
- Name string
- Resource name.
- Partner
Database string - Resource partner database.
- Partner
Database stringId - Resource partner database Id.
- Partner
Location string - Resource partner location.
- Partner
Role string - Partner replication role.
- Partner
Server string - Resource partner server.
- Percent
Complete int - Seeding completion percentage for the link.
- Replication
Mode string - Replication mode.
- Replication
State string - Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
- Role string
- Local replication role.
- Start
Time string - Time at which the link was created.
- Type string
- Resource type.
- Link
Type string - Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Resource ID.
- is
Termination BooleanAllowed - Whether the user is currently allowed to terminate the link.
- name String
- Resource name.
- partner
Database String - Resource partner database.
- partner
Database StringId - Resource partner database Id.
- partner
Location String - Resource partner location.
- partner
Role String - Partner replication role.
- partner
Server String - Resource partner server.
- percent
Complete Integer - Seeding completion percentage for the link.
- replication
Mode String - Replication mode.
- replication
State String - Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
- role String
- Local replication role.
- start
Time String - Time at which the link was created.
- type String
- Resource type.
- link
Type String - Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- Resource ID.
- is
Termination booleanAllowed - Whether the user is currently allowed to terminate the link.
- name string
- Resource name.
- partner
Database string - Resource partner database.
- partner
Database stringId - Resource partner database Id.
- partner
Location string - Resource partner location.
- partner
Role string - Partner replication role.
- partner
Server string - Resource partner server.
- percent
Complete number - Seeding completion percentage for the link.
- replication
Mode string - Replication mode.
- replication
State string - Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
- role string
- Local replication role.
- start
Time string - Time at which the link was created.
- type string
- Resource type.
- link
Type string - Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED.
- azure_
api_ strversion - The Azure API version of the resource.
- 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.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Resource ID.
- is
Termination BooleanAllowed - Whether the user is currently allowed to terminate the link.
- name String
- Resource name.
- partner
Database String - Resource partner database.
- partner
Database StringId - Resource partner database Id.
- partner
Location String - Resource partner location.
- partner
Role String - Partner replication role.
- partner
Server String - Resource partner server.
- percent
Complete Number - Seeding completion percentage for the link.
- replication
Mode String - Replication mode.
- replication
State String - Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
- role String
- Local replication role.
- start
Time String - Time at which the link was created.
- type String
- Resource type.
- link
Type 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