portal_configs

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

Overview

Name	portal_configs
Type	Resource
Id	azure.api_management.portal_configs

Fields

vw_portal_configs

Name	Datatype	Description
cors	text	field from the properties object
csp	text	field from the properties object
delegation	text	field from the properties object
enable_basic_auth	text	field from the properties object
portalConfigId	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
signin	text	field from the properties object
signup	text	field from the properties object
subscriptionId	text	field from the properties object

portal_configs

Name	Datatype	Description
properties	object	The developer portal configuration contract properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	portalConfigId, resourceGroupName, serviceName, subscriptionId	Get the developer portal configuration.
list_by_service	SELECT	resourceGroupName, serviceName, subscriptionId	Lists the developer portal configurations.
create_or_update	INSERT	If-Match, portalConfigId, resourceGroupName, serviceName, subscriptionId	Create or update the developer portal configuration.
update	UPDATE	If-Match, portalConfigId, resourceGroupName, serviceName, subscriptionId	Update the developer portal configuration.

SELECT examples

Lists the developer portal configurations.

vw_portal_configs

SELECT
cors,
csp,
delegation,
enable_basic_auth,
portalConfigId,
resourceGroupName,
serviceName,
signin,
signup,
subscriptionId
FROM azure.api_management.vw_portal_configs
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

portal_configs

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.api_management.portal_configs (
If-Match,
portalConfigId,
resourceGroupName,
serviceName,
subscriptionId,
properties
)
SELECT 
'{{ If-Match }}',
'{{ portalConfigId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: enableBasicAuth
          value: boolean
        - name: signin
          value:
            - name: require
              value: boolean
        - name: signup
          value:
            - name: termsOfService
              value:
                - name: text
                  value: string
                - name: requireConsent
                  value: boolean
        - name: delegation
          value:
            - name: delegateRegistration
              value: boolean
            - name: delegateSubscription
              value: boolean
            - name: delegationUrl
              value: string
            - name: validationKey
              value: string
        - name: cors
          value:
            - name: allowedOrigins
              value:
                - string
        - name: csp
          value:
            - name: mode
              value: string
            - name: reportUri
              value:
                - string
            - name: allowedSources
              value:
                - string

UPDATE example

Updates a portal_configs resource.

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