Share via

ApiManagementSubscriptionResource.Update Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.ApiManagement
Assembly:
Azure.ResourceManager.ApiManagement.dll
Package:
Azure.ResourceManager.ApiManagement v1.2.0
Package:
Azure.ResourceManager.ApiManagement v1.3.0-beta.1
Source:
ApiManagementSubscriptionResource.cs
Source:
ApiManagementSubscriptionResource.cs

Updates the details of a subscription specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}
  • Operation Id: Subscription_Update
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiManagementSubscriptionResource
public virtual Azure.Response<Azure.ResourceManager.ApiManagement.ApiManagementSubscriptionResource> Update (Azure.ETag ifMatch, Azure.ResourceManager.ApiManagement.Models.ApiManagementSubscriptionPatch patch, bool? notify = default, Azure.ResourceManager.ApiManagement.Models.AppType? appType = default, System.Threading.CancellationToken cancellationToken = default);
abstract member Update : Azure.ETag * Azure.ResourceManager.ApiManagement.Models.ApiManagementSubscriptionPatch * Nullable<bool> * Nullable<Azure.ResourceManager.ApiManagement.Models.AppType> * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.ApiManagement.ApiManagementSubscriptionResource>
override this.Update : Azure.ETag * Azure.ResourceManager.ApiManagement.Models.ApiManagementSubscriptionPatch * Nullable<bool> * Nullable<Azure.ResourceManager.ApiManagement.Models.AppType> * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.ApiManagement.ApiManagementSubscriptionResource>
Public Overridable Function Update (ifMatch As ETag, patch As ApiManagementSubscriptionPatch, Optional notify As Nullable(Of Boolean) = Nothing, Optional appType As Nullable(Of AppType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ApiManagementSubscriptionResource)

Parameters

ifMatch
ETag

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.

patch
ApiManagementSubscriptionPatch

Update 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
appType
Nullable<AppType>

Determines the type of application which send the create user request. Default is legacy publisher portal.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Response<ApiManagementSubscriptionResource>

Exceptions

ArgumentNullException

patch is null.

Applies to