workspace_policy_fragment

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

Overview

Name	workspace_policy_fragment
Type	Resource
Id	azure.api_management.workspace_policy_fragment

Fields

The following fields are returned by SELECT queries:

get

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.
description	string	Policy fragment description.
format	string	Format of the policy fragment content. Known values are: "xml" and "rawxml". (xml, rawxml)
provisioningState	string	The provisioning state.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
value	string	Contents of the policy fragment. Required.

list_by_service

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.
description	string	Policy fragment description.
format	string	Format of the policy fragment content. Known values are: "xml" and "rawxml". (xml, rawxml)
provisioningState	string	The provisioning state.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
value	string	Contents of the policy fragment. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, workspace_id, id, subscription_id	format	Gets a policy fragment.
list_by_service	select	resource_group_name, service_name, workspace_id, subscription_id	$filter, $orderby, $top, $skip	Gets all policy fragments defined within a workspace.
create_or_update	insert	resource_group_name, service_name, workspace_id, id, subscription_id		Creates or updates a policy fragment.
create_or_update	replace	resource_group_name, service_name, workspace_id, id, subscription_id		Creates or updates a policy fragment.
delete	delete	resource_group_name, service_name, workspace_id, id, subscription_id		Deletes a policy fragment.
get_entity_tag	exec	resource_group_name, service_name, workspace_id, id, subscription_id		Gets the entity state (Etag) version of a policy fragment.
list_references	exec	resource_group_name, service_name, workspace_id, id, subscription_id	$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. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
workspace_id	string	Workspace identifier. Must be unique in the current API Management service instance. Required.
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter, orderBy | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || value | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |. Default value is None.
$orderby	string	OData order by query option. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.
format	string	Policy fragment content format. Known values are: "xml" and "rawxml". Default value is None.

SELECT examples

get

Gets a policy fragment.

SELECT
id,
name,
description,
format,
provisioningState,
systemData,
type,
value
FROM azure.api_management.workspace_policy_fragment
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND id = '{{ id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND format = '{{ format }}'
;

list_by_service

Gets all policy fragments defined within a workspace.

SELECT
id,
name,
description,
format,
provisioningState,
systemData,
type,
value
FROM azure.api_management.workspace_policy_fragment
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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_fragment (
properties,
resource_group_name,
service_name,
workspace_id,
id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ workspace_id }}',
'{{ id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace_policy_fragment
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace_policy_fragment resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the workspace_policy_fragment resource.
  - name: workspace_id
    value: "{{ workspace_id }}"
    description: Required parameter for the workspace_policy_fragment resource.
  - name: id
    value: "{{ id }}"
    description: Required parameter for the workspace_policy_fragment resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_policy_fragment resource.
  - name: properties
    description: |
      Properties of the Policy Fragment.
    value:
      value: "{{ value }}"
      description: "{{ description }}"
      format: "{{ format }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates a policy fragment.

REPLACE azure.api_management.workspace_policy_fragment
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND id = '{{ id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a policy fragment.

DELETE FROM azure.api_management.workspace_policy_fragment
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND workspace_id = '{{ workspace_id }}' --required
AND id = '{{ id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

Gets the entity state (Etag) version of a policy fragment.

EXEC azure.api_management.workspace_policy_fragment.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@workspace_id='{{ workspace_id }}' --required, 
@id='{{ id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_references

Lists policy resources that reference the policy fragment.

EXEC azure.api_management.workspace_policy_fragment.list_references 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@workspace_id='{{ workspace_id }}' --required, 
@id='{{ id }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$top='{{ $top }}', 
@$skip='{{ $skip }}'
;