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

Get-CrmAttribute

Synopsis

Get Attribute Metadata

Syntax

Get-CrmAttribute [-Entity] <String> [-Include <String>] [-Exclude <String>] [-CustomOnly] [-ExcludeManaged] [-IncludeLinked] [-AttributeType <String>] [<CommonParameters>]

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

Get-CrmAttribute [-Entity] <String> [-Name] <String> [<CommonParameters>]

Description

Get the metadata from attributes

Parameters

-Entity <String>

Logicalname of the entity to get attributes for

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

-Include <String>

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

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

-Exclude <String>

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

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

-CustomOnly <SwitchParameter>

Return only custom attributes of the entity

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

-ExcludeManaged <SwitchParameter>

Exclude managed attributes.

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

-IncludeLinked <SwitchParameter>

Include attributes that are linked to other attributes, like base attributes.

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

-AttributeType <String>

The type of attribute to return. Use the values for the AttributeType enumeration or the fields of the AttributeTypeDisplayName Class.

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

-Id <Guid>

The MetadataId of the attribute

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

-Name <String>

The logicalname of the attribute

Required? True
Position? 2
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.AttributeMetadata

Notes

Examples

Related links

AttributeTypeCode Enumeration https://msdn.microsoft.com/en-us/library/gg327645.aspx
AttributeTypeDisplayName Class https://msdn.microsoft.com/en-us/library/microsoft.xrm.sdk.metadata.attributetypedisplayname.aspx
AttributeMetadata Class https://msdn.microsoft.com/en-us/library/microsoft.xrm.sdk.metadata.attributemetadata.aspx

Last edited Mar 11 at 7:02 PM by amsoftware, version 2