Get-SCSPFVMRoleGalleryItemIcon

  • Reference
Module:
spfadmin

Gets the icon associated with a gallery item.

Syntax

Get-SCSPFVMRoleGalleryItemIcon
   [-VMRoleGalleryItem] <VMRoleGalleryItem>
   -IconFileName <String>
   [<CommonParameters>]
Get-SCSPFVMRoleGalleryItemIcon
   -Name <String>
   -Version <String>
   -Publisher <String>
   -IconFileName <String>
   [<CommonParameters>]

Description

The Get-SCSPFVMRoleGalleryItemIcon cmdlet gets a System.IO.MemoryStream object for the icon that is associated with a gallery item used by a virtual machine role.

Examples

PS C:\>$GalleryItem = Get-SCSPFVMRoleGalleryItem -Name 570569955cbfb62b374358b34467020750f65c
PS C:\> $GalleryItemIcon = Get-SCSPFVMRoleGalleryItemIcon -Name $GalleryItem.Name -Publisher $GalleryItem.Publisher -Version $GalleryItem.Version -IconFilename "Contoso.ico"

The first command gets a gallery item and stores it in $GalleryItem.

The second command gets the icon object by specifying the required parameters with the variable. Specify the IconFileName parameter explicitly in case the variable has a null value for the icon file name.

Parameters

-IconFileName

Specifies the file name of the icon.

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

-Name

Specifies the name of the item.

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

-Publisher

Specifies the publisher of the item.

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

-Version

Specifies the version of the item.

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

-VMRoleGalleryItem

Specifies the gallery item associated with the icon.

Type:VMRoleGalleryItem
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False