api_policies

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

Overview

Name	api_policies
Type	Resource
Id	azure.api_management.api_policies

Fields

vw_api_policies

Name	Datatype	Description
apiId	text	field from the properties object
format	text	field from the properties object
policyId	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object
value	text	field from the properties object

api_policies

Name	Datatype	Description
properties	object	Policy contract Properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	apiId, policyId, resourceGroupName, serviceName, subscriptionId	Get the policy configuration at the API level.
list_by_api	SELECT	apiId, resourceGroupName, serviceName, subscriptionId	Get the policy configuration at the API level.
create_or_update	INSERT	apiId, policyId, resourceGroupName, serviceName, subscriptionId	Creates or updates policy configuration for the API.
delete	DELETE	If-Match, apiId, policyId, resourceGroupName, serviceName, subscriptionId	Deletes the policy configuration at the Api.

SELECT examples

Get the policy configuration at the API level.

vw_api_policies

SELECT
apiId,
format,
policyId,
resourceGroupName,
serviceName,
subscriptionId,
value
FROM azure.api_management.vw_api_policies
WHERE apiId = '{{ apiId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

api_policies

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

INSERT example

Use the following StackQL query and manifest file to create a new api_policies resource.

All Properties

/*+ create */
INSERT INTO azure.api_management.api_policies (
apiId,
policyId,
resourceGroupName,
serviceName,
subscriptionId,
properties
)
SELECT 
'{{ apiId }}',
'{{ policyId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: value
          value: string
        - name: format
          value: string

DELETE example

Deletes the specified api_policies resource.

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