This project has moved. For the latest updates, please go here.

New-CrmEntity

Synopsis

Add Entity

Syntax

New-CrmEntity [-Entity] <EntityMetadata> [-PrimaryAttribute] <StringAttributeMetadata> [<CommonParameters>]

New-CrmEntity [-IsActivity] [-ExcludeFromMenu] [-Name] <String> [-DisplayName] <String> -DisplayCollectionName <String> [-Description <String>] [-Customizable <Nullable`1[Boolean]>] [<CommonParameters>]

New-CrmEntity [-Name] <String> [-DisplayName] <String> -DisplayCollectionName <String> [-Description <String>] [-Owner <CrmEntityOwner>] -AttributeName <String> -AttributeDisplayName <String> [-AttributeRequired <CrmRequiredLevel>] [-AttributeLength <Nullable`1[Int32]>] [-AttributeDescription <String>] [-Customizable <Nullable`1[Boolean]>] [-CanChangeHierarchicalRelationship <Nullable`1[Boolean]>] [-CanEnableSyncToExternalSearchIndex <Nullable`1[Boolean]>] [-ChangeTrackingEnabled <Nullable`1[Boolean]>] [-EntityColor <String>] [-EntityHelpUrlEnabled <Nullable`1[Boolean]>] [-EntityHelpUrl <Uri>] [-IsInteractionCentricEnabled <Nullable`1[Boolean]>] [-IsKnowledgeManagementEnabled <Nullable`1[Boolean]>] [-IsOfflineInMobileClient <Nullable`1[Boolean]>] [-IsOneNoteIntegrationEnabled <Nullable`1[Boolean]>] [-IsOptimisticConcurrencyEnabled <Nullable`1[Boolean]>] [-IsSLAEnabled <Nullable`1[Boolean]>] [-SyncToExternalSearchIndex <Nullable`1[Boolean]>] [-HasNotes <Nullable`1[Boolean]>] [-HasActivities <Nullable`1[Boolean]>] [-AutoRouteToOwnerQueue <Nullable`1[Boolean]>] [-CanCreateAttributes <Nullable`1[Boolean]>] [-CanCreateCharts <Nullable`1[Boolean]>] [-CanCreateForms <Nullable`1[Boolean]>] [-CanCreateViews <Nullable`1[Boolean]>] [-CanModifyAdditionalSettings <Nullable`1[Boolean]>] [-IsActivityParty <Nullable`1[Boolean]>] [-IsAuditEnabled <Nullable`1[Boolean]>] [-IsAvailableOffline <Nullable`1[Boolean]>] [-IsConnectionsEnabled <Nullable`1[Boolean]>] [-IsDocumentManagementEnabled <Nullable`1[Boolean]>] [-IsDuplicateDetectionEnabled <Nullable`1[Boolean]>] [-IsMailMergeEnabled <Nullable`1[Boolean]>] [-IsMappable <Nullable`1[Boolean]>] [-IsRenameable <Nullable`1[Boolean]>] [-IsValidForQueue <Nullable`1[Boolean]>] [-IsVisibleInMobile <Nullable`1[Boolean]>] [-IconLargeName <String>] [-IconMediumName <String>] [-IconSmallName <String>] [<CommonParameters>]

Description

Add new Entity to an organization

Parameters

-Entity <EntityMetadata>

EntityMetadata object with new configuration

Required? True
Position? 1
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-PrimaryAttribute <StringAttributeMetadata>

Required? True
Position? 2
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsActivity <SwitchParameter>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-ExcludeFromMenu <SwitchParameter>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-Name <String>

Required? True
Position? 1
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-DisplayName <String>

Required? True
Position? 2
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-DisplayCollectionName <String>

Required? True
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-Description <String>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-Customizable <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-AttributeName <String>

Required? True
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-AttributeDisplayName <String>

Required? True
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-AttributeLength <Nullable`1[Int32]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-AttributeDescription <String>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-Owner <CrmEntityOwner>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-AttributeRequired <CrmRequiredLevel>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-CanChangeHierarchicalRelationship <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-CanEnableSyncToExternalSearchIndex <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-ChangeTrackingEnabled <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-EntityColor <String>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-EntityHelpUrlEnabled <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-EntityHelpUrl <Uri>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsInteractionCentricEnabled <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsKnowledgeManagementEnabled <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsOfflineInMobileClient <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsOneNoteIntegrationEnabled <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsOptimisticConcurrencyEnabled <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsSLAEnabled <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-SyncToExternalSearchIndex <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-HasNotes <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-HasActivities <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-AutoRouteToOwnerQueue <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-CanCreateAttributes <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-CanCreateCharts <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-CanCreateForms <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-CanCreateViews <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-CanModifyAdditionalSettings <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsActivityParty <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsAuditEnabled <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsAvailableOffline <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsConnectionsEnabled <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsDocumentManagementEnabled <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsDuplicateDetectionEnabled <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsMailMergeEnabled <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsMappable <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsRenameable <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsValidForQueue <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IsVisibleInMobile <Nullable`1[Boolean]>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IconLargeName <String>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IconMediumName <String>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-IconSmallName <String>

Required? False
Position? named
Default value  
Accept pipeline input? false
Accept wildcard characters? False

<CommonParameters>

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

Inputs

Outputs

Microsoft.Xrm.Sdk.Metadata.EntityMetadata

Notes

Available parameters depend on the version of the connected organization and the SDK used

Examples

Related links

EntityMetadata Class https://msdn.microsoft.com/en-us/library/microsoft.xrm.sdk.metadata.entitymetadata.aspx

Last edited Mar 11 at 7:02 PM by amsoftware, version 2