| external help file | Module Name | online version | schema |
|---|---|---|---|
AMSoftware.Crm.PowerShell.Commands.dll-Help.xml |
AMSoftware.Crm |
2.0.0 |
Update an attribute of type String.
Set-CrmStringAttribute [-Format <CrmStringAttributeFormat>] [-ImeType <CrmImeType>] [-Length <Int32>]
[-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>]
Update an attribute of type String.
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: FalseThe 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: FalseThe 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: FalseThe 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: FalseThe 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: FalseThe format options for the string attribute.
Type: AMSoftware.Crm.PowerShell.Common.CrmStringAttributeFormat
Parameter Sets: (All)
Aliases:
Accepted values: Text, Email, Phone, PhoneticGuide, TextArea, TickerSymbol, Url, VersionNumber
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe 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: FalseWhether 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: FalseWhether 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: FalseDetermines 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: FalseWhether 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: FalseWhether 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: FalseDetermines 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: FalseWhether 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: FalseThe maximum length for the attribute.
Type: System.Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe 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: FalseReturns an object that represents the StringAttributeMetadata. 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: FalseThe 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: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.