SubscriptionOperationsExtensions.UpdateAsync Method

Definition

Updates the details of a subscription specified by its identifier.

public static System.Threading.Tasks.Task<Microsoft.Azure.Management.ApiManagement.Models.SubscriptionContract> UpdateAsync (this Microsoft.Azure.Management.ApiManagement.ISubscriptionOperations operations, string resourceGroupName, string serviceName, string sid, Microsoft.Azure.Management.ApiManagement.Models.SubscriptionUpdateParameters parameters, string ifMatch, bool? notify = default, string appType = default, System.Threading.CancellationToken cancellationToken = default);
static member UpdateAsync : Microsoft.Azure.Management.ApiManagement.ISubscriptionOperations * string * string * string * Microsoft.Azure.Management.ApiManagement.Models.SubscriptionUpdateParameters * string * Nullable<bool> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Management.ApiManagement.Models.SubscriptionContract>
<Extension()>
Public Function UpdateAsync (operations As ISubscriptionOperations, 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 cancellationToken As CancellationToken = Nothing) As Task(Of SubscriptionContract)

Parameters

operations
ISubscriptionOperations

The operations group for this extension method.

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'

cancellationToken
CancellationToken

The cancellation token.

Returns

Applies to