sql_managed_instances

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

Overview

Name	sql_managed_instances
Type	Resource
Id	azure.azure_arc_data.sql_managed_instances

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.
activeDirectoryInformation	object	Active Directory information related to this SQL Managed Instance.
admin	string	The instance admin user.
basicLoginInformation	object	Username and password for basic authentication.
clusterId	string	If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to.
dataControllerId	string	null.
endTime	string	The instance end time.
extendedLocation	object	The extendedLocation of the resource.
extensionId	string	If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to.
k8sRaw	object	The raw kubernetes information.
lastUploadedDate	string (date-time)	Last uploaded date from Kubernetes cluster. Defaults to current date time.
licenseType	string	The license type to apply for this managed instance. Known values are: "BasePrice", "LicenseIncluded", and "DisasterRecovery".
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the Arc-enabled SQL Managed Instance resource.
sku	object	Resource sku.
startTime	string	The instance start time.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
activeDirectoryInformation	object	Active Directory information related to this SQL Managed Instance.
admin	string	The instance admin user.
basicLoginInformation	object	Username and password for basic authentication.
clusterId	string	If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to.
dataControllerId	string	null.
endTime	string	The instance end time.
extendedLocation	object	The extendedLocation of the resource.
extensionId	string	If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to.
k8sRaw	object	The raw kubernetes information.
lastUploadedDate	string (date-time)	Last uploaded date from Kubernetes cluster. Defaults to current date time.
licenseType	string	The license type to apply for this managed instance. Known values are: "BasePrice", "LicenseIncluded", and "DisasterRecovery".
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the Arc-enabled SQL Managed Instance resource.
sku	object	Resource sku.
startTime	string	The instance start time.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
activeDirectoryInformation	object	Active Directory information related to this SQL Managed Instance.
admin	string	The instance admin user.
basicLoginInformation	object	Username and password for basic authentication.
clusterId	string	If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to.
dataControllerId	string	null.
endTime	string	The instance end time.
extendedLocation	object	The extendedLocation of the resource.
extensionId	string	If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to.
k8sRaw	object	The raw kubernetes information.
lastUploadedDate	string (date-time)	Last uploaded date from Kubernetes cluster. Defaults to current date time.
licenseType	string	The license type to apply for this managed instance. Known values are: "BasePrice", "LicenseIncluded", and "DisasterRecovery".
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the Arc-enabled SQL Managed Instance resource.
sku	object	Resource sku.
startTime	string	The instance start time.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, sql_managed_instance_name, subscription_id		Retrieves a SQL Managed Instance resource.
list_by_resource_group	select	resource_group_name, subscription_id		List sqlManagedInstance resources in the resource group. Gets all sqlManagedInstances in a resource group.
list	select	subscription_id		List sqlManagedInstance resources in the subscription. List sqlManagedInstance resources in the subscription.
create	insert	resource_group_name, sql_managed_instance_name, subscription_id, location, properties		Creates or replaces a SQL Managed Instance resource.
update	update	resource_group_name, sql_managed_instance_name, subscription_id		Updates a SQL Managed Instance resource.
delete	delete	resource_group_name, sql_managed_instance_name, subscription_id		Deletes a SQL Managed Instance resource.

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
resource_group_name	string	The name of the Azure resource group. Required.
sql_managed_instance_name	string	Name of SQL Managed Instance. Required.
subscription_id	string

SELECT examples

get

Retrieves a SQL Managed Instance resource.

SELECT
id,
name,
activeDirectoryInformation,
admin,
basicLoginInformation,
clusterId,
dataControllerId,
endTime,
extendedLocation,
extensionId,
k8sRaw,
lastUploadedDate,
licenseType,
location,
provisioningState,
sku,
startTime,
systemData,
tags,
type
FROM azure.azure_arc_data.sql_managed_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND sql_managed_instance_name = '{{ sql_managed_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List sqlManagedInstance resources in the resource group. Gets all sqlManagedInstances in a resource group.

SELECT
id,
name,
activeDirectoryInformation,
admin,
basicLoginInformation,
clusterId,
dataControllerId,
endTime,
extendedLocation,
extensionId,
k8sRaw,
lastUploadedDate,
licenseType,
location,
provisioningState,
sku,
startTime,
systemData,
tags,
type
FROM azure.azure_arc_data.sql_managed_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List sqlManagedInstance resources in the subscription. List sqlManagedInstance resources in the subscription.

SELECT
id,
name,
activeDirectoryInformation,
admin,
basicLoginInformation,
clusterId,
dataControllerId,
endTime,
extendedLocation,
extensionId,
k8sRaw,
lastUploadedDate,
licenseType,
location,
provisioningState,
sku,
startTime,
systemData,
tags,
type
FROM azure.azure_arc_data.sql_managed_instances
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates or replaces a SQL Managed Instance resource.

INSERT INTO azure.azure_arc_data.sql_managed_instances (
tags,
location,
properties,
extendedLocation,
sku,
resource_group_name,
sql_managed_instance_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ extendedLocation }}',
'{{ sku }}',
'{{ resource_group_name }}',
'{{ sql_managed_instance_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: sql_managed_instances
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sql_managed_instances resource.
  - name: sql_managed_instance_name
    value: "{{ sql_managed_instance_name }}"
    description: Required parameter for the sql_managed_instances resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sql_managed_instances resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      null. Required.
    value:
      dataControllerId: "{{ dataControllerId }}"
      admin: "{{ admin }}"
      startTime: "{{ startTime }}"
      endTime: "{{ endTime }}"
      k8sRaw:
        : "{{  }}"
        spec:
          : "{{  }}"
          scheduling:
            : "{{  }}"
            default:
              : "{{  }}"
              resources: "{{ resources }}"
          replicas: {{ replicas }}
      basicLoginInformation:
        username: "{{ username }}"
        password: "{{ password }}"
      lastUploadedDate: "{{ lastUploadedDate }}"
      provisioningState: "{{ provisioningState }}"
      activeDirectoryInformation:
        keytabInformation:
          keytab: "{{ keytab }}"
      licenseType: "{{ licenseType }}"
      clusterId: "{{ clusterId }}"
      extensionId: "{{ extensionId }}"
  - name: extendedLocation
    description: |
      The extendedLocation of the resource.
    value:
      name: "{{ name }}"
      type: "{{ type }}"
  - name: sku
    description: |
      Resource sku.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      dev: {{ dev }}
      size: "{{ size }}"
      family: "{{ family }}"
      capacity: {{ capacity }}

UPDATE examples

update

Updates a SQL Managed Instance resource.

UPDATE azure.azure_arc_data.sql_managed_instances
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND sql_managed_instance_name = '{{ sql_managed_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes a SQL Managed Instance resource.

DELETE FROM azure.azure_arc_data.sql_managed_instances
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND sql_managed_instance_name = '{{ sql_managed_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;