Partilhar via

Remove-AzApiManagementApiRelease

  • Referência
Módulo:
Az.ApiManagement

Remove uma versão específica da API

Syntax

Remove-AzApiManagementApiRelease
      -Context <PsApiManagementContext>
      -ApiId <String>
      -ReleaseId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzApiManagementApiRelease
      -InputObject <PsApiManagementApiRelease>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O cmdlet Remove-AzApiManagementApiRelease remove uma versão de API existente.

Exemplos

Exemplo 1: Remover uma versão da API

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementApiRelease -Context $apimContext -ApiId "echo-api" -ReleaseId "2"

Este comando remove a versão da API com o ApiId e o ReleaseId especificados.

Parâmetros

-ApiId

Identificador da API. Este parâmetro é obrigatório.

Tipo:String
Position:Named
valor predefinido:None
Necessário:True
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

Instância de PsApiManagementContext. Este parâmetro é obrigatório.

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

-InputObject

Instância de PsApiManagementApiRelease. Este parâmetro é obrigatório.

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

-PassThru

Se especificado irá escrever true caso a operação seja bem-sucedida. Este parâmetro é opcional.

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

-ReleaseId

Identificador da versão da API. Este parâmetro é obrigatório.

Tipo:String
Position:Named
valor predefinido:None
Necessário:True
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

PsApiManagementApiRelease

String

Saídas

Boolean