New-CrmInstanceInfo
Creates the object that defines the parameters used to create a new Dataverse environment by using the New-CrmInstance cmdlet.
Syntax
New-CrmInstanceInfo
-BaseLanguage <Int32>
-DomainName <String>
-InitialUserEmail <String>
-ServiceVersionId <Guid>
-InstanceType <InstanceType>
-FriendlyName <String>
[-TemplateList <System.Collections.Generic.List`1[System.String]>]
[-Purpose <String>]
[-SecurityGroupId <Guid>]
[-CurrencyCode <String>]
[-CurrencyName <String>]
[-CurrencyPrecision <Int32>]
[-CurrencySymbol <String>] New-CrmInstanceInfo
-CurrencyCode <String>
-CurrencyName <String>
-CurrencyPrecision <Int32>
-CurrencySymbol <String> Description
The New-CrmInstanceInfo cmdlet creates the object that defines the parameters used to create a new Dataverse environment by using the New-CrmInstance cmdlet.
Examples
Example 1
PS C:\> $NewCrmInstance = New-CrmInstanceInfo -BaseLanguage 1033 -DomainName matptest -FriendlyName "Contoso production instance" -InitialUserEmail admin@contoso.onmicrosoft.com -InstanceType Sandbox -ServiceVersionId 31cafafe-c6b1-4c0a-bb53-73927841bc5c -CurrencyCode 840 -CurrencyName USD -CurrencyPrecision 2 -CurrencySymbol $ -Purpose "This is a new production environment for Contoso."Defines the object that can be used to create a Sandbox environment with version 8.2, 1033 (US English) as the base language, and USD as the currency.
Parameters
-BaseLanguage
Required parameter. The base language for the environment. For a list of available languages, run the Get-CrmLanguages cmdlet.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-CurrencyCode
Optional parameter. The currency region code to use for the environment. You can find a list of currency region codes by running the Get-CrmCurrencies cmdlet.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CurrencyName
Optional parameter. The currency name to use for the environment. You can find a list of currency names by running the Get-CrmCurrencies cmdlet.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CurrencyPrecision
Optional parameter. Set the pricing decimal precision. Valid values are 0-4.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CurrencySymbol
Optional parameter. Set the symbol that will represent the currency.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DomainName
Required parameter. Used for part of the domain namespace and appears in the application url. For example, if you use contoso as the DomainName, the url will appear similar to https://contoso.crm.dynamics.com.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-FriendlyName
Required parameter. This is typically the name of your organization and is displayed in the Dataverse application.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InitialUserEmail
Required parameter. Email address to receive notifications about the environment.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InstanceType
Required parameter. Sets the environment type, such as Sandbox or Production. For a full list, run the Get-CrmInstanceTypes cmdlet.
| Type: | InstanceType |
| Accepted values: | None, Production, Sandbox, Support, Preview, Trial |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Purpose
Optional parameter. A description used to associate the environment with a specific intent. Only tenant administrators will see this description.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SecurityGroupId
Optional parameter. This value is used to determine the security group that includes the users who will have access to this Dataverse environment.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ServiceVersionId
Required parameter. Specifies the service release of the environment. For a list of available service releases, run the Get-CrmServiceVersions cmdlet.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TemplateList
Optional parameter. Specifies the apps you want provisioned in the environment. For a list of available template names, run the Get-CrmTemplates cmdlet.
| Type: | System.Collections.Generic.List`1[System.String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
System.Int32
System.String System.Guid Microsoft.Xrm.Services.Admin.Client.Models.InstanceType System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
Outputs
System.Object