Edit

Share via

Set-AzureStoreAddOn

  • Reference
Module:
Azure

Updates an existing add-on instance.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Set-AzureStoreAddOn
   -Name <String>
   -Plan <String>
   [-PromotionCode <String>]
   [-PassThru]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.

This cmdlet updates an existing add-on instance from the current subscription.

Examples

Example 1

PS C:\> Set-AzureStoreAddOn MyAddOn NewPlanId

This example updates an add-on with a new plan ID.

Example 2

PS C:\> Set-AzureStoreAddOn MyAddOn NewPlanId MyPromoCode

This example updates an add-on with a new plan ID and promotional code.

Parameters

-Name

Specifies the name of the add-on instance.

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

-PassThru

If specified, the cmdlet returns true if the command succeeds and false if it fails.

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

-Plan

Specifies the plan ID.

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

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

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

-PromotionCode

Specifies the promotional code.

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