Skip to content
This repository was archived by the owner on Jan 29, 2022. It is now read-only.

Latest commit

 

History

History
871 lines (694 loc) · 18.6 KB

Set-CrmEntity.md

File metadata and controls

871 lines (694 loc) · 18.6 KB
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] <EntityMetadata> [-PassThru] [<CommonParameters>]

SetVirtualEntity

Set-CrmEntity [-Virtual] [-Name] <String> [-DisplayName <String>] [-DisplayCollectionName <String>]
 [-Description <String>] [-ExternalName <String>] [-ExternalCollectionName <String>]
 [-DataSourceConfiguration <EntityReference>] [-Customizable <Boolean>] [-HasNotes <Boolean>]
 [-HasActivities <Boolean>] [-CanCreateAttributes <Boolean>] [-CanCreateForms <Boolean>]
 [-CanCreateViews <Boolean>] [-CanModifyAdditionalSettings <Boolean>] [-IsConnectionsEnabled <Boolean>]
 [-IsDocumentManagementEnabled <Boolean>] [-IsMailMergeEnabled <Boolean>] [-IsMappable <Boolean>]
 [-IsRenameable <Boolean>] [-IsValidForQueue <Boolean>] [-IsVisibleInMobile <Boolean>]
 [-IconLargeName <String>] [-IconMediumName <String>] [-IconSmallName <String>]
 [-IsQuickCreateEnabled <Boolean>] [-IsReadOnlyInMobileClient <Boolean>] [-IsVisibleInMobileClient <Boolean>]
 [-EntityColor <String>] [-EntityHelpUrlEnabled <Boolean>] [-EntityHelpUrl <Uri>]
 [-IsInteractionCentricEnabled <Boolean>] [-IsOneNoteIntegrationEnabled <Boolean>] [-PassThru]
 [<CommonParameters>]

SetDataSourceEntity

Set-CrmEntity [-DataSource] [-Name] <String> [-DisplayName <String>] [-DisplayCollectionName <String>]
 [-Description <String>] [-PassThru] [<CommonParameters>]

SetEntity

Set-CrmEntity [-Name] <String> [-DisplayName <String>] [-DisplayCollectionName <String>]
 [-Description <String>] [-Customizable <Boolean>] [-HasNotes <Boolean>] [-HasActivities <Boolean>]
 [-AutoRouteToOwnerQueue <Boolean>] [-CanCreateAttributes <Boolean>] [-CanCreateCharts <Boolean>]
 [-CanCreateForms <Boolean>] [-CanCreateViews <Boolean>] [-CanModifyAdditionalSettings <Boolean>]
 [-IsActivityParty <Boolean>] [-IsAuditEnabled <Boolean>] [-IsAvailableOffline <Boolean>]
 [-IsConnectionsEnabled <Boolean>] [-IsDocumentManagementEnabled <Boolean>]
 [-IsDuplicateDetectionEnabled <Boolean>] [-IsMailMergeEnabled <Boolean>] [-IsMappable <Boolean>]
 [-IsRenameable <Boolean>] [-IsValidForQueue <Boolean>] [-IsVisibleInMobile <Boolean>]
 [-IconLargeName <String>] [-IconMediumName <String>] [-IconSmallName <String>]
 [-AutoCreateAccessTeams <Boolean>] [-IsBusinessProcessEnabled <Boolean>] [-IsQuickCreateEnabled <Boolean>]
 [-IsReadOnlyInMobileClient <Boolean>] [-IsVisibleInMobileClient <Boolean>]
 [-CanChangeHierarchicalRelationship <Boolean>] [-CanEnableSyncToExternalSearchIndex <Boolean>]
 [-ChangeTrackingEnabled <Boolean>] [-EntityColor <String>] [-EntityHelpUrlEnabled <Boolean>]
 [-EntityHelpUrl <Uri>] [-IsInteractionCentricEnabled <Boolean>] [-IsKnowledgeManagementEnabled <Boolean>]
 [-IsOfflineInMobileClient <Boolean>] [-IsOneNoteIntegrationEnabled <Boolean>]
 [-IsOptimisticConcurrencyEnabled <Boolean>] [-IsSLAEnabled <Boolean>] [-SyncToExternalSearchIndex <Boolean>]
 [-PassThru] [<CommonParameters>]

DESCRIPTION

Update an entity.

EXAMPLES

PARAMETERS

-AutoCreateAccessTeams

Whether the entity is enabled for auto created access teams

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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.

Type: System.Boolean
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

Type: System.Management.Automation.SwitchParameter
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

Type: Microsoft.Xrm.Sdk.EntityReference
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.

Type: System.String
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.

Type: System.String
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.

Type: System.String
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.

Type: System.String
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

Type: System.Uri
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

Type: System.Boolean
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

Type: System.String
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

Type: System.String
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.

Type: System.Boolean
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)

Type: System.Boolean
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

Type: System.String
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

Type: System.String
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

Type: System.String
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.

Type: Microsoft.Xrm.Sdk.Metadata.EntityMetadata
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
Parameter Sets: SetVirtualEntity, SetEntity
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IsOfflineInMobileClient

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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)

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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

Type: System.Boolean
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.

Type: System.String
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.

Type: System.Management.Automation.SwitchParameter
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.

Type: System.Boolean
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

Type: System.Management.Automation.SwitchParameter
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.

INPUTS

Microsoft.Xrm.Sdk.Metadata.EntityMetadata

OUTPUTS

Microsoft.Xrm.Sdk.Metadata.EntityMetadata

NOTES

RELATED LINKS

Get-CrmEntity

New-CrmEntity

Remove-CrmEntity

EntityMetadata Class