Compartilhar via

Remove-AzApiManagementProduct

  • Referência
Módulo:
Az.ApiManagement

Remove um produto de Gerenciamento de API existente.

Sintaxe

Remove-AzApiManagementProduct
      -Context <PsApiManagementContext>
      -ProductId <String>
      [-DeleteSubscriptions]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O cmdlet Remove-AzApiManagementProduct remove um produto de Gerenciamento de API existente.

Exemplos

Exemplo 1: remover um produto existente e todas as assinaturas

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementProduct -Context $apimContext -ProductId "0123456789" -DeleteSubscriptions

Esse comando remove um produto existente e todas as assinaturas.

Parâmetros

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Context

Especifica uma instância do objeto PsApiManagementContext .

Tipo:PsApiManagementContext
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga: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
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DeleteSubscriptions

Indica se as assinaturas devem ser excluídas para o produto. Se você não definir esse parâmetro e as assinaturas existirem, uma exceção será gerada.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-PassThru

Indica que esse cmdlet retorna um valor de $True, se for bem-sucedido ou um valor de $False, se falhar.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ProductId

Especifica o identificador do produto existente.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

PsApiManagementContext

String

SwitchParameter

Saídas

Boolean