Set-MgmtSvcPlan

Updates the properties of a service plan.

Syntax

Set-MgmtSvcPlan [-AdminUri] <Uri> [-Token] <String> [-DisplayName] <String> [[-State] <PlanState>]
 [[-MaxSubscriptionsPerAccount] <Int32>] [[-InvitationCode] <String>] [[-Price] <String>] [-PlanId] <String>
 [[-SecurityGroup] <String[]>] [-Confirm] [-DisableCertificateValidation] [-WhatIf] [<CommonParameters>]
Set-MgmtSvcPlan [-AdminUri] <Uri> [-Token] <String> [[-Plan] <Plan>] [-Confirm] [-DisableCertificateValidation]
 [-WhatIf] [<CommonParameters>]

Description

The Set-MgmtSvcPlan cmdlet updates the properties of a service plan.

Examples

Example 1: Update a service plan

PS C:\> Set-MgmtSvcPlan -AdminUri "https://Computer01:30004" -Token $Token -DisplayName "Service Plan 01" -PlanId "4396660b" -State Public
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 updates the state of the plan named Service Plan 01, making it public.

Parameters

-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 the display name of a plan.

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

-InvitationCode

Specifies the invitation code for the plan.
This code allows tenants to subscribe to the plan.

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

-MaxSubscriptionsPerAccount

Specifies the maximum subscriptions that are allowed per account for the plan.

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

-Plan

Specifies a plan object.
To get a plan object, use the Get-MgmtSvcPlan cmdlet.

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

-PlanId

Specifies the ID of a plan.

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

-Price

Specifies the price for subscribing to the plan.

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

-SecurityGroup

Specifies an array of security groups that can be associated with a plan.
The plan is only visible for subscription by members of these security groups.

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

-State

Specifies the state of the plan.
Valid values are:

- Public. Tenants can subscribe to a plan only when it is public.
- Private. This is the initial state of a plan after it is created.
- Decomissioned. The plan is active, but will not accept any new subscriptions.

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