Share via

Microsoft.Sql servers/databases/extensions 2024-05-01-preview

  • Article

Bicep resource definition

The servers/databases/extensions 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.Sql/servers/databases/extensions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Sql/servers/databases/extensions@2024-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    authenticationType: 'string'
    databaseEdition: 'string'
    maxSizeBytes: 'string'
    networkIsolation: {
      sqlServerResourceId: 'string'
      storageAccountResourceId: 'string'
    }
    operationMode: 'string'
    serviceObjectiveName: 'string'
    storageKey: 'string'
    storageKeyType: 'string'
    storageUri: 'string'
  }
}

Property values

DatabaseExtensionsProperties

Name Description Value
administratorLogin Administrator login name. If AuthenticationType is ManagedIdentity, this field should specify the Managed Identity's resource ID. string
administratorLoginPassword Administrator login password. If AuthenticationType is ManagedIdentity, this field should not be specified. string

Constraints:
Sensitive value. Pass in as a secure parameter.
authenticationType Authentication type used to access the SQL: Sql, ADPassword or ManagedIdentity. string
databaseEdition Database edition for the newly created database in the case of an import operation. string
maxSizeBytes Database max size in bytes for the newly created database in the case of an import operation. string
networkIsolation Optional resource information to enable network isolation for request. NetworkIsolationSettings
operationMode Operation mode of the operation: Import, Export, or PolybaseImport. 'Export'
'Import'
'PolybaseImport' (required)
serviceObjectiveName Database service level objective for the newly created database in the case of an import operation. string
storageKey Storage key for the storage account. If StorageKeyType is ManagedIdentity, this field should specify the Managed Identity's resource ID. string (required)
storageKeyType Storage key type: StorageAccessKey, SharedAccessKey or ManagedIdentity. 'ManagedIdentity'
'SharedAccessKey'
'StorageAccessKey' (required)
storageUri Storage Uri for the storage account. string (required)

Microsoft.Sql/servers/databases/extensions

Name Description Value
name The resource name string (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: servers/databases
properties Resource properties. DatabaseExtensionsProperties

NetworkIsolationSettings

Name Description Value
sqlServerResourceId The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation. string
storageAccountResourceId The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter. string

ARM template resource definition

The servers/databases/extensions 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.Sql/servers/databases/extensions resource, add the following JSON to your template.

{
  "type": "Microsoft.Sql/servers/databases/extensions",
  "apiVersion": "2024-05-01-preview",
  "name": "string",
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "authenticationType": "string",
    "databaseEdition": "string",
    "maxSizeBytes": "string",
    "networkIsolation": {
      "sqlServerResourceId": "string",
      "storageAccountResourceId": "string"
    },
    "operationMode": "string",
    "serviceObjectiveName": "string",
    "storageKey": "string",
    "storageKeyType": "string",
    "storageUri": "string"
  }
}

Property values

DatabaseExtensionsProperties

Name Description Value
administratorLogin Administrator login name. If AuthenticationType is ManagedIdentity, this field should specify the Managed Identity's resource ID. string
administratorLoginPassword Administrator login password. If AuthenticationType is ManagedIdentity, this field should not be specified. string

Constraints:
Sensitive value. Pass in as a secure parameter.
authenticationType Authentication type used to access the SQL: Sql, ADPassword or ManagedIdentity. string
databaseEdition Database edition for the newly created database in the case of an import operation. string
maxSizeBytes Database max size in bytes for the newly created database in the case of an import operation. string
networkIsolation Optional resource information to enable network isolation for request. NetworkIsolationSettings
operationMode Operation mode of the operation: Import, Export, or PolybaseImport. 'Export'
'Import'
'PolybaseImport' (required)
serviceObjectiveName Database service level objective for the newly created database in the case of an import operation. string
storageKey Storage key for the storage account. If StorageKeyType is ManagedIdentity, this field should specify the Managed Identity's resource ID. string (required)
storageKeyType Storage key type: StorageAccessKey, SharedAccessKey or ManagedIdentity. 'ManagedIdentity'
'SharedAccessKey'
'StorageAccessKey' (required)
storageUri Storage Uri for the storage account. string (required)

Microsoft.Sql/servers/databases/extensions

Name Description Value
apiVersion The api version '2024-05-01-preview'
name The resource name string (required)
properties Resource properties. DatabaseExtensionsProperties
type The resource type 'Microsoft.Sql/servers/databases/extensions'

NetworkIsolationSettings

Name Description Value
sqlServerResourceId The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation. string
storageAccountResourceId The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter. string

Terraform (AzAPI provider) resource definition

The servers/databases/extensions 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.Sql/servers/databases/extensions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/databases/extensions@2024-05-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      authenticationType = "string"
      databaseEdition = "string"
      maxSizeBytes = "string"
      networkIsolation = {
        sqlServerResourceId = "string"
        storageAccountResourceId = "string"
      }
      operationMode = "string"
      serviceObjectiveName = "string"
      storageKey = "string"
      storageKeyType = "string"
      storageUri = "string"
    }
  })
}

Property values

DatabaseExtensionsProperties

Name Description Value
administratorLogin Administrator login name. If AuthenticationType is ManagedIdentity, this field should specify the Managed Identity's resource ID. string
administratorLoginPassword Administrator login password. If AuthenticationType is ManagedIdentity, this field should not be specified. string

Constraints:
Sensitive value. Pass in as a secure parameter.
authenticationType Authentication type used to access the SQL: Sql, ADPassword or ManagedIdentity. string
databaseEdition Database edition for the newly created database in the case of an import operation. string
maxSizeBytes Database max size in bytes for the newly created database in the case of an import operation. string
networkIsolation Optional resource information to enable network isolation for request. NetworkIsolationSettings
operationMode Operation mode of the operation: Import, Export, or PolybaseImport. 'Export'
'Import'
'PolybaseImport' (required)
serviceObjectiveName Database service level objective for the newly created database in the case of an import operation. string
storageKey Storage key for the storage account. If StorageKeyType is ManagedIdentity, this field should specify the Managed Identity's resource ID. string (required)
storageKeyType Storage key type: StorageAccessKey, SharedAccessKey or ManagedIdentity. 'ManagedIdentity'
'SharedAccessKey'
'StorageAccessKey' (required)
storageUri Storage Uri for the storage account. string (required)

Microsoft.Sql/servers/databases/extensions

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: servers/databases
properties Resource properties. DatabaseExtensionsProperties
type The resource type "Microsoft.Sql/servers/databases/extensions@2024-05-01-preview"

NetworkIsolationSettings

Name Description Value
sqlServerResourceId The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation. string
storageAccountResourceId The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter. string