Set-​Azure​Rm​Api​Management​Product

Sets the API Management product details.

Syntax

Set-AzureRmApiManagementProduct
   [-ApprovalRequired <Boolean>]
   -Context <PsApiManagementContext>
   [-Description <String>]
   [-LegalTerms <String>]
   [-PassThru]
   -ProductId <String>
   [-State <PsApiManagementProductState>]
   [-SubscriptionRequired <Boolean>]
   [-SubscriptionsLimit <Int32>]
   [-Title <String>]
   [<CommonParameters>]

Description

The Set-AzureRmApiManagementProduct cmdlet sets the API Management product details.

Examples

Example 1: Update the product details

PS C:\>Set-AzureRmApiManagementProduct -Context $APImContext -ProductId "0123456789" -Title "Starter" -Description "Starter Product" -LegalTerms "Free for all" -SubscriptionRequired $True -State "NotPublished"

This command updates the API Management product details, requires a subscription, and then unpublishes.

Required Parameters

-Context

Specifies an instance of the PsApiManagementContext object.

Type:PsApiManagementContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ProductId

Specifies the identifier of the existing product.

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

Optional Parameters

-ApprovalRequired

Indicates whether the subscription to the product requires approval. The default value is $False.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Description

Specifies the product description.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-LegalTerms

Specifies the legal terms of use of the product.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PassThru

passthru

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-State

Specifies the product state. psdx_paramvalues

  • NotPublished
  • Published
Type:PsApiManagementProductState
Parameter Sets:NotPublished, Published
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SubscriptionRequired

Indicates whether the product requires a subscription. The default value for this parameter is $True.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SubscriptionsLimit

Specifies the maximum number of simultaneous subscriptions. The default value for this parameter is 1.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Title

Specifies the product title this cmdlet sets.

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

Outputs

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct