Share via


SubscriptionUpdateParameters Class

Definition

Subscription update details.

[Microsoft.Rest.Serialization.JsonTransformation]
public class SubscriptionUpdateParameters
[<Microsoft.Rest.Serialization.JsonTransformation>]
type SubscriptionUpdateParameters = class
Public Class SubscriptionUpdateParameters
Inheritance
SubscriptionUpdateParameters
Attributes

Constructors

SubscriptionUpdateParameters()

Initializes a new instance of the SubscriptionUpdateParameters class.

SubscriptionUpdateParameters(String, String, Nullable<DateTime>, String, String, String, Nullable<SubscriptionState>, String, Nullable<Boolean>)

Initializes a new instance of the SubscriptionUpdateParameters class.

Properties

AllowTracing

Gets or sets determines whether tracing can be enabled

DisplayName

Gets or sets subscription name.

ExpirationDate

Gets or sets 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

Gets or sets user identifier path: /users/{userId}

PrimaryKey

Gets or sets primary subscription key.

Scope

Gets or sets scope like /products/{productId} or /apis or /apis/{apiId}

SecondaryKey

Gets or sets secondary subscription key.

State

Gets or sets 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. Possible values include: 'suspended', 'active', 'expired', 'submitted', 'rejected', 'cancelled'
StateComment

Gets or sets comments describing subscription state change by the administrator when the state is changed to the 'rejected'.

Methods

Validate()

Validate the object.

Applies to