managed_databases

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

Overview

Name	managed_databases
Type	Resource
Id	azure.sql.managed_databases

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified managed database.

Name	Datatype	Description
location	string	Resource location.
properties	object	Resource properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, managedInstanceName, databaseName, subscriptionId		Gets a managed database.
create_or_update	insert	resourceGroupName, managedInstanceName, databaseName, subscriptionId, data__location		Creates a new database or updates an existing database.
update	update	resourceGroupName, managedInstanceName, databaseName, subscriptionId		Updates an existing database.
delete	delete	resourceGroupName, managedInstanceName, databaseName, subscriptionId		Deletes a managed database.
cancel_move	exec	resourceGroupName, managedInstanceName, databaseName, subscriptionId, destinationManagedDatabaseId		Cancels a managed database move operation.
complete_move	exec	resourceGroupName, managedInstanceName, databaseName, subscriptionId, destinationManagedDatabaseId		Completes a managed database move operation.
complete_restore	exec	resourceGroupName, managedInstanceName, databaseName, subscriptionId, lastBackupName		Completes the restore operation on a managed database.
start_move	exec	resourceGroupName, managedInstanceName, databaseName, subscriptionId, destinationManagedDatabaseId		Starts a managed database move operation.

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.
managedInstanceName	string	The name of the managed instance.
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.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a managed database.

SELECT
location,
properties,
tags
FROM azure.sql.managed_databases
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates a new database or updates an existing database.

INSERT INTO azure.sql.managed_databases (
data__location,
data__tags,
data__properties,
resourceGroupName,
managedInstanceName,
databaseName,
subscriptionId
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ managedInstanceName }}',
'{{ databaseName }}',
'{{ subscriptionId }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: managed_databases
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the managed_databases resource.
    - name: managedInstanceName
      value: string
      description: Required parameter for the managed_databases resource.
    - name: databaseName
      value: string
      description: Required parameter for the managed_databases resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the managed_databases resource.
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: properties
      value: object
      description: |
        Resource properties.

UPDATE examples

update

Updates an existing database.

UPDATE azure.sql.managed_databases
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND managedInstanceName = '{{ managedInstanceName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes a managed database.

DELETE FROM azure.sql.managed_databases
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND managedInstanceName = '{{ managedInstanceName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

cancel_move

Cancels a managed database move operation.

EXEC azure.sql.managed_databases.cancel_move 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managedInstanceName='{{ managedInstanceName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"destinationManagedDatabaseId": "{{ destinationManagedDatabaseId }}"
}'
;

complete_move

Completes a managed database move operation.

EXEC azure.sql.managed_databases.complete_move 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managedInstanceName='{{ managedInstanceName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"destinationManagedDatabaseId": "{{ destinationManagedDatabaseId }}"
}'
;

complete_restore

Completes the restore operation on a managed database.

EXEC azure.sql.managed_databases.complete_restore 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managedInstanceName='{{ managedInstanceName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"lastBackupName": "{{ lastBackupName }}"
}'
;

start_move

Starts a managed database move operation.

EXEC azure.sql.managed_databases.start_move 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managedInstanceName='{{ managedInstanceName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"destinationManagedDatabaseId": "{{ destinationManagedDatabaseId }}", 
"operationMode": "{{ operationMode }}"
}'
;