Get-CrmEntityAttributes

NAME Get-CrmEntityAttributes



SYNOPSIS

Retrieves all attributes metadata for an Entity.





SYNTAX

Get-CrmEntityAttributes [-conn <CrmServiceClient>] [-EntityLogicalName] <String> [<CommonParameters>]





DESCRIPTION

The Get-CrmEntityAttributes cmdlet lets you retrieve all attributes metadata for an Entity.





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



<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-CrmEntityAttributes -conn $conn -EntityLogicalName account



This example retrieves all attributes metadata for Account Entity.







AttributeOf : preferredcontactmethodcode

AttributeType : Virtual

AttributeTypeName : Microsoft.Xrm.Sdk.Metadata.AttributeTypeDisplayName

ColumnNumber : 149

Description : Microsoft.Xrm.Sdk.Label

DisplayName : Microsoft.Xrm.Sdk.Label

DeprecatedVersion :

IntroducedVersion : 5.0.0.0

EntityLogicalName : account

IsAuditEnabled : Microsoft.Xrm.Sdk.BooleanManagedProperty

IsCustomAttribute : False

...



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



Get-CrmEntityAttributes account



This example retrieves all attributes metadata for Account Entity by omitting parameter names.

When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.







AttributeOf : preferredcontactmethodcode

AttributeType : Virtual

AttributeTypeName : Microsoft.Xrm.Sdk.Metadata.AttributeTypeDisplayName

ColumnNumber : 149

Description : Microsoft.Xrm.Sdk.Label

DisplayName : Microsoft.Xrm.Sdk.Label

DeprecatedVersion :

IntroducedVersion : 5.0.0.0

EntityLogicalName : account

IsAuditEnabled : Microsoft.Xrm.Sdk.BooleanManagedProperty

IsCustomAttribute : False

...



-------------------------- Example 3 --------------------------



Get-CrmEntityAttributes account | Where {$_.IsCustomAttribute -eq $true} | Select logicalname



This example retrieves all attributes metadata for an account, and filter for only custom fields. Then displays

logicalname field only.









RELATED LINKS