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

Description

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 指向的 Backend 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

本範例會更新指向的 ServiceUrl echo-api 。

參數

-ApiId

指定要修改之 API 的識別碼。

類型:	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

共用方式為

Set-AzApiManagementApi

語法

Description

範例

範例 1：修改 API

範例 2：將 API 新增至現有的 ApiVersionSet

範例 3：變更 API 指向的 Backend ServiceUrl

參數

-ApiId

-ApiType

-AuthorizationScope

-AuthorizationServerId

-BearerTokenSendingMethod

-ContactEmail

-ContactName

-ContactUrl

-Context

-DefaultProfile

-Description

-InputObject

-LicenseName

-LicenseUrl

-Name

-OpenIdProviderId

-PassThru

-Path

-Protocols

-ServiceUrl

-SubscriptionKeyHeaderName

-SubscriptionKeyQueryParamName

-SubscriptionRequired

-TermsOfServiceUrl

輸入

輸出

其他資源

共用方式為

Set-AzApiManagementApi

語法

Description

範例

範例 1：修改 API

範例 2：將 API 新增至現有的 ApiVersionSet

範例 3：變更 API 指向的 Backend ServiceUrl

參數

-ApiId

-ApiType

-AuthorizationScope

-AuthorizationServerId

-BearerTokenSendingMethod

-ContactEmail

-ContactName

-ContactUrl

-Context

-DefaultProfile

-Description

-InputObject

-LicenseName

-LicenseUrl

-Name

-OpenIdProviderId

-PassThru

-Path

-Protocols

-ServiceUrl

-SubscriptionKeyHeaderName

-SubscriptionKeyQueryParamName

-SubscriptionRequired

-TermsOfServiceUrl

輸入

輸出

相關連結

其他資源