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

Remove-CrmEntityKey

Synopsis

Remove key from an Entity

Syntax

Remove-CrmEntityKey [-Entity] <String> [-Name] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Remove the Key from an Entity

Parameters

-Entity <String>

Logicalname of the Entity

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

-Name <String>

Logicalname of the key to remove

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

-Force <SwitchParameter>

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

-WhatIf <SwitchParameter>

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

-Confirm <SwitchParameter>

Required? False
Position? named
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

Notes

Available from Dynamics CRM 2015.1 and up

Examples

Remove Key from Entity

PS C:\> Remove-CrmEntityKey -entity account -Name ams_accountnumber

remove the key with logicalname 'ams_accountnumber' from the entity Account.

Related links

EntityKeyMetadata Class https://msdn.microsoft.com/en-us/library/microsoft.xrm.sdk.metadata.entitykeymetadata.aspx

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