Edit

Share via

Get-EntraTenantDetail

  • Reference
Module:
Microsoft.Graph.Entra

Gets the details of a tenant.

Syntax

Get-EntraTenantDetail
   [-All]
   [-Top <Int32>]
   [-Property <String[]>]
   [<CommonParameters>]

Description

The Get-EntraTenantDetail cmdlet gets the details of a tenant in Microsoft Entra ID.

In delegated scenarios involving work or school accounts, the signed-in user must be assigned either a supported Microsoft Entra role or a custom role with the necessary permissions. The following least-privileged roles are supported for this operation:

  • Application Administrator
  • Authentication Administrator
  • Cloud Application Administrator
  • Directory Readers
  • Directory Reviewer
  • Global Reader
  • Helpdesk Administrator
  • Security Administrator
  • Security Operator
  • Security Reader
  • Service Support Administrator
  • User Administrator
  • Privileged Role Administrator

Examples

Example 1: Get all tenant details

Connect-Entra -Scopes 'Organization.Read.All' 
Get-EntraTenantDetail -All

DisplayName Id                                   TenantType CountryLetterCode VerifiedDomains
----------- --                                   ---------- ----------------- ---------------
Contoso     aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb AAD        NL                {@{Capabilities=Email, OfficeCommunicationsOnline; IsDefault=False; IsInitial=True; Name=contoso.onmicrosoft.com; Type=Mana...

This example shows how to retrieve all tenant details.

Example 2: Get top one tenant details

Connect-Entra -Scopes 'Organization.Read.All'
Get-EntraTenantDetail -Top 1

DisplayName Id                                   CountryLetterCode VerifiedDomains
----------- --                                   ----------------- ---------------
Contoso     aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb NL                {@{Capabilities=Email, OfficeCommunicationsOnline; IsDefault=False; IsInitial=True; Name=contoso.onmicrosoft.com; Type=Managed; Addition…}}

This example shows how to retrieve details of a top one tenant in Microsoft Entra ID.

Example 3: Get directory tenant size quota

Connect-Entra -Scopes 'Organization.Read.All'
(Get-EntraTenantDetail).AdditionalProperties.directorySizeQuota

Key   Value
---   -----
used    339
total 50000

This example shows how to retrieve the directory tenant size quota.

A directory quota represents the maximum number of objects allowed in a tenant, including user accounts, app registrations, and groups. Once this limit is reached, attempts to create new objects will result in an error.

Parameters

-All

List all pages.

Type:System.Management.Automation.SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Property

Specifies properties to be returned.

Type:System.String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Top

Specifies the maximum number of records to return.

Type:System.Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False