workspace_certificates

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

Overview

Name	workspace_certificates
Type	Resource
Id	azure.api_management.workspace_certificates

Fields

vw_workspace_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
workspaceId	text	field from the properties object

workspace_certificates

Name	Datatype	Description
properties	object	Properties of the Certificate contract.

Methods

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

SELECT examples

Lists a collection of all certificates in the specified workspace.

vw_workspace_certificates

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

workspace_certificates

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.api_management.workspace_certificates (
certificateId,
resourceGroupName,
serviceName,
subscriptionId,
workspaceId,
properties
)
SELECT 
'{{ certificateId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ workspaceId }}',
'{{ 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 workspace_certificates resource.

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