Partilhar via

Set-AzApiManagementProduct

  • Referência
Módulo:
Az.ApiManagement

Define os detalhes do produto Gerenciamento de API.

Syntax

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

Description

O cmdlet Set-AzApiManagementProduct define os detalhes do produto API Management.

Exemplos

Exemplo 1: Atualizar os detalhes do produto

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

Este comando atualiza os detalhes do produto Gerenciamento de API, requer uma assinatura e cancela a publicação.

Parâmetros

-ApprovalRequired

Indica se a assinatura do produto requer aprovação. O valor padrão é $False.

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

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Especifica uma instância do 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

-PassThru

Passthru

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

-ProductId

Especifica o identificador do produto existente.

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

-State

Especifica o estado do produto. psdx_paramvalues

  • NãoPublicado
  • Publicado
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 para esse parâmetro é $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 padrão para esse parâmetro é 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 definido por esse cmdlet.

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

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:False
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]]

SwitchParameter

Saídas

PsApiManagementProduct