Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. sql
  5. getSyncAgent
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.sql.getSyncAgent

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a sync agent. Azure REST API version: 2021-11-01.

Other available API versions: 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview.

Using getSyncAgent

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 getSyncAgent(args: GetSyncAgentArgs, opts?: InvokeOptions): Promise<GetSyncAgentResult>
function getSyncAgentOutput(args: GetSyncAgentOutputArgs, opts?: InvokeOptions): Output<GetSyncAgentResult>
Copy
def get_sync_agent(resource_group_name: Optional[str] = None,
                   server_name: Optional[str] = None,
                   sync_agent_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetSyncAgentResult
def get_sync_agent_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                   server_name: Optional[pulumi.Input[str]] = None,
                   sync_agent_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetSyncAgentResult]
Copy
func LookupSyncAgent(ctx *Context, args *LookupSyncAgentArgs, opts ...InvokeOption) (*LookupSyncAgentResult, error)
func LookupSyncAgentOutput(ctx *Context, args *LookupSyncAgentOutputArgs, opts ...InvokeOption) LookupSyncAgentResultOutput
Copy

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

public static class GetSyncAgent 
{
    public static Task<GetSyncAgentResult> InvokeAsync(GetSyncAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetSyncAgentResult> Invoke(GetSyncAgentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSyncAgentResult> getSyncAgent(GetSyncAgentArgs args, InvokeOptions options)
public static Output<GetSyncAgentResult> getSyncAgent(GetSyncAgentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:sql:getSyncAgent
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the server on which the sync agent is hosted.
SyncAgentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the sync agent.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the server on which the sync agent is hosted.
SyncAgentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the sync agent.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the server on which the sync agent is hosted.
syncAgentName
This property is required.
Changes to this property will trigger replacement.
String
The name of the sync agent.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the server on which the sync agent is hosted.
syncAgentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the sync agent.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
str
The name of the server on which the sync agent is hosted.
sync_agent_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the sync agent.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the server on which the sync agent is hosted.
syncAgentName
This property is required.
Changes to this property will trigger replacement.
String
The name of the sync agent.

getSyncAgent Result

The following output properties are available:

ExpiryTime string
Expiration time of the sync agent version.
Id string
Resource ID.
IsUpToDate bool
If the sync agent version is up to date.
LastAliveTime string
Last alive time of the sync agent.
Name string
Resource name.
State string
State of the sync agent.
Type string
Resource type.
Version string
Version of the sync agent.
SyncDatabaseId string
ARM resource id of the sync database in the sync agent.
ExpiryTime string
Expiration time of the sync agent version.
Id string
Resource ID.
IsUpToDate bool
If the sync agent version is up to date.
LastAliveTime string
Last alive time of the sync agent.
Name string
Resource name.
State string
State of the sync agent.
Type string
Resource type.
Version string
Version of the sync agent.
SyncDatabaseId string
ARM resource id of the sync database in the sync agent.
expiryTime String
Expiration time of the sync agent version.
id String
Resource ID.
isUpToDate Boolean
If the sync agent version is up to date.
lastAliveTime String
Last alive time of the sync agent.
name String
Resource name.
state String
State of the sync agent.
type String
Resource type.
version String
Version of the sync agent.
syncDatabaseId String
ARM resource id of the sync database in the sync agent.
expiryTime string
Expiration time of the sync agent version.
id string
Resource ID.
isUpToDate boolean
If the sync agent version is up to date.
lastAliveTime string
Last alive time of the sync agent.
name string
Resource name.
state string
State of the sync agent.
type string
Resource type.
version string
Version of the sync agent.
syncDatabaseId string
ARM resource id of the sync database in the sync agent.
expiry_time str
Expiration time of the sync agent version.
id str
Resource ID.
is_up_to_date bool
If the sync agent version is up to date.
last_alive_time str
Last alive time of the sync agent.
name str
Resource name.
state str
State of the sync agent.
type str
Resource type.
version str
Version of the sync agent.
sync_database_id str
ARM resource id of the sync database in the sync agent.
expiryTime String
Expiration time of the sync agent version.
id String
Resource ID.
isUpToDate Boolean
If the sync agent version is up to date.
lastAliveTime String
Last alive time of the sync agent.
name String
Resource name.
state String
State of the sync agent.
type String
Resource type.
version String
Version of the sync agent.
syncDatabaseId String
ARM resource id of the sync database in the sync agent.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native