certificate_issuers
Creates, updates, deletes, gets or lists a certificate_issuers resource.
Overview
| Name | certificate_issuers |
| Type | Resource |
| Id | azure.key_vault_certificates.certificate_issuers |
Fields
The following fields are returned by SELECT queries:
- get_certificate_issuer
- get_certificate_issuers
| Name | Datatype | Description |
|---|---|---|
id | string | Identifier for the issuer object. |
attributes | object | Attributes of the issuer object. |
credentials | object | The credentials to be used for the issuer. |
org_details | object | Details of the organization as provided to the issuer. |
provider | string | The issuer provider. |
| Name | Datatype | Description |
|---|---|---|
id | string | Certificate Identifier. |
provider | string | The issuer provider. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_certificate_issuer | select | issuer_name, vault_name | Lists the specified certificate issuer. The GetCertificateIssuer operation returns the specified certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission. | |
get_certificate_issuers | select | vault_name | maxresults | List certificate issuers for a specified key vault. The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission. |
update_certificate_issuer | update | issuer_name, vault_name | Updates the specified certificate issuer. The UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers permission. | |
set_certificate_issuer | replace | issuer_name, vault_name, provider | Sets the specified certificate issuer. The SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission. | |
delete_certificate_issuer | delete | issuer_name, vault_name | Deletes the specified certificate issuer. The DeleteCertificateIssuer operation permanently removes the specified certificate issuer from the vault. This operation requires the certificates/manageissuers/deleteissuers 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 |
|---|---|---|
issuer_name | string | The name of the issuer. Required. |
vault_name | string | Key vault name. (default: ) |
maxresults | integer | Maximum number of results to return in a page. If not specified the service will return up to 25 results. Default value is None. |
SELECT examples
- get_certificate_issuer
- get_certificate_issuers
Lists the specified certificate issuer. The GetCertificateIssuer operation returns the specified certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.
SELECT
id,
attributes,
credentials,
org_details,
provider
FROM azure.key_vault_certificates.certificate_issuers
WHERE issuer_name = '{{ issuer_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
;
List certificate issuers for a specified key vault. The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.
SELECT
id,
provider
FROM azure.key_vault_certificates.certificate_issuers
WHERE vault_name = '{{ vault_name }}' -- required
AND maxresults = '{{ maxresults }}'
;
UPDATE examples
- update_certificate_issuer
Updates the specified certificate issuer. The UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers permission.
UPDATE azure.key_vault_certificates.certificate_issuers
SET
provider = '{{ provider }}',
credentials = '{{ credentials }}',
org_details = '{{ org_details }}',
attributes = '{{ attributes }}'
WHERE
issuer_name = '{{ issuer_name }}' --required
AND vault_name = '{{ vault_name }}' --required
RETURNING
id,
attributes,
credentials,
org_details,
provider;
REPLACE examples
- set_certificate_issuer
Sets the specified certificate issuer. The SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission.
REPLACE azure.key_vault_certificates.certificate_issuers
SET
provider = '{{ provider }}',
credentials = '{{ credentials }}',
org_details = '{{ org_details }}',
attributes = '{{ attributes }}'
WHERE
issuer_name = '{{ issuer_name }}' --required
AND vault_name = '{{ vault_name }}' --required
AND provider = '{{ provider }}' --required
RETURNING
id,
attributes,
credentials,
org_details,
provider;
DELETE examples
- delete_certificate_issuer
Deletes the specified certificate issuer. The DeleteCertificateIssuer operation permanently removes the specified certificate issuer from the vault. This operation requires the certificates/manageissuers/deleteissuers permission.
DELETE FROM azure.key_vault_certificates.certificate_issuers
WHERE issuer_name = '{{ issuer_name }}' --required
AND vault_name = '{{ vault_name }}' --required
;