Share via


ISubscriptionOperations.CreateOrUpdateWithHttpMessagesAsync Method

Definition

Creates or updates the subscription of specified user to the specified product.

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

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
SubscriptionCreateParameters

Create parameters.

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

ETag of the Entity. Not required when creating an entity, but required when updating an entity.

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