Databricks SDK for JavaScript
    Preparing search index...

    Interface CreatePrivateEndpointRule

    Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure portal after initialization.

    interface CreatePrivateEndpointRule {
        accountId?: string;
        connectionState?: NccPrivateEndpointRule_PrivateLinkConnectionState;
        creationTime?: bigint;
        deactivated?: boolean;
        deactivatedAt?: bigint;
        domainNames?: string[];
        enabled?: boolean;
        endpoint?: { $case: "gcpEndpoint"; gcpEndpoint: GcpEndpoint };
        endpointName?: string;
        endpointService?: string;
        errorMessage?: string;
        groupId?: string;
        networkConnectivityConfigId?: string;
        resourceId?: string;
        resourceNames?: string[];
        ruleId?: string;
        updatedTime?: bigint;
        vpcEndpointId?: string;
    }
    Index

    Properties

    accountId? connectionState? creationTime? deactivated? deactivatedAt? domainNames? enabled? endpoint? endpointName? endpointService? errorMessage? groupId? networkConnectivityConfigId? resourceId? resourceNames? ruleId? updatedTime? vpcEndpointId?

    Properties

    accountId?: string

    account ID. You can find your account ID from the Accounts Console.

    connectionState?: NccPrivateEndpointRule_PrivateLinkConnectionState

    The current status of this private endpoint. The private endpoint rules are effective only if the connection state is ESTABLISHED. Remember that you must approve new endpoints on your resources in the Cloud console before they take effect. The possible values are:

    • PENDING: The endpoint has been created and pending approval.
    • ESTABLISHED: The endpoint has been approved and is ready to use in your serverless compute resources.
    • REJECTED: Connection was rejected by the private link resource owner.
    • DISCONNECTED: Connection was removed by the private link resource owner, the private endpoint becomes informative and should be deleted for clean-up.
    • EXPIRED: If the endpoint was created but not approved in 14 days, it will be EXPIRED.
    • CREATING: The endpoint creation is in progress. Once successfully created, the state will transition to PENDING.
    • CREATE_FAILED: The endpoint creation failed. You can check the error_message field for more details.
    creationTime?: bigint

    Time in epoch milliseconds when this object was created.

    deactivated?: boolean

    Whether this private endpoint is deactivated.

    deactivatedAt?: bigint

    Time in epoch milliseconds when this object was deactivated.

    domainNames?: string[]

    Only used by private endpoints to customer-managed private endpoint services.

    Domain names of target private link service. When updating this field, the full list of target domain_names must be specified.

    enabled?: boolean

    Update this field to activate/deactivate this private endpoint to allow egress access from serverless compute resources. Only honored for first-party services on each cloud (e.g. AWS S3).

    endpoint?: { $case: "gcpEndpoint"; gcpEndpoint: GcpEndpoint }
    endpointName?: string

    The name of the Azure private endpoint resource.

    endpointService?: string

    The full target AWS endpoint service name that connects to the destination resources of the private endpoint.

    errorMessage?: string
    groupId?: string

    Not used by customer-managed private endpoint services.

    The sub-resource type (group ID) of the target resource. Note that to connect to workspace root storage (root DBFS), you need two endpoints, one for blob and one for dfs.

    networkConnectivityConfigId?: string

    The ID of a network connectivity configuration, which is the parent resource of this private endpoint rule object.

    resourceId?: string

    The Azure resource ID of the target resource.

    resourceNames?: string[]

    Only used by private endpoints towards AWS S3 service.

    The globally unique S3 bucket names that will be accessed via the VPC endpoint. The bucket names must be in the same region as the NCC/endpoint service. When updating this field, we perform full update on this field. Please ensure a full list of desired resource_names is provided.

    ruleId?: string

    The ID of a private endpoint rule.

    updatedTime?: bigint

    Time in epoch milliseconds when this object was updated.

    vpcEndpointId?: string

    The AWS VPC endpoint ID. You can use this ID to identify the VPC endpoint created by .

    Settings

    Member Visibility

    On This Page

    Properties