Microsoft.AzureArcData sqlServerInstances 2021-11-01

• Latest
• 2025-03-01-preview
• 2024-05-01-preview
• 2024-01-01
• 2023-01-15-preview
• 2022-06-15-preview
• 2022-03-01-preview
• 2021-11-01
• 2021-08-01
• 2021-07-01-preview
• 2021-06-01-preview

Bicep resource definition

The sqlServerInstances resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureArcData/sqlServerInstances resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AzureArcData/sqlServerInstances@2021-11-01' = {
  location: 'string'
  name: 'string'
  properties: {
    azureDefenderStatus: 'string'
    azureDefenderStatusLastUpdated: 'string'
    collation: 'string'
    containerResourceId: 'string'
    currentVersion: 'string'
    edition: 'string'
    instanceName: 'string'
    licenseType: 'string'
    patchLevel: 'string'
    productId: 'string'
    status: 'string'
    tcpDynamicPorts: 'string'
    tcpStaticPorts: 'string'
    vCore: 'string'
    version: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.AzureArcData/sqlServerInstances

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	null	SqlServerInstanceProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

SqlServerInstanceProperties

Name	Description	Value
azureDefenderStatus	Status of Azure Defender.	'Protected' 'Unknown' 'Unprotected'
azureDefenderStatusLastUpdated	Timestamp of last Azure Defender status update.	string
collation	SQL Server collation.	string
containerResourceId	ARM Resource id of the container resource (Azure Arc for Servers).	string (required)
currentVersion	SQL Server current version.	string
edition	SQL Server edition.	'Developer' 'Enterprise' 'Evaluation' 'Express' 'Standard' 'Web'
instanceName	SQL Server instance name.	string
licenseType	SQL Server license type.	'Free' 'HADR' 'Paid' 'Undefined'
patchLevel	SQL Server update level.	string
productId	SQL Server product ID.	string
status	The cloud connectivity status.	'Connected' 'Disconnected' 'Unknown' (required)
tcpDynamicPorts	Dynamic TCP ports used by SQL Server.	string
tcpStaticPorts	Static TCP ports used by SQL Server.	string
vCore	The number of logical processors used by the SQL Server instance.	string
version	SQL Server version.	'SQL Server 2016' 'SQL Server 2017' 'SQL Server 2019'

TrackedResourceTags

Name	Description	Value

ARM template resource definition

The sqlServerInstances resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureArcData/sqlServerInstances resource, add the following JSON to your template.

{
  "type": "Microsoft.AzureArcData/sqlServerInstances",
  "apiVersion": "2021-11-01",
  "name": "string",
  "location": "string",
  "properties": {
    "azureDefenderStatus": "string",
    "azureDefenderStatusLastUpdated": "string",
    "collation": "string",
    "containerResourceId": "string",
    "currentVersion": "string",
    "edition": "string",
    "instanceName": "string",
    "licenseType": "string",
    "patchLevel": "string",
    "productId": "string",
    "status": "string",
    "tcpDynamicPorts": "string",
    "tcpStaticPorts": "string",
    "vCore": "string",
    "version": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.AzureArcData/sqlServerInstances

Name	Description	Value
apiVersion	The api version	'2021-11-01'
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	null	SqlServerInstanceProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.AzureArcData/sqlServerInstances'

SqlServerInstanceProperties

Name	Description	Value
azureDefenderStatus	Status of Azure Defender.	'Protected' 'Unknown' 'Unprotected'
azureDefenderStatusLastUpdated	Timestamp of last Azure Defender status update.	string
collation	SQL Server collation.	string
containerResourceId	ARM Resource id of the container resource (Azure Arc for Servers).	string (required)
currentVersion	SQL Server current version.	string
edition	SQL Server edition.	'Developer' 'Enterprise' 'Evaluation' 'Express' 'Standard' 'Web'
instanceName	SQL Server instance name.	string
licenseType	SQL Server license type.	'Free' 'HADR' 'Paid' 'Undefined'
patchLevel	SQL Server update level.	string
productId	SQL Server product ID.	string
status	The cloud connectivity status.	'Connected' 'Disconnected' 'Unknown' (required)
tcpDynamicPorts	Dynamic TCP ports used by SQL Server.	string
tcpStaticPorts	Static TCP ports used by SQL Server.	string
vCore	The number of logical processors used by the SQL Server instance.	string
version	SQL Server version.	'SQL Server 2016' 'SQL Server 2017' 'SQL Server 2019'

TrackedResourceTags

Name	Description	Value

Usage Examples

Terraform (AzAPI provider) resource definition

The sqlServerInstances resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureArcData/sqlServerInstances resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureArcData/sqlServerInstances@2021-11-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      azureDefenderStatus = "string"
      azureDefenderStatusLastUpdated = "string"
      collation = "string"
      containerResourceId = "string"
      currentVersion = "string"
      edition = "string"
      instanceName = "string"
      licenseType = "string"
      patchLevel = "string"
      productId = "string"
      status = "string"
      tcpDynamicPorts = "string"
      tcpStaticPorts = "string"
      vCore = "string"
      version = "string"
    }
  }
}

Property Values

Microsoft.AzureArcData/sqlServerInstances

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	null	SqlServerInstanceProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.AzureArcData/sqlServerInstances@2021-11-01"

SqlServerInstanceProperties

Name	Description	Value
azureDefenderStatus	Status of Azure Defender.	'Protected' 'Unknown' 'Unprotected'
azureDefenderStatusLastUpdated	Timestamp of last Azure Defender status update.	string
collation	SQL Server collation.	string
containerResourceId	ARM Resource id of the container resource (Azure Arc for Servers).	string (required)
currentVersion	SQL Server current version.	string
edition	SQL Server edition.	'Developer' 'Enterprise' 'Evaluation' 'Express' 'Standard' 'Web'
instanceName	SQL Server instance name.	string
licenseType	SQL Server license type.	'Free' 'HADR' 'Paid' 'Undefined'
patchLevel	SQL Server update level.	string
productId	SQL Server product ID.	string
status	The cloud connectivity status.	'Connected' 'Disconnected' 'Unknown' (required)
tcpDynamicPorts	Dynamic TCP ports used by SQL Server.	string
tcpStaticPorts	Static TCP ports used by SQL Server.	string
vCore	The number of logical processors used by the SQL Server instance.	string
version	SQL Server version.	'SQL Server 2016' 'SQL Server 2017' 'SQL Server 2019'

TrackedResourceTags

Name	Description	Value