tenants

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

Overview

Name	tenants
Type	Resource
Id	azure.subscription.tenants

Fields

The following fields are returned by SELECT queries:

list

OK - Returns an array of tenants.

Name	Datatype	Description
id	string	The fully qualified ID of the tenant. For example, /tenants/00000000-0000-0000-0000-000000000000.
country	string	The country/region name of the address for the tenant.
countryCode	string	The Country/region abbreviation for the tenant.
defaultDomain	string	The default domain for the tenant.
displayName	string	The display name of the tenant.
domains	string	The list of domains for the tenant.
tenantCategory	string	The category of the tenant. Possible values are TenantCategoryHome,TenantCategoryProjectedBy,TenantCategoryManagedBy
tenantId	string	The tenant ID. For example, 00000000-0000-0000-0000-000000000000.
tenantType	string	The tenant type. Only available for Home tenant category.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select			Gets the tenants for your account.

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

SELECT examples

list

Gets the tenants for your account.

SELECT
id,
country,
countryCode,
defaultDomain,
displayName,
domains,
tenantCategory,
tenantId,
tenantType
FROM azure.subscription.tenants
;