Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getSyncAgent
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.getSyncAgent

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 agent.

    Uses Azure REST API version 2023-08-01.

    Other available API versions: 2015-05-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 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>
    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]
    func LookupSyncAgent(ctx *Context, args *LookupSyncAgentArgs, opts ...InvokeOption) (*LookupSyncAgentResult, error)
func LookupSyncAgentOutput(ctx *Context, args *LookupSyncAgentOutputArgs, opts ...InvokeOption) LookupSyncAgentResultOutput

    > 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)
}
    public static CompletableFuture<GetSyncAgentResult> getSyncAgent(GetSyncAgentArgs args, InvokeOptions options)
public static Output<GetSyncAgentResult> getSyncAgent(GetSyncAgentArgs args, InvokeOptions options)

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

    The following arguments are supported:

    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 on which the sync agent is hosted.
    SyncAgentName string
    The name of the sync agent.
    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 on which the sync agent is hosted.
    SyncAgentName string
    The name of the sync agent.
    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 on which the sync agent is hosted.
    syncAgentName String
    The name of the sync agent.
    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 on which the sync agent is hosted.
    syncAgentName string
    The name of the sync agent.
    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 on which the sync agent is hosted.
    sync_agent_name str
    The name of the sync agent.
    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 on which the sync agent is hosted.
    syncAgentName String
    The name of the sync agent.

    getSyncAgent Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    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.
    AzureApiVersion string
    The Azure API version of the resource.
    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.
    azureApiVersion String
    The Azure API version of the resource.
    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.
    azureApiVersion string
    The Azure API version of the resource.
    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.
    azure_api_version str
    The Azure API version of the resource.
    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.
    azureApiVersion String
    The Azure API version of the resource.
    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 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