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

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.
subscriptions	object	Subscriptions delegation settings.
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".
url	string	A delegation Url.
userRegistration	object	User registration delegation settings.
validationKey	string	A base64-encoded validation key to validate, that a request is coming from Azure API Management.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, subscription_id		Get Delegation Settings for the Portal.
create_or_update	insert	resource_group_name, service_name, subscription_id		Create or Update Delegation settings.
update	update	resource_group_name, service_name, subscription_id		Update Delegation settings.
create_or_update	replace	resource_group_name, service_name, subscription_id		Create or Update Delegation settings.
get_entity_tag	exec	resource_group_name, service_name, subscription_id		Gets the entity state (Etag) version of the DelegationSettings.
list_secrets	exec	resource_group_name, service_name, subscription_id		Gets the secret validation key of the DelegationSettings.

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
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

SELECT examples

get

Get Delegation Settings for the Portal.

SELECT
id,
name,
subscriptions,
systemData,
type,
url,
userRegistration,
validationKey
FROM azure.api_management.delegation_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or Update Delegation settings.

INSERT INTO azure.api_management.delegation_settings (
properties,
resource_group_name,
service_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: delegation_settings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the delegation_settings resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the delegation_settings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the delegation_settings resource.
  - name: properties
    description: |
      Delegation settings contract properties.
    value:
      url: "{{ url }}"
      validationKey: "{{ validationKey }}"
      subscriptions:
        enabled: {{ enabled }}
      userRegistration:
        enabled: {{ enabled }}

UPDATE examples

update

Update Delegation settings.

UPDATE azure.api_management.delegation_settings
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required;

REPLACE examples

create_or_update

Create or Update Delegation settings.

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

Lifecycle Methods

get_entity_tag

Gets the entity state (Etag) version of the DelegationSettings.

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

list_secrets

Gets the secret validation key of the DelegationSettings.

EXEC azure.api_management.delegation_settings.list_secrets 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;