SubscriptionCreateParameters interface

Package:

@azure/arm-apimanagement

Subscription create details.

Properties

allowTracing	Determines whether tracing can be enabled
displayName	Subscription name.
ownerId	User (user id path) for whom subscription is being created in form /users/{userId}
primaryKey	Primary subscription key. If not specified during request key will be generated automatically.
scope	Scope like /products/{productId} or /apis or /apis/{apiId}.
secondaryKey	Secondary subscription key. If not specified during request key will be generated automatically.
state	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.

Property Details

allowTracing

Determines whether tracing can be enabled

allowTracing?: boolean

Property Value

boolean

displayName

Subscription name.

displayName?: string

Property Value

string

ownerId

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

ownerId?: string

Property Value

string

primaryKey

Primary subscription key. If not specified during request key will be generated automatically.

primaryKey?: string

Property Value

string

scope

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

scope?: string

Property Value

string

secondaryKey

Secondary subscription key. If not specified during request key will be generated automatically.

secondaryKey?: string

Property Value

string

state

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.

state?: SubscriptionState

Property Value

SubscriptionState