Set-MgmtSvcAddOn
Updates a service add-on.
Syntax
Set-MgmtSvcAddOn
[-AddOnId] <String>
[-DisplayName] <String>
[[-State] <PlanState>]
[[-MaxOccurrencesPerPlan] <Int32>]
[-AdminUri] <Uri>
[-Token] <String>
[-DisableCertificateValidation]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-MgmtSvcAddOn
[[-AddOn] <PlanAddOn>]
[-AdminUri] <Uri>
[-Token] <String>
[-DisableCertificateValidation]
[-WhatIf]
[-Confirm]
[<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 |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AddOnId
Specifies the ID of an add-on.
| Type: | String |
| Position: | 5 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| 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 |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | 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 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisplayName
Specifies a display name for an add-on.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-MaxOccurrencesPerPlan
Specifies the maximum number of occurrences an add-on can exist for a plan.
| Type: | Int32 |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-State
Specifies the state of an add-on. Valid values are:
- Private
- Public
- Decommissioned
| Type: | PlanState |
| Accepted values: | Private, Public, Decommissioned |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Token
Specifies an identity token. To create a token, use the Get-MgmtSvcToken cmdlet.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |