server_keys

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

Overview

Name	server_keys
Type	Resource
Id	azure.sql.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}.
name	string	The name of the resource.
autoRotationEnabled	boolean	Key auto rotation opt-in flag. Either true or false.
creationDate	string (date-time)	The server key creation date.
keyVersion	string	The version of the server key.
kind	string	Kind of encryption protector. This is metadata used for the Azure portal experience.
location	string	Resource location.
serverKeyType	string	The server key type like 'ServiceManaged', 'AzureKeyVault'. Required. Known values are: "ServiceManaged" and "AzureKeyVault". (ServiceManaged, AzureKeyVault)
subregion	string	Subregion of the server key.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
thumbprint	string	Thumbprint of the server key.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uri	string	The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion ' or can be 'https://YourVaultName.vault.azure.net/keys/YourKeyName '.

list_by_server

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 server key creation date.
keyVersion	string	The version of the server key.
kind	string	Kind of encryption protector. This is metadata used for the Azure portal experience.
location	string	Resource location.
serverKeyType	string	The server key type like 'ServiceManaged', 'AzureKeyVault'. Required. Known values are: "ServiceManaged" and "AzureKeyVault". (ServiceManaged, AzureKeyVault)
subregion	string	Subregion of the server key.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
thumbprint	string	Thumbprint of the server key.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uri	string	The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion ' or can be 'https://YourVaultName.vault.azure.net/keys/YourKeyName '.

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 server key.
list_by_server	select	resource_group_name, server_name, subscription_id		Gets a list of server keys.
create_or_update	insert	resource_group_name, server_name, key_name, subscription_id		Creates or updates a server key.
create_or_update	replace	resource_group_name, server_name, key_name, subscription_id		Creates or updates a server key.
delete	delete	resource_group_name, server_name, key_name, subscription_id		Deletes the 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 server key to be retrieved. 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 server key.

SELECT
id,
name,
autoRotationEnabled,
creationDate,
keyVersion,
kind,
location,
serverKeyType,
subregion,
systemData,
thumbprint,
type,
uri
FROM azure.sql.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_by_server

Gets a list of server keys.

SELECT
id,
name,
autoRotationEnabled,
creationDate,
keyVersion,
kind,
location,
serverKeyType,
subregion,
systemData,
thumbprint,
type,
uri
FROM azure.sql.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 server key.

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

Manifest

# Description fields are for documentation purposes
- name: server_keys
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the server_keys resource.
  - 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: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the server_keys resource.
  - name: properties
    description: |
      Resource properties.
    value:
      subregion: "{{ subregion }}"
      serverKeyType: "{{ serverKeyType }}"
      uri: "{{ uri }}"
      thumbprint: "{{ thumbprint }}"
      creationDate: "{{ creationDate }}"
      autoRotationEnabled: {{ autoRotationEnabled }}
      keyVersion: "{{ keyVersion }}"

REPLACE examples

create_or_update

Creates or updates a server key.

REPLACE azure.sql.server_keys
SET 
properties = '{{ properties }}'
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
RETURNING
id,
name,
kind,
location,
properties,
systemData,
type;

DELETE examples

delete

Deletes the server key with the given name.

DELETE FROM azure.sql.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
;