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

Get-CrmEntity

Synopsis

Get Entity Metadata

Syntax

Get-CrmEntity [-Include <String>] [-Exclude <String>] [-CustomOnly] [-ExcludeManaged] [-IncludeIntersects] [<CommonParameters>]

Get-CrmEntity [-Id] <Guid> [<CommonParameters>]

Get-CrmEntity [-Name] <String> [<CommonParameters>]

Description

Get the metadata from entities

Parameters

-Include <String>

Filter for entity to include based on the logicalname of the entity.

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

-Exclude <String>

Filter for entity to exclude based on the logicalname of the entity.

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

-CustomOnly <SwitchParameter>

Get custom entities only

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

-ExcludeManaged <SwitchParameter>

Exclude managed entities from the result

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

-IncludeIntersects <SwitchParameter>

Include intersect entities from many-to-many relationships

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

-Id <Guid>

MetadataId of the entity

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

-Name <String>

Logicalname of the entity

Required? True
Position? 1
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

Examples

Get specific entity

PS C:\> Get-CrmEntity -Name contact

Get the metadata for a specific entity

Get entities by filter

PS C:\> Get-CrmEntity -CustomOnly

Get metadata from custom entities only

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