共用方式為


Set-AzApiManagementOperation

設定 API 作業詳細數據。

語法

Set-AzApiManagementOperation
   -Context <PsApiManagementContext>
   -ApiId <String>
   [-ApiRevision <String>]
   -OperationId <String>
   -Name <String>
   -Method <String>
   -UrlTemplate <String>
   [-Description <String>]
   [-TemplateParameters <PsApiManagementParameter[]>]
   [-Request <PsApiManagementRequest>]
   [-Responses <PsApiManagementResponse[]>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Set-AzApiManagementOperation Cmdlet 會設定 API 作業詳細數據。

範例

範例 1:設定作業詳細數據

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementOperation -Context $apimContext -ApiId $APIID -OperationId $OperationId -Name "Get Resource" -Method GET -UrlTemplate "/newresource" -Description "Use this operation to get newresource"

此命令會設定 API 管理的作業詳細資料。

範例 2

設定 API 作業詳細數據。 ( 自動產生 )

Set-AzApiManagementOperation -ApiId '0001' -Context <PsApiManagementContext> -Method 'GET' -Name 'ContosoApi' -OperationId 'Operation003' -UrlTemplate '/newresource'

參數

-ApiId

指定 API 的識別碼。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-ApiRevision

API 修訂的標識碼。 這個參數是選擇性的。 如果未指定,作業將會在目前作用中的 API 修訂中更新。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-Confirm

在執行 Cmdlet 之前,提示您進行確認。

類型:SwitchParameter
別名:cf
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Context

指定 PsApiManagementContext實例。

類型:PsApiManagementContext
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶。

類型:IAzureContextContainer
別名:AzContext, AzureRmContext, AzureCredential
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Description

指定新作業的描述。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-Method

指定新作業的 HTTP 方法。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-Name

指定新作業的顯示名稱。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-OperationId

指定現有作業的識別碼。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-PassThru

passthru

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-Request

指定作業要求詳細數據。

類型:PsApiManagementRequest
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-Responses

指定可能的作業回應陣列。

類型:PsApiManagementResponse[]
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-TemplateParameters

指定參數 UrlTemplate中定義的陣列或參數。 如果您未指定值,則會根據 UrlTemplate 產生預設值。 使用 參數來提供有關參數的詳細數據,例如描述、類型和其他可能的值。

類型:PsApiManagementParameter[]
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-UrlTemplate

指定 URL 範本。 例如:customers/{cid}/orders/{oid}/?date={date}。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 Cmdlet 未執行。

類型:SwitchParameter
別名:wi
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

輸入

PsApiManagementContext

String

PsApiManagementParameter[]

PsApiManagementRequest

PsApiManagementResponse[]

SwitchParameter

輸出

PsApiManagementOperation