SubscriptionCreateParameters | @azure/arm-apimanagement

Subscription create details.

Hierarchy

SubscriptionCreateParameters

Index

Properties

Optional allowTracing

allowTracing: undefined | false | true

Determines whether tracing can be enabled

Optional displayName

displayName: undefined | string

Subscription name.

Optional ownerId

ownerId: undefined | string

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

Optional primaryKey

primaryKey: undefined | string

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

Optional scope

scope: undefined | string

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

Optional secondaryKey

secondaryKey: undefined | string

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

Optional state

state: SubscriptionState

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.