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

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.
administratorType	string	Type of the managed instance administrator. Required. "ActiveDirectory" (ActiveDirectory)
login	string	Login name of the managed instance administrator. Required.
sid	string	SID (object ID) of the managed instance administrator. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId	string	Tenant ID of the managed instance administrator.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_instance

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.
administratorType	string	Type of the managed instance administrator. Required. "ActiveDirectory" (ActiveDirectory)
login	string	Login name of the managed instance administrator. Required.
sid	string	SID (object ID) of the managed instance administrator. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId	string	Tenant ID of the managed instance administrator.
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
get	select	resource_group_name, managed_instance_name, administrator_name, subscription_id		Gets a managed instance administrator.
list_by_instance	select	resource_group_name, managed_instance_name, subscription_id		Gets a list of managed instance administrators.
create_or_update	insert	resource_group_name, managed_instance_name, administrator_name, subscription_id		Creates or updates a managed instance administrator.
create_or_update	replace	resource_group_name, managed_instance_name, administrator_name, subscription_id		Creates or updates a managed instance administrator.
delete	delete	resource_group_name, managed_instance_name, administrator_name, subscription_id		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
administrator_name	string	"ActiveDirectory" Required.
managed_instance_name	string	The name of the managed instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a managed instance administrator.

SELECT
id,
name,
administratorType,
login,
sid,
systemData,
tenantId,
type
FROM azure.sql.managed_instance_administrators
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND administrator_name = '{{ administrator_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_instance

Gets a list of managed instance administrators.

SELECT
id,
name,
administratorType,
login,
sid,
systemData,
tenantId,
type
FROM azure.sql.managed_instance_administrators
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a managed instance administrator.

INSERT INTO azure.sql.managed_instance_administrators (
properties,
resource_group_name,
managed_instance_name,
administrator_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ managed_instance_name }}',
'{{ administrator_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: managed_instance_administrators
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the managed_instance_administrators resource.
  - name: managed_instance_name
    value: "{{ managed_instance_name }}"
    description: Required parameter for the managed_instance_administrators resource.
  - name: administrator_name
    value: "{{ administrator_name }}"
    description: Required parameter for the managed_instance_administrators resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the managed_instance_administrators resource.
  - name: properties
    description: |
      Resource properties.
    value:
      administratorType: "{{ administratorType }}"
      login: "{{ login }}"
      sid: "{{ sid }}"
      tenantId: "{{ tenantId }}"

REPLACE examples

create_or_update

Creates or updates a managed instance administrator.

REPLACE azure.sql.managed_instance_administrators
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND managed_instance_name = '{{ managed_instance_name }}' --required
AND administrator_name = '{{ administrator_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a managed instance administrator.

DELETE FROM azure.sql.managed_instance_administrators
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND managed_instance_name = '{{ managed_instance_name }}' --required
AND administrator_name = '{{ administrator_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;