Share via

Add-AzApiManagementApiToGateway

  • Referens
Modul:
Az.ApiManagement

Kopplar ett API till en gateway.

Syntax

Add-AzApiManagementApiToGateway
   -Context <PsApiManagementContext>
   -GatewayId <String>
   -ApiId <String>
   [-ProvisioningState <PsApiManagementGatewayApiProvisioningState>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Cmdleten Add-AzApiManagementApiToGateway lägger till ett Azure API Management API till en gateway.

Exempel

Exempel 1

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Add-AzApiManagementApiToGateway -Context $ApiMgmtContext -GatewayId "0123456789" -ApiId "0001"

Det här kommandot lägger till det angivna API:et i den angivna gatewayen.

Parametrar

-ApiId

Identifierare för befintligt API. Den här parametern krävs.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Instans av PsApiManagementContext. Den här parametern krävs.

Type:PsApiManagementContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GatewayId

Identifierare för befintlig gateway. Den här parametern krävs.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Om det anges skrivs true om åtgärden lyckas. Den här parametern är valfri. Standardvärdet är "falsk".

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ProvisioningState

Etableringstillstånd (skapat). Den här parametern är valfri.

Type:Nullable<T>[PsApiManagementGatewayApiProvisioningState]
Accepted values:Created
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Indata

PsApiManagementContext

String

Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGatewayApiProvisioningState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=2.0.1.0, Culture=neutral, PublicKeyToken=null]]

SwitchParameter

Utdata

Boolean