managed_instance_keys

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

Overview

Name	managed_instance_keys
Type	Resource
Id	azure.sql.managed_instance_keys

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified managed instance key.

Name	Datatype	Description
kind	string	Kind of encryption protector. This is metadata used for the Azure portal experience.
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, keyName, subscriptionId		Gets a managed instance key.
create_or_update	insert	resourceGroupName, managedInstanceName, keyName, subscriptionId		Creates or updates a managed instance key.
delete	delete	resourceGroupName, managedInstanceName, keyName, subscriptionId		Deletes the managed instance key with the given name.

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
keyName	string	The name of the managed instance key to be deleted.
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 key.

SELECT
kind,
properties
FROM azure.sql.managed_instance_keys
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- required
AND keyName = '{{ keyName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a managed instance key.

INSERT INTO azure.sql.managed_instance_keys (
data__properties,
resourceGroupName,
managedInstanceName,
keyName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ managedInstanceName }}',
'{{ keyName }}',
'{{ subscriptionId }}'
RETURNING
kind,
properties
;

Manifest

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

DELETE examples

delete

Deletes the managed instance key with the given name.

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