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

The following fields are returned by SELECT queries:

get

The response body contains the specified Certificate entity.

Name	Datatype	Description
properties	object	Certificate properties details.

list_by_workspace

Returns a collection of Certificate entity.

Name	Datatype	Description
properties	object	Certificate properties details.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, workspaceId, certificateId, subscriptionId		Gets the details of the certificate specified by its identifier.
list_by_workspace	select	resourceGroupName, serviceName, workspaceId, subscriptionId	$filter, $top, $skip, isKeyVaultRefreshFailed	Lists a collection of all certificates in the specified workspace.
create_or_update	insert	resourceGroupName, serviceName, workspaceId, certificateId, subscriptionId	If-Match	Creates or updates the certificate being used for authentication with the backend.
delete	delete	resourceGroupName, serviceName, workspaceId, certificateId, If-Match, subscriptionId		Deletes specific certificate.
refresh_secret	exec	resourceGroupName, serviceName, workspaceId, certificateId, subscriptionId		From KeyVault, Refresh the certificate being used for authentication with the backend.

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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
certificateId	string	Identifier of the certificate entity. Must be unique in the current API Management service instance.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
workspaceId	string	Workspace identifier. Must be unique in the current API Management service instance.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| expirationDate | filter | ge, le, eq, ne, gt, lt | |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.
isKeyVaultRefreshFailed	boolean	When set to true, the response contains only certificates entities which failed refresh.

SELECT examples

get

Gets the details of the certificate specified by its identifier.

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

list_by_workspace

Lists a collection of all certificates in the specified workspace.

SELECT
properties
FROM azure.api_management.workspace_certificates
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceId = '{{ workspaceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND isKeyVaultRefreshFailed = '{{ isKeyVaultRefreshFailed }}'
;

INSERT examples

create_or_update

Creates or updates the certificate being used for authentication with the backend.

INSERT INTO azure.api_management.workspace_certificates (
data__properties,
resourceGroupName,
serviceName,
workspaceId,
certificateId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ workspaceId }}',
'{{ certificateId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: workspace_certificates
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspace_certificates resource.
    - name: serviceName
      value: string
      description: Required parameter for the workspace_certificates resource.
    - name: workspaceId
      value: string
      description: Required parameter for the workspace_certificates resource.
    - name: certificateId
      value: string
      description: Required parameter for the workspace_certificates resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the workspace_certificates resource.
    - name: properties
      value: object
      description: |
        Certificate create or update properties details.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

DELETE examples

delete

Deletes specific certificate.

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

Lifecycle Methods

refresh_secret

From KeyVault, Refresh the certificate being used for authentication with the backend.

EXEC azure.api_management.workspace_certificates.refresh_secret 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@workspaceId='{{ workspaceId }}' --required, 
@certificateId='{{ certificateId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;