Databricks SDK for JavaScript
    Preparing search index...

    Interface Endpoint

    Endpoint represents a cloud networking resource in a user's cloud account and binds it to the account.

    interface Endpoint {
        accountId?: string;
        createTime?: Instant;
        displayName?: string;
        endpointId?: string;
        endpointInfo?: {
            $case: "azurePrivateEndpointInfo";
            azurePrivateEndpointInfo: AzurePrivateEndpointInfo;
        };
        name?: string;
        region?: string;
        state?: EndpointState;
        useCase?: EndpointUseCase_EndpointUseCase;
    }
    Index

    Properties

    accountId? createTime? displayName? endpointId? endpointInfo? name? region? state? useCase?

    Properties

    accountId?: string

    The Databricks Account in which the endpoint object exists.

    createTime?: Instant

    The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone.

    displayName?: string

    The human-readable display name of this endpoint. The input should conform to RFC-1034, which restricts to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum.

    endpointId?: string

    The unique identifier for this endpoint under the account. This field is a UUID generated by .

    endpointInfo?: {
        $case: "azurePrivateEndpointInfo";
        azurePrivateEndpointInfo: AzurePrivateEndpointInfo;
    }

    The cloud info of this endpoint. (-- For now it only supports Azure PL, but in future we can support other clouds and more use cases (e.g. public endpoint) --)

    Type Declaration

    name?: string

    The resource name of the endpoint, which uniquely identifies the endpoint.

    region?: string

    The cloud provider region where this endpoint is located.

    state?: EndpointState

    The state of the endpoint. The endpoint can only be used if the state is APPROVED.

    useCase?: EndpointUseCase_EndpointUseCase

    The use case that determines the type of network connectivity this endpoint provides. This field is automatically determined based on the endpoint configuration and cloud-specific settings.

    Settings

    Member Visibility

    On This Page

    Properties