database_extensions

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

Overview

Name	database_extensions
Type	Resource
Id	azure.sql.database_extensions

Fields

The following fields are returned by SELECT queries:

list_by_database

List extensions import/export operations. This will return an empty list as it is not supported.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_database	select	resourceGroupName, serverName, databaseName, subscriptionId		List database extension. This will return an empty list as it is not supported.
create_or_update	insert	resourceGroupName, serverName, databaseName, extensionName, subscriptionId		Perform a database extension operation, like polybase import
get	exec	resourceGroupName, serverName, databaseName, extensionName, subscriptionId		Gets a database extension. This will return resource not found as it is not supported.

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.

Name	Datatype	Description
databaseName	string	The name of the database.
extensionName	string
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

list_by_database

List database extension. This will return an empty list as it is not supported.

SELECT
properties
FROM azure.sql.database_extensions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Perform a database extension operation, like polybase import

INSERT INTO azure.sql.database_extensions (
data__properties,
resourceGroupName,
serverName,
databaseName,
extensionName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ databaseName }}',
'{{ extensionName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: database_extensions
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the database_extensions resource.
    - name: serverName
      value: string
      description: Required parameter for the database_extensions resource.
    - name: databaseName
      value: string
      description: Required parameter for the database_extensions resource.
    - name: extensionName
      value: string
      description: Required parameter for the database_extensions resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the database_extensions resource.
    - name: properties
      value: object
      description: |
        Resource properties.

Lifecycle Methods

get

Gets a database extension. This will return resource not found as it is not supported.

EXEC azure.sql.database_extensions.get 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@extensionName='{{ extensionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;