ekm_connections

Creates, updates, deletes, gets or lists an ekm_connections resource.

Overview

Name	ekm_connections
Type	Resource
Id	azure.key_vault_administration.ekm_connections

Fields

The following fields are returned by SELECT queries:

get_ekm_connection

Name	Datatype	Description
server_subject_common_name	string	The subject common name of the server certificate of EKM Proxy.
host	string	EKM proxy FQDN (Fully Qualified Domain Name). Only allowed characters are a-z, A-Z, 0-9, hyphen (-), dot (.), and colon (:). Required.
path_prefix	string	Optional path prefix for the EKM proxy (if any).
server_ca_certificates	array	The root CA certificate chain that issued the proxy server's certificate. An array of certificates in the certificate chain, each in DER format and base64 encoded. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ekm_connection	select	vault_base_url		Gets the EKM connection. The External Key Manager (EKM) Get operation returns EKM connection. This operation requires ekm/read permission.
create_ekm_connection	insert	vault_base_url, host, server_ca_certificates		Creates the EKM connection. The External Key Manager (EKM) sets up the EKM connection. If the EKM connection already exists, this operation fails. This operation requires ekm/write permission.
update_ekm_connection	update	vault_base_url, host, server_ca_certificates		Updates the EKM connection. The External Key Manager (EKM) updates the existing EKM connection. If the EKM connection does not exist, this operation fails. This operation requires ekm/write permission.
delete_ekm_connection	delete	vault_base_url		Deletes the EKM connection. The External Key Manager (EKM) deletes the existing EKM connection. If the EKM connection does not already exists, this operation fails. This operation requires ekm/delete permission.

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
vault_base_url	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client vaultBaseUrl parameter. (default: )

SELECT examples

get_ekm_connection

Gets the EKM connection. The External Key Manager (EKM) Get operation returns EKM connection. This operation requires ekm/read permission.

SELECT
server_subject_common_name,
host,
path_prefix,
server_ca_certificates
FROM azure.key_vault_administration.ekm_connections
WHERE vault_base_url = '{{ vault_base_url }}' -- required
;

INSERT examples

create_ekm_connection

Creates the EKM connection. The External Key Manager (EKM) sets up the EKM connection. If the EKM connection already exists, this operation fails. This operation requires ekm/write permission.

INSERT INTO azure.key_vault_administration.ekm_connections (
host,
path_prefix,
server_ca_certificates,
server_subject_common_name,
vault_base_url
)
SELECT 
'{{ host }}' /* required */,
'{{ path_prefix }}',
'{{ server_ca_certificates }}' /* required */,
'{{ server_subject_common_name }}',
'{{ vault_base_url }}'
RETURNING
server_subject_common_name,
host,
path_prefix,
server_ca_certificates
;

Manifest

# Description fields are for documentation purposes
- name: ekm_connections
props:
  - name: vault_base_url
    value: "{{ vault_base_url }}"
    description: Required parameter for the ekm_connections resource.
  - name: host
    value: "{{ host }}"
    description: |
      EKM proxy FQDN (Fully Qualified Domain Name). Only allowed characters are a-z, A-Z, 0-9, hyphen (-), dot (.), and colon (:). Required.
  - name: path_prefix
    value: "{{ path_prefix }}"
    description: |
      Optional path prefix for the EKM proxy (if any).
  - name: server_ca_certificates
    value:
      - "{{ server_ca_certificates }}"
    description: |
      The root CA certificate chain that issued the proxy server's certificate. An array of certificates in the certificate chain, each in DER format and base64 encoded. Required.
  - name: server_subject_common_name
    value: "{{ server_subject_common_name }}"
    description: |
      The subject common name of the server certificate of EKM Proxy.

UPDATE examples

update_ekm_connection

Updates the EKM connection. The External Key Manager (EKM) updates the existing EKM connection. If the EKM connection does not exist, this operation fails. This operation requires ekm/write permission.

UPDATE azure.key_vault_administration.ekm_connections
SET 
host = '{{ host }}',
path_prefix = '{{ path_prefix }}',
server_ca_certificates = '{{ server_ca_certificates }}',
server_subject_common_name = '{{ server_subject_common_name }}'
WHERE 
vault_base_url = '{{ vault_base_url }}' --required
AND host = '{{ host }}' --required
AND server_ca_certificates = '{{ server_ca_certificates }}' --required
RETURNING
server_subject_common_name,
host,
path_prefix,
server_ca_certificates;

DELETE examples

delete_ekm_connection

Deletes the EKM connection. The External Key Manager (EKM) deletes the existing EKM connection. If the EKM connection does not already exists, this operation fails. This operation requires ekm/delete permission.

DELETE FROM azure.key_vault_administration.ekm_connections
WHERE vault_base_url = '{{ vault_base_url }}' --required
;