managed_instance_administrators

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

Overview

Name	managed_instance_administrators
Type	Resource
Id	azure.sql.managed_instance_administrators

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the the specified managed instance administrator.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, managedInstanceName, administratorName, subscriptionId		Gets a managed instance administrator.
create_or_update	insert	resourceGroupName, managedInstanceName, administratorName, subscriptionId		Creates or updates a managed instance administrator.
delete	delete	resourceGroupName, managedInstanceName, administratorName, subscriptionId		Deletes a managed instance administrator.

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
administratorName	string
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 instance administrator.

SELECT
properties
FROM azure.sql.managed_instance_administrators
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- required
AND administratorName = '{{ administratorName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a managed instance administrator.

INSERT INTO azure.sql.managed_instance_administrators (
data__properties,
resourceGroupName,
managedInstanceName,
administratorName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ managedInstanceName }}',
'{{ administratorName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

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

DELETE examples

delete

Deletes a managed instance administrator.

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