你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Set-AzApiManagementBackend

更新后端。

语法

ContextParameterSet (默认值)

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>]

ByInputObject

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 管理中的现有后端。

示例

示例 1:更新后端 123 的说明

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

示例 2

更新后端。 (autogenerated)

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

新后端的标识符。 此参数是必需的。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ContextParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Confirm

在运行 cmdlet 之前,提示你进行确认。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Context

PsApiManagementContext 的实例。 此参数是必需的。

参数属性

类型:PsApiManagementContext
默认值:None
支持通配符:False
不显示:False

参数集

ContextParameterSet
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Credential

与后端通信时应使用的凭据详细信息。 此参数是可选的。

参数属性

类型:PsApiManagementBackendCredential
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Description

后端说明。 此参数是可选的。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-InputObject

PsApiManagementBackend 的实例。 此参数是必需的。

参数属性

类型:PsApiManagementBackend
默认值:None
支持通配符:False
不显示:False

参数集

ByInputObject
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PassThru

指示此 cmdlet 返回此 cmdlet 修改的 PsApiManagementBackend

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Protocol

后端通信协议(http 或 soap)。 此参数是可选的

参数属性

类型:String
默认值:None
接受的值:http, soap
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Proxy

将请求发送到后端时要使用的代理服务器详细信息。 此参数是可选的。

参数属性

类型:PsApiManagementBackendProxy
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-ResourceId

外部系统中资源的管理 URI。 Azure 资源的绝对 http URL。 此参数是可选的。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-ServiceFabricCluster

Service Fabric 群集后端详细信息。 此参数是可选的。

参数属性

类型:PsApiManagementServiceFabric
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-SkipCertificateChainValidation

在与后端通信时是否跳过证书链验证。 此参数是可选的。

参数属性

类型:

Nullable<T>[Boolean]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-SkipCertificateNameValidation

在与后端通信时是否跳过证书名称验证。 此参数是可选的。

参数属性

类型:

Nullable<T>[Boolean]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Title

后端标题。 此参数是可选的。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Url

后端的运行时 URL。 此参数是可选的。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

PsApiManagementContext

String

Nullable<T>

PsApiManagementBackendCredential

PsApiManagementBackendProxy

PsApiManagementServiceFabric

SwitchParameter

输出

PsApiManagementBackend