Condividi tramite


New-AzApiManagementProduct

Crea un prodotto Gestione API.

Sintassi

New-AzApiManagementProduct
   -Context <PsApiManagementContext>
   [-ProductId <String>]
   -Title <String>
   [-Description <String>]
   [-LegalTerms <String>]
   [-SubscriptionRequired <Boolean>]
   [-ApprovalRequired <Boolean>]
   [-SubscriptionsLimit <Int32>]
   [-State <PsApiManagementProductState>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Descrizione

Il cmdlet New-AzApiManagementProduct crea un prodotto Gestione API.

Esempio

Esempio 1: Creare un prodotto che non richiede una sottoscrizione

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementProduct -Context $apimContext -ProductId "0123456789" -Title "Starter" -Description "Starter Product" -LegalTerms "Free for all" -SubscriptionRequired $False -State "Published"

Questo comando crea un prodotto Gestione API. Non è necessaria alcuna sottoscrizione.

Esempio 2: Creare un prodotto che richiede una sottoscrizione e un'approvazione

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementProduct -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"

Questo comando crea un prodotto. Sono necessarie una sottoscrizione e un'approvazione.

Parametri

-ApprovalRequired

Indica se la sottoscrizione al prodotto richiede o meno l'approvazione. Per impostazione predefinita, questo parametro è $False.

Tipo:Nullable<T>[Boolean]
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-Context

Specifica un'istanza di un oggetto PsApiManagementContext .

Tipo:PsApiManagementContext
Position:Named
valore predefinito:None
Necessario:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifica la descrizione del prodotto.

Tipo:String
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-LegalTerms

Specifica le condizioni legali per l'utilizzo del prodotto.

Tipo:String
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-ProductId

Specifica l'identificatore del nuovo prodotto. Se non si specifica questo parametro, viene generato un nuovo prodotto.

Tipo:String
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-State

Specifica lo stato del prodotto. psdx_paramvalues

  • NotPubblicato
  • Pubblicato Il valore predefinito è NotPublished.
Tipo:Nullable<T>[PsApiManagementProductState]
valori accettati:NotPublished, Published
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionRequired

Indica se il prodotto richiede una sottoscrizione. Il valore predefinito è $True.

Tipo:Nullable<T>[Boolean]
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionsLimit

Specifica il numero massimo di sottoscrizioni simultanee. Il valore predefinito è None.

Tipo:Nullable<T>[Int32]
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-Title

Specifica il titolo del prodotto.

Tipo:String
Position:Named
valore predefinito:None
Necessario:True
Accept pipeline input:True
Accept wildcard characters:False

Input

PsApiManagementContext

String

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Nullable<T>[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProductState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Output

PsApiManagementProduct