New-AXModel

Important

This content is archived and is not being updated. For the latest documentation, see Microsoft Dynamics 365 product documentation. For the latest release plans, see Dynamics 365 and Microsoft Power Platform release plans.

New-AXModel

Creates an empty model in a Microsoft Dynamics AX model store.

Syntax

Parameter Set: Default
New-AXModel -Model <String> [-Config <String> ] [-Database <String> ] [-Layer <String> ] [-ManifestFile <String> ] [-ManifestProperty <String> ] [-Server <String> ] [ <CommonParameters>]

Detailed description

The New-AXModel cmdlet creates an empty model in a Microsoft Dynamics AX model store. You can pass in either a manifest file or a series of manifest properties to specify properties for the model.

Parameters

-Config<String>

Specifies an Application Object Server (AOS) configuration to use to determine the model store database and server name. The default value is the configuration that is currently active. This parameter cannot be used with the Database or Server parameters. If no Database or Server parameters are supplied, the default configuration is used.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Database<String>

Specifies the Microsoft Dynamics AX model store database. This parameter cannot be used with the -Config parameter. If the -Database parameter is specified without a -Server parameter, the default server value of "(local)" is used.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Layer<String>

Specifies the layer to create the new model in.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ManifestFile<String>

Specifies an XML file that contains descriptive properties of a model (a model manifest file). Use the Get-AXModelManifest cmdlet with the -Xml parameter to output a sample manifest file. The properties that can be set include the following, with the data type indicated in parentheses: Name (String), DisplayName (String), Description (String), Publisher (String), InstallMode (String), Version, Layer (String).

Version is a four-part indicator, in the format Number.Number.Number.Number, for example, 6.0.0.0.

Possible values for InstallMode are Standard, Overwrite, and Conflict. Standard stops the import process if a conflicting ID is encountered. Overwrite replaces the existing model element with the imported model element. Conflict duplicates the model element into the related update layer. For example, for the ISV layer, the update layer is ISP. The default value is Standard.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ManifestProperty<String>

Specifies descriptive properties of a model to set. The properties that can be set include the following, with data type indicated in parentheses: Name (String), DisplayName (String), Description (String), Publisher (String), InstallMode (String), Version, Layer (String).

Version is a four-part indicator, in the format Number.Number.Number.Number, for example, 6.0.0.0.

Possible values for InstallMode are Standard, Overwrite, and Conflict. Standard stops the import process if a conflicting ID is encountered. Overwrite replaces the existing model element with the imported model element. Conflict duplicates the model element into the related update layer. For example, for the ISV layer, the update layer is ISP. The default value is Standard.

Properties can be specified in the format <property>:value

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Model<String>

Specifies the name of the model to create.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Server<String>

Specifies the server that hosts the Microsoft Dynamics AX model store database. This parameter can only be used with the -Database parameter--it cannot be used by itself.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see about_CommonParameters https://go.microsoft.com/fwlink/?LinkID=113216

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

    You cannot pipe input to this cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • ModelManifest

    Returns the model manifest class.

Examples

PS C:\>C:\PS>New-AXModel -Model TestModel -Layer ISV
PS C:\>
                        

How to: Create a New Model from the Command Line

Copyright Microsoft Corporation. All rights reserved.