Set-AzApiManagementBackend

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

バックエンドを更新します。

構文

Set-AzApiManagementBackend
   -Context <PsApiManagementContext>
   -BackendId <String>
   [-Protocol <String>]
   [-Url <String>]
   [-ResourceId <String>]
   [-Title <String>]
   [-Description <String>]
   [-SkipCertificateChainValidation <Boolean>]
   [-SkipCertificateNameValidation <Boolean>]
   [-Credential <PsApiManagementBackendCredential>]
   [-Proxy <PsApiManagementBackendProxy>]
   [-ServiceFabricCluster <PsApiManagementServiceFabric>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzApiManagementBackend
   -InputObject <PsApiManagementBackend>
   [-Protocol <String>]
   [-Url <String>]
   [-ResourceId <String>]
   [-Title <String>]
   [-Description <String>]
   [-SkipCertificateChainValidation <Boolean>]
   [-SkipCertificateNameValidation <Boolean>]
   [-Credential <PsApiManagementBackendCredential>]
   [-Proxy <PsApiManagementBackendProxy>]
   [-ServiceFabricCluster <PsApiManagementServiceFabric>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Api Management で既存のバックエンドを更新します。

例

例 1: バックエンド 123 の説明を更新する

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementBackend -Context $apimContext -BackendId 123 -Description "updated description" -PassThru

例 2

バックエンドを更新します。 (自動生成)

Set-AzApiManagementBackend -BackendId 123 -Context <PsApiManagementContext> -Credential <PsApiManagementBackendCredential> -Protocol http -ResourceId /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso -Url 'https://contoso.com/awesomeapi'

パラメーター

-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

-Credential

バックエンドと通信するときに使用する必要がある資格情報の詳細。 このパラメーターは省略可能です。

Type:PsApiManagementBackendCredential
Position:Named
Default value:None
Required:False
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

-Description

バックエンドの説明。 このパラメーターは省略可能です。

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

-InputObject

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

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

-PassThru

このコマンドレットが、このコマンドレットが変更した PsApiManagementBackend を返したことを示します。

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

-Protocol

バックエンド通信プロトコル (http または soap)。 このパラメータは省略可能です。

Type:String
Accepted values:http, soap
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Proxy

バックエンドへの要求の送信中に使用されるプロキシ サーバーの詳細。 このパラメーターは省略可能です。

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

-ResourceId

外部システムのリソースの管理 URI。 Azure リソースの絶対 http URL。 このパラメーターは省略可能です。

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

-ServiceFabricCluster

Service Fabric クラスター バックエンドの詳細。 このパラメーターは省略可能です。

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

-SkipCertificateChainValidation

バックエンドと通信するときに証明書チェーンの検証をスキップするかどうか。 このパラメーターは省略可能です。

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

-SkipCertificateNameValidation

バックエンドと通信するときに証明書名の検証をスキップするかどうか。 このパラメーターは省略可能です。

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

-Title

バックエンド タイトル。 このパラメーターは省略可能です。

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

-Url

バックエンドのランタイム URL。 このパラメーターは省略可能です。

Type:String
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>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

PsApiManagementBackendCredential

PsApiManagementBackendProxy

PsApiManagementServiceFabric

SwitchParameter

出力

PsApiManagementBackend