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

The following fields are returned by SELECT queries:

get

The developer portal configuration.

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

list_by_service

The developer portal configuration.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName, portalConfigId		Get the developer portal configuration.
list_by_service	select	resourceGroupName, serviceName, subscriptionId		Lists the developer portal configurations.
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, portalConfigId, If-Match		Create or update the developer portal configuration.
update	update	subscriptionId, resourceGroupName, serviceName, portalConfigId, If-Match		Update 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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
portalConfigId	string	Portal configuration identifier.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get the developer portal configuration.

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

list_by_service

Lists the developer portal configurations.

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

INSERT examples

create_or_update

Create or update the developer portal configuration.

INSERT INTO azure.api_management.portal_configs (
data__properties,
subscriptionId,
resourceGroupName,
serviceName,
portalConfigId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ portalConfigId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: portal_configs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the portal_configs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the portal_configs resource.
    - name: serviceName
      value: string
      description: Required parameter for the portal_configs resource.
    - name: portalConfigId
      value: string
      description: Required parameter for the portal_configs resource.
    - name: If-Match
      value: string
      description: Required parameter for the portal_configs resource.
    - name: properties
      value: object
      description: |
        The developer portal configuration contract properties.

UPDATE examples

update

Update the developer portal configuration.

UPDATE azure.api_management.portal_configs
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND portalConfigId = '{{ portalConfigId }}' --required
AND If-Match = '{{ If-Match }}' --required
RETURNING
properties;