Add-AzApiManagementApiToGateway

  • リファレンス
モジュール:
Az.ApiManagement

API をゲートウェイにアタッチします。

構文

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

説明

Add-AzApiManagementApiToGateway コマンドレットは、Azure API Management API をゲートウェイに追加します。

例

例 1

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

このコマンドは、指定した API を指定したゲートウェイに追加します。

パラメーター

-ApiId

既存の API の識別子。 このパラメーターは必須です。

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

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-Context

PsApiManagementContext のインスタンス。 このパラメーターは必須です。

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

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

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

-GatewayId

既存のゲートウェイの識別子。 このパラメーターは必須です。

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

-PassThru

指定した場合、操作が成功した場合に true が書き込まれます。 このパラメーターは省略可能です。 既定値は false です。

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

-ProvisioningState

プロビジョニング状態 (作成)。 このパラメーターは省略可能です。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

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

入力

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

出力

Boolean