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

Latest commit

 

History

History
156 lines (115 loc) · 3.51 KB

Get-CrmPluginStepImage.md

File metadata and controls

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

Get-CrmPluginStepImage

SYNOPSIS

Get SDK Message Processing Step Image.

SYNTAX

GetPluginStepImageByFilter (Default)

Get-CrmPluginStepImage [[-PluginStep] <Guid>] [-ImageType <CrmPluginImageType>] [-IncludeTotalCount]
 [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]

GetPluginStepImageById

Get-CrmPluginStepImage -Id <Guid> [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]

DESCRIPTION

Get SDK Message Processing Step Image.

EXAMPLES

Example 1

PS C:\> Get-CrmPluginStepImage -PluginStep '1F1DE3ED-7CC0-497F-8A9A-DB9F1EE67B6F' -ImageType PostImage

Get post images for the specified SDK Message Processing Step.

PARAMETERS

-Id

The id of the SDK Message Processing Step image to retrieve.

Type: System.Guid
Parameter Sets: GetPluginStepImageById
Aliases:

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

-ImageType

The type of SDK Message Procesing Step image to retrieve. If not specified all image types are retrieved.

Type: AMSoftware.Crm.PowerShell.Common.CrmPluginImageType
Parameter Sets: GetPluginStepImageByFilter
Aliases:
Accepted values: PreImage, PostImage

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

-PluginStep

The id of the SDK Message Processing Step to retrieve images for.

Type: System.Guid
Parameter Sets: GetPluginStepImageByFilter
Aliases:

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

-IncludeTotalCount

Return the total count (and accuracy) of the number of records before returning the result.

Because of the limitations of Dynamics CRM, the total count is only returned accurate when the result is limited to 5000 items.

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

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

-Skip

Skips (does not return) the specified number of records.

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

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

-First

Specifies the number of records to retrieve from the beginning.

Type: System.UInt64
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.Guid

OUTPUTS

Microsoft.Xrm.Sdk.Entity

NOTES

RELATED LINKS

Register-CrmPluginStepImage

Set-CrmPluginStepImage

Unregister-CrmPluginStepImage

Get-CrmPluginStep

Entity Class