Remove-AzApiManagementApiFromGateway
Collega un'API a un gateway.
Sintassi
Remove-AzApiManagementApiFromGateway
-Context <PsApiManagementContext>
-GatewayId <String>
-ApiId <String>
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Descrizione
Il cmdlet Remove-AzApiManagementApiFromGateway collega un'API a un gateway.
Esempio
Esempio 1: Rimuovere un'API da un gateway
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementApiFromGateway -Context $ApiMgmtContext -GatewayId "0123456789" -ApiId "0001" -PassThru
Questo comando rimuove l'API specificata da un gateway.
Esempio 2: Rimuovere un'API da un gateway gestito
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementApiFromGateway -Context $ApiMgmtContext -GatewayId "managed" -ApiId "0001" -PassThru
Questo comando rimuove l'API specificata dal gateway gestito.
Parametri
-ApiId
Identificatore delle API esistenti da rimuovere dal gateway. Questo parametro è obbligatorio.
Tipo: | String |
Position: | Named |
valore predefinito: | None |
Necessario: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
Richiede conferma prima di eseguire il cmdlet.
Tipo: | SwitchParameter |
Aliases: | cf |
Position: | Named |
valore predefinito: | None |
Necessario: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Context
Istanza di PsApiManagementContext. Questo parametro è obbligatorio.
Tipo: | PsApiManagementContext |
Position: | Named |
valore predefinito: | None |
Necessario: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DefaultProfile
Le credenziali, l’account, il tenant e la sottoscrizione usati per comunicare con Azure.
Tipo: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
valore predefinito: | None |
Necessario: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GatewayId
Identificatore del gateway esistente da cui rimuovere l'API. Questo parametro è obbligatorio.
Tipo: | String |
Position: | Named |
valore predefinito: | None |
Necessario: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PassThru
Se specificato scriverà true nel caso in cui l'operazione abbia esito positivo. Il parametro è facoltativo. Il valore predefinito è false.
Tipo: | SwitchParameter |
Position: | Named |
valore predefinito: | None |
Necessario: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Mostra gli effetti dell'esecuzione del cmdlet. Il cmdlet non viene eseguito.
Tipo: | SwitchParameter |
Aliases: | wi |
Position: | Named |
valore predefinito: | None |
Necessario: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |