New-AzApiManagementProduct

  • Referenz
Modul:
Az.ApiManagement

Erstellt ein API-Verwaltungsprodukt.

Syntax

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

Beschreibung

Das Cmdlet New-AzApiManagementProduct erstellt ein API-Verwaltungsprodukt.

Beispiele

Beispiel 1: Erstellen eines Produkts, für das kein Abonnement erforderlich ist

$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"

Mit diesem Befehl wird ein API-Verwaltungsprodukt erstellt. Es ist kein Abonnement erforderlich.

Beispiel 2: Erstellen eines Produkts, das ein Abonnement und eine Genehmigung erfordert

$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"

Mit diesem Befehl wird ein Produkt erstellt. Ein Abonnement und eine Genehmigung sind erforderlich.

Parameter

-ApprovalRequired

Gibt an, ob das Abonnement für das Produkt eine Genehmigung erfordert oder nicht. Dieser Parameter ist standardmäßig $False.

Typ:Nullable<T>[Boolean]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Context

Gibt eine Instanz eines PsApiManagementContext -Objekts an.

Typ:PsApiManagementContext
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.

Typ:IAzureContextContainer
Aliase:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Description

Gibt die Produktbeschreibung an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-LegalTerms

Gibt die gesetzlichen Nutzungsbedingungen des Produkts an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ProductId

Gibt den Bezeichner des neuen Produkts an. Wenn Sie diesen Parameter nicht angeben, wird ein neues Produkt generiert.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-State

Gibt den Produktstatus an. psdx_paramvalues

  • NotPublished
  • Veröffentlicht Der Standardwert ist "NotPublished".
Typ:Nullable<T>[PsApiManagementProductState]
Zulässige Werte:NotPublished, Published
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-SubscriptionRequired

Gibt an, ob für das Produkt ein Abonnement erforderlich ist. Der Standardwert ist $True.

Typ:Nullable<T>[Boolean]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-SubscriptionsLimit

Gibt die maximale Anzahl gleichzeitiger Abonnements an. Der Standardwert ist Keiner.

Typ:Nullable<T>[Int32]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Title

Gibt den Produkttitel an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

Eingaben

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]]

Ausgaben

PsApiManagementProduct