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

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.
enabled	boolean	Redirect Anonymous users to the Sign-In page.
subscriptions	object	Subscriptions delegation settings.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
termsOfService	object	Terms of service contract properties.
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
list_by_service	select	resource_group_name, service_name, subscription_id		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
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

list_by_service

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

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