| external help file | Module Name | online version | schema |
|---|---|---|---|
AMSoftware.Crm.PowerShell.Commands.dll-Help.xml |
AMSoftware.Crm |
2.0.0 |
Set-CrmEntity
SYNOPSIS
Update an entity.
SYNTAX
SetEntityByInputObject (Default)
Set-CrmEntity [-InputObject] [-PassThru] []
SetVirtualEntity
Set-CrmEntity [-Virtual] [-Name] [-DisplayName ] [-DisplayCollectionName ]
[-Description ] [-ExternalName ] [-ExternalCollectionName ]
[-DataSourceConfiguration ] [-Customizable ] [-HasNotes ]
[-HasActivities ] [-CanCreateAttributes ] [-CanCreateForms ]
[-CanCreateViews ] [-CanModifyAdditionalSettings ] [-IsConnectionsEnabled ]
[-IsDocumentManagementEnabled ] [-IsMailMergeEnabled ] [-IsMappable ]
[-IsRenameable ] [-IsValidForQueue ] [-IsVisibleInMobile ]
[-IconLargeName ] [-IconMediumName ] [-IconSmallName ]
[-IsQuickCreateEnabled ] [-IsReadOnlyInMobileClient ] [-IsVisibleInMobileClient ]
[-EntityColor ] [-EntityHelpUrlEnabled ] [-EntityHelpUrl ]
[-IsInteractionCentricEnabled ] [-IsOneNoteIntegrationEnabled ] [-PassThru]
[]
SetDataSourceEntity
Set-CrmEntity [-DataSource] [-Name] [-DisplayName ] [-DisplayCollectionName ]
[-Description ] [-PassThru] []
SetEntity
Set-CrmEntity [-Name] [-DisplayName ] [-DisplayCollectionName ]
[-Description ] [-Customizable ] [-HasNotes ] [-HasActivities ]
[-AutoRouteToOwnerQueue ] [-CanCreateAttributes ] [-CanCreateCharts ]
[-CanCreateForms ] [-CanCreateViews ] [-CanModifyAdditionalSettings ]
[-IsActivityParty ] [-IsAuditEnabled ] [-IsAvailableOffline ]
[-IsConnectionsEnabled ] [-IsDocumentManagementEnabled ]
[-IsDuplicateDetectionEnabled ] [-IsMailMergeEnabled ] [-IsMappable ]
[-IsRenameable ] [-IsValidForQueue ] [-IsVisibleInMobile ]
[-IconLargeName ] [-IconMediumName ] [-IconSmallName ]
[-AutoCreateAccessTeams ] [-IsBusinessProcessEnabled ] [-IsQuickCreateEnabled ]
[-IsReadOnlyInMobileClient ] [-IsVisibleInMobileClient ]
[-CanChangeHierarchicalRelationship ] [-CanEnableSyncToExternalSearchIndex ]
[-ChangeTrackingEnabled ] [-EntityColor ] [-EntityHelpUrlEnabled ]
[-EntityHelpUrl ] [-IsInteractionCentricEnabled ] [-IsKnowledgeManagementEnabled ]
[-IsOfflineInMobileClient ] [-IsOneNoteIntegrationEnabled ]
[-IsOptimisticConcurrencyEnabled ] [-IsSLAEnabled ] [-SyncToExternalSearchIndex ]
[-PassThru] []
DESCRIPTION
Update an entity.
EXAMPLES
PARAMETERS
-AutoCreateAccessTeams
Whether the entity is enabled for auto created access teams
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AutoRouteToOwnerQueue
Whether to automatically move records to the owner's default queue when a record of this type is created or assigned
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CanChangeHierarchicalRelationship
Whether the hierarchical state of entity relationships included in your managed solutions can be changed
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CanCreateAttributes
Determines whether additional attributes can be added to the entity
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CanCreateCharts
Determines whether new charts can be created for the entity
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CanCreateForms
Determines whether new forms can be created for the entity
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CanCreateViews
Determines whether new views can be created for the entity
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CanEnableSyncToExternalSearchIndex
Whether this entity can be enabled for relevance search when customizing a managed solution
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CanModifyAdditionalSettings
Determines whether any other entity properties not represented by a managed property can be changed
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ChangeTrackingEnabled
Boolean value that specifies whether change tracking is enabled for an entity or not
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Customizable
Whether the entity is customizable.
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DataSource
Create a DataSource Entity
Parameter Sets: SetDataSourceEntity
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DataSourceConfiguration
Entity containing the DataSource configuration
Parameter Sets: SetVirtualEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
The label containing the description for the entity.
Parameter Sets: SetVirtualEntity, SetDataSourceEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DisplayCollectionName
The label containing the plural display name for the entity.
Parameter Sets: SetVirtualEntity, SetDataSourceEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DisplayName
The label containing the display name for the entity.
Parameter Sets: SetVirtualEntity, SetDataSourceEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EntityColor
The code to represent the color to be used for this entity in the application. Provide a well known colorname or the hexadecimal code of the color.
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EntityHelpUrl
The URL of the resource to display help content for this entity
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EntityHelpUrlEnabled
Whether the entity supports custom help content
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExternalCollectionName
The ExternalName when used as a Virtual Entity
Parameter Sets: SetVirtualEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExternalName
The ExternalName when used as a Virtual Entity
Parameter Sets: SetVirtualEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HasActivities
Allow this table to represent a task that is performed by an activity table.
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HasNotes
Enable Attachments (including Notes and Files)
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IconLargeName
The name of the image web resource for the large icon for the entity
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IconMediumName
The name of the image web resource for the medium icon for the entity
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IconSmallName
The name of the image web resource for the small icon for the entity
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InputObject
The updated EntityMetadata object for the entity.
Parameter Sets: SetEntityByInputObject
Aliases: Entity
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-IsActivityParty
Whether the email messages can be sent to an email address stored in a record of this type
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsAuditEnabled
Determines whether auditing has been enabled for the entity
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsAvailableOffline
Whether the entity is available offline
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsBusinessProcessEnabled
Whether the entity is enabled for business process flows
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsConnectionsEnabled
Determines whether connections are enabled for this entity
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsDocumentManagementEnabled
Determines whether document management is enabled
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsDuplicateDetectionEnabled
Determines whether duplicate detection is enabled
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsInteractionCentricEnabled
Whether the entity is enabled for interactive experience
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsKnowledgeManagementEnabled
Whether Parature knowledge management integration is enabled for the entity
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsMailMergeEnabled
Determines whether mail merge is enabled for this entity
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsMappable
Determines whether entity mapping is available for the entity
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsOfflineInMobileClient
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsOneNoteIntegrationEnabled
Whether OneNote integration is enabled for the Entity
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsOptimisticConcurrencyEnabled
Whether optimistic concurrency is enabled for the entity
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsQuickCreateEnabled
Indicating if the entity is enabled for quick create forms
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsReadOnlyInMobileClient
Determines whether Microsoft Dynamics 365 for tablets users can update data for this entity
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsRenameable
Determines whether the entity DisplayName and DisplayCollectionName can be changed by editing the entity in the application
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsSLAEnabled
Indicating if the entity is enabled for service level agreements (SLAs)
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsValidForQueue
Determines whether the entity is enabled for queues
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsVisibleInMobile
Determines whether Microsoft Dynamics 365 for phones users can see data for this entity
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsVisibleInMobileClient
Determines whether Microsoft Dynamics 365 for tablets users can see data for this entity
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
The LogicalName of the entity to update.
Parameter Sets: SetVirtualEntity, SetDataSourceEntity, SetEntity
Aliases: LogicalName
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
Returns an object that represents the EntityMetadata. By default, this cmdlet does not generate any output.
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SyncToExternalSearchIndex
Whether this entity is searchable in relevance search.
Parameter Sets: SetEntity
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Virtual
Create the Entity as a Virtual Entity
Parameter Sets: SetVirtualEntity
Aliases:
Required: True
Position: Named
Default value: None
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.