Databricks SDK for JavaScript
    Preparing search index...

    Interface PrivateNetworkGateway

    A private network gateway connects serverless compute to destinations in a customer-managed VPC or VNet.

    interface PrivateNetworkGateway {
        bandwidthTierGigabitsPerSecond?: number;
        cloudConnection?:
            | {
                $case: "azureCloudConnection";
                azureCloudConnection: PrivateNetworkGateway_AzureCloudConnection;
            }
            | {
                $case: "awsCloudConnection";
                awsCloudConnection: PrivateNetworkGateway_AwsCloudConnection;
            };
        createTime?: Instant;
        destinations?: PrivateNetworkGateway_Destination[];
        displayName?: string;
        errorMessage?: string;
        name?: string;
        privateDnsResolvers?: PrivateNetworkGateway_PrivateDnsResolver[];
        state?: PrivateNetworkGateway_GatewayState;
        trafficMode?: PrivateNetworkGateway_TrafficMode;
        updateTime?: Instant;
    }
    Index

    Properties

    bandwidthTierGigabitsPerSecond? cloudConnection? createTime? destinations? displayName? errorMessage? name? privateDnsResolvers? state? trafficMode? updateTime?

    Properties

    bandwidthTierGigabitsPerSecond?: number

    The provisioned bandwidth tier for an Azure gateway, in gigabits per second. Required when creating an Azure gateway.

    cloudConnection?:
        | {
            $case: "azureCloudConnection";
            azureCloudConnection: PrivateNetworkGateway_AzureCloudConnection;
        }
        | {
            $case: "awsCloudConnection";
            awsCloudConnection: PrivateNetworkGateway_AwsCloudConnection;
        }

    Exactly one cloud connection must be provided when creating a gateway.

    Type Declaration

    createTime?: Instant

    The time when the gateway was created.

    destinations?: PrivateNetworkGateway_Destination[]

    The destinations routed through this gateway.

    displayName?: string

    The human-readable name of the gateway.

    errorMessage?: string

    The failure reason when the gateway is in the FAILED state.

    name?: string

    The canonical resource name of the gateway, in the form accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}.

    privateDnsResolvers?: PrivateNetworkGateway_PrivateDnsResolver[]

    The DNS resolvers used for private name resolution.

    state?: PrivateNetworkGateway_GatewayState

    The current lifecycle state of the gateway.

    trafficMode?: PrivateNetworkGateway_TrafficMode

    The traffic routed through this gateway.

    updateTime?: Instant

    The time when the gateway was last updated.

    Settings

    Member Visibility

    On This Page

    Properties