Share via


Get-CrmOrganization

Retrieves information for one or all of the organizations in the Dynamics 365 deployment.

Syntax

Default (Default)

Get-CrmOrganization
    [[-Name] <String>]
    [-Timeout <Int32>]
    [-Diag]
    [-Credential <PSCredential>]
    [-DwsServerUrl <String>]

Description

The Get-CrmOrganization cmdlet retrieves information for one or all of the organizations in the deployment. If no parameters are provided, the cmdlet retrieves details for all organizations in the deployment. If the Name parameter is provided, the cmdlet retrieves the organization with the specified name.

Examples

Example 1

PS C:\> Get-CrmOrganization

Retrieves information for all organizations in the deployment.

Example 2

PS C:\> Get-CrmOrganization -Name org1

Retrieves details for the org1 organization.

Parameters

-Credential

Expects a variable that contains the user credentials used for signing in to Dynamics 365 on-premises organization. To establish this variable, run the PowerShell command $Cred = Get-Credential.

Parameter properties

Type:PSCredential
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

-Diag

Turns on stack traces for error reports returned from Dynamics 365 service calls. Enabling this emits a detailed error message, including a stack trace, when an error is encountered by the Dynamics 365 PowerShell command.

Parameter properties

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

Parameter sets

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

-DwsServerUrl

The URL of the Deployment Web Service. This should be in the format: https://<serverurl>, for example, https://contoso.

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

-Name

The unique name of the Dynamics 365 organization.

Parameter properties

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

Parameter sets

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

-Timeout

For internal use only.

Parameter properties

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

Parameter sets

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

Inputs

System.String

System.Int32

System.Management.Automation.SwitchParameter

System.Management.Automation.PSCredential

Outputs

Microsoft.Xrm.Sdk.Deployment.Organization