Edit

Share via

Add-EntraEnvironment

  • Reference
Module:
Microsoft.Graph.Entra

Adds Microsoft Entra environment to the settings file.

Syntax

Add-EntraEnvironment
     [-Name] <String>
     [-AzureADEndpoint] <String>
     [-GraphEndpoint] <String>
     [-ProgressAction <ActionPreference>]
     [-WhatIf]
     [-Confirm]  
   [<CommonParameters>]

Description

Adds Microsoft Entra environment to the settings file.

Examples

Example 1: Add a user defined environment

$params = @{
    Name = 'Canary'
    GraphEndpoint = 'https://canary.graph.microsoft.com'
    AzureADEndpoint = 'https://login.microsoftonline.com'
}

Add-EntraEnvironment @params

Name     AzureADEndpoint                      GraphEndpoint                 Type
----     ---------------                      -------------                 ----
Canary    https://login.microsoftonline.com   https://microsoftgraph.com User-defined                                                                                    {}

Adds a user-defined Entra environment to the settings file.

Parameters

-AzueADEndpoint

Specifies the AzureADEndpoint URL of an environment

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

-GraphEndpoint

Specifies the GraphEndpoint URL of an environment

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

-Name

Specifies the name of an environment

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