workspace_policy_fragments

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

Overview

Name	workspace_policy_fragments
Type	Resource
Id	azure.api_management.workspace_policy_fragments

Fields

The following fields are returned by SELECT queries:

get

Successfully returned a policy fragment.

Name	Datatype	Description
properties	object	Properties of the Policy Fragment.

list_by_service

Successfully returned an array of policy fragments.

Name	Datatype	Description
properties	object	Properties of the Policy Fragment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, workspaceId, id, subscriptionId	format	Gets a policy fragment.
list_by_service	select	resourceGroupName, serviceName, workspaceId, subscriptionId	$filter, $orderby, $top, $skip	Gets all policy fragments defined within a workspace.
create_or_update	insert	resourceGroupName, serviceName, workspaceId, id, subscriptionId	If-Match	Creates or updates a policy fragment.
delete	delete	resourceGroupName, serviceName, workspaceId, id, If-Match, subscriptionId		Deletes a 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
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.
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.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter, orderBy | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| value | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$orderby	string	OData order by query option.
$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.
format	string	Policy fragment content format.

SELECT examples

get

Gets a policy fragment.

SELECT
properties
FROM azure.api_management.workspace_policy_fragments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceId = '{{ workspaceId }}' -- required
AND id = '{{ id }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND format = '{{ format }}'
;

list_by_service

Gets all policy fragments defined within a workspace.

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

INSERT examples

create_or_update

Creates or updates a policy fragment.

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

Manifest

# Description fields are for documentation purposes
- name: workspace_policy_fragments
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspace_policy_fragments resource.
    - name: serviceName
      value: string
      description: Required parameter for the workspace_policy_fragments resource.
    - name: workspaceId
      value: string
      description: Required parameter for the workspace_policy_fragments resource.
    - name: id
      value: string
      description: Required parameter for the workspace_policy_fragments resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the workspace_policy_fragments resource.
    - name: properties
      value: object
      description: |
        Properties of the Policy Fragment.
    - 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 a policy fragment.

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