< Back
Set-AzureRmApiManagementProduct
Post
NAME Set-AzureRmApiManagementProduct
SYNOPSIS
Sets the API Management product details.
SYNTAX
Set-AzureRmApiManagementProduct [-ApprovalRequired <Boolean>] -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>]
[-Description <String>] [-LegalTerms <String>] [-PassThru] -ProductId <String> [-State {NotPublished | Published}] [-SubscriptionRequired
<Boolean>] [-SubscriptionsLimit <Int32>] [-Title <String>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmApiManagementProduct cmdlet sets the API Management product details.
PARAMETERS
-ApprovalRequired <Boolean>
Indicates whether the subscription to the product requires approval. The default value is $False .
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Context <PsApiManagementContext>
Specifies an instance of the PsApiManagementContext object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Specifies the product description.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-LegalTerms <String>
Specifies the legal terms of use of the product.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
passthru
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ProductId <String>
Specifies the identifier of the existing product.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-State <PsApiManagementProductState>
Specifies the product state. psdx_paramvalues
- NotPublished
- Published
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SubscriptionRequired <Boolean>
Indicates whether the product requires a subscription. The default value for this parameter is $True .
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SubscriptionsLimit <Int32>
Specifies the maximum number of simultaneous subscriptions. The default value for this parameter is 1.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Title <String>
Specifies the product title this cmdlet sets.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct
NOTES
Example 1: Update the product details
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... entproduct
Get-AzureRmApiManagementProduct
New-AzureRmApiManagementProduct
Remove-AzureRmApiManagementProduct
SYNOPSIS
Sets the API Management product details.
SYNTAX
Set-AzureRmApiManagementProduct [-ApprovalRequired <Boolean>] -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>]
[-Description <String>] [-LegalTerms <String>] [-PassThru] -ProductId <String> [-State {NotPublished | Published}] [-SubscriptionRequired
<Boolean>] [-SubscriptionsLimit <Int32>] [-Title <String>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmApiManagementProduct cmdlet sets the API Management product details.
PARAMETERS
-ApprovalRequired <Boolean>
Indicates whether the subscription to the product requires approval. The default value is $False .
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Context <PsApiManagementContext>
Specifies an instance of the PsApiManagementContext object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Specifies the product description.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-LegalTerms <String>
Specifies the legal terms of use of the product.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
passthru
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ProductId <String>
Specifies the identifier of the existing product.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-State <PsApiManagementProductState>
Specifies the product state. psdx_paramvalues
- NotPublished
- Published
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SubscriptionRequired <Boolean>
Indicates whether the product requires a subscription. The default value for this parameter is $True .
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SubscriptionsLimit <Int32>
Specifies the maximum number of simultaneous subscriptions. The default value for this parameter is 1.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Title <String>
Specifies the product title this cmdlet sets.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct
NOTES
Example 1: Update the product details
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... entproduct
Get-AzureRmApiManagementProduct
New-AzureRmApiManagementProduct
Remove-AzureRmApiManagementProduct