workspace_subscription_secrets

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

Overview

Name	workspace_subscription_secrets
Type	Resource
Id	azure.api_management.workspace_subscription_secrets

Fields

The following fields are returned by SELECT queries:

list

The response body contains subscription keys.

Name	Datatype	Description
primaryKey	string	Subscription primary key.
secondaryKey	string	Subscription secondary key.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resourceGroupName, serviceName, workspaceId, sid, subscriptionId		Gets the specified Subscription keys.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
sid	string	Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
subscriptionId	string	The ID of the target subscription.
workspaceId	string	Workspace identifier. Must be unique in the current API Management service instance.

SELECT examples

list

Gets the specified Subscription keys.

SELECT
primaryKey,
secondaryKey
FROM azure.api_management.workspace_subscription_secrets
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceId = '{{ workspaceId }}' -- required
AND sid = '{{ sid }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;