portal_config

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

Overview

Name	portal_config
Type	Resource
Id	azure.api_management.portal_config

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.
cors	object	The developer portal Cross-Origin Resource Sharing (CORS) settings.
csp	object	The developer portal Content Security Policy (CSP) settings.
delegation	object	The developer portal delegation settings.
enableBasicAuth	boolean	Enable or disable Basic authentication method.
signin	object	:vartype signin: ~azure.mgmt.apimanagement.models.PortalConfigPropertiesSignin
signup	object	:vartype signup: ~azure.mgmt.apimanagement.models.PortalConfigPropertiesSignup
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".

list_by_service

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.
cors	object	The developer portal Cross-Origin Resource Sharing (CORS) settings.
csp	object	The developer portal Content Security Policy (CSP) settings.
delegation	object	The developer portal delegation settings.
enableBasicAuth	boolean	Enable or disable Basic authentication method.
signin	object	:vartype signin: ~azure.mgmt.apimanagement.models.PortalConfigPropertiesSignin
signup	object	:vartype signup: ~azure.mgmt.apimanagement.models.PortalConfigPropertiesSignup
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, portal_config_id, subscription_id		Get the developer portal configuration.
list_by_service	select	resource_group_name, service_name, subscription_id		Lists the developer portal configurations.
create_or_update	insert	resource_group_name, service_name, portal_config_id, subscription_id		Create or update the developer portal configuration.
update	update	resource_group_name, service_name, portal_config_id, subscription_id		Update the developer portal configuration.
create_or_update	replace	resource_group_name, service_name, portal_config_id, subscription_id		Create or update the developer portal configuration.
get_entity_tag	exec	resource_group_name, service_name, portal_config_id, subscription_id		Gets the entity state (Etag) version of the developer portal configuration.

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
portal_config_id	string	Portal configuration identifier. Required.
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 the developer portal configuration.

SELECT
id,
name,
cors,
csp,
delegation,
enableBasicAuth,
signin,
signup,
systemData,
type
FROM azure.api_management.portal_config
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND portal_config_id = '{{ portal_config_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists the developer portal configurations.

SELECT
id,
name,
cors,
csp,
delegation,
enableBasicAuth,
signin,
signup,
systemData,
type
FROM azure.api_management.portal_config
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 the developer portal configuration.

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

Manifest

# Description fields are for documentation purposes
- name: portal_config
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the portal_config resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the portal_config resource.
  - name: portal_config_id
    value: "{{ portal_config_id }}"
    description: Required parameter for the portal_config resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the portal_config resource.
  - name: properties
    description: |
      The developer portal configuration contract properties.
    value:
      enableBasicAuth: {{ enableBasicAuth }}
      signin:
        require: {{ require }}
      signup:
        termsOfService:
          text: "{{ text }}"
          requireConsent: {{ requireConsent }}
      delegation:
        delegateRegistration: {{ delegateRegistration }}
        delegateSubscription: {{ delegateSubscription }}
        delegationUrl: "{{ delegationUrl }}"
        validationKey: "{{ validationKey }}"
      cors:
        allowedOrigins:
          - "{{ allowedOrigins }}"
      csp:
        mode: "{{ mode }}"
        reportUri:
          - "{{ reportUri }}"
        allowedSources:
          - "{{ allowedSources }}"

UPDATE examples

update

Update the developer portal configuration.

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

REPLACE examples

create_or_update

Create or update the developer portal configuration.

REPLACE azure.api_management.portal_config
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND portal_config_id = '{{ portal_config_id }}' --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 developer portal configuration.

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