SubscriptionUpdateParameters interface

Package:

@azure/arm-apimanagement

Subscription update details.

Properties

allowTracing	Determines whether tracing can be enabled
displayName	Subscription name.
expirationDate	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'.

Property Details

allowTracing

Determines whether tracing can be enabled

allowTracing?: boolean

Property Value

boolean

displayName

Subscription name.

displayName?: string

Property Value

string

expirationDate

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.

expirationDate?: Date

Property Value

Date

ownerId

User identifier path: /users/{userId}

ownerId?: string

Property Value

string

primaryKey

Primary subscription key.

primaryKey?: string

Property Value

string

scope

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

scope?: string

Property Value

string

secondaryKey

Secondary subscription key.

secondaryKey?: string

Property Value

string

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.

state?: SubscriptionState

Property Value

SubscriptionState

stateComment

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

stateComment?: string

Property Value

string