< Back

Get-CrmEntityAllMetadata

Sat Jan 18, 2020 3:59 pm

NAME Get-CrmEntityAllMetadata



SYNOPSIS

Retrieves all Metadata for CRM organization.





SYNTAX

Get-CrmEntityAllMetadata [-conn <CrmServiceClient>] [[-OnlyPublished] <Boolean>] [[-EntityFilters] <String>]

[<CommonParameters>]





DESCRIPTION

The Get-CrmEntityAllMetadata cmdlet lets you retrieve all Metadata for CRM organization. You can specify which

type of Metadata you want to retrive 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



-OnlyPublished [<Boolean>]

Specify $True if you retrieve only published Metadata. Specifying $False will display unpublished metadata

(metadata that will eventually become published)



Required? false

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-CrmEntityAllMetadata -conn $conn -OnlyPublished $True -EntityFilters all



This example retrieves all published Metadata.







ActivityTypeMask : 0

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

AutoRouteToOwnerQueue : False

CanTriggerWorkflow : False

Description : Microsoft.Xrm.Sdk.Label

DisplayCollectionName : Microsoft.Xrm.Sdk.Label

DisplayName : Microsoft.Xrm.Sdk.Label

EntityHelpUrlEnabled : False

EntityHelpUrl :

...



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



Get-CrmEntityAllMetadata $True Entity



This example retrieves all published Entity metadata by omitting parameter names.

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







ActivityTypeMask : 0

Attributes :

AutoRouteToOwnerQueue : False

CanTriggerWorkflow : False

Description : Microsoft.Xrm.Sdk.Label

DisplayCollectionName : Microsoft.Xrm.Sdk.Label

DisplayName : Microsoft.Xrm.Sdk.Label

EntityHelpUrlEnabled : False

...



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



Get-CrmEntityAllMetadata -conn $conn -EntityFilters Entity | select -property

@{N='LogicalName';E={$_.logicalname}}, @{N='DisplayName';E={$_.DisplayCollectionName.UserLocalizedLabel.Label}} |

sort DisplayName



This samples get Entity metadata and list its logicalname and display name as table.







LogicalName DisplayName

----------- -----------

cardtype Action Card Type

actioncardusersettings Action Card User Settings

actioncard Action Cards

actioncarduserstate ActionCardUserStates

activitypointer Activities

activityparty Activity Parties

customeraddress Addresses

advancedsimilarityrule Advanced Similarity Rules





RELATED LINKS