1. Packages
  2. Azure Native
  3. API Docs
  4. azurearcdata
  5. getSqlServerInstance
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.4.0 published on Wednesday, May 7, 2025 by Pulumi

azure-native.azurearcdata.getSqlServerInstance

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.4.0 published on Wednesday, May 7, 2025 by Pulumi

    Retrieves a SQL Server Instance resource

    Uses Azure REST API version 2024-01-01.

    Other available API versions: 2023-01-15-preview, 2024-05-01-preview, 2025-03-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azurearcdata [ApiVersion]. See the version guide for details.

    Using getSqlServerInstance

    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 getSqlServerInstance(args: GetSqlServerInstanceArgs, opts?: InvokeOptions): Promise<GetSqlServerInstanceResult>
    function getSqlServerInstanceOutput(args: GetSqlServerInstanceOutputArgs, opts?: InvokeOptions): Output<GetSqlServerInstanceResult>
    def get_sql_server_instance(resource_group_name: Optional[str] = None,
                                sql_server_instance_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetSqlServerInstanceResult
    def get_sql_server_instance_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                sql_server_instance_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetSqlServerInstanceResult]
    func LookupSqlServerInstance(ctx *Context, args *LookupSqlServerInstanceArgs, opts ...InvokeOption) (*LookupSqlServerInstanceResult, error)
    func LookupSqlServerInstanceOutput(ctx *Context, args *LookupSqlServerInstanceOutputArgs, opts ...InvokeOption) LookupSqlServerInstanceResultOutput

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

    public static class GetSqlServerInstance 
    {
        public static Task<GetSqlServerInstanceResult> InvokeAsync(GetSqlServerInstanceArgs args, InvokeOptions? opts = null)
        public static Output<GetSqlServerInstanceResult> Invoke(GetSqlServerInstanceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSqlServerInstanceResult> getSqlServerInstance(GetSqlServerInstanceArgs args, InvokeOptions options)
    public static Output<GetSqlServerInstanceResult> getSqlServerInstance(GetSqlServerInstanceArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:azurearcdata:getSqlServerInstance
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the Azure resource group
    SqlServerInstanceName string
    Name of SQL Server Instance
    ResourceGroupName string
    The name of the Azure resource group
    SqlServerInstanceName string
    Name of SQL Server Instance
    resourceGroupName String
    The name of the Azure resource group
    sqlServerInstanceName String
    Name of SQL Server Instance
    resourceGroupName string
    The name of the Azure resource group
    sqlServerInstanceName string
    Name of SQL Server Instance
    resource_group_name str
    The name of the Azure resource group
    sql_server_instance_name str
    Name of SQL Server Instance
    resourceGroupName String
    The name of the Azure resource group
    sqlServerInstanceName String
    Name of SQL Server Instance

    getSqlServerInstance Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.AzureArcData.Outputs.SqlServerInstancePropertiesResponse
    null
    SystemData Pulumi.AzureNative.AzureArcData.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties SqlServerInstancePropertiesResponse
    null
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties SqlServerInstancePropertiesResponse
    null
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties SqlServerInstancePropertiesResponse
    null
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties SqlServerInstancePropertiesResponse
    null
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    null
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Map<String>
    Resource tags.

    Supporting Types

    BackupPolicyResponse

    DifferentialBackupHours int
    The differential backup interval in hours.
    FullBackupDays int
    The value indicating days between full backups.
    RetentionPeriodDays int
    The retention period for all the databases in this managed instance.
    TransactionLogBackupMinutes int
    The value indicating minutes between transaction log backups.
    DifferentialBackupHours int
    The differential backup interval in hours.
    FullBackupDays int
    The value indicating days between full backups.
    RetentionPeriodDays int
    The retention period for all the databases in this managed instance.
    TransactionLogBackupMinutes int
    The value indicating minutes between transaction log backups.
    differentialBackupHours Integer
    The differential backup interval in hours.
    fullBackupDays Integer
    The value indicating days between full backups.
    retentionPeriodDays Integer
    The retention period for all the databases in this managed instance.
    transactionLogBackupMinutes Integer
    The value indicating minutes between transaction log backups.
    differentialBackupHours number
    The differential backup interval in hours.
    fullBackupDays number
    The value indicating days between full backups.
    retentionPeriodDays number
    The retention period for all the databases in this managed instance.
    transactionLogBackupMinutes number
    The value indicating minutes between transaction log backups.
    differential_backup_hours int
    The differential backup interval in hours.
    full_backup_days int
    The value indicating days between full backups.
    retention_period_days int
    The retention period for all the databases in this managed instance.
    transaction_log_backup_minutes int
    The value indicating minutes between transaction log backups.
    differentialBackupHours Number
    The differential backup interval in hours.
    fullBackupDays Number
    The value indicating days between full backups.
    retentionPeriodDays Number
    The retention period for all the databases in this managed instance.
    transactionLogBackupMinutes Number
    The value indicating minutes between transaction log backups.

    FailoverClusterResponse

    HostNames List<string>
    The host names which are part of the SQL FCI resource group.
    Id string
    The GUID of the SQL Server's underlying Failover Cluster.
    NetworkName string
    The network name to connect to the SQL FCI.
    SqlInstanceIds List<string>
    The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster.
    HostNames []string
    The host names which are part of the SQL FCI resource group.
    Id string
    The GUID of the SQL Server's underlying Failover Cluster.
    NetworkName string
    The network name to connect to the SQL FCI.
    SqlInstanceIds []string
    The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster.
    hostNames List<String>
    The host names which are part of the SQL FCI resource group.
    id String
    The GUID of the SQL Server's underlying Failover Cluster.
    networkName String
    The network name to connect to the SQL FCI.
    sqlInstanceIds List<String>
    The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster.
    hostNames string[]
    The host names which are part of the SQL FCI resource group.
    id string
    The GUID of the SQL Server's underlying Failover Cluster.
    networkName string
    The network name to connect to the SQL FCI.
    sqlInstanceIds string[]
    The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster.
    host_names Sequence[str]
    The host names which are part of the SQL FCI resource group.
    id str
    The GUID of the SQL Server's underlying Failover Cluster.
    network_name str
    The network name to connect to the SQL FCI.
    sql_instance_ids Sequence[str]
    The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster.
    hostNames List<String>
    The host names which are part of the SQL FCI resource group.
    id String
    The GUID of the SQL Server's underlying Failover Cluster.
    networkName String
    The network name to connect to the SQL FCI.
    sqlInstanceIds List<String>
    The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster.

    MonitoringResponse

    Enabled bool
    Indicates if monitoring is enabled for this SQL Server instance.
    Enabled bool
    Indicates if monitoring is enabled for this SQL Server instance.
    enabled Boolean
    Indicates if monitoring is enabled for this SQL Server instance.
    enabled boolean
    Indicates if monitoring is enabled for this SQL Server instance.
    enabled bool
    Indicates if monitoring is enabled for this SQL Server instance.
    enabled Boolean
    Indicates if monitoring is enabled for this SQL Server instance.

    SqlServerInstancePropertiesResponse

    AlwaysOnRole string
    The role of the SQL Server, based on availability.
    AzureDefenderStatus string
    Status of Azure Defender.
    AzureDefenderStatusLastUpdated string
    Timestamp of last Azure Defender status update.
    Collation string
    SQL Server collation.
    ContainerResourceId string
    ARM Resource id of the container resource (Azure Arc for Servers).
    CreateTime string
    The time when the resource was created.
    CurrentVersion string
    SQL Server current version.
    LastInventoryUploadTime string
    The time when last successful inventory upload was performed.
    LastUsageUploadTime string
    The time when last successful usage upload was performed.
    LicenseType string
    SQL Server license type.
    PatchLevel string
    SQL Server update level.
    ProductId string
    SQL Server product ID.
    ProvisioningState string
    The provisioning state of the Arc-enabled SQL Server resource.
    Status string
    The cloud connectivity status.
    TcpDynamicPorts string
    Dynamic TCP ports used by SQL Server.
    TcpStaticPorts string
    Static TCP ports used by SQL Server.
    VCore string
    The number of logical processors used by the SQL Server instance.
    BackupPolicy Pulumi.AzureNative.AzureArcData.Inputs.BackupPolicyResponse
    The backup profile for the SQL server.
    Cores string
    The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance.
    Edition string
    SQL Server edition.
    FailoverCluster Pulumi.AzureNative.AzureArcData.Inputs.FailoverClusterResponse
    Failover Cluster Instance properties.
    HostType string
    Type of host for Azure Arc SQL Server
    InstanceName string
    SQL Server instance name.
    Monitoring Pulumi.AzureNative.AzureArcData.Inputs.MonitoringResponse
    The monitoring configuration.
    UpgradeLockedUntil string
    Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty.
    Version string
    SQL Server version.
    AlwaysOnRole string
    The role of the SQL Server, based on availability.
    AzureDefenderStatus string
    Status of Azure Defender.
    AzureDefenderStatusLastUpdated string
    Timestamp of last Azure Defender status update.
    Collation string
    SQL Server collation.
    ContainerResourceId string
    ARM Resource id of the container resource (Azure Arc for Servers).
    CreateTime string
    The time when the resource was created.
    CurrentVersion string
    SQL Server current version.
    LastInventoryUploadTime string
    The time when last successful inventory upload was performed.
    LastUsageUploadTime string
    The time when last successful usage upload was performed.
    LicenseType string
    SQL Server license type.
    PatchLevel string
    SQL Server update level.
    ProductId string
    SQL Server product ID.
    ProvisioningState string
    The provisioning state of the Arc-enabled SQL Server resource.
    Status string
    The cloud connectivity status.
    TcpDynamicPorts string
    Dynamic TCP ports used by SQL Server.
    TcpStaticPorts string
    Static TCP ports used by SQL Server.
    VCore string
    The number of logical processors used by the SQL Server instance.
    BackupPolicy BackupPolicyResponse
    The backup profile for the SQL server.
    Cores string
    The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance.
    Edition string
    SQL Server edition.
    FailoverCluster FailoverClusterResponse
    Failover Cluster Instance properties.
    HostType string
    Type of host for Azure Arc SQL Server
    InstanceName string
    SQL Server instance name.
    Monitoring MonitoringResponse
    The monitoring configuration.
    UpgradeLockedUntil string
    Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty.
    Version string
    SQL Server version.
    alwaysOnRole String
    The role of the SQL Server, based on availability.
    azureDefenderStatus String
    Status of Azure Defender.
    azureDefenderStatusLastUpdated String
    Timestamp of last Azure Defender status update.
    collation String
    SQL Server collation.
    containerResourceId String
    ARM Resource id of the container resource (Azure Arc for Servers).
    createTime String
    The time when the resource was created.
    currentVersion String
    SQL Server current version.
    lastInventoryUploadTime String
    The time when last successful inventory upload was performed.
    lastUsageUploadTime String
    The time when last successful usage upload was performed.
    licenseType String
    SQL Server license type.
    patchLevel String
    SQL Server update level.
    productId String
    SQL Server product ID.
    provisioningState String
    The provisioning state of the Arc-enabled SQL Server resource.
    status String
    The cloud connectivity status.
    tcpDynamicPorts String
    Dynamic TCP ports used by SQL Server.
    tcpStaticPorts String
    Static TCP ports used by SQL Server.
    vCore String
    The number of logical processors used by the SQL Server instance.
    backupPolicy BackupPolicyResponse
    The backup profile for the SQL server.
    cores String
    The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance.
    edition String
    SQL Server edition.
    failoverCluster FailoverClusterResponse
    Failover Cluster Instance properties.
    hostType String
    Type of host for Azure Arc SQL Server
    instanceName String
    SQL Server instance name.
    monitoring MonitoringResponse
    The monitoring configuration.
    upgradeLockedUntil String
    Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty.
    version String
    SQL Server version.
    alwaysOnRole string
    The role of the SQL Server, based on availability.
    azureDefenderStatus string
    Status of Azure Defender.
    azureDefenderStatusLastUpdated string
    Timestamp of last Azure Defender status update.
    collation string
    SQL Server collation.
    containerResourceId string
    ARM Resource id of the container resource (Azure Arc for Servers).
    createTime string
    The time when the resource was created.
    currentVersion string
    SQL Server current version.
    lastInventoryUploadTime string
    The time when last successful inventory upload was performed.
    lastUsageUploadTime string
    The time when last successful usage upload was performed.
    licenseType string
    SQL Server license type.
    patchLevel string
    SQL Server update level.
    productId string
    SQL Server product ID.
    provisioningState string
    The provisioning state of the Arc-enabled SQL Server resource.
    status string
    The cloud connectivity status.
    tcpDynamicPorts string
    Dynamic TCP ports used by SQL Server.
    tcpStaticPorts string
    Static TCP ports used by SQL Server.
    vCore string
    The number of logical processors used by the SQL Server instance.
    backupPolicy BackupPolicyResponse
    The backup profile for the SQL server.
    cores string
    The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance.
    edition string
    SQL Server edition.
    failoverCluster FailoverClusterResponse
    Failover Cluster Instance properties.
    hostType string
    Type of host for Azure Arc SQL Server
    instanceName string
    SQL Server instance name.
    monitoring MonitoringResponse
    The monitoring configuration.
    upgradeLockedUntil string
    Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty.
    version string
    SQL Server version.
    always_on_role str
    The role of the SQL Server, based on availability.
    azure_defender_status str
    Status of Azure Defender.
    azure_defender_status_last_updated str
    Timestamp of last Azure Defender status update.
    collation str
    SQL Server collation.
    container_resource_id str
    ARM Resource id of the container resource (Azure Arc for Servers).
    create_time str
    The time when the resource was created.
    current_version str
    SQL Server current version.
    last_inventory_upload_time str
    The time when last successful inventory upload was performed.
    last_usage_upload_time str
    The time when last successful usage upload was performed.
    license_type str
    SQL Server license type.
    patch_level str
    SQL Server update level.
    product_id str
    SQL Server product ID.
    provisioning_state str
    The provisioning state of the Arc-enabled SQL Server resource.
    status str
    The cloud connectivity status.
    tcp_dynamic_ports str
    Dynamic TCP ports used by SQL Server.
    tcp_static_ports str
    Static TCP ports used by SQL Server.
    v_core str
    The number of logical processors used by the SQL Server instance.
    backup_policy BackupPolicyResponse
    The backup profile for the SQL server.
    cores str
    The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance.
    edition str
    SQL Server edition.
    failover_cluster FailoverClusterResponse
    Failover Cluster Instance properties.
    host_type str
    Type of host for Azure Arc SQL Server
    instance_name str
    SQL Server instance name.
    monitoring MonitoringResponse
    The monitoring configuration.
    upgrade_locked_until str
    Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty.
    version str
    SQL Server version.
    alwaysOnRole String
    The role of the SQL Server, based on availability.
    azureDefenderStatus String
    Status of Azure Defender.
    azureDefenderStatusLastUpdated String
    Timestamp of last Azure Defender status update.
    collation String
    SQL Server collation.
    containerResourceId String
    ARM Resource id of the container resource (Azure Arc for Servers).
    createTime String
    The time when the resource was created.
    currentVersion String
    SQL Server current version.
    lastInventoryUploadTime String
    The time when last successful inventory upload was performed.
    lastUsageUploadTime String
    The time when last successful usage upload was performed.
    licenseType String
    SQL Server license type.
    patchLevel String
    SQL Server update level.
    productId String
    SQL Server product ID.
    provisioningState String
    The provisioning state of the Arc-enabled SQL Server resource.
    status String
    The cloud connectivity status.
    tcpDynamicPorts String
    Dynamic TCP ports used by SQL Server.
    tcpStaticPorts String
    Static TCP ports used by SQL Server.
    vCore String
    The number of logical processors used by the SQL Server instance.
    backupPolicy Property Map
    The backup profile for the SQL server.
    cores String
    The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance.
    edition String
    SQL Server edition.
    failoverCluster Property Map
    Failover Cluster Instance properties.
    hostType String
    Type of host for Azure Arc SQL Server
    instanceName String
    SQL Server instance name.
    monitoring Property Map
    The monitoring configuration.
    upgradeLockedUntil String
    Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty.
    version String
    SQL Server version.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    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.4.0 published on Wednesday, May 7, 2025 by Pulumi