azure-native.azurearcdata.getSqlServerInstance
Explore with Pulumi AI
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:
- Resource
Group stringName - The name of the Azure resource group
- Sql
Server stringInstance Name - Name of SQL Server Instance
- Resource
Group stringName - The name of the Azure resource group
- Sql
Server stringInstance Name - Name of SQL Server Instance
- resource
Group StringName - The name of the Azure resource group
- sql
Server StringInstance Name - Name of SQL Server Instance
- resource
Group stringName - The name of the Azure resource group
- sql
Server stringInstance Name - Name of SQL Server Instance
- resource_
group_ strname - The name of the Azure resource group
- sql_
server_ strinstance_ name - Name of SQL Server Instance
- resource
Group StringName - The name of the Azure resource group
- sql
Server StringInstance Name - Name of SQL Server Instance
getSqlServerInstance Result
The following output properties are available:
- Azure
Api stringVersion - 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.
Azure Native. Azure Arc Data. Outputs. Sql Server Instance Properties Response - null
- System
Data Pulumi.Azure Native. Azure Arc Data. Outputs. System Data Response - 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"
- Dictionary<string, string>
- Resource tags.
- Azure
Api stringVersion - 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
Sql
Server Instance Properties Response - null
- System
Data SystemData Response - 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"
- map[string]string
- Resource tags.
- azure
Api StringVersion - 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
Sql
Server Instance Properties Response - null
- system
Data SystemData Response - 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"
- Map<String,String>
- Resource tags.
- azure
Api stringVersion - 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
Sql
Server Instance Properties Response - null
- system
Data SystemData Response - 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"
- {[key: string]: string}
- Resource tags.
- azure_
api_ strversion - 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
Sql
Server Instance Properties Response - null
- system_
data SystemData Response - 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"
- Mapping[str, str]
- Resource tags.
- azure
Api StringVersion - 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
- system
Data 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"
- Map<String>
- Resource tags.
Supporting Types
BackupPolicyResponse
- Differential
Backup intHours - The differential backup interval in hours.
- Full
Backup intDays - The value indicating days between full backups.
- Retention
Period intDays - The retention period for all the databases in this managed instance.
- Transaction
Log intBackup Minutes - The value indicating minutes between transaction log backups.
- Differential
Backup intHours - The differential backup interval in hours.
- Full
Backup intDays - The value indicating days between full backups.
- Retention
Period intDays - The retention period for all the databases in this managed instance.
- Transaction
Log intBackup Minutes - The value indicating minutes between transaction log backups.
- differential
Backup IntegerHours - The differential backup interval in hours.
- full
Backup IntegerDays - The value indicating days between full backups.
- retention
Period IntegerDays - The retention period for all the databases in this managed instance.
- transaction
Log IntegerBackup Minutes - The value indicating minutes between transaction log backups.
- differential
Backup numberHours - The differential backup interval in hours.
- full
Backup numberDays - The value indicating days between full backups.
- retention
Period numberDays - The retention period for all the databases in this managed instance.
- transaction
Log numberBackup Minutes - The value indicating minutes between transaction log backups.
- differential_
backup_ inthours - The differential backup interval in hours.
- full_
backup_ intdays - The value indicating days between full backups.
- retention_
period_ intdays - The retention period for all the databases in this managed instance.
- transaction_
log_ intbackup_ minutes - The value indicating minutes between transaction log backups.
- differential
Backup NumberHours - The differential backup interval in hours.
- full
Backup NumberDays - The value indicating days between full backups.
- retention
Period NumberDays - The retention period for all the databases in this managed instance.
- transaction
Log NumberBackup Minutes - The value indicating minutes between transaction log backups.
FailoverClusterResponse
- Host
Names 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.
- Network
Name string - The network name to connect to the SQL FCI.
- Sql
Instance List<string>Ids - The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster.
- Host
Names []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.
- Network
Name string - The network name to connect to the SQL FCI.
- Sql
Instance []stringIds - The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster.
- host
Names 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.
- network
Name String - The network name to connect to the SQL FCI.
- sql
Instance List<String>Ids - The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster.
- host
Names 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.
- network
Name string - The network name to connect to the SQL FCI.
- sql
Instance string[]Ids - 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_ Sequence[str]ids - The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster.
- host
Names 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.
- network
Name String - The network name to connect to the SQL FCI.
- sql
Instance List<String>Ids - 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
- Always
On stringRole - The role of the SQL Server, based on availability.
- Azure
Defender stringStatus - Status of Azure Defender.
- Azure
Defender stringStatus Last Updated - Timestamp of last Azure Defender status update.
- Collation string
- SQL Server collation.
- Container
Resource stringId - ARM Resource id of the container resource (Azure Arc for Servers).
- Create
Time string - The time when the resource was created.
- Current
Version string - SQL Server current version.
- Last
Inventory stringUpload Time - The time when last successful inventory upload was performed.
- Last
Usage stringUpload Time - The time when last successful usage upload was performed.
- License
Type string - SQL Server license type.
- Patch
Level string - SQL Server update level.
- Product
Id string - SQL Server product ID.
- Provisioning
State string - The provisioning state of the Arc-enabled SQL Server resource.
- Status string
- The cloud connectivity status.
- Tcp
Dynamic stringPorts - Dynamic TCP ports used by SQL Server.
- Tcp
Static stringPorts - Static TCP ports used by SQL Server.
- VCore string
- The number of logical processors used by the SQL Server instance.
- Backup
Policy Pulumi.Azure Native. Azure Arc Data. Inputs. Backup Policy Response - 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.
- Failover
Cluster Pulumi.Azure Native. Azure Arc Data. Inputs. Failover Cluster Response - Failover Cluster Instance properties.
- Host
Type string - Type of host for Azure Arc SQL Server
- Instance
Name string - SQL Server instance name.
- Monitoring
Pulumi.
Azure Native. Azure Arc Data. Inputs. Monitoring Response - The monitoring configuration.
- Upgrade
Locked stringUntil - 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 stringRole - The role of the SQL Server, based on availability.
- Azure
Defender stringStatus - Status of Azure Defender.
- Azure
Defender stringStatus Last Updated - Timestamp of last Azure Defender status update.
- Collation string
- SQL Server collation.
- Container
Resource stringId - ARM Resource id of the container resource (Azure Arc for Servers).
- Create
Time string - The time when the resource was created.
- Current
Version string - SQL Server current version.
- Last
Inventory stringUpload Time - The time when last successful inventory upload was performed.
- Last
Usage stringUpload Time - The time when last successful usage upload was performed.
- License
Type string - SQL Server license type.
- Patch
Level string - SQL Server update level.
- Product
Id string - SQL Server product ID.
- Provisioning
State string - The provisioning state of the Arc-enabled SQL Server resource.
- Status string
- The cloud connectivity status.
- Tcp
Dynamic stringPorts - Dynamic TCP ports used by SQL Server.
- Tcp
Static stringPorts - Static TCP ports used by SQL Server.
- VCore string
- The number of logical processors used by the SQL Server instance.
- Backup
Policy BackupPolicy Response - 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.
- Failover
Cluster FailoverCluster Response - Failover Cluster Instance properties.
- Host
Type string - Type of host for Azure Arc SQL Server
- Instance
Name string - SQL Server instance name.
- Monitoring
Monitoring
Response - The monitoring configuration.
- Upgrade
Locked stringUntil - 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 StringRole - The role of the SQL Server, based on availability.
- azure
Defender StringStatus - Status of Azure Defender.
- azure
Defender StringStatus Last Updated - Timestamp of last Azure Defender status update.
- collation String
- SQL Server collation.
- container
Resource StringId - ARM Resource id of the container resource (Azure Arc for Servers).
- create
Time String - The time when the resource was created.
- current
Version String - SQL Server current version.
- last
Inventory StringUpload Time - The time when last successful inventory upload was performed.
- last
Usage StringUpload Time - The time when last successful usage upload was performed.
- license
Type String - SQL Server license type.
- patch
Level String - SQL Server update level.
- product
Id String - SQL Server product ID.
- provisioning
State String - The provisioning state of the Arc-enabled SQL Server resource.
- status String
- The cloud connectivity status.
- tcp
Dynamic StringPorts - Dynamic TCP ports used by SQL Server.
- tcp
Static StringPorts - Static TCP ports used by SQL Server.
- v
Core String - The number of logical processors used by the SQL Server instance.
- backup
Policy BackupPolicy Response - 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.
- failover
Cluster FailoverCluster Response - Failover Cluster Instance properties.
- host
Type String - Type of host for Azure Arc SQL Server
- instance
Name String - SQL Server instance name.
- monitoring
Monitoring
Response - The monitoring configuration.
- upgrade
Locked StringUntil - 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 stringRole - The role of the SQL Server, based on availability.
- azure
Defender stringStatus - Status of Azure Defender.
- azure
Defender stringStatus Last Updated - Timestamp of last Azure Defender status update.
- collation string
- SQL Server collation.
- container
Resource stringId - ARM Resource id of the container resource (Azure Arc for Servers).
- create
Time string - The time when the resource was created.
- current
Version string - SQL Server current version.
- last
Inventory stringUpload Time - The time when last successful inventory upload was performed.
- last
Usage stringUpload Time - The time when last successful usage upload was performed.
- license
Type string - SQL Server license type.
- patch
Level string - SQL Server update level.
- product
Id string - SQL Server product ID.
- provisioning
State string - The provisioning state of the Arc-enabled SQL Server resource.
- status string
- The cloud connectivity status.
- tcp
Dynamic stringPorts - Dynamic TCP ports used by SQL Server.
- tcp
Static stringPorts - Static TCP ports used by SQL Server.
- v
Core string - The number of logical processors used by the SQL Server instance.
- backup
Policy BackupPolicy Response - 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.
- failover
Cluster FailoverCluster Response - Failover Cluster Instance properties.
- host
Type string - Type of host for Azure Arc SQL Server
- instance
Name string - SQL Server instance name.
- monitoring
Monitoring
Response - The monitoring configuration.
- upgrade
Locked stringUntil - 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_ strrole - The role of the SQL Server, based on availability.
- azure_
defender_ strstatus - Status of Azure Defender.
- azure_
defender_ strstatus_ last_ updated - Timestamp of last Azure Defender status update.
- collation str
- SQL Server collation.
- container_
resource_ strid - 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_ strupload_ time - The time when last successful inventory upload was performed.
- last_
usage_ strupload_ time - 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_ strports - Dynamic TCP ports used by SQL Server.
- tcp_
static_ strports - Static TCP ports used by SQL Server.
- v_
core str - The number of logical processors used by the SQL Server instance.
- backup_
policy BackupPolicy Response - 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 FailoverCluster Response - Failover Cluster Instance properties.
- host_
type str - Type of host for Azure Arc SQL Server
- instance_
name str - SQL Server instance name.
- monitoring
Monitoring
Response - The monitoring configuration.
- upgrade_
locked_ struntil - 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.
- always
On StringRole - The role of the SQL Server, based on availability.
- azure
Defender StringStatus - Status of Azure Defender.
- azure
Defender StringStatus Last Updated - Timestamp of last Azure Defender status update.
- collation String
- SQL Server collation.
- container
Resource StringId - ARM Resource id of the container resource (Azure Arc for Servers).
- create
Time String - The time when the resource was created.
- current
Version String - SQL Server current version.
- last
Inventory StringUpload Time - The time when last successful inventory upload was performed.
- last
Usage StringUpload Time - The time when last successful usage upload was performed.
- license
Type String - SQL Server license type.
- patch
Level String - SQL Server update level.
- product
Id String - SQL Server product ID.
- provisioning
State String - The provisioning state of the Arc-enabled SQL Server resource.
- status String
- The cloud connectivity status.
- tcp
Dynamic StringPorts - Dynamic TCP ports used by SQL Server.
- tcp
Static StringPorts - Static TCP ports used by SQL Server.
- v
Core String - The number of logical processors used by the SQL Server instance.
- backup
Policy 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.
- failover
Cluster Property Map - Failover Cluster Instance properties.
- host
Type String - Type of host for Azure Arc SQL Server
- instance
Name String - SQL Server instance name.
- monitoring Property Map
- The monitoring configuration.
- upgrade
Locked StringUntil - 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
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0