IGatewayOperations.UpdateWithHttpMessagesAsync Method

Definition

Updates the details of the gateway specified by its identifier.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.GatewayContract,Microsoft.Azure.Management.ApiManagement.Models.GatewayUpdateHeaders>> UpdateWithHttpMessagesAsync (string resourceGroupName, string serviceName, string gatewayId, Microsoft.Azure.Management.ApiManagement.Models.GatewayContract parameters, string ifMatch, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member UpdateWithHttpMessagesAsync : string * string * string * Microsoft.Azure.Management.ApiManagement.Models.GatewayContract * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.GatewayContract, Microsoft.Azure.Management.ApiManagement.Models.GatewayUpdateHeaders>>
Public Function UpdateWithHttpMessagesAsync (resourceGroupName As String, serviceName As String, gatewayId As String, parameters As GatewayContract, ifMatch As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of GatewayContract, GatewayUpdateHeaders))

Parameters

resourceGroupName
System.String

The name of the resource group.

serviceName
System.String

The name of the API Management service.

gatewayId
System.String

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

parameters
GatewayContract
ifMatch
System.String

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

customHeaders
System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>

The headers that will be added to request.

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task<AzureOperationResponse<GatewayContract,GatewayUpdateHeaders>>

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Applies to