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

Set-AzApiManagementApi

模块:

Az.ApiManagement

修改 API。

语法

Set-AzApiManagementApi
   -Context <PsApiManagementContext>
   -ApiId <String>
   [-Name <String>]
   [-Description <String>]
   [-ServiceUrl <String>]
   [-Path <String>]
   [-Protocols <PsApiManagementSchema[]>]
   [-AuthorizationServerId <String>]
   [-AuthorizationScope <String>]
   [-OpenIdProviderId <String>]
   [-BearerTokenSendingMethod <String[]>]
   [-SubscriptionKeyHeaderName <String>]
   [-SubscriptionKeyQueryParamName <String>]
   [-SubscriptionRequired]
   [-PassThru]
   [-ApiType <PsApiManagementApiType>]
   [-TermsOfServiceUrl <String>]
   [-ContactName <String>]
   [-ContactUrl <String>]
   [-ContactEmail <String>]
   [-LicenseName <String>]
   [-LicenseUrl <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Set-AzApiManagementApi
   -InputObject <PsApiManagementApi>
   [-Name <String>]
   [-Description <String>]
   [-ServiceUrl <String>]
   [-Path <String>]
   [-Protocols <PsApiManagementSchema[]>]
   [-AuthorizationServerId <String>]
   [-AuthorizationScope <String>]
   [-OpenIdProviderId <String>]
   [-BearerTokenSendingMethod <String[]>]
   [-SubscriptionKeyHeaderName <String>]
   [-SubscriptionKeyQueryParamName <String>]
   [-SubscriptionRequired]
   [-PassThru]
   [-ApiType <PsApiManagementApiType>]
   [-TermsOfServiceUrl <String>]
   [-ContactName <String>]
   [-ContactUrl <String>]
   [-ContactEmail <String>]
   [-LicenseName <String>]
   [-LicenseUrl <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

说明

Set-AzApiManagementApi cmdlet 修改 Azure API 管理 API。

示例

示例 1：修改 API

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApi -Context $ApiMgmtContext -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https') -Description "Responds with what was sent" -Path "echo"

示例 2：将 API 添加到现有 ApiVersionSet

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$versionSet = New-AzApiManagementApiVersionSet -Context $context -Name "Echo API Version Set" -Scheme Segment -Description "version set sample"
$api = Get-AzApiManagementApi -Context $ApiMgmtContext -ApiId "echo-api"
$api.ApiVersionSetId = $versionSet.Id
$api.ApiVersion = "v1"
$api.ApiVersionSetDescription = $versionSet.Description
Set-AzApiManagementApi -InputObject $api -PassThru

此示例将 API 添加到现有 API 版本集

示例 3：更改 API 指向的后端 ServiceUrl

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$updatedApiServiceUrl = "http://newechoapi.cloudapp.net/updateapi"
$updatedApi = Set-AzApiManagementApi -Context $ApiMgmtContext -ApiId $echoApiId -ServiceUrl $updatedApiServiceUrl

此示例更新指向的 echo-api ServiceUrl。

参数

-ApiId

指定要修改的 API 的 ID。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-ApiType

要创建的 API 类型（http、soap、websocket、graphql）。 此参数是可选的。

类型:	Nullable<T>[PsApiManagementApiType]
接受的值:	Http, Soap, WebSocket, GraphQL
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-AuthorizationScope

指定 OAuth 操作范围。 默认值为$Null。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-AuthorizationServerId

指定 OAuth 授权服务器标识符。 默认值为$Null。 如果 指定 AuthorizationScope ，则必须指定此参数。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-BearerTokenSendingMethod

OpenId 授权服务器机制，通过该机制将访问令牌传递给 API。 请参阅 https://datatracker.ietf.org/doc/html/rfc6749#section-4 。 此参数是可选的。 默认值为$null。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-ContactEmail

联系人/组织的电子邮件地址。 必须采用电子邮件地址的格式。 此参数是可选的。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-ContactName

联系人/组织的标识名称。 此参数是可选的。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-ContactUrl

指向联系信息的 URL。 必须采用 URL 格式。 此参数是可选的。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-Context

指定 PsApiManagementContext 对象。

类型:	PsApiManagementContext
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-DefaultProfile

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

类型:	IAzureContextContainer
别名:	AzContext, AzureRmContext, AzureCredential
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Description

指定 Web API 的说明。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-InputObject

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

类型:	PsApiManagementApi
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-LicenseName

用于 API 的许可证名称。 此参数是可选的。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-LicenseUrl

API 服务条款的 URL。 此参数是可选的。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-Name

指定 Web API 的名称。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-OpenIdProviderId

OpenId 授权服务器标识符。 此参数是可选的。 默认值为$null。 如果指定 BearerTokenSendingMethods，则必须指定。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-PassThru

passthru

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-Path

指定 Web API 路径，这是 API 公共 URL 的最后一部分。 API 使用者使用此 URL 向 Web 服务发送请求，并且长度必须为 400 个字符。 默认值为$Null。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-Protocols

指定 Web API 协议数组。 psdx_paramvalues http 和 https。 这些是 API 可用时使用的 Web 协议。 默认值为$Null。

类型:	PsApiManagementSchema[]
接受的值:	Http, Https, Ws, Wss
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-ServiceUrl

指定公开 API 的 Web 服务的 URL。 此 URL 仅供 Azure API 管理使用，不公开。 URL 长度必须为 2000 个字符。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-SubscriptionKeyHeaderName

指定订阅密钥标头的名称。 默认值为$Null。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-SubscriptionKeyQueryParamName

指定订阅密钥查询字符串参数的名称。 默认值为$Null。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-SubscriptionRequired

用于对 Api 的请求强制实施 SubscriptionRequired 的标志。 此参数是可选的。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-TermsOfServiceUrl

API 服务条款的 URL。 此参数是可选的。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

输入

PsApiManagementContext

String

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

输出

PsApiManagementApi

相关链接

• Export-AzApiManagementApi
• Get-AzApiManagementApi
• Import-AzApiManagementApi
• New-AzApiManagementApi
• Remove-AzApiManagementApi