Get-CrmEntityMetadata

NAME Get-CrmEntityMetadata



SYNOPSIS

Retrieves Metadata for an Entity.





SYNTAX

Get-CrmEntityMetadata [-conn <CrmServiceClient>] [-EntityLogicalName] <String> [[-EntityFilters] <String>]

[<CommonParameters>]





DESCRIPTION

The Get-CrmEntityMetadata cmdlet lets you retrieve Metadata for an Entity. You can specify which type of Metadata

you want to retrieve by using EntityFilters parameter.





PARAMETERS

-conn <CrmServiceClient>

A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-EntityLogicalName <String>

A logicalname for Entity. i.e.)account, contact, lead, etc..



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-EntityFilters <String>

Specify which type of Metadata you want to retrieve. Valid options are "all", "attributes", "entity",

"privileges", "relationships".



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS









OUTPUTS









NOTES









-------------------------- Example 1 --------------------------



Get-CrmEntityMetadata -conn $conn -EntityLogicalName account EntityFilters all



This example retrieves all Metadata for Account Entity.







ActivityTypeMask : 0

Attributes : {Microsoft.Xrm.Sdk.Metadata.AttributeTypeDisplayName,

Microsoft.Xrm.Sdk.Metadata.StringFormatName,

Microsoft.Xrm.Sdk.Metadata.StringFormatName,

Microsoft.Xrm.Sdk.Metadata.StringFormatName...}

AutoRouteToOwnerQueue : False

CanTriggerWorkflow : True

Description : Microsoft.Xrm.Sdk.Label

DisplayCollectionName : Microsoft.Xrm.Sdk.Label

...



-------------------------- Example 2 --------------------------



Get-CrmEntityMetadata account relationships



ActivityTypeMask : 0

Attributes : {Microsoft.Xrm.Sdk.Metadata.AttributeTypeDisplayName,

Microsoft.Xrm.Sdk.Metadata.StringFormatName,

Microsoft.Xrm.Sdk.Metadata.StringFormatName,

Microsoft.Xrm.Sdk.Metadata.StringFormatName...}

AutoRouteToOwnerQueue : False

CanTriggerWorkflow : True

Description : Microsoft.Xrm.Sdk.Label

DisplayCollectionName : Microsoft.Xrm.Sdk.Label

...









RELATED LINKS