< Back
Set-AzureRmVMPlan
Post
NAME Set-AzureRmVMPlan
SYNOPSIS
Sets the Marketplace plan information on a virtual machine.
SYNTAX
Set-AzureRmVMPlan [-VM] <PSVirtualMachine> [-Name] <String> [[-Product] <String>] [[-PromotionCode] <String>] [[-Publisher] <String>]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmVMPlan cmdlet sets the Azure Marketplace plan information for a virtual machine.
Before being able to deploy a Marketplace image through the command-line, programmatic access must be enabled or the virtual machine must be
deployed by using the Azure portal.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the image from the Marketplace. This is the same value that is returned by the Get-AzureRmVMImageSku cmdlet. For more
information about how to find image information, see Navigating and Selecting Azure Virtual Machine images with PowerShell and the Azure
CLIhttps://azure.microsoft.com/documentation/articles/resource-groups-vm-searching/
(https://azure.microsoft.com/documentati ... searching/) in the Microsoft Azure documentation.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Product <String>
Specifies the product of the image from the Marketplace. This is the same information as the Offer value of the imageReference element.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PromotionCode <String>
Specifies a promotion code.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Publisher <String>
Specifies the publisher of the image. You can find this information by using the Get-AzureRmVMImagePublisher cmdlet.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VM <PSVirtualMachine>
Specifies the virtual machine object for which to set a Marketplace plan. You can use the Get-AzureRmVM cmdlet to obtain a virtual machine
object. You can use the New-AzureRmVMConfig cmdlet to create a virtual machine object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSVirtualMachine
Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine
NOTES
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rermvmplan
Get-AzureRmVmssDiskEncryption
Get-AzureRmVMImagePublisher
Get-AzureRmVMImageSku
New-AzureRmVMConfig
SYNOPSIS
Sets the Marketplace plan information on a virtual machine.
SYNTAX
Set-AzureRmVMPlan [-VM] <PSVirtualMachine> [-Name] <String> [[-Product] <String>] [[-PromotionCode] <String>] [[-Publisher] <String>]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmVMPlan cmdlet sets the Azure Marketplace plan information for a virtual machine.
Before being able to deploy a Marketplace image through the command-line, programmatic access must be enabled or the virtual machine must be
deployed by using the Azure portal.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the image from the Marketplace. This is the same value that is returned by the Get-AzureRmVMImageSku cmdlet. For more
information about how to find image information, see Navigating and Selecting Azure Virtual Machine images with PowerShell and the Azure
CLIhttps://azure.microsoft.com/documentation/articles/resource-groups-vm-searching/
(https://azure.microsoft.com/documentati ... searching/) in the Microsoft Azure documentation.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Product <String>
Specifies the product of the image from the Marketplace. This is the same information as the Offer value of the imageReference element.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PromotionCode <String>
Specifies a promotion code.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Publisher <String>
Specifies the publisher of the image. You can find this information by using the Get-AzureRmVMImagePublisher cmdlet.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VM <PSVirtualMachine>
Specifies the virtual machine object for which to set a Marketplace plan. You can use the Get-AzureRmVM cmdlet to obtain a virtual machine
object. You can use the New-AzureRmVMConfig cmdlet to create a virtual machine object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSVirtualMachine
Parameter 'VM' accepts value of type 'PSVirtualMachine' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine
NOTES
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rermvmplan
Get-AzureRmVmssDiskEncryption
Get-AzureRmVMImagePublisher
Get-AzureRmVMImageSku
New-AzureRmVMConfig