workspace_policy_fragment_references

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

Overview

Name	workspace_policy_fragment_references
Type	Resource
Id	azure.api_management.workspace_policy_fragment_references

Fields

The following fields are returned by SELECT queries:

list

Successfully returned an array of references to policy resources that include the policy fragment in their definitions.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resourceGroupName, serviceName, workspaceId, id, subscriptionId	$top, $skip	Lists policy resources that reference the policy fragment.

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
id	string	A resource identifier.
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.
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.

SELECT examples

list

Lists policy resources that reference the policy fragment.

SELECT
id,
name,
type
FROM azure.api_management.workspace_policy_fragment_references
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceId = '{{ workspaceId }}' -- required
AND id = '{{ id }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;