tenant_settings

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

Overview

Name	tenant_settings
Type	Resource
Id	azure.api_management.tenant_settings

Fields

The following fields are returned by SELECT queries:

get

Tenant Settings.

Name	Datatype	Description
properties	object	TenantSettings entity contract properties.

list_by_service

Lists a collection of TenantSettings entities.

Name	Datatype	Description
properties	object	TenantSettings entity contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, subscriptionId, settingsType		Get tenant settings.
list_by_service	select	resourceGroupName, serviceName, subscriptionId	$filter	Public settings.

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.
settingsType	string	The identifier of the settings.
subscriptionId	string	The ID of the target subscription.
$filter	string	Not used

SELECT examples

get

Get tenant settings.

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

list_by_service

Public settings.

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