Update-AzApiManagementGateway

リファレンス

モジュール:: Az.ApiManagement

API Management Gateway を構成します。

構文

Update-AzApiManagementGateway
      -Context <PsApiManagementContext>
      -GatewayId <String>
      [-Description <String>]
      [-LocationData <PsApiManagementResourceLocation>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzApiManagementGateway
      -InputObject <PsApiManagementGateway>
      [-Description <String>]
      [-LocationData <PsApiManagementResourceLocation>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzApiManagementGateway
      -ResourceId <String>
      [-Description <String>]
      [-LocationData <PsApiManagementResourceLocation>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Update-AzApiManagementGateway コマンドレットは、API 管理ゲートウェイを構成します。

例

例 1: 管理グループを構成する

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Update-AzApiManagementGateway -Context $apimContext -GatewayId "0001" -Description "Updated Gateway"

このコマンドは、ゲートウェイを構成します。

パラメーター

-Confirm

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Context

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

型:	PsApiManagementContext
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-DefaultProfile

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

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Description

ゲートウェイの説明。このパラメーターは省略可能です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-GatewayId

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

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-InputObject

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

型:	PsApiManagementGateway
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-LocationData

ゲートウェイの場所。このパラメーターは省略可能です。

型:	PsApiManagementResourceLocation
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-PassThru

指定した場合、変更されたゲートウェイを表す Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGateway 型のインスタンス。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ResourceId

ゲートウェイの Arm ResourceId。このパラメーターは必須です。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-WhatIf

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

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False