SubscriptionCreateParameters Class

Definition

Subscription create details.

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

Constructors

SubscriptionCreateParameters()

Initializes a new instance of the SubscriptionCreateParameters class.

SubscriptionCreateParameters(String, String, String, String, String, Nullable<SubscriptionState>, Nullable<Boolean>)

Initializes a new instance of the SubscriptionCreateParameters class.

Properties

AllowTracing

Gets or sets determines whether tracing can be enabled

DisplayName

Gets or sets subscription name.

OwnerId

Gets or sets user (user id path) for whom subscription is being created in form /users/{userId}

PrimaryKey

Gets or sets primary subscription key. If not specified during request key will be generated automatically.

Scope

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

SecondaryKey

Gets or sets secondary subscription key. If not specified during request key will be generated automatically.

State

Gets or sets initial subscription state. If no value is specified, subscription is created with Submitted 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'

Methods

Validate()

Validate the object.

Applies to