portal_settings

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

Overview

Name	portal_settings
Type	Resource
Id	azure.api_management.portal_settings

Fields

The following fields are returned by SELECT queries:

list_by_service

Lists a collection of Portal Settings entities.

Name	Datatype	Description
properties	object	Portal Settings contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_service	select	resourceGroupName, serviceName, subscriptionId		Lists a collection of portalsettings defined within a service instance..

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

list_by_service

Lists a collection of portalsettings defined within a service instance..

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