api_policies

Creates, updates, deletes, gets or lists an api_policies resource.

Overview

Name	api_policies
Type	Resource
Id	azure.api_management.api_policies

Fields

The following fields are returned by SELECT queries:

get

Api Policy information.

Name	Datatype	Description
properties	object	Properties of the Policy.

list_by_api

Apis Policy Collection.

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, apiId, policyId, subscriptionId	format	Get the policy configuration at the API level.
list_by_api	select	resourceGroupName, serviceName, apiId, subscriptionId		Get the policy configuration at the API level.
create_or_update	insert	resourceGroupName, serviceName, apiId, policyId, subscriptionId	If-Match	Creates or updates policy configuration for the API.
delete	delete	resourceGroupName, serviceName, apiId, policyId, If-Match, subscriptionId		Deletes the policy configuration at the Api.

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.
apiId	string	API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
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 policy configuration at the API level.

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

list_by_api

Get the policy configuration at the API level.

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

INSERT examples

create_or_update

Creates or updates policy configuration for the API.

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

Manifest

# Description fields are for documentation purposes
- name: api_policies
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the api_policies resource.
    - name: serviceName
      value: string
      description: Required parameter for the api_policies resource.
    - name: apiId
      value: string
      description: Required parameter for the api_policies resource.
    - name: policyId
      value: string
      description: Required parameter for the api_policies resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the api_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 policy configuration at the Api.

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