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

Successfully retrieved the specified server key.

Name	Datatype	Description
kind	string	Kind of encryption protector. This is metadata used for the Azure portal experience.
location	string	Resource location.
properties	object	Resource properties.

list_by_server

Successfully retrieved the list of server keys.

Name	Datatype	Description
kind	string	Kind of encryption protector. This is metadata used for the Azure portal experience.
location	string	Resource location.
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, keyName, subscriptionId		Gets a server key.
list_by_server	select	resourceGroupName, serverName, subscriptionId		Gets a list of server keys.
create_or_update	insert	resourceGroupName, serverName, keyName, subscriptionId		Creates or updates a server key.
delete	delete	resourceGroupName, serverName, keyName, subscriptionId		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
keyName	string	The name of the server key to be deleted.
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.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a server key.

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

list_by_server

Gets a list of server keys.

SELECT
kind,
location,
properties
FROM azure.sql.server_keys
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a server key.

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

Manifest

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

DELETE examples

delete

Deletes the server key with the given name.

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