check_ekm_connections

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

Overview

Name	check_ekm_connections
Type	Resource
Id	azure.key_vault_administration.check_ekm_connections

Fields

The following fields are returned by SELECT queries:

check_ekm_connection

Name	Datatype	Description
proxy_name	string	The name of the proxy product and its version. Required.
api_version	string	The highest version of proxy interface API supported by the EKM Proxy. Required.
ekm_product	string	The name of the EKM product and its version. Required.
ekm_vendor	string	The name of the EKM vendor. Required.
proxy_vendor	string	The name of the proxy vendor. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
check_ekm_connection	select	vault_base_url		Checks the connectivity and authentication with the EKM proxy. The External Key Manager (EKM) Check operation checks the connectivity and authentication with the EKM proxy. This operation requires ekm/read 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

check_ekm_connection

Checks the connectivity and authentication with the EKM proxy. The External Key Manager (EKM) Check operation checks the connectivity and authentication with the EKM proxy. This operation requires ekm/read permission.

SELECT
proxy_name,
api_version,
ekm_product,
ekm_vendor,
proxy_vendor
FROM azure.key_vault_administration.check_ekm_connections
WHERE vault_base_url = '{{ vault_base_url }}' -- required
;