As an organization administrator, you can configure a list of connections to ArcGIS for your enterprise organization members.
You can configure one or more ArcGISConnectionInfo connections using PowerShell functions that contain a URL string and a title. These are used by licensed organization members at sign in. The URL string determines the ArcGIS Online or ArcGIS Enterprise instance to which a user is connected when they create a map using a Microsoft 365 product integrated with ArcGIS.
Organization members can determine the ArcGIS connection by selecting one from a list of connections at the ArcGIS sign-in prompt. See Sign in to an ArcGIS account for more information.
Set up is a one-time process performed by the tenant administrator. All ArcGISConnectionInfo related PowerShell functions use the Microsoft.Graph module.
Install and configure enterprise connections
To install and configure enterprise connections, complete the following steps:
- Ensure that the Microsoft.Graph module is installed.
The Microsoft.Graph module is used to call MSGraph API to configure organization-level open extensions. See the Microsoft Install the Microsoft Graph PowerShell SDK article for more information about this module.
- Run the following Windows PowerShell command
line as a system administrator to run the Install-Module
cmdlet:
Install-Module -Name Microsoft.Graph - Run the following cmdlet to install the ArcGIS.Microsoft365 module:
Install-Module -Name ArcGIS.Microsoft365 - Run the following cmdlet to add the module to the current session:
Import-Module .\ArcGIS.Microsoft365.psm1 -Force - Run the following cmdlet to allow remotely signed PowerShell cmdlets and functions:
Set-ExecutionPolicy RemoteSigned
Manage ArcGIS connections
Tenant administrators manage the connections used by organization members to sign in to ArcGIS for Microsoft 365 products.
Sign in to Microsoft Azure in the PowerShell command line session with the following cmdlet before using ArcGIS.Microsoft365 PowerShell module functions:Connect-MgGraph -Scopes "Organization.ReadWrite.All"
Once signed in to Microsoft Azure, tenant administrators can configure a list of ArcGIS connections for organization members. This list is shown as a drop-down menu when users sign in using a Microsoft 365 product integrated with ArcGIS.
The tenant administrator can use PowerShell to create, edit, remove, clear, display, or export configured ArcGISConnectionInfo connections. The following tables list the available PowerShell functions:
Set a new ArcGIS connection
| Function | Required/optional | Description |
|---|---|---|
Command: New-ArcGISConnection -ArcGISConnectionUrl [ARCGIS_CONNECTION_URL_STRING] -ArcGISConnectionTitle [ARCGIS_CONNECTION_TITLE] [-Default] | ||
-ArcGISConnectionUrl | Required | Set the URL path for the new connection. |
-ArcGISConnectionTitle | Required | Set a title for the new connection. |
-Default | Optional | Set this connection as the default (shown first at sign in). |
Examples:
| ||
Set ArcGIS Online connection permission
| Function | Required/optional | Description |
|---|---|---|
Command: Set-ArcGISOnlineConnectionPermission [- allow] [- disallow] | ||
-ArcGISOnlineConnecionPermission | Required | Specify if the user can connect to ArcGIS Online. |
-allow or -disallow | One of the functions is required. | This function either allows or disallows the user to connect to an ArcGIS Online organization that was not set up by the tenant administrator. |
Set custom URL connection permissions
| Function | Required/optional | Description |
|---|---|---|
Command: Set-CustomURLConnectionPermission [- allow] [- disallow] | ||
-CustomURLConnectionPermission | Required | Specify if the user can use custom URL connections. |
-allow or -disallow | One of the functions is required. | This function either allows or disallows the user to manually enter custom Enterprise connections. If disallowed, this ensures that the user can only access URLs set up by the tenant administrator. |
Update connection information
| Function | Required/optional | Description |
|---|---|---|
Command: Update-ArcGISConnection -ArcGISConnectionUrl [ARCGIS_CONNECTION_URL_STRING] -ArcGISConnectionTitle [ARCGIS_CONNECTION_TITLE] [-Default] | ||
-ArcGISConnectionUrl | Required | Specify an existing URL path for this connection. Caution:The URL must match an existing connection or this command will fail. |
-ArcGISConnectionTitle | Required | Specify the new title to use or update for this connection. |
-Default | Optional | Set this connection as the default (shown first at sign in). |
Example: Update-ArcGISConnection -ArcGISConnectionUrl "https://xxx.maps.arcgis.com" -ArcGISConnectionTitle "My org 2022" -Default | ||
Show existing connections
| Command | Description | |
|---|---|---|
Show-ArcGISConnections | Display all available connections in PowerShell. | |
Remove a connection
| Function | Required/optional | Description |
|---|---|---|
Command: Remove-ArcGISConnection ArcGISConnectionTitle [ARCGIS_CONNECTION_TITLE] | ||
-ArcGISConnectionTitle | Required | Specify a single connection to remove from the existing connections. |
Example: Remove-ArcGISConnection -ArcGISConnectionTitle "My org 2022" | ||
Clear ArcGIS connection
| Command | Description | |
|---|---|---|
Clear-AllTenantArcGISConnections | Remove all added ArcGIS Online and ArcGIS Enterprise connection strings set up by the tenant administrator. | |
Reset all ArcGIS connection settings
| Command | Description | |
|---|---|---|
Reset-TenantArcGISSettings | Reset all settings and restore connection settings to defaults. If you previously disallowed ArcGIS Online or custom ArcGIS connections, these settings are reverted to the default of permitting these connections. | |
Export connections
| Command | Description | |
|---|---|---|
Export-ArcGISConnections | Export all connections to a local .txt file. | |