policies

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

Overview

Name	policies
Type	Resource
Id	azure.api_management.policies

Fields

The following fields are returned by SELECT queries:

get

Get the Global policy definition of the Api Management service.

Name	Datatype	Description
properties	object	Properties of the Policy.

list_by_service

Returns an array of Policy Contracts.

Name	Datatype	Description
properties	object	Properties of the Policy.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, policyId, subscriptionId	format	Get the Global policy definition of the Api Management service.
list_by_service	select	resourceGroupName, serviceName, subscriptionId		Lists all the Global Policy definitions of the Api Management service.
create_or_update	insert	resourceGroupName, serviceName, policyId, subscriptionId	If-Match	Creates or updates the global policy configuration of the Api Management service.
delete	delete	resourceGroupName, serviceName, policyId, If-Match, subscriptionId		Deletes the global policy configuration of the Api Management Service.

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.
policyId	string	The identifier of the Policy.
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.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.
format	string	Policy Export Format.

SELECT examples

get

Get the Global policy definition of the Api Management service.

SELECT
properties
FROM azure.api_management.policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND policyId = '{{ policyId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND format = '{{ format }}'
;

list_by_service

Lists all the Global Policy definitions of the Api Management service.

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

INSERT examples

create_or_update

Creates or updates the global policy configuration of the Api Management service.

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

Manifest

# Description fields are for documentation purposes
- name: policies
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the policies resource.
    - name: serviceName
      value: string
      description: Required parameter for the policies resource.
    - name: policyId
      value: string
      description: Required parameter for the policies resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the policies resource.
    - name: properties
      value: object
      description: |
        Properties of the Policy.
    - 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 the global policy configuration of the Api Management Service.

DELETE FROM azure.api_management.policies
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND policyId = '{{ policyId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;