Get-SCSPFVMRoleGalleryItemIcon
Gets the icon associated with a gallery item.
Syntax
FromGalleryItemParameterSetName (Default)
Get-SCSPFVMRoleGalleryItemIcon
[-VMRoleGalleryItem] <VMRoleGalleryItem>
-IconFileName <String>
[<CommonParameters>]
FromGalleryItemNameVersionPublisherParameterSetName
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
Example 1: Get the icon associated with a gallery item
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.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of the item.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromGalleryItemNameVersionPublisherParameterSetName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Publisher
Specifies the publisher of the item.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromGalleryItemNameVersionPublisherParameterSetName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Version
Specifies the version of the item.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromGalleryItemNameVersionPublisherParameterSetName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMRoleGalleryItem
Specifies the gallery item associated with the icon.
Parameter properties
| Type: | Microsoft.SystemCenter.Foundation.SPFData.Types.Gallery.VMRoleGalleryItem |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromGalleryItemParameterSetName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.