ekm_certificates
Creates, updates, deletes, gets or lists an ekm_certificates resource.
Overview​
| Name | ekm_certificates |
| Type | Resource |
| Id | azure.key_vault_administration.ekm_certificates |
Fields​
The following fields are returned by SELECT queries:
- get_ekm_certificate
| Name | Datatype | Description |
|---|---|---|
subject_common_name | string | The subject common name of the client certificate used to authenticate to the EKM proxy. Required. |
ca_certificates | array | The client root CA certificate chain to authenticate to the EKM proxy. 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_certificate | select | vault_base_url | Gets the EKM proxy client certificate. The External Key Manager (EKM) Certificate Get operation returns Proxy client certificate. 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​
- get_ekm_certificate
Gets the EKM proxy client certificate. The External Key Manager (EKM) Certificate Get operation returns Proxy client certificate. This operation requires ekm/read permission.
SELECT
subject_common_name,
ca_certificates
FROM azure.key_vault_administration.ekm_certificates
WHERE vault_base_url = '{{ vault_base_url }}' -- required
;