Skip to content
This repository was archived by the owner on Jan 29, 2022. It is now read-only.

Latest commit

 

History

History
356 lines (274 loc) · 7.29 KB

Set-CrmDateTimeAttribute.md

File metadata and controls

356 lines (274 loc) · 7.29 KB
external help file Module Name online version schema
AMSoftware.Crm.PowerShell.Commands.dll-Help.xml
AMSoftware.Crm
2.0.0

Set-CrmDateTimeAttribute

SYNOPSIS

Update an attribute of type DateTime.

SYNTAX

Set-CrmDateTimeAttribute [-Format <CrmDateTimeAttributeFormat>] [-ImeType <CrmImeType>]
 [-CanChangeBehavior <Boolean>] [-Behavior <CrmDateTimeBehavior>] [-Entity] <String> [-Name] <String>
 [-DisplayName <String>] [-Description <String>] [-ExternalName <String>]
 [-CanModifyAdditionalSettings <Boolean>] [-IsAuditEnabled <Boolean>] [-IsCustomizable <Boolean>]
 [-IsRenameable <Boolean>] [-IsSecured <Boolean>] [-IsValidForAdvancedFind <Boolean>]
 [-Required <CrmRequiredLevel>] [-IsGlobalFilterEnabled <Boolean>] [-IsSortableEnabled <Boolean>] [-PassThru]
 [<CommonParameters>]

DESCRIPTION

Update an attribute of type DateTime.

EXAMPLES

PARAMETERS

-Behavior

The behavior of the attribute.

Type: AMSoftware.Crm.PowerShell.Common.CrmDateTimeBehavior
Parameter Sets: (All)
Aliases:
Accepted values: UserSettings, DateOnly, TimeZoneIndependent

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CanChangeBehavior

Whether the date and time behavior can be changed for the attribute.

Type: System.Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CanModifyAdditionalSettings

Whether any settings not controlled by managed properties can be changed.

Type: System.Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

The description of the attribute.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DisplayName

The display name for the attribute.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Entity

The LogicalName of the entity containing the attribute.

Type: System.String
Parameter Sets: (All)
Aliases: EntityLogicalName

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ExternalName

The ExternalName when used in a Virtual Entity

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Format

The date/time display format.

Type: AMSoftware.Crm.PowerShell.Common.CrmDateTimeAttributeFormat
Parameter Sets: (All)
Aliases:
Accepted values: DateOnly, DateAndTime

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ImeType

The input method editor (IME) mode for the attribute.

Type: AMSoftware.Crm.PowerShell.Common.CrmImeType
Parameter Sets: (All)
Aliases:
Accepted values: Auto, Active, Disabled, Inactive

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IsAuditEnabled

Whether the attribute is enabled for auditing.

Type: System.Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IsCustomizable

Whether the attribute is a custom attribute.

Type: System.Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IsGlobalFilterEnabled

Determines whether this column appears as an available filter when using interactive experiences dashboards.

Type: System.Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IsRenameable

Whether the attribute display name can be changed.

Type: System.Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IsSecured

Whether the attribute is secured for field-level security.

Type: System.Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IsSortableEnabled

Determines whether data can be sorted by this column when using interactive experience dashboards.

Type: System.Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IsValidForAdvancedFind

Whether the attribute appears in Advanced Find.

Type: System.Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

The LogicalName of the attribute to update.

Type: System.String
Parameter Sets: (All)
Aliases: LogicalName

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-PassThru

Returns an object that represents the DateTimeAttributeMetadata. By default, this cmdlet does not generate any output.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Required

The data entry requirement level enforced for the attribute.

Type: AMSoftware.Crm.PowerShell.Common.CrmRequiredLevel
Parameter Sets: (All)
Aliases:
Accepted values: Unknown, Required, Recommended, Optional

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

OUTPUTS

Microsoft.Xrm.Sdk.Metadata.DateTimeAttributeMetadata

NOTES

RELATED LINKS

Set-CrmBigIntAttribute

Set-CrmBooleanAttribute

Set-CrmDecimalAttribute

Set-CrmDoubleAttribute

Set-CrmImageAttribute

Set-CrmIntegerAttribute

Set-CrmMemoAttribute

Set-CrmMoneyAttribute

Set-CrmOptionSetAttribute

Set-CrmStringAttribute

DateTimeAttributeMetadata Class