managed_instances

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

Overview

Name	managed_instances
Type	Resource
Id	azure.sql.managed_instances

Fields

vw_managed_instances

Name	Datatype	Description
administrator_login	text	field from the properties object
administrator_login_password	text	field from the properties object
administrators	text	field from the properties object
authentication_metadata	text	field from the properties object
collation	text	field from the properties object
create_time	text	field from the properties object
current_backup_storage_redundancy	text	field from the properties object
database_format	text	field from the properties object
dns_zone	text	field from the properties object
dns_zone_partner	text	field from the properties object
external_governance_status	text	field from the properties object
fully_qualified_domain_name	text	field from the properties object
hybrid_secondary_usage	text	field from the properties object
hybrid_secondary_usage_detected	text	field from the properties object
identity	text	Azure Active Directory identity configuration for a resource.
instance_pool_id	text	field from the properties object
is_general_purpose_v2	text	field from the properties object
key_id	text	field from the properties object
license_type	text	field from the properties object
location	text	Resource location.
maintenance_configuration_id	text	field from the properties object
managedInstanceName	text	field from the properties object
managed_instance_create_mode	text	field from the properties object
minimal_tls_version	text	field from the properties object
pricing_model	text	field from the properties object
primary_user_assigned_identity_id	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
proxy_override	text	field from the properties object
public_data_endpoint_enabled	text	field from the properties object
requested_backup_storage_redundancy	text	field from the properties object
resourceGroupName	text	field from the properties object
restore_point_in_time	text	field from the properties object
service_principal	text	field from the properties object
sku	text	An ARM Resource SKU.
source_managed_instance_id	text	field from the properties object
state	text	field from the properties object
storage_i_ops	text	field from the properties object
storage_size_in_gb	text	field from the properties object
storage_throughput_mbps	text	field from the properties object
subnet_id	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
timezone_id	text	field from the properties object
v_cores	text	field from the properties object
virtual_cluster_id	text	field from the properties object
zone_redundant	text	field from the properties object

managed_instances

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	managedInstanceName, resourceGroupName, subscriptionId	Gets a managed instance.
list	SELECT	subscriptionId	Gets a list of all managed instances in the subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets a list of managed instances in a resource group.
create_or_update	INSERT	managedInstanceName, resourceGroupName, subscriptionId, data__location	Creates or updates a managed instance.
delete	DELETE	managedInstanceName, resourceGroupName, subscriptionId	Deletes a managed instance.
update	UPDATE	managedInstanceName, resourceGroupName, subscriptionId	Updates a managed instance.
failover	EXEC	managedInstanceName, resourceGroupName, subscriptionId	Failovers a managed instance.
refresh_status	EXEC	managedInstanceName, resourceGroupName, subscriptionId	Refresh external governance enablement status.
start	EXEC	managedInstanceName, resourceGroupName, subscriptionId	Starts the managed instance.
stop	EXEC	managedInstanceName, resourceGroupName, subscriptionId	Stops the managed instance.

SELECT examples

Gets a list of all managed instances in the subscription.

vw_managed_instances

SELECT
administrator_login,
administrator_login_password,
administrators,
authentication_metadata,
collation,
create_time,
current_backup_storage_redundancy,
database_format,
dns_zone,
dns_zone_partner,
external_governance_status,
fully_qualified_domain_name,
hybrid_secondary_usage,
hybrid_secondary_usage_detected,
identity,
instance_pool_id,
is_general_purpose_v2,
key_id,
license_type,
location,
maintenance_configuration_id,
managedInstanceName,
managed_instance_create_mode,
minimal_tls_version,
pricing_model,
primary_user_assigned_identity_id,
private_endpoint_connections,
provisioning_state,
proxy_override,
public_data_endpoint_enabled,
requested_backup_storage_redundancy,
resourceGroupName,
restore_point_in_time,
service_principal,
sku,
source_managed_instance_id,
state,
storage_i_ops,
storage_size_in_gb,
storage_throughput_mbps,
subnet_id,
subscriptionId,
tags,
timezone_id,
v_cores,
virtual_cluster_id,
zone_redundant
FROM azure.sql.vw_managed_instances
WHERE subscriptionId = '{{ subscriptionId }}';

managed_instances

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.sql.managed_instances
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new managed_instances resource.

All Properties

/*+ create */
INSERT INTO azure.sql.managed_instances (
managedInstanceName,
resourceGroupName,
subscriptionId,
data__location,
location,
tags,
identity,
sku,
properties
)
SELECT 
'{{ managedInstanceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ location }}',
'{{ tags }}',
'{{ identity }}',
'{{ sku }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: tags
      value: object
    - name: identity
      value:
        - name: principalId
          value: string
        - name: type
          value: string
        - name: tenantId
          value: string
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: size
          value: string
        - name: family
          value: string
        - name: capacity
          value: integer
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: managedInstanceCreateMode
          value: string
        - name: fullyQualifiedDomainName
          value: string
        - name: isGeneralPurposeV2
          value: boolean
        - name: administratorLogin
          value: string
        - name: administratorLoginPassword
          value: string
        - name: subnetId
          value: string
        - name: state
          value: string
        - name: licenseType
          value: string
        - name: hybridSecondaryUsage
          value: string
        - name: hybridSecondaryUsageDetected
          value: string
        - name: vCores
          value: integer
        - name: storageSizeInGB
          value: integer
        - name: storageIOps
          value: integer
        - name: storageThroughputMBps
          value: integer
        - name: collation
          value: string
        - name: dnsZone
          value: string
        - name: dnsZonePartner
          value: string
        - name: publicDataEndpointEnabled
          value: boolean
        - name: sourceManagedInstanceId
          value: string
        - name: restorePointInTime
          value: string
        - name: proxyOverride
          value: string
        - name: timezoneId
          value: string
        - name: instancePoolId
          value: string
        - name: maintenanceConfigurationId
          value: string
        - name: privateEndpointConnections
          value:
            - - name: id
                value: string
              - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: string
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: string
        - name: minimalTlsVersion
          value: string
        - name: currentBackupStorageRedundancy
          value: string
        - name: requestedBackupStorageRedundancy
          value: string
        - name: zoneRedundant
          value: boolean
        - name: primaryUserAssignedIdentityId
          value: string
        - name: keyId
          value: string
        - name: administrators
          value:
            - name: administratorType
              value: string
            - name: principalType
              value: string
            - name: login
              value: string
            - name: sid
              value: string
            - name: tenantId
              value: string
            - name: azureADOnlyAuthentication
              value: boolean
        - name: servicePrincipal
          value:
            - name: principalId
              value: string
            - name: clientId
              value: string
            - name: tenantId
              value: string
            - name: type
              value: string
        - name: virtualClusterId
          value: string
        - name: externalGovernanceStatus
          value: string
        - name: pricingModel
          value: string
        - name: createTime
          value: string
        - name: authenticationMetadata
          value: string
        - name: databaseFormat
          value: string

UPDATE example

Updates a managed_instances resource.

/*+ update */
UPDATE azure.sql.managed_instances
SET 
sku = '{{ sku }}',
identity = '{{ identity }}',
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
managedInstanceName = '{{ managedInstanceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified managed_instances resource.

/*+ delete */
DELETE FROM azure.sql.managed_instances
WHERE managedInstanceName = '{{ managedInstanceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';