Edit

Share via

Get-EntraEnvironment

  • Reference
Module:
Microsoft.Graph.Entra

Gets global public Environments.

Syntax

Get-EntraEnvironment 
 []
Get-EntraEnvironment
    -Name <String> 
   [<CommonParameters>]

Description

When you use Connect-Entra, you can choose to target other environments. By default, Connect-Entra targets the global public cloud.

Examples

Example 1: Get a list of public cloud environments

Get-EntraEnvironment

Name     AzureADEndpoint                   GraphEndpoint                           Type
----     ---------------                   -------------                           ----
Global   https://login.microsoftonline.com https://graph.microsoft.com             Built-in
China    https://login.chinacloudapi.cn    https://microsoftgraph.chinacloudapi.cn Built-in
USGovDoD https://login.microsoftonline.us  https://dod-graph.microsoft.us          Built-in
USGov    https://login.microsoftonline.us  https://graph.microsoft.us              Built-in
Germany  https://login.microsoftonline.de  https://graph.microsoft.de              Built-in
Canary   https://login.microsoftonline.com https://canary.graph.microsoft.com      User-defined

This command retrieves a list of global public Environments.

Example 2: Get a specific environment created

Get-EntraEnvironment -Name 'Global'

Name   AzureADEndpoint                   GraphEndpoint               Type
----   ---------------                   -------------               ----
Global https://login.microsoftonline.com https://graph.microsoft.com Built-in

This command retrieves an environment with the specified name.

Parameters

-Name

Specifies the name of an environment

Type:undefined
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False