Get-AzTenant

  • Reference
Module:
Az.Accounts

Gets tenants that are authorized for the current user.

Syntax

Get-AzTenant
   [[-TenantId] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzTenant cmdlet gets tenants authorized for the current user.

Examples

Example 1: Getting all tenants

Connect-AzAccount
Get-AzTenant

Id                                   Name        Category Domains
--                                   ----------- -------- -------
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft   Home     {test0.com, test1.com, test2.microsoft.com, test3.microsoft.com...}
yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy Testhost    Home     testhost.onmicrosoft.com

This example shows how to get all of the authorized tenants of an Azure account.

Example 2: Getting a specific tenant

Connect-AzAccount
Get-AzTenant -TenantId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Id                                   Name        Category Domains
--                                   ----------- -------- -------
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft   Home     {test0.com, test1.com, test2.microsoft.com, test3.microsoft.com...}

This example shows how to get a specific authorized tenant of an Azure account.

Parameters

-DefaultProfile

The credentials, tenant and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TenantId

Specifies the ID of the tenant that this cmdlet gets.

Type:String
Aliases:Domain, Tenant
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Outputs

PSAzureTenant