Partilhar via

New-AzApiManagementProduct

  • Referência
Módulo:
Az.ApiManagement

Cria um produto de gerenciamento de API.

Syntax

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

Description

O cmdlet New-AzApiManagementProduct cria um produto de Gerenciamento de API.

Exemplos

Exemplo 1: Criar um produto que não requer uma assinatura

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

Este comando cria um produto de Gerenciamento de API. Não é necessária subscrição.

Exemplo 2: Criar um produto que requer uma assinatura e aprovação

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

Este comando cria um produto. É necessária uma subscrição e aprovação.

Parâmetros

-ApprovalRequired

Indica se a assinatura do produto requer aprovação ou não. Por padrão, esse parâmetro é $False.

Tipo:Nullable<T>[Boolean]
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-Context

Especifica uma instância de um objeto PsApiManagementContext .

Tipo:PsApiManagementContext
Position:Named
valor predefinido:None
Necessário:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Especifica a descrição do produto.

Tipo:String
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-LegalTerms

Especifica os termos legais de uso do produto.

Tipo:String
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-ProductId

Especifica o identificador do novo produto. Se você não especificar esse parâmetro, um novo produto será gerado.

Tipo:String
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-State

Especifica o estado do produto. psdx_paramvalues

  • NãoPublicado
  • Publicado O valor padrão é NotPublished.
Tipo:Nullable<T>[PsApiManagementProductState]
valores aceites:NotPublished, Published
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionRequired

Indica se o produto requer uma assinatura. O valor padrão é $True.

Tipo:Nullable<T>[Boolean]
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionsLimit

Especifica o número máximo de assinaturas simultâneas. O valor predefinido é None.

Tipo:Nullable<T>[Int32]
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-Title

Especifica o título do produto.

Tipo:String
Position:Named
valor predefinido:None
Necessário:True
Accept pipeline input:True
Accept wildcard characters:False

Entradas

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

Saídas

PsApiManagementProduct