Share via


ISubscriptionOperations.UpdateWithHttpMessagesAsync Method

Definition

Updates the details of a subscription specified by its identifier.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.SubscriptionContract,Microsoft.Azure.Management.ApiManagement.Models.SubscriptionUpdateHeaders>> UpdateWithHttpMessagesAsync (string resourceGroupName, string serviceName, string sid, Microsoft.Azure.Management.ApiManagement.Models.SubscriptionUpdateParameters parameters, string ifMatch, bool? notify = default, string appType = default, 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.SubscriptionUpdateParameters * string * Nullable<bool> * 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.SubscriptionContract, Microsoft.Azure.Management.ApiManagement.Models.SubscriptionUpdateHeaders>>
Public Function UpdateWithHttpMessagesAsync (resourceGroupName As String, serviceName As String, sid As String, parameters As SubscriptionUpdateParameters, ifMatch As String, Optional notify As Nullable(Of Boolean) = Nothing, Optional appType As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of SubscriptionContract, SubscriptionUpdateHeaders))

Parameters

resourceGroupName
String

The name of the resource group.

serviceName
String

The name of the API Management service.

sid
String

Subscription entity Identifier. The entity represents the association between a user and a product in API Management.

parameters
SubscriptionUpdateParameters

Update parameters.

ifMatch
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.

notify
Nullable<Boolean>

Notify change in Subscription State.

  • If false, do not send any email notification for change of state of subscription
  • If true, send email notification of change of state of subscription
appType
String

Determines the type of application which send the create user request. Default is legacy publisher portal. Possible values include: 'portal', 'developerPortal'

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

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