< Back
New-AzureRmApiManagementProduct
Post
NAME New-AzureRmApiManagementProduct
SYNOPSIS
Creates an API Management product.
SYNTAX
New-AzureRmApiManagementProduct [-ApprovalRequired <Boolean>] -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>]
[-Description <String>] [-LegalTerms <String>] [-ProductId <String>] [-State {NotPublished | Published}] [-SubscriptionRequired <Boolean>]
[-SubscriptionsLimit <Int32>] -Title <String> [<CommonParameters>]
DESCRIPTION
The New-AzureRmApiManagementProduct cmdlet creates an API Management product.
PARAMETERS
-ApprovalRequired <Boolean>
Indicates whether the subscription to the product requires approval or not. By default, this parameter is $False .
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Context <PsApiManagementContext>
Specifies an instance of a 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
-ProductId <String>
Specifies the identifier of new product. If you do not specify this parameter, a new product is generated.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-State <PsApiManagementProductState>
Specifies the product state. psdx_paramvalues
- NotPublished
- Published
The default value is NotPublished.
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 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 is 1.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Title <String>
Specifies the product title.
Required? true
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: Create a product that does not require a subscription
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>New-AzureRmApiManagementProduct -Context $apimContext -ProductId "0123456789" -Title "Starter" -Description "Starter Product" -LegalTerms
"Free for all" -SubscriptionRequired $False -State "Published"
This command creates an API Management product. No subscription is required.
Example 2: Create a product that requires a subscription and approval
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>New-AzureRmApiManagementProduct -Context $apimContext -ProductId "9876543210" -Title "Unlimited" -Description "Subscribers have completely
unlimited access to the API. Administrator approval is required." -LegalTerms "Free for all" -ApprovalRequired $True -State "Published"
-NotificationPeriod "D10" -SubscriptionPeriod "Y1"
This command creates a product. A subscription and approval are required. This command sets the notification period to 10 days. The subscription
duration is set to one year.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... entproduct
Get-AzureRmApiManagementProduct
Remove-AzureRmApiManagementProduct
Set-AzureRmApiManagementProduct
SYNOPSIS
Creates an API Management product.
SYNTAX
New-AzureRmApiManagementProduct [-ApprovalRequired <Boolean>] -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>]
[-Description <String>] [-LegalTerms <String>] [-ProductId <String>] [-State {NotPublished | Published}] [-SubscriptionRequired <Boolean>]
[-SubscriptionsLimit <Int32>] -Title <String> [<CommonParameters>]
DESCRIPTION
The New-AzureRmApiManagementProduct cmdlet creates an API Management product.
PARAMETERS
-ApprovalRequired <Boolean>
Indicates whether the subscription to the product requires approval or not. By default, this parameter is $False .
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Context <PsApiManagementContext>
Specifies an instance of a 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
-ProductId <String>
Specifies the identifier of new product. If you do not specify this parameter, a new product is generated.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-State <PsApiManagementProductState>
Specifies the product state. psdx_paramvalues
- NotPublished
- Published
The default value is NotPublished.
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 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 is 1.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Title <String>
Specifies the product title.
Required? true
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: Create a product that does not require a subscription
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>New-AzureRmApiManagementProduct -Context $apimContext -ProductId "0123456789" -Title "Starter" -Description "Starter Product" -LegalTerms
"Free for all" -SubscriptionRequired $False -State "Published"
This command creates an API Management product. No subscription is required.
Example 2: Create a product that requires a subscription and approval
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>New-AzureRmApiManagementProduct -Context $apimContext -ProductId "9876543210" -Title "Unlimited" -Description "Subscribers have completely
unlimited access to the API. Administrator approval is required." -LegalTerms "Free for all" -ApprovalRequired $True -State "Published"
-NotificationPeriod "D10" -SubscriptionPeriod "Y1"
This command creates a product. A subscription and approval are required. This command sets the notification period to 10 days. The subscription
duration is set to one year.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... entproduct
Get-AzureRmApiManagementProduct
Remove-AzureRmApiManagementProduct
Set-AzureRmApiManagementProduct