Set-MgmtSvcAddOn

Updates a service add-on.

Syntax

Set-MgmtSvcAddOn [-AdminUri] <Uri> [-Token] <String> [[-AddOn] <PlanAddOn>] [-Confirm]
 [-DisableCertificateValidation] [-WhatIf] [<CommonParameters>]
Set-MgmtSvcAddOn [-AdminUri] <Uri> [-Token] <String> [-DisplayName] <String> [[-State] <PlanState>]
 [[-MaxOccurrencesPerPlan] <Int32>] [-AddOnId] <String> [-Confirm] [-DisableCertificateValidation] [-WhatIf]
 [<CommonParameters>]

Description

The Set-MgmtSvcAddOn updates a service add-on.

Examples

Example 1: Update a service add-on

PS C:\> Set-MgmtSvcAddOn -AdminUri "https://Computer01:30004" -Token $Token -DisplayName "Add-On 01" -AddOnId "7b337b38" -State "Decommissioned"
NOTE: This example assumes that you have created a token by using **Get-MgmtSvcToken** and have stored it in a variable named $Token. This command decommissions the add-on named Add-On 01.

Parameters

-AddOn

Specifies an add-on object.
To get an add-on object, use the Get-MgmtSvcAddOn cmdlet.

Type:PlanAddOn
Required:False
Position:2
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

-AddOnId

Specifies the ID of an add-on.

Type:String
Required:True
Position:5
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-AdminUri

Specifies the URI of the Windows Azure Pack administrator API.
Use the following format: https://<computer>:<port>, where <computer> is the computer on which the administrator API is installed.

Type:Uri
Required:True
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableCertificateValidation

Disables certificate validation for the Windows Azure Pack installation.

If you specify this parameter, you can use self-signed certificates.

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

-DisplayName

Specifies a display name for an add-on.

Type:String
Required:True
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-MaxOccurrencesPerPlan

Specifies the maximum number of occurrences an add-on can exist for a plan.

Type:Int32
Required:False
Position:4
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-State

Specifies the state of an add-on.
Valid values are:

- Private
- Public
- Decommissioned

Type:PlanState
Parameter Sets:Private, Public, Decommissioned
Required:False
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-Token

Specifies an identity token.
To create a token, use the Get-MgmtSvcToken cmdlet.

Type:String
Required:True
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs.
The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False