Share via


ApiManagementSubscriptionPatch Class

Definition

Subscription update details.

public class ApiManagementSubscriptionPatch : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ApiManagement.Models.ApiManagementSubscriptionPatch>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ApiManagement.Models.ApiManagementSubscriptionPatch>
type ApiManagementSubscriptionPatch = class
    interface IJsonModel<ApiManagementSubscriptionPatch>
    interface IPersistableModel<ApiManagementSubscriptionPatch>
Public Class ApiManagementSubscriptionPatch
Implements IJsonModel(Of ApiManagementSubscriptionPatch), IPersistableModel(Of ApiManagementSubscriptionPatch)
Inheritance
ApiManagementSubscriptionPatch
Implements

Constructors

ApiManagementSubscriptionPatch()

Initializes a new instance of ApiManagementSubscriptionPatch.

Properties

AllowTracing

Determines whether tracing can be enabled.

DisplayName

Subscription name.

ExpireOn

Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

OwnerId

User identifier path: /users/{userId}.

PrimaryKey

Primary subscription key.

Scope

Scope like /products/{productId} or /apis or /apis/{apiId}.

SecondaryKey

Secondary subscription key.

State

Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.

StateComment

Comments describing subscription state change by the administrator when the state is changed to the 'rejected'.

Explicit Interface Implementations

IJsonModel<ApiManagementSubscriptionPatch>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ApiManagementSubscriptionPatch>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ApiManagementSubscriptionPatch>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ApiManagementSubscriptionPatch>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ApiManagementSubscriptionPatch>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to