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

Latest commit

 

History

History
322 lines (246 loc) · 6.56 KB

Add-CrmImageAttribute.md

File metadata and controls

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

Add-CrmImageAttribute

SYNOPSIS

Add an attribute of type Image.

SYNTAX

Add-CrmImageAttribute [-Entity] <String> [-Name] <String> [-DisplayName] <String> [-Description <String>]
 [-CanModifyAdditionalSettings <Boolean>] [-IsAuditEnabled <Boolean>] [-IsCustomizable <Boolean>]
 [-IsRenameable <Boolean>] [-IsSecured <Boolean>] [-IsValidForAdvancedFind <Boolean>]
 [-Required <CrmRequiredLevel>] [-SchemaName <String>] [-ExternalName <String>]
 [-IsGlobalFilterEnabled <Boolean>] [-IsSortableEnabled <Boolean>] [-IsDataSourceSecret] [-PassThru]
 [<CommonParameters>]

DESCRIPTION

Add an attribute of type Image.

EXAMPLES

PARAMETERS

-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: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Entity

The LogicalName of the entity to add the attribute to.

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

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

-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

-IsDataSourceSecret

Indicates whether the field contains sensitive information. Only applies to Attribute in DataSource Entities

Type: System.Management.Automation.SwitchParameter
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 for the attribute.

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

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

-PassThru

Returns an object that represents the ImageAttributeMetadata. 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

-SchemaName

The SchemaName for the attribute. If omitted the Name will be used as the SchemaName.

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

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.ImageAttributeMetadata

NOTES

RELATED LINKS

Add-CrmBigIntAttribute

Add-CrmBooleanAttribute

Add-CrmDateTimeAttribute

Add-CrmDecimalAttribute

Add-CrmDoubleAttribute

Add-CrmIntegerAttribute

Add-CrmMemoAttribute

Add-CrmMoneyAttribute

Add-CrmOptionSetAttribute

Add-CrmStringAttribute

ImageAttributeMetadata Class