Set-MgmtSvcPlan

Set-MgmtSvcPlan

Updates the properties of a service plan.

Syntax

Parameter Set: ByProperties
Set-MgmtSvcPlan [-AdminUri] <Uri> [-Token] <String> [-DisplayName] <String> [[-State] {Private | Public | Decommissioned} ] [[-MaxSubscriptionsPerAccount] <Int32> ] [[-InvitationCode] <String> ] [[-Price] <String> ] [-PlanId] <String> [-DisableCertificateValidation] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByObject
Set-MgmtSvcPlan [-AdminUri] <Uri> [-Token] <String> [[-Plan] <Plan> ] [-DisableCertificateValidation] [-Confirm] [-WhatIf] [ <CommonParameters>]


 

Detailed Description

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

Parameters

-AdminUri<Uri>

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.

 

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

 

-DisableCertificateValidation

Disables certificate validation for the Windows Azure Pack installation.

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

 

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

-DisplayName<String>

Specifies the display name of a plan.

 

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

 

-InvitationCode<String>

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

 

Aliases

none

Required?

false

Position?

6

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

 

-MaxSubscriptionsPerAccount<Int32>

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

 

Aliases

none

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

 

-Plan<Plan>

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

 

Aliases

none

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

 

-PlanId<String>

Specifies the ID of a plan.

 

Aliases

none

Required?

true

Position?

8

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

 

-Price<String>

Specifies the price for subscribing to the plan.

 

Aliases

none

Required?

false

Position?

7

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

 

-State<PlanState>

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.

The acceptable values for this parameter are:

 

Private

 

Public

 

Decommissioned

 

 

 

Aliases

none

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

 

-Token<String>

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

 

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

 

-Confirm

Prompts you for confirmation before executing the command.

 

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

 

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Examples

Example 1: Update a service plan

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.

PS C:\> Set-MgmtSvcPlan -AdminUri "https://Computer01:30004" -Token $Token -DisplayName "Service Plan 01" -PlanId "4396660b" -State Public

 

Related topics

Add-MgmtSvcPlan

Get-MgmtSvcPlan

Sync-MgmtSvcPlan

Remove-MgmtSvcPlan