Microsoft.Web staticSites/databaseConnections 2023-01-01

Bicep resource definition

The staticSites/databaseConnections resource type can be deployed with operations that target:

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

Resource format

To create a Microsoft.Web/staticSites/databaseConnections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Web/staticSites/databaseConnections@2023-01-01' = {
  kind: 'string'
  name: 'string'
  properties: {
    connectionIdentity: 'string'
    connectionString: 'string'
    region: 'string'
    resourceId: 'string'
  }
}

Property values

DatabaseConnectionProperties

Name Description Value
connectionIdentity If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. string
connectionString The connection string to use to connect to the database. string

Constraints:
Sensitive value. Pass in as a secure parameter.
region The region of the database resource. string (required)
resourceId The resource id of the database. string (required)

Microsoft.Web/staticSites/databaseConnections

Name Description Value
kind Kind of resource. string
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9]+$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: staticSites
properties DatabaseConnection resource specific properties DatabaseConnectionProperties

ARM template resource definition

The staticSites/databaseConnections resource type can be deployed with operations that target:

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

Resource format

To create a Microsoft.Web/staticSites/databaseConnections resource, add the following JSON to your template.

{
  "type": "Microsoft.Web/staticSites/databaseConnections",
  "apiVersion": "2023-01-01",
  "name": "string",
  "kind": "string",
  "properties": {
    "connectionIdentity": "string",
    "connectionString": "string",
    "region": "string",
    "resourceId": "string"
  }
}

Property values

DatabaseConnectionProperties

Name Description Value
connectionIdentity If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. string
connectionString The connection string to use to connect to the database. string

Constraints:
Sensitive value. Pass in as a secure parameter.
region The region of the database resource. string (required)
resourceId The resource id of the database. string (required)

Microsoft.Web/staticSites/databaseConnections

Name Description Value
apiVersion The api version '2023-01-01'
kind Kind of resource. string
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9]+$ (required)
properties DatabaseConnection resource specific properties DatabaseConnectionProperties
type The resource type 'Microsoft.Web/staticSites/databaseConnections'

Terraform (AzAPI provider) resource definition

The staticSites/databaseConnections 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.Web/staticSites/databaseConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/staticSites/databaseConnections@2023-01-01"
  name = "string"
  kind = "string"
  body = jsonencode({
    properties = {
      connectionIdentity = "string"
      connectionString = "string"
      region = "string"
      resourceId = "string"
    }
  })
}

Property values

DatabaseConnectionProperties

Name Description Value
connectionIdentity If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. string
connectionString The connection string to use to connect to the database. string

Constraints:
Sensitive value. Pass in as a secure parameter.
region The region of the database resource. string (required)
resourceId The resource id of the database. string (required)

Microsoft.Web/staticSites/databaseConnections

Name Description Value
kind Kind of resource. string
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9]+$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: staticSites
properties DatabaseConnection resource specific properties DatabaseConnectionProperties
type The resource type "Microsoft.Web/staticSites/databaseConnections@2023-01-01"