Share via

Get-CrmOrganizations

Module:
Microsoft.Xrm.Tooling.CrmConnector.PowerShell Module

Returns a list of Dataverse environments or Dynamics 365 Customer Engagement (on-premises) organizations that the current user has access to.

Syntax

OnLine 

Get-CrmOrganizations
    [[-DeploymentRegion] <String>]
    [-OnLineType] <OnlineType>
    [[-Credential] <PSCredential>]
    [[-MaxCrmConnectionTimeOutMinutes] <Int32>]
    [-LogWriteDirectory <String>]
    [-WhatIf]
    [-Confirm]

OnPrem 

Get-CrmOrganizations
    [[-HomeRealmUrl] <Uri>]
    [-ServerUrl] <Uri>
    [[-Credential] <PSCredential>]
    [[-MaxCrmConnectionTimeOutMinutes] <Int32>]
    [-LogWriteDirectory <String>]
    [-WhatIf]
    [-Confirm]

Description

The Get-CrmOrganizations cmdlet returns a list of Dataverse environments or Dynamics 365 Customer Engagement (on-premises) organizations that the current user has access to.

Examples

Example 1

PS C:\> Get-CrmOrganizations -OnLineType Office365 -Credential $cred

Returns a detailed list of all Dataverse environments across all geographic regions that the user has access to.

Example 2

PS C:\> Get-CrmOrganizations -DeploymentRegion NorthAmerica -OnLineType Office365 -Credential $cred

Returns a detailed list of all Dataverse environments in the named geographic region that the user has access to.

Example 3

PS C:\> Get-CrmOrganizations -ServerUrl https://myserver -Credential $cred

Returns a detailed list of all Dynamics 365 Customer Engagement (on-premises) organizations for the named Dynamics 365 server.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Credential

User credential for signing in to Dataverse or Dynamics 365 Customer Engagement (on-premises). For information about how to create this object, see Overview.

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-DeploymentRegion

Geographic region of your Dataverse environment. Valid values are NorthAmerica, EMEA, APAC, SouthAmerica, Oceania, JPN, CAN, IND, and NorthAmerica2.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

OnLine
Position:4
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-HomeRealmUrl

URI of the WS-Trust metadata endpoint.

Parameter properties

Type:Uri
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

OnPrem
Position:3
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-LogWriteDirectory

Custom directory location to store the cmdlet log files. The directory must already exist, and the user who is running the cmdlet must have Write permission to the directory. You must also use the -Verbose parameter along with the -LogWriteDirectory parameter to be able to store the log files in a custom location.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-MaxCrmConnectionTimeOutMinutes

Maximum number in minutes to wait before quitting the operation.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:20
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-OnLineType

Type of online service. Valid value is Office365.

Parameter properties

Type:OnlineType
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

OnLine
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-ServerUrl

URL of the Dynamics 365 Customer Engagement (on-premises) server specified in the format https://<server>:<port>.

Parameter properties

Type:Uri
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

OnPrem
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

Inputs

System.String

System.Uri Microsoft.Xrm.Tooling.CrmConnector.Powershell.CommandsCommonAuth+OnlineType System.Management.Automation.PSCredential System.Int32

Outputs

System.Object