managed_instances

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

Overview

Name	managed_instances
Type	Resource
Id	azure.sql.managed_instances

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified managed instance.

Name	Datatype	Description
identity	object	The Azure Active Directory identity of the managed instance.
location	string	Resource location.
properties	object	Resource properties.
sku	object	An ARM Resource SKU.
tags	object	Resource tags.

list_by_resource_group

Successfully retrieved the list of managed instances.

Name	Datatype	Description
identity	object	The Azure Active Directory identity of the managed instance.
location	string	Resource location.
properties	object	Resource properties.
sku	object	An ARM Resource SKU.
tags	object	Resource tags.

list

Successfully retrieved the list of managed instances.

Name	Datatype	Description
identity	object	The Azure Active Directory identity of the managed instance.
location	string	Resource location.
properties	object	Resource properties.
sku	object	An ARM Resource SKU.
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, subscriptionId	$expand	Gets a managed instance.
list_by_resource_group	select	resourceGroupName, subscriptionId	$expand	Gets a list of managed instances in a resource group.
list	select	subscriptionId	$expand	Gets a list of all managed instances in the subscription.
create_or_update	insert	resourceGroupName, managedInstanceName, subscriptionId, data__location		Creates or updates a managed instance.
update	update	resourceGroupName, managedInstanceName, subscriptionId		Updates a managed instance.
delete	delete	resourceGroupName, managedInstanceName, subscriptionId		Deletes a managed instance.
failover	exec	resourceGroupName, managedInstanceName, subscriptionId	replicaType	Failovers a managed instance.
refresh_status	exec	resourceGroupName, managedInstanceName, subscriptionId		Refresh external governance enablement status.
start	exec	resourceGroupName, managedInstanceName, subscriptionId		Starts the managed instance.
stop	exec	resourceGroupName, managedInstanceName, subscriptionId		Stops the managed instance.

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
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.
$expand	string	The child resources to include in the response.
replicaType	string	The type of replica to be failed over.

SELECT examples

get

Gets a managed instance.

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.sql.managed_instances
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Gets a list of managed instances in a resource group.

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.sql.managed_instances
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets a list of all managed instances in the subscription.

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.sql.managed_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

INSERT examples

create_or_update

Creates or updates a managed instance.

INSERT INTO azure.sql.managed_instances (
data__location,
data__tags,
data__identity,
data__sku,
data__properties,
resourceGroupName,
managedInstanceName,
subscriptionId
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ identity }}',
'{{ sku }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ managedInstanceName }}',
'{{ subscriptionId }}'
RETURNING
identity,
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: managed_instances
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the managed_instances resource.
    - name: managedInstanceName
      value: string
      description: Required parameter for the managed_instances resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the managed_instances resource.
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: identity
      value: object
      description: |
        The Azure Active Directory identity of the managed instance.
    - name: sku
      value: object
      description: |
        An ARM Resource SKU.
    - name: properties
      value: object
      description: |
        Resource properties.

UPDATE examples

update

Updates a managed instance.

UPDATE azure.sql.managed_instances
SET 
data__sku = '{{ sku }}',
data__identity = '{{ identity }}',
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND managedInstanceName = '{{ managedInstanceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
identity,
location,
properties,
sku,
tags;

DELETE examples

delete

Deletes a managed instance.

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

Lifecycle Methods

failover

Failovers a managed instance.

EXEC azure.sql.managed_instances.failover 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managedInstanceName='{{ managedInstanceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@replicaType='{{ replicaType }}'
;

refresh_status

Refresh external governance enablement status.

EXEC azure.sql.managed_instances.refresh_status 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managedInstanceName='{{ managedInstanceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

start

Starts the managed instance.

EXEC azure.sql.managed_instances.start 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managedInstanceName='{{ managedInstanceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

stop

Stops the managed instance.

EXEC azure.sql.managed_instances.stop 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managedInstanceName='{{ managedInstanceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;