New-CrmOrganization

Applies To: CRM 2016 on-prem, Dynamics 365 (on-premises)

New-CrmOrganization

Initiates the process to create a new organization in the Microsoft Dynamics 365 deployment.

Syntax

Parameter Set: Default
New-CrmOrganization [-DisplayName] <String> [[-Name] <String> ] [[-BaseCurrencyCode] <String> ] [[-BaseCurrencyName] <String> ] [[-BaseCurrencySymbol] <String> ] [[-BaseCurrencyPrecision] <Int32> ] [[-BaseLanguageCode] <Int32> ] [[-SqlCollation] <String> ] [[-SQMOptIn] <String> ] [-SqlServerName] <String> [-SrsUrl] <String> [[-SysAdminName] <String> ] [-Credential <PSCredential> ] [-Diag] [-DwsServerUrl <String> ] [-Timeout <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The New-CrmOrganization cmdlet initiates the process to create a new organization in the Microsoft Dynamics 365 deployment. This command doesn’t wait for the import to complete. To check for the status of the import, you need to use the Get-CrmOperationStatus cmdlet, passing in the ID returned by the New-CrmOrganization cmdlet, to determine the status of the action.

Parameters

-BaseCurrencyCode<String>

Contains the base currency code for the organization to be created, for example, USD for US dollar.

Aliases	none
Required?	false
Position?	3
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-BaseCurrencyName<String>

Contains the name of the base currency for the organization to be created. If no value is provided for this parameter, the base currency name defaults to the name of the BaseCurrencyCode value.

Aliases	none
Required?	false
Position?	4
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-BaseCurrencyPrecision<Int32>

Specifies the precision of the base currency for the organization to be created. If no value is provided for this parameter, the base currency precision defaults to the precision of the BaseCurrencyCode value.

Aliases	none
Required?	false
Position?	6
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-BaseCurrencySymbol<String>

A string that contains the symbol of the base currency for the organization to be created. If no value is provided for this parameter, the base currency symbol defaults to the symbol of the BaseCurrencyCode value.

Aliases	none
Required?	false
Position?	5
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-BaseLanguageCode<Int32>

Specifies the integer value that maps to the base language for the organization to be created. For example, English is 1033.

Aliases	none
Required?	false
Position?	7
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-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 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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-DisplayName<String>

Contains the display name of the organization to be created. For example, Adventure Works Cycle.

Aliases	none
Required?	true
Position?	1
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>

Contains the unique name of the organization to be created. If no value is provided, the default unique name is generated from the display name. For this parameter, you can’t use spaces and extended characters in the name. So, for example, you could use a name that’s formatted like this: AdventureWorksCycle.

Aliases	none
Required?	false
Position?	2
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-SqlCollation<String>

Specifies the preferred SQL collation that the organization database will use to sort and compare data characters.

Aliases	none
Required?	false
Position?	8
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-SqlServerName<String>

Contains the name of the SQL Server or SQL Server instance on which to create the organization database.

Aliases	none
Required?	true
Position?	10
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-SQMOptIn<String>

Indicates whether the organization will participate in the Microsoft Customer Experience Improvement Program, otherwise known as SQM or CEIP. If not supplied, this value is False.

Aliases	none
Required?	false
Position?	9
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-SrsUrl<String>

Specifies the URL of the Microsoft SQL Server Reporting Services report server for the organization to be created.

Aliases	none
Required?	true
Position?	11
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-SysAdminName<String>

Contains the name of the first user to be created in the new organization. The format of the name must be: domain\username or User@domain. If the parameter isn’t supplied, this defaults to the user name for the currently logged on user.

Aliases	none
Required?	false
Position?	12
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

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

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

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

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 uses default parameters to initiate the process to create a new organization in the Microsoft Dynamics 365 deployment.

PS C:\> $OpId = New-CrmOrganization –DisplayName “MyOrg” –SqlServerName “ContosoSQL” –SrsUrl “http://ContosoReporting/reportserver”

-------------------------- EXAMPLE 2 --------------------------

This example specifies settings in the creation of a new organization in the Microsoft Dynamics 365 deployment.

PS C:\> $idOut2 = New-CrmOrganization –DisplayName “ORG3” –SqlServerName “ContosoSQL” –SrsUrl “http://ContosoReporting/reportserver” -BaseCurencyCode “USD” –BaseCurrencyName “US Dollar” –BaseCurrencySymbol “$” –BaseCurrencyPrecision 2 –BaseLanguageCode 1033 –SqlCollation “Latin1_General_CI_AI” –SQMOptIn $true –Name “ORG3” –SysAdminName Contoso\testuser10