certificates

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

Overview

Name	certificates
Type	Resource
Id	azure.api_management.certificates

Fields

vw_certificates

Name	Datatype	Description
certificateId	text	field from the properties object
expiration_date	text	field from the properties object
key_vault	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
subject	text	field from the properties object
subscriptionId	text	field from the properties object
thumbprint	text	field from the properties object

certificates

Name	Datatype	Description
properties	object	Properties of the Certificate contract.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	certificateId, resourceGroupName, serviceName, subscriptionId	Gets the details of the certificate specified by its identifier.
list_by_service	SELECT	resourceGroupName, serviceName, subscriptionId	Lists a collection of all certificates in the specified service instance.
create_or_update	INSERT	certificateId, resourceGroupName, serviceName, subscriptionId	Creates or updates the certificate being used for authentication with the backend.
delete	DELETE	If-Match, certificateId, resourceGroupName, serviceName, subscriptionId	Deletes specific certificate.
refresh_secret	EXEC	certificateId, resourceGroupName, serviceName, subscriptionId	From KeyVault, Refresh the certificate being used for authentication with the backend.

SELECT examples

Lists a collection of all certificates in the specified service instance.

vw_certificates

SELECT
certificateId,
expiration_date,
key_vault,
resourceGroupName,
serviceName,
subject,
subscriptionId,
thumbprint
FROM azure.api_management.vw_certificates
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

certificates

SELECT
properties
FROM azure.api_management.certificates
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new certificates resource.

All Properties

/*+ create */
INSERT INTO azure.api_management.certificates (
certificateId,
resourceGroupName,
serviceName,
subscriptionId,
properties
)
SELECT 
'{{ certificateId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: data
          value: string
        - name: password
          value: string
        - name: keyVault
          value:
            - name: secretIdentifier
              value: string
            - name: identityClientId
              value: string

DELETE example

Deletes the specified certificates resource.

/*+ delete */
DELETE FROM azure.api_management.certificates
WHERE If-Match = '{{ If-Match }}'
AND certificateId = '{{ certificateId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';