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

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.
settings	object	Tenant settings.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
settings	object	Tenant settings.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, settings_type, subscription_id		Get tenant settings.
list_by_service	select	resource_group_name, service_name, subscription_id	$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
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.
settings_type	string	The identifier of the settings. "public" Required.
subscription_id	string
$filter	string	Not used. Default value is None.

SELECT examples

get

Get tenant settings.

SELECT
id,
name,
settings,
systemData,
type
FROM azure.api_management.tenant_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND settings_type = '{{ settings_type }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Public settings.

SELECT
id,
name,
settings,
systemData,
type
FROM azure.api_management.tenant_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;