Get-SCSPFVMRoleGalleryItemIcon
Applies To: System Center 2012 R2 Orchestrator
Get-SCSPFVMRoleGalleryItemIcon
Gets the icon associated with a virtual machine role item in the gallery.
Syntax
Parameter Set: FromGalleryItemParameterSetName
Get-SCSPFVMRoleGalleryItemIcon [-IconFileName] <String> [-VMRoleGalleryItem] <VMRoleGalleryItem> [ <CommonParameters>]
Parameter Set: FromGalleryItemNameVersionPublisherParameterSetName
Get-SCSPFVMRoleGalleryItemIcon -Name <String> -Publisher <String> -Version <String> [ <CommonParameters>]
Detailed Description
The Get-SCSPFVMRoleGalleryItemIcon gets System.IO.MemoryStream object of the icon associated with the gallery item.
Parameters
-Name<String>
Specifies the name of the gallery item.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Publisher<String>
Specifies the publisher of the gallery item.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Version<String>
Specifies the version of the gallery item.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMRoleGalleryItem<VMRoleGalleryItem>
Specifies the gallery item associated with the icon.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-IconFileName<String>
Specifies the file name of the icon.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
1: Get the icon for a gallery item
The first command gets a gallery item and stores it in the $galItem variable. The next command gets the icon object by specifying the required parameters with the variable. The IconFileName parameter is explicitly specified in case the variable has a null value for the icon file name.
PS C:\> $galItem = Get-SCSPFVMRoleGalleryItem -Name 570569955cbfb62b374358b34467020750f65c
PS C:\> $galItemIcon = Get-SCSPFVMRoleGalleryItemIcon -Name $galItem.Name -Publisher $galItem.Publisher -Version $galItem.Version -IconFilename "contoso.ico"