delegation_settings

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

Overview

Name	delegation_settings
Type	Resource
Id	azure.api_management.delegation_settings

Fields

vw_delegation_settings

Name	Datatype	Description
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object
subscriptions	text	field from the properties object
url	text	field from the properties object
user_registration	text	field from the properties object
validation_key	text	field from the properties object

delegation_settings

Name	Datatype	Description
properties	object	Delegation settings contract properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, serviceName, subscriptionId	Get Delegation Settings for the Portal.
create_or_update	INSERT	resourceGroupName, serviceName, subscriptionId	Create or Update Delegation settings.
update	UPDATE	If-Match, resourceGroupName, serviceName, subscriptionId	Update Delegation settings.

SELECT examples

Get Delegation Settings for the Portal.

vw_delegation_settings

SELECT
resourceGroupName,
serviceName,
subscriptionId,
subscriptions,
url,
user_registration,
validation_key
FROM azure.api_management.vw_delegation_settings
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

delegation_settings

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: url
          value: string
        - name: validationKey
          value: string
        - name: subscriptions
          value:
            - name: enabled
              value: boolean
        - name: userRegistration
          value:
            - name: enabled
              value: boolean

UPDATE example

Updates a delegation_settings resource.

/*+ update */
UPDATE azure.api_management.delegation_settings
SET 
properties = '{{ properties }}'
WHERE 
If-Match = '{{ If-Match }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';