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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
blobUri	string	Blob URI.
databaseName	string	Database name.
errorMessage	string	Error message.
lastModifiedTime	string	Last modified time.
privateEndpointConnections	array	Gets the status of private endpoints associated with this request.
queuedTime	string	Queued time.
requestId	string	Request Id.
requestType	string	Request type.
serverName	string	Server name.
status	string	Operation status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_database	select	resource_group_name, server_name, database_name, subscription_id		List database extension. This will return an empty list as it is not supported.
create_or_update	insert	resource_group_name, server_name, database_name, extension_name, subscription_id		Perform a database extension operation, like database import, database export, or polybase import.
create_or_update	replace	resource_group_name, server_name, database_name, extension_name, subscription_id		Perform a database extension operation, like database import, database export, or polybase import.
get_raw	exec	resource_group_name, server_name, database_name, extension_name, subscription_id		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
database_name	string	The name of the database. Required.
extension_name	string	Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

list_by_database

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

SELECT
id,
name,
blobUri,
databaseName,
errorMessage,
lastModifiedTime,
privateEndpointConnections,
queuedTime,
requestId,
requestType,
serverName,
status,
systemData,
type
FROM azure.sql.database_extensions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Perform a database extension operation, like database import, database export, or polybase import.

INSERT INTO azure.sql.database_extensions (
properties,
resource_group_name,
server_name,
database_name,
extension_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ database_name }}',
'{{ extension_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: database_extensions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the database_extensions resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the database_extensions resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the database_extensions resource.
  - name: extension_name
    value: "{{ extension_name }}"
    description: Required parameter for the database_extensions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the database_extensions resource.
  - name: properties
    description: |
      Resource properties.
    value:
      operationMode: "{{ operationMode }}"
      storageKeyType: "{{ storageKeyType }}"
      storageKey: "{{ storageKey }}"
      storageUri: "{{ storageUri }}"
      administratorLogin: "{{ administratorLogin }}"
      administratorLoginPassword: "{{ administratorLoginPassword }}"
      authenticationType: "{{ authenticationType }}"
      databaseEdition: "{{ databaseEdition }}"
      serviceObjectiveName: "{{ serviceObjectiveName }}"
      maxSizeBytes: "{{ maxSizeBytes }}"
      networkIsolation:
        storageAccountResourceId: "{{ storageAccountResourceId }}"
        sqlServerResourceId: "{{ sqlServerResourceId }}"

REPLACE examples

create_or_update

Perform a database extension operation, like database import, database export, or polybase import.

REPLACE azure.sql.database_extensions
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND database_name = '{{ database_name }}' --required
AND extension_name = '{{ extension_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

Lifecycle Methods

get_raw

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

EXEC azure.sql.database_extensions.get_raw 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@extension_name='{{ extension_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;