Sdílet prostřednictvím

Remove-AzApiManagementApi

  • Reference
Modul:
Az.ApiManagement

Odebere rozhraní API.

Syntax

Remove-AzApiManagementApi
      -Context <PsApiManagementContext>
      -ApiId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Rutina Remove-AzApiManagementApi odebere existující rozhraní API.

Příklady

Příklad 1: Odebrání rozhraní API

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementApi -Context $apimContext -ApiId "0123456789"

Tento příkaz odebere rozhraní API se zadaným ID.

Parametry

-ApiId

Určuje ID odebrání rozhraní API.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Před spuštěním rutiny zobrazí výzvu k potvrzení.

Typ:SwitchParameter
Aliases:cf
Position:Named
výchozí hodnota:False
Vyžadováno:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Určuje PsApiManagementContext objektu.

Typ:PsApiManagementContext
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Typ:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

passthru

Typ:SwitchParameter
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.

Typ:SwitchParameter
Aliases:wi
Position:Named
výchozí hodnota:False
Vyžadováno:False
Accept pipeline input:False
Accept wildcard characters:False

Vstupy

PsApiManagementContext

String

SwitchParameter

Výstupy

Boolean