Add-EntraEnvironment
Adds Microsoft Entra environment to the settings file.
Syntax
Add Entra Environment Name
Add-EntraEnvironment
[-Name] <String>
[-AzureADEndpoint] <String>
[-GraphEndpoint] <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Adds Microsoft Entra environment to the settings file.
Examples
Example 1: Add a user defined environment
$name = 'Canary'
$graphEndpoint = 'https://canary.graph.microsoft.com'
$azureADEndpoint = 'https://login.microsoftonline.com'
Add-EntraEnvironment -Name $name -GraphEndpoint $graphEndpoint -AzureADEndpoint $azureADEndpoint
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
Parameter properties
Type: | undefined |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | True |
Value from pipeline: | True |
Value from pipeline by property name: | True |
Value from remaining arguments: | False |
-GraphEndpoint
Specifies the GraphEndpoint URL of an environment
Parameter properties
Type: | undefined |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | True |
Value from pipeline: | True |
Value from pipeline by property name: | True |
Value from remaining arguments: | False |
-Name
Specifies the name of an environment
Parameter properties
Type: | undefined |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | True |
Value from pipeline: | True |
Value from pipeline by property name: | True |
Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.