| external help file | Module Name | online version | schema |
|---|---|---|---|
AMSoftware.Crm.PowerShell.Commands.dll-Help.xml |
AMSoftware.Crm |
2.0.0 |
Get the metadata of an entity.
Get-CrmEntity [[-Name] <String>] [-Exclude <String>] [-CustomOnly] [-ExcludeManaged] [-IncludeIntersects]
[-VirtualOnly] [-DataSourcesOnly] [<CommonParameters>]
Get-CrmEntity [-Id] <Guid[]> [<CommonParameters>]
Get-CrmEntity [-EntityTypeCode] <Int32> [<CommonParameters>]
Get the metadata of an entity.
The first time retrieving the metadata will take some time. In consecutive calls the performance will improve as the metadata will be cached in the session. For Dynamics CRM 2011 Rollup 12 and later the cache will be automatically updated as required based on metadata changes. Before Dynamics CRM 2011 Rollup 12 the cache will be updated after 5 minutes. To force and update of the cache reconnect to the organization.
PS C:\> Get-CrmEntity -Name account
Get the metadata of the entity 'account'.
PS C:\> Get-CrmEntity -Include '*account*' -CustomOnly -ExcludeManaged
Get the metadata of all entities with 'account' in the LogicalName. Retrieve only custom entities, that are not managed.
Retrieve only the metadata for entities that are marked as custom.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: GetEntitiesByFilter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOnly include DataSource Entities in de results
Type: System.Management.Automation.SwitchParameter
Parameter Sets: GetEntitiesByFilter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseEntity Type Code of the Entity to return
Type: System.Int32
Parameter Sets: GetEntityByEtc
Aliases: ObjectTypeCode
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseExclude the metadata for entities whose LogicalName matches the provided pattern.
Type: System.String
Parameter Sets: GetEntitiesByFilter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: TrueDo not retrieve metadata for entities that are marked as managed.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: GetEntitiesByFilter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe MetadataId of the entity to retrieve.
Type: System.Guid[]
Parameter Sets: GetEntityById
Aliases: MetadataId
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseInclude the metadata for entities marked as intersect. These are entities which are created by Dynamics CRM to support N:N relationships.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: GetEntitiesByFilter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe LogicalName of the entity to retrieve the metadata for.
NOTE: This parameter is case sensitive. i.e. it must match the case of the LogicalName exactly.
Type: System.String
Parameter Sets: GetEntitiesByFilter
Aliases: Include
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: TrueOnly include Virtual Entities in de results
Type: System.Management.Automation.SwitchParameter
Parameter Sets: GetEntitiesByFilter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
The Name parameter is case sensitive. i.e. it must match the case of the LogicalName exactly.