Skip to main content

sql_server_instances

Creates, updates, deletes, gets or lists a sql_server_instances resource.

Overview​

Namesql_server_instances
TypeResource
Idazure.azure_arc_data.sql_server_instances

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
azureDefenderStatusstringStatus of Azure Defender. Known values are: "Protected", "Unprotected", and "Unknown".
azureDefenderStatusLastUpdatedstring (date-time)Timestamp of last Azure Defender status update.
collationstringSQL Server collation.
containerResourceIdstringARM Resource id of the container resource (Azure Arc for Servers). Required.
createTimestringThe time when the resource was created.
currentVersionstringSQL Server current version.
editionstringSQL Server edition. Known values are: "Evaluation", "Enterprise", "Standard", "Web", "Developer", and "Express".
hostTypestringType of host for Azure Arc SQL Server. Known values are: "Azure Virtual Machine", "Azure VMWare Virtual Machine", "Azure Kubernetes Service", "AWS VMWare Virtual Machine", "AWS Kubernetes Service", "GCP VMWare Virtual Machine", "GCP Kubernetes Service", "Container", "Virtual Machine", "Physical Server", "AWS Virtual Machine", "GCP Virtual Machine", and "Other".
instanceNamestringSQL Server instance name.
licenseTypestringSQL Server license type. Known values are: "Undefined", "Free", "HADR", "ServerCAL", "LicenseOnly", "PAYG", and "Paid".
locationstringThe geo-location where the resource lives. Required.
patchLevelstringSQL Server update level.
productIdstringSQL Server product ID.
provisioningStatestringThe provisioning state of the Arc-enabled SQL Server resource.
statusstringThe cloud connectivity status. Required. Known values are: "Connected", "Disconnected", "Registered", and "Unknown".
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagsobjectResource tags.
tcpDynamicPortsstringDynamic TCP ports used by SQL Server.
tcpStaticPortsstringStatic TCP ports used by SQL Server.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vCorestringThe number of logical processors used by the SQL Server instance.
versionstringSQL Server version. Known values are: "SQL Server 2012", "SQL Server 2014", "SQL Server 2016", "SQL Server 2017", "SQL Server 2019", "SQL Server 2022", and "Unknown".

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, sql_server_instance_name, subscription_idRetrieves a SQL Server Instance resource.
list_by_resource_groupselectresource_group_name, subscription_idList sqlServerInstance resources in the resource group. Gets all sqlServerInstances in a resource group.
listselectsubscription_idList sqlServerInstance resources in the subscription. List sqlServerInstance resources in the subscription.
createinsertresource_group_name, sql_server_instance_name, subscription_id, locationCreates or replaces a SQL Server Instance resource.
updateupdateresource_group_name, sql_server_instance_name, subscription_idUpdates a SQL Server Instance resource.
deletedeleteresource_group_name, sql_server_instance_name, subscription_idDeletes a SQL Server Instance resource.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
resource_group_namestringThe name of the Azure resource group. Required.
sql_server_instance_namestringName of SQL Server Instance. Required.
subscription_idstring

SELECT examples​

Retrieves a SQL Server Instance resource.

SELECT
id,
name,
azureDefenderStatus,
azureDefenderStatusLastUpdated,
collation,
containerResourceId,
createTime,
currentVersion,
edition,
hostType,
instanceName,
licenseType,
location,
patchLevel,
productId,
provisioningState,
status,
systemData,
tags,
tcpDynamicPorts,
tcpStaticPorts,
type,
vCore,
version
FROM azure.azure_arc_data.sql_server_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND sql_server_instance_name = '{{ sql_server_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

Creates or replaces a SQL Server Instance resource.

INSERT INTO azure.azure_arc_data.sql_server_instances (
tags,
location,
properties,
resource_group_name,
sql_server_instance_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ sql_server_instance_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

UPDATE examples​

Updates a SQL Server Instance resource.

UPDATE azure.azure_arc_data.sql_server_instances
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND sql_server_instance_name = '{{ sql_server_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples​

Deletes a SQL Server Instance resource.

DELETE FROM azure.azure_arc_data.sql_server_instances
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND sql_server_instance_name = '{{ sql_server_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;