GradientEdge CDK Utils
    Preparing search index...

    Interface ApiSubscriptionProps

    interface ApiSubscriptionProps {
        allowTracing?: Input<boolean>;
        appType?: Input<string>;
        displayName: Input<string>;
        notify?: Input<boolean>;
        ownerId?: Input<string>;
        primaryKey?: Input<string>;
        resourceGroupName: Input<string>;
        scope: Input<string>;
        secondaryKey?: Input<string>;
        serviceName: Input<string>;
        sid?: Input<string>;
        state?: Input<SubscriptionState>;
    }

    Hierarchy

    • SubscriptionArgs
      • ApiSubscriptionProps
    Index

    Properties

    allowTracing? appType? displayName notify? ownerId? primaryKey? resourceGroupName scope secondaryKey? serviceName sid? state?

    Properties

    allowTracing?: Input<boolean>

    Determines whether tracing can be enabled

    appType?: Input<string>

    Determines the type of application which send the create user request. Default is legacy publisher portal.

    displayName: Input<string>

    Subscription name.

    notify?: Input<boolean>

    Notify change in Subscription State.

    • If false, do not send any email notification for change of state of subscription
    • If true, send email notification of change of state of subscription
    ownerId?: Input<string>

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

    primaryKey?: Input<string>

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

    resourceGroupName: Input<string>

    The name of the resource group. The name is case insensitive.

    scope: Input<string>

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

    secondaryKey?: Input<string>

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

    serviceName: Input<string>

    The name of the API Management service.

    sid?: Input<string>

    Subscription entity Identifier. The entity represents the association between a user and a product in API Management.

    state?: Input<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.

    Settings

    Member Visibility

    On This Page

    Properties