New-CrmOrganization
Initiates the process to create a new organization in the Dynamics 365 deployment.
Syntax
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>]
[-Timeout <Int32>]
[-Diag]
[-Credential <PSCredential>]
[-DwsServerUrl <String>]
[-WhatIf]
[-Confirm] Description
The New-CrmOrganization cmdlet initiates the process to create a new organization in the 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.
Examples
Example 1
PS C:\> $OpId = New-CrmOrganization -DisplayName “My Org” -SqlServerName “ContosoSQL” -SrsUrl “http://ContosoReporting/reportserver”Uses default parameters to initiate the process to create a new organization in the Dynamics 365 deployment. Run the PowerShell command Get-CrmOperationStatus -OperationId $OpId to monitor progress status.
Example 1
PS C:\> $OpId2 = New-CrmOrganization -DisplayName “My Org 2” -SqlServerName “ContosoSQL” -SrsUrl “http://ContosoReporting/reportserver” -BaseCurrencyCode "USD" -BaseCurrencyName "US Dollar" -BaseCurrencySymbol "$" -BaseCurrencyPrecision 2 -BaseLanguageCode 1033 -SqlCollation "Latin1_General_CI_AI" -SQMOptIn $true -Name "ORG3"Specifies settings in the creation of a new organization in the Dynamics 365 deployment.
Parameters
-BaseCurrencyCode
Contains the base currency code for the organization to be created, for example, USD for US dollar.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-BaseCurrencyName
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.
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-BaseCurrencyPrecision
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.
| Type: | Int32 |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-BaseCurrencySymbol
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.
| Type: | String |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-BaseLanguageCode
Specifies the integer value that maps to the base language for the organization to be created. For example, English United States is 1033.
| Type: | Int32 |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DisplayName
Specifies the display name of the organization to be created. For example, Adventure Works Cycle.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DwsServerUrl
The URL of the Deployment Web Service. This should be in the format: https://, for example, https://contoso.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies 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.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SqlCollation
Specifies the preferred SQL collation that the organization database will use to sort and compare data characters.
| Type: | String |
| Position: | 7 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SqlServerName
The name of the SQL Server or SQL Server instance on which to create the organization database.
| Type: | String |
| Position: | 9 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SQMOptIn
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.
| Type: | String |
| Position: | 8 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SrsUrl
Specifies the URL of the Microsoft SQL Server Reporting Services server to use for the organization to be created.
| Type: | String |
| Position: | 10 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SysAdminName
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.
| Type: | String |
| Position: | 11 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Timeout
For internal user only.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
System.String
System.Int32 System.Management.Automation.SwitchParameter System.Management.Automation.PSCredential
Outputs
System.Guid