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;
        tokens?: bigint;
    }
    Index

    Properties

    key? principal? renewalPeriod? requests? tokens?

    Properties

    key?: RateLimit_RateLimitKey

    Scope of the rate limit. Depending on this value, the limit applies to a principal, the service as a whole, or each user by default.

    principal?: string

    Principal this limit applies to: user email, group name, or service principal application ID. Required when key applies to a user, group, or service principal; otherwise it must be unset.

    renewalPeriod?: RateLimit_RateLimitRenewalPeriod

    Renewal period.

    requests?: bigint

    Maximum requests allowed in one renewal period. Leave unset for no request limit. Set to 0 to deny all requests.

    tokens?: bigint

    Maximum tokens allowed in one renewal period. Leave unset for no token limit. Set to 0 to deny all requests.

    Settings

    Member Visibility

    On This Page

    Properties