Get-CrmOrganization
Applies To: CRM 2015 on-prem
Get-CrmOrganization
Retrieves one or all of the organizations in the Microsoft Dynamics CRM deployment.
Syntax
Parameter Set: Default
Get-CrmOrganization [[-Name] <String> ] [-Credential <PSCredential> ] [-Diag] [-DwsServerUrl <String> ] [-Timeout <Int32> ] [ <CommonParameters>]
Detailed Description
The Get-CrmOrganization cmdlet retrieves one or all of the organizations in the deployment. If no parameters are provided, the cmdlet retrieves all organizations in the deployment. If the Name parameter is provided, the cmdlet retrieves the organization with the specified name.
Parameters
-Credential<PSCredential>
Specifies the credentials used to log in to the Deployment web service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Diag
Turns on stack traces for error reports returned from Microsoft Dynamics CRM service calls. Enabling this emits a detailed error message, including a stack trace, when an error is encountered by the CRM PowerShell command.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-DwsServerUrl<String>
Identifies the location of the Deployment web service.This should be in the format: http://<serverurl> or https://<serverurl>, for example, http://contoso.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the unique name of the Microsoft Dynamics CRM organization to return. You can find the name in the Organization.UniqueName property. If this parameter is supplied, the specified organization is returned. Otherwise, all organizations are returned.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Timeout<Int32>
For internal use only.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
-------------------------- EXAMPLE 1 --------------------------
This example retrieves the organization object.
PS C:\> Get-CrmOrganization
-------------------------- EXAMPLE 2 --------------------------
This example retrieves the “org1” organization.
PS C:\> Get-CrmOrganization org1