Remove-AzApiManagementBackend

リファレンス

モジュール:: Az.ApiManagement

バックエンドを削除します。

構文

Remove-AzApiManagementBackend
      -Context <PsApiManagementContext>
      -BackendId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

識別子で指定されたバックエンドを Api Management から削除します。

例

例 1: バックエンド 123 を削除する

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementBackend -Context $apimContext -BackendId 123 -PassThru

パラメーター

-BackendId

既存のバックエンドの識別子。このパラメーターは必須です。

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

-PassThru

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

Type:	SwitchParameter
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

SwitchParameter

出力

Boolean