Databricks SDK for JavaScript
    Preparing search index...

    Interface RateLimit

    A rate limit applied to service requests. Leave requests or tokens unset to impose no limit on that dimension; set a value to cap that dimension within the renewal period.

    interface RateLimit {
        key?: RateLimit_RateLimitKey;
        principal?: string;
        renewalPeriod?: RateLimit_RateLimitRenewalPeriod;
        requests?: bigint;
        requestTagKey?: string;
        requestTagValue?: string;
        tokens?: bigint;
    }
    Index

    Properties

    key? principal? renewalPeriod? requests? requestTagKey? requestTagValue? tokens?

    Properties

    key?: RateLimit_RateLimitKey

    Scope key. Determines whether principal is required.

    principal?: string

    Principal this limit applies to: user email, group name, or service principal application ID. Required unless key is RATE_LIMIT_KEY_SERVICE, RATE_LIMIT_KEY_USER_DEFAULT, or RATE_LIMIT_KEY_REQUEST_TAG (which must not set a principal).

    renewalPeriod?: RateLimit_RateLimitRenewalPeriod

    Renewal period.

    requests?: bigint

    Max requests allowed within a renewal period. Leave unset for no request limit.

    requestTagKey?: string

    Request tag key this limit applies to. Required when key is RATE_LIMIT_KEY_REQUEST_TAG, forbidden otherwise.

    requestTagValue?: string

    Request tag value this limit applies to. Only valid when key is RATE_LIMIT_KEY_REQUEST_TAG. Leave unset to apply the limit to every value of request_tag_key (an any-value default); a set value is a specific override for that value.

    tokens?: bigint

    Max tokens allowed within a renewal period. Leave unset for no token limit.

    Settings

    Member Visibility

    On This Page

    Properties