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

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.
autoRotationEnabled	boolean	Key auto rotation opt-in flag. Either true or false.
creationDate	string (date-time)	The key creation date.
kind	string	Kind of encryption protector. This is metadata used for the Azure portal experience.
serverKeyType	string	The key type like 'ServiceManaged', 'AzureKeyVault'. Required. Known values are: "ServiceManaged" and "AzureKeyVault". (ServiceManaged, AzureKeyVault)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
thumbprint	string	Thumbprint of the key.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uri	string	The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required.

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.
autoRotationEnabled	boolean	Key auto rotation opt-in flag. Either true or false.
creationDate	string (date-time)	The key creation date.
kind	string	Kind of encryption protector. This is metadata used for the Azure portal experience.
serverKeyType	string	The key type like 'ServiceManaged', 'AzureKeyVault'. Required. Known values are: "ServiceManaged" and "AzureKeyVault". (ServiceManaged, AzureKeyVault)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
thumbprint	string	Thumbprint of the key.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uri	string	The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required.

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, key_name, subscription_id		Gets a managed instance key.
list_by_instance	select	resource_group_name, managed_instance_name, subscription_id	$filter	Gets a list of managed instance keys.
create_or_update	insert	resource_group_name, managed_instance_name, key_name, subscription_id		Creates or updates a managed instance key.
create_or_update	replace	resource_group_name, managed_instance_name, key_name, subscription_id		Creates or updates a managed instance key.
delete	delete	resource_group_name, managed_instance_name, key_name, subscription_id		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
key_name	string	The name of the managed instance key to be retrieved. 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
$filter	string	An OData filter expression that filters elements in the collection. Default value is None.

SELECT examples

get

Gets a managed instance key.

SELECT
id,
name,
autoRotationEnabled,
creationDate,
kind,
serverKeyType,
systemData,
thumbprint,
type,
uri
FROM azure.sql.managed_instance_keys
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND key_name = '{{ key_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_instance

Gets a list of managed instance keys.

SELECT
id,
name,
autoRotationEnabled,
creationDate,
kind,
serverKeyType,
systemData,
thumbprint,
type,
uri
FROM azure.sql.managed_instance_keys
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Creates or updates a managed instance key.

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

Manifest

# Description fields are for documentation purposes
- name: managed_instance_keys
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the managed_instance_keys resource.
  - name: managed_instance_name
    value: "{{ managed_instance_name }}"
    description: Required parameter for the managed_instance_keys resource.
  - name: key_name
    value: "{{ key_name }}"
    description: Required parameter for the managed_instance_keys resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the managed_instance_keys resource.
  - name: properties
    description: |
      Resource properties.
    value:
      serverKeyType: "{{ serverKeyType }}"
      uri: "{{ uri }}"
      thumbprint: "{{ thumbprint }}"
      creationDate: "{{ creationDate }}"
      autoRotationEnabled: {{ autoRotationEnabled }}

REPLACE examples

create_or_update

Creates or updates a managed instance key.

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

DELETE examples

delete

Deletes the managed instance key with the given name.

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