SubscriptionContract Class

Definition

Subscription details.

[Microsoft.Rest.Serialization.JsonTransformation]
public class SubscriptionContract : Microsoft.Azure.Management.ApiManagement.Models.Resource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type SubscriptionContract = class
    inherit Resource
Public Class SubscriptionContract
Inherits Resource
Inheritance
System.Object
SubscriptionContract
Attributes

Constructors

SubscriptionContract()

Initializes a new instance of the SubscriptionContract class.

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

Initializes a new instance of the SubscriptionContract class.

Properties

AllowTracing

Gets or sets determines whether tracing is enabled

CreatedDate

Gets subscription creation date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

DisplayName

Gets or sets the name of the subscription, or null if the subscription has no name.

EndDate

Gets or sets date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. 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.

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.

Id

Gets resource ID.

(Inherited from Resource)
Name

Gets resource name.

(Inherited from Resource)
NotificationDate

Gets or sets upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

OwnerId

Gets or sets the user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier.

OwnerIdentifier
PrimaryKey

Gets or sets subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

Scope

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

ScopeIdentifier
SecondaryKey

Gets or sets subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

StartDate

Gets or sets subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. 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.

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 optional subscription comment added by an administrator when the state is changed to the 'rejected'.

Type

Gets resource type for API Management resource.

(Inherited from Resource)

Methods

Validate()

Validate the object.

Applies to