server_keys

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

Overview

Name	server_keys
Type	Resource
Id	azure_extras.rdbms.server_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}. # pylint: disable=line-too-long
name	string	The name of the resource.
creationDate	string (date-time)	The key creation date.
kind	string	Kind of encryption protector used to protect the key.
serverKeyType	string	The key type like 'AzureKeyVault'. "AzureKeyVault"
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uri	string	The URI of the key.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
creationDate	string (date-time)	The key creation date.
kind	string	Kind of encryption protector used to protect the key.
serverKeyType	string	The key type like 'AzureKeyVault'. "AzureKeyVault"
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uri	string	The URI of the key.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, key_name, subscription_id		Gets a MySQL Server key.
list	select	resource_group_name, server_name, subscription_id		Gets a list of Server keys.
create_or_update	insert	server_name, key_name, resource_group_name, subscription_id		Creates or updates a MySQL Server key.
create_or_update	replace	server_name, key_name, resource_group_name, subscription_id		Creates or updates a MySQL Server key.
delete	delete	server_name, key_name, resource_group_name, subscription_id		Deletes the MySQL Server 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 MySQL Server key to be deleted. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets a MySQL Server key.

SELECT
id,
name,
creationDate,
kind,
serverKeyType,
type,
uri
FROM azure_extras.rdbms.server_keys
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND key_name = '{{ key_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of Server keys.

SELECT
id,
name,
creationDate,
kind,
serverKeyType,
type,
uri
FROM azure_extras.rdbms.server_keys
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a MySQL Server key.

INSERT INTO azure_extras.rdbms.server_keys (
properties,
server_name,
key_name,
resource_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ server_name }}',
'{{ key_name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: server_keys
props:
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the server_keys resource.
  - name: key_name
    value: "{{ key_name }}"
    description: Required parameter for the server_keys resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the server_keys resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the server_keys resource.
  - name: properties
    value:
      serverKeyType: "{{ serverKeyType }}"
      uri: "{{ uri }}"

REPLACE examples

create_or_update

Creates or updates a MySQL Server key.

REPLACE azure_extras.rdbms.server_keys
SET 
properties = '{{ properties }}'
WHERE 
server_name = '{{ server_name }}' --required
AND key_name = '{{ key_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
kind,
properties,
type;

DELETE examples

delete

Deletes the MySQL Server key with the given name.

DELETE FROM azure_extras.rdbms.server_keys
WHERE server_name = '{{ server_name }}' --required
AND key_name = '{{ key_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;