@databricks/sdk-networking 0.34.0 → 0.35.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ //#region package.json
2
+ var name = "@databricks/sdk-networking";
3
+ var version = "0.35.0";
4
+
5
+ //#endregion
6
+ export { name, version };
7
+ //# sourceMappingURL=package.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"package.js","names":[],"sources":["../package.json"],"sourcesContent":[""],"mappings":""}
@@ -1,265 +1,269 @@
1
- import type { CallOptions } from '@databricks/sdk-options/call';
2
- import type { ClientOptions } from '@databricks/sdk-options/client';
3
- import type { AccountNetworkPolicy, CreateAccountIpAccessListRequest, CreateAccountIpAccessListResponse, CreateEndpointRequest, CreateIpAccessListRequest, CreateIpAccessListResponse, CreateNccPrivateEndpointRuleRequest, CreateNetworkConnectivityConfigRequest, CreateNetworkPolicyRequest, CreateNetworkRequest, CreatePrivateAccessSettingsRequest, CreateVpcEndpointRequest, DeleteAccountIpAccessListRequest, DeleteAccountIpAccessListResponse, DeleteEndpointRequest, DeleteIpAccessListRequest, DeleteIpAccessListResponse, DeleteNccPrivateEndpointRuleRequest, DeleteNetworkConnectivityConfigRequest, DeleteNetworkPolicyRequest, DeleteNetworkRequest, DeletePrivateAccessSettingsRequest, DeleteVpcEndpointRequest, Endpoint, GetAccountIpAccessListRequest, GetAccountIpAccessListResponse, GetEndpointRequest, GetIpAccessListRequest, GetIpAccessListResponse, GetNccPrivateEndpointRuleRequest, GetNetworkConnectivityConfigRequest, GetNetworkPolicyRequest, GetNetworkRequest, GetPrivateAccessSettingsRequest, GetVpcEndpointRequest, GetWorkspaceNetworkOptionRequest, ListAccountIpAccessListsRequest, ListAccountIpAccessListsResponse, ListEndpointsRequest, ListEndpointsResponse, ListIpAccessLists, ListIpAccessListsResponse, ListNccPrivateEndpointRulesRequest, ListNccPrivateEndpointRulesResponse, ListNetworkConnectivityConfigsRequest, ListNetworkConnectivityConfigsResponse, ListNetworkPoliciesRequest, ListNetworkPoliciesResponse, ListNetworkRequest, ListNetworkResponse, ListPrivateAccessSettingsRequest, ListPrivateAccessSettingsResponse, ListVpcEndpointRequest, ListVpcEndpointResponse, NccPrivateEndpointRule, Network, NetworkConnectivityConfig, PrivateAccessSettings, ReplaceAccountIpAccessListRequest, ReplaceAccountIpAccessListResponse, ReplaceIpAccessListRequest, ReplaceIpAccessListResponse, UpdateAccountIpAccessListRequest, UpdateAccountIpAccessListResponse, UpdateIpAccessListRequest, UpdateIpAccessListResponse, UpdateNccPrivateEndpointRuleRequest, UpdateNetworkPolicyRequest, UpdatePrivateAccessSettingsRequest, UpdateWorkspaceNetworkOptionRequest, VpcEndpoint, WorkspaceNetworkOption } from './model';
4
- export declare class NetworkingClient {
5
- private readonly options;
6
- private readonly logger;
7
- private readonly userAgent;
8
- private config;
9
- constructor(options: ClientOptions);
10
- private resolveConfig;
11
- /**
12
- * Creates an IP access list for the account.
13
- *
14
- * A list can be an allow list or a block list. See the top of this file for a description of
15
- * how the server treats allow lists and block lists at runtime.
16
- *
17
- * When creating or updating an IP access list:
18
- *
19
- * * For all allow lists and block lists combined, the API supports a maximum of 1000
20
- * IP/CIDR values, where one CIDR counts as a single value. Attempts to exceed that number
21
- * return error 400 with `error_code` value `QUOTA_EXCEEDED`.
22
- * * If the new list would block the calling user's current IP, error 400 is returned with
23
- * `error_code` value `INVALID_STATE`.
24
- *
25
- * It can take a few minutes for the changes to take effect.
26
- */
27
- createAccountIpAccessList(req: CreateAccountIpAccessListRequest, options?: CallOptions): Promise<CreateAccountIpAccessListResponse>;
28
- /** Deletes an IP access list, specified by its list ID. */
29
- deleteAccountIpAccessList(req: DeleteAccountIpAccessListRequest, options?: CallOptions): Promise<DeleteAccountIpAccessListResponse>;
30
- /** Gets an IP access list, specified by its list ID. */
31
- getAccountIpAccessList(req: GetAccountIpAccessListRequest, options?: CallOptions): Promise<GetAccountIpAccessListResponse>;
32
- /** Gets all IP access lists for the specified account. */
33
- listAccountIpAccessLists(req: ListAccountIpAccessListsRequest, options?: CallOptions): Promise<ListAccountIpAccessListsResponse>;
34
- /**
35
- * Replaces an IP access list, specified by its ID.
36
- *
37
- * A list can include allow lists and block lists. See the top of this file for a description
38
- * of how the server treats allow lists and block lists at run time. When replacing an IP
39
- * access list:
40
- * * For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values,
41
- * where one CIDR counts as a single value. Attempts to exceed that number return error 400 with `error_code`
42
- * value `QUOTA_EXCEEDED`.
43
- * * If the resulting list would block the calling user's current IP, error 400 is returned with `error_code`
44
- * value `INVALID_STATE`.
45
- * It can take a few minutes for the changes to take effect.
46
- */
47
- replaceAccountIpAccessList(req: ReplaceAccountIpAccessListRequest, options?: CallOptions): Promise<ReplaceAccountIpAccessListResponse>;
48
- /**
49
- * Updates an existing IP access list, specified by its ID.
50
- *
51
- * A list can include allow lists and block lists. See the top of this file for a description
52
- * of how the server treats allow lists and block lists at run time.
53
- *
54
- * When updating an IP access list:
55
- *
56
- * * For all allow lists and block lists combined, the API supports a maximum of 1000
57
- * IP/CIDR values, where one CIDR counts as a single value. Attempts to exceed that number
58
- * return error 400 with `error_code` value `QUOTA_EXCEEDED`.
59
- * * If the updated list would block the calling user's current IP, error 400 is returned
60
- * with `error_code` value `INVALID_STATE`.
61
- *
62
- * It can take a few minutes for the changes to take effect.
63
- */
64
- updateAccountIpAccessList(req: UpdateAccountIpAccessListRequest, options?: CallOptions): Promise<UpdateAccountIpAccessListResponse>;
65
- /**
66
- * Creates a new network connectivity endpoint that enables private connectivity
67
- * between your network resources and <Databricks> services.
68
- *
69
- * After creation, the endpoint is initially in the PENDING state. The <Databricks>
70
- * endpoint service automatically reviews and approves the endpoint within a few
71
- * minutes. Use the GET method to retrieve the latest endpoint state.
72
- *
73
- * An endpoint can be used only after it reaches the APPROVED state.
74
- */
75
- createEndpoint(req: CreateEndpointRequest, options?: CallOptions): Promise<Endpoint>;
76
- /**
77
- * Deletes a network endpoint. This will remove the endpoint configuration from <Databricks>.
78
- * Depending on the endpoint type and use case, you may also need to delete corresponding network resources
79
- * in your cloud provider account.
80
- */
81
- deleteEndpoint(req: DeleteEndpointRequest, options?: CallOptions): Promise<void>;
82
- /** Gets details of a specific network endpoint. */
83
- getEndpoint(req: GetEndpointRequest, options?: CallOptions): Promise<Endpoint>;
84
- /** Lists all network connectivity endpoints for the account. */
85
- listEndpoints(req: ListEndpointsRequest, options?: CallOptions): Promise<ListEndpointsResponse>;
86
- listEndpointsIter(req: ListEndpointsRequest, options?: CallOptions): AsyncGenerator<Endpoint>;
87
- /**
88
- * Creates an IP access list for this workspace.
89
- *
90
- * A list can be an allow list or a block list.
91
- * See the top of this file for a description of how the server treats allow lists and block lists at runtime.
92
- *
93
- * When creating or updating an IP access list:
94
- *
95
- * * For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values,
96
- * where one CIDR counts as a single value. Attempts to exceed that number return error 400 with `error_code` value `QUOTA_EXCEEDED`.
97
- * * If the new list would block the calling user's current IP, error 400 is returned with `error_code` value `INVALID_STATE`.
98
- *
99
- * It can take a few minutes for the changes to take effect. **Note**: Your new IP access list has no effect until you enable the feature. See [workspaceconf/setStatus](https://docs.databricks.com/api/workspace/workspaceconf/setstatus)
100
- */
101
- createIpAccessList(req: CreateIpAccessListRequest, options?: CallOptions): Promise<CreateIpAccessListResponse>;
102
- /** Deletes an IP access list, specified by its list ID. */
103
- deleteIpAccessList(req: DeleteIpAccessListRequest, options?: CallOptions): Promise<DeleteIpAccessListResponse>;
104
- /** Gets an IP access list, specified by its list ID. */
105
- getIpAccessList(req: GetIpAccessListRequest, options?: CallOptions): Promise<GetIpAccessListResponse>;
106
- /** Gets all IP access lists for the specified workspace. */
107
- listIpAccessLists(_req: ListIpAccessLists, options?: CallOptions): Promise<ListIpAccessListsResponse>;
108
- /**
109
- * Replaces an IP access list, specified by its ID.
110
- *
111
- * A list can include allow lists and block lists. See the top
112
- * of this file for a description of how the server treats allow lists and block lists at run time. When
113
- * replacing an IP access list:
114
- * * For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values,
115
- * where one CIDR counts as a single value. Attempts to exceed that number return error 400 with `error_code`
116
- * value `QUOTA_EXCEEDED`.
117
- * * If the resulting list would block the calling user's current IP, error 400 is returned with `error_code`
118
- * value `INVALID_STATE`.
119
- * It can take a few minutes for the changes to take effect. Note that your resulting IP access list has no
120
- * effect until you enable the feature. See [workspaceconf/setStatus](https://docs.databricks.com/api/workspace/workspaceconf/setstatus).
121
- */
122
- replaceIpAccessList(req: ReplaceIpAccessListRequest, options?: CallOptions): Promise<ReplaceIpAccessListResponse>;
123
- /**
124
- * Updates an existing IP access list, specified by its ID.
125
- *
126
- * A list can include allow lists and block lists.
127
- * See the top of this file for a description of how the server treats allow lists and block lists at run time.
128
- *
129
- * When updating an IP access list:
130
- *
131
- * * For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values,
132
- * where one CIDR counts as a single value. Attempts to exceed that number return error 400 with `error_code` value `QUOTA_EXCEEDED`.
133
- * * If the updated list would block the calling user's current IP, error 400 is returned with `error_code` value `INVALID_STATE`.
134
- *
135
- * It can take a few minutes for the changes to take effect. Note that your resulting IP access list has no effect until you enable
136
- * the feature. See [workspaceconf/setStatus](https://docs.databricks.com/api/workspace/workspaceconf/setstatus).
137
- */
138
- updateIpAccessList(req: UpdateIpAccessListRequest, options?: CallOptions): Promise<UpdateIpAccessListResponse>;
139
- /**
140
- * Creates a network connectivity configuration (NCC), which provides stable Azure service
141
- * subnets when accessing your Azure Storage accounts. You can also use a network connectivity configuration to create
142
- * <Databricks> managed private endpoints so that <Databricks> serverless compute resources privately access your
143
- * resources.
144
- *
145
- * **IMPORTANT**: After you create the network connectivity configuration, you must assign one or more workspaces to the new network connectivity configuration.
146
- * You can share one network connectivity configuration with multiple workspaces from the same Azure region within
147
- * the same <Databricks> account.
148
- * See [configure serverless secure connectivity](https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security).
149
- */
150
- createNetworkConnectivityConfigPublic(req: CreateNetworkConnectivityConfigRequest, options?: CallOptions): Promise<NetworkConnectivityConfig>;
151
- /** Deletes a network connectivity configuration. */
152
- deleteNetworkConnectivityConfigPublic(req: DeleteNetworkConnectivityConfigRequest, options?: CallOptions): Promise<void>;
153
- /** Gets a network connectivity configuration. */
154
- getNetworkConnectivityConfigPublic(req: GetNetworkConnectivityConfigRequest, options?: CallOptions): Promise<NetworkConnectivityConfig>;
155
- /** Gets an array of network connectivity configurations. */
156
- listNetworkConnectivityConfigsPublic(req: ListNetworkConnectivityConfigsRequest, options?: CallOptions): Promise<ListNetworkConnectivityConfigsResponse>;
157
- listNetworkConnectivityConfigsPublicIter(req: ListNetworkConnectivityConfigsRequest, options?: CallOptions): AsyncGenerator<NetworkConnectivityConfig>;
158
- /**
159
- * Create a private endpoint rule for the specified network connectivity config object.
160
- * Once the object is created, <Databricks> asynchronously provisions a new Azure private endpoint to your
161
- * specified Azure resource.
162
- *
163
- * **IMPORTANT**: You must use Azure portal or other Azure tools to approve the private endpoint to complete the
164
- * connection. To get the information of the private endpoint created, make a `GET` request on the new private
165
- * endpoint rule. See [serverless private link](https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security/serverless-private-link).
166
- */
167
- createNccPrivateEndpointRule(req: CreateNccPrivateEndpointRuleRequest, options?: CallOptions): Promise<NccPrivateEndpointRule>;
168
- /**
169
- * Initiates deleting a private endpoint rule. If the connection state is PENDING or EXPIRED,
170
- * the private endpoint is immediately deleted. Otherwise, the private endpoint is deactivated
171
- * and will be deleted after one day of deactivation. When a private endpoint is deactivated,
172
- * the `deactivated` field is set to `true` and the private endpoint is not
173
- * available to your serverless compute resources.
174
- */
175
- deleteNccPrivateEndpointRule(req: DeleteNccPrivateEndpointRuleRequest, options?: CallOptions): Promise<NccPrivateEndpointRule>;
176
- /** Gets the private endpoint rule. */
177
- getNccPrivateEndpointRule(req: GetNccPrivateEndpointRuleRequest, options?: CallOptions): Promise<NccPrivateEndpointRule>;
178
- /** Gets an array of private endpoint rules. */
179
- listNccPrivateEndpointRules(req: ListNccPrivateEndpointRulesRequest, options?: CallOptions): Promise<ListNccPrivateEndpointRulesResponse>;
180
- listNccPrivateEndpointRulesIter(req: ListNccPrivateEndpointRulesRequest, options?: CallOptions): AsyncGenerator<NccPrivateEndpointRule>;
181
- /** Updates a private endpoint rule. Currently only a private endpoint rule to customer-managed resources is allowed to be updated. */
182
- updateNccPrivateEndpointRule(req: UpdateNccPrivateEndpointRuleRequest, options?: CallOptions): Promise<NccPrivateEndpointRule>;
183
- /**
184
- * Creates a new network policy to manage which network destinations can be accessed from the <Databricks>
185
- * environment.
186
- */
187
- createNetworkPolicyRpc(req: CreateNetworkPolicyRequest, options?: CallOptions): Promise<AccountNetworkPolicy>;
188
- /** Deletes a network policy. Cannot be called on 'default-policy'. */
189
- deleteNetworkPolicyRpc(req: DeleteNetworkPolicyRequest, options?: CallOptions): Promise<void>;
190
- /** Gets a network policy. */
191
- getNetworkPolicyRpc(req: GetNetworkPolicyRequest, options?: CallOptions): Promise<AccountNetworkPolicy>;
192
- /** Gets an array of network policies. */
193
- listNetworkPoliciesRpc(req: ListNetworkPoliciesRequest, options?: CallOptions): Promise<ListNetworkPoliciesResponse>;
194
- listNetworkPoliciesRpcIter(req: ListNetworkPoliciesRequest, options?: CallOptions): AsyncGenerator<AccountNetworkPolicy>;
195
- /** Updates a network policy. This allows you to modify the configuration of a network policy. */
196
- updateNetworkPolicyRpc(req: UpdateNetworkPolicyRequest, options?: CallOptions): Promise<AccountNetworkPolicy>;
197
- /** Creates a <Databricks> network configuration that represents an VPC and its resources. The VPC will be used for new <Databricks> clusters. This requires a pre-existing VPC and subnets. */
198
- createNetworkPublic(req: CreateNetworkRequest, options?: CallOptions): Promise<Network>;
199
- /**
200
- * Creates a private access settings configuration, which represents
201
- * network access restrictions for workspace resources. Private access
202
- * settings configure whether workspaces can be accessed from the public
203
- * internet or only from private endpoints.
204
- */
205
- createPrivateAccessSettingsPublic(req: CreatePrivateAccessSettingsRequest, options?: CallOptions): Promise<PrivateAccessSettings>;
206
- /**
207
- * Creates a VPC endpoint configuration, which represents a
208
- * [VPC endpoint](https://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints.html)
209
- * object in AWS used to communicate privately with <Databricks> over
210
- * [AWS PrivateLink](https://aws.amazon.com/privatelink).
211
- *
212
- * After you create the VPC endpoint configuration, the <Databricks>
213
- * [endpoint service](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html)
214
- * automatically accepts the VPC endpoint.
215
- *
216
- * Before configuring PrivateLink, read the
217
- * [<Databricks> article about PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).
218
- */
219
- createVpcEndpointPublic(req: CreateVpcEndpointRequest, options?: CallOptions): Promise<VpcEndpoint>;
220
- /**
221
- * Deletes a <Databricks> network configuration, which represents a cloud VPC and its resources. You cannot delete a network that is associated with a workspace.
222
- *
223
- * This operation is available only if your account is on the E2 version of the platform.
224
- */
225
- deleteNetworkPublic(req: DeleteNetworkRequest, options?: CallOptions): Promise<Network>;
226
- /** Deletes a <Databricks> private access settings configuration, both specified by ID. */
227
- deletePrivateAccessSettingsPublic(req: DeletePrivateAccessSettingsRequest, options?: CallOptions): Promise<PrivateAccessSettings>;
228
- /** Deletes a Databricks VPC endpoint configuration. You cannot delete a VPC endpoint configuration that is associated with any workspace. */
229
- deleteVpcEndpointPublic(req: DeleteVpcEndpointRequest, options?: CallOptions): Promise<VpcEndpoint>;
230
- /** Gets a <Databricks> network configuration, which represents a cloud VPC and its resources. */
231
- getNetworkPublic(req: GetNetworkRequest, options?: CallOptions): Promise<Network>;
232
- /** Gets a <Databricks> private access settings configuration, both specified by ID. */
233
- getPrivateAccessSettingsPublic(req: GetPrivateAccessSettingsRequest, options?: CallOptions): Promise<PrivateAccessSettings>;
234
- /**
235
- * Gets a VPC endpoint configuration, which represents
236
- * a [VPC endpoint](https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html)
237
- * object in AWS used to communicate privately with <Databricks> over
238
- * [AWS PrivateLink](https://aws.amazon.com/privatelink).
239
- */
240
- getVpcEndpointPublic(req: GetVpcEndpointRequest, options?: CallOptions): Promise<VpcEndpoint>;
241
- /** Lists <Databricks> network configurations for an account. */
242
- listNetworkPublic(req: ListNetworkRequest, options?: CallOptions): Promise<ListNetworkResponse>;
243
- /** Lists <Databricks> private access settings for an account. */
244
- listPrivateAccessSettingsPublic(req: ListPrivateAccessSettingsRequest, options?: CallOptions): Promise<ListPrivateAccessSettingsResponse>;
245
- /** Lists Databricks VPC endpoint configurations for an account. */
246
- listVpcEndpointPublic(req: ListVpcEndpointRequest, options?: CallOptions): Promise<ListVpcEndpointResponse>;
247
- /**
248
- * Updates an existing private access settings object, which specifies how your workspace is accessed over AWS PrivateLink. To use AWS PrivateLink, a workspace must have a private access settings object referenced by ID in the workspace's private_access_settings_id property.
249
- * This operation completely overwrites your existing private access settings object attached to your workspaces. All workspaces attached to the private access settings are affected by any change. If public_access_enabled, private_access_level, or allowed_vpc_endpoint_ids are updated, effects of these changes might take several minutes to propagate to the workspace API.
250
- * You can share one private access settings object with multiple workspaces in a single account. However, private access settings are specific to AWS regions, so only workspaces in the same AWS region can use a given private access settings object.
251
- * Before configuring PrivateLink, read the <Databricks> article about PrivateLink.
252
- */
253
- updatePrivateAccessSettingsPublic(req: UpdatePrivateAccessSettingsRequest, options?: CallOptions): Promise<PrivateAccessSettings>;
254
- /**
255
- * Gets the network option for a workspace. Every workspace has exactly one network policy binding,
256
- * with 'default-policy' used if no explicit assignment exists.
257
- */
258
- getWorkspaceNetworkOptionRpc(req: GetWorkspaceNetworkOptionRequest, options?: CallOptions): Promise<WorkspaceNetworkOption>;
259
- /**
260
- * Updates the network option for a workspace. This operation associates the workspace with the specified network policy.
261
- * To revert to the default policy, specify 'default-policy' as the network_policy_id.
262
- */
263
- updateWorkspaceNetworkOptionRpc(req: UpdateWorkspaceNetworkOptionRequest, options?: CallOptions): Promise<WorkspaceNetworkOption>;
1
+ import { AccountNetworkPolicy, CreateAccountIpAccessListRequest, CreateAccountIpAccessListResponse, CreateEndpointRequest, CreateIpAccessListRequest, CreateIpAccessListResponse, CreateNccPrivateEndpointRuleRequest, CreateNetworkConnectivityConfigRequest, CreateNetworkPolicyRequest, CreateNetworkRequest, CreatePrivateAccessSettingsRequest, CreateVpcEndpointRequest, DeleteAccountIpAccessListRequest, DeleteAccountIpAccessListResponse, DeleteEndpointRequest, DeleteIpAccessListRequest, DeleteIpAccessListResponse, DeleteNccPrivateEndpointRuleRequest, DeleteNetworkConnectivityConfigRequest, DeleteNetworkPolicyRequest, DeleteNetworkRequest, DeletePrivateAccessSettingsRequest, DeleteVpcEndpointRequest, Endpoint, GetAccountIpAccessListRequest, GetAccountIpAccessListResponse, GetEndpointRequest, GetIpAccessListRequest, GetIpAccessListResponse, GetNccPrivateEndpointRuleRequest, GetNetworkConnectivityConfigRequest, GetNetworkPolicyRequest, GetNetworkRequest, GetPrivateAccessSettingsRequest, GetVpcEndpointRequest, GetWorkspaceNetworkOptionRequest, ListAccountIpAccessListsRequest, ListAccountIpAccessListsResponse, ListEndpointsRequest, ListEndpointsResponse, ListIpAccessLists, ListIpAccessListsResponse, ListNccPrivateEndpointRulesRequest, ListNccPrivateEndpointRulesResponse, ListNetworkConnectivityConfigsRequest, ListNetworkConnectivityConfigsResponse, ListNetworkPoliciesRequest, ListNetworkPoliciesResponse, ListNetworkRequest, ListNetworkResponse, ListPrivateAccessSettingsRequest, ListPrivateAccessSettingsResponse, ListVpcEndpointRequest, ListVpcEndpointResponse, NccPrivateEndpointRule, Network, NetworkConnectivityConfig, PrivateAccessSettings, ReplaceAccountIpAccessListRequest, ReplaceAccountIpAccessListResponse, ReplaceIpAccessListRequest, ReplaceIpAccessListResponse, UpdateAccountIpAccessListRequest, UpdateAccountIpAccessListResponse, UpdateIpAccessListRequest, UpdateIpAccessListResponse, UpdateNccPrivateEndpointRuleRequest, UpdateNetworkPolicyRequest, UpdatePrivateAccessSettingsRequest, UpdateWorkspaceNetworkOptionRequest, VpcEndpoint, WorkspaceNetworkOption } from "./model.js";
2
+ import { CallOptions } from "@databricks/sdk-options/call";
3
+ import { ClientOptions } from "@databricks/sdk-options/client";
4
+
5
+ //#region src/v1/client.d.ts
6
+ declare class NetworkingClient {
7
+ private readonly options;
8
+ private readonly logger;
9
+ private readonly userAgent;
10
+ private config;
11
+ constructor(options: ClientOptions);
12
+ private resolveConfig;
13
+ /**
14
+ * Creates an IP access list for the account.
15
+ *
16
+ * A list can be an allow list or a block list. See the top of this file for a description of
17
+ * how the server treats allow lists and block lists at runtime.
18
+ *
19
+ * When creating or updating an IP access list:
20
+ *
21
+ * * For all allow lists and block lists combined, the API supports a maximum of 1000
22
+ * IP/CIDR values, where one CIDR counts as a single value. Attempts to exceed that number
23
+ * return error 400 with `error_code` value `QUOTA_EXCEEDED`.
24
+ * * If the new list would block the calling user's current IP, error 400 is returned with
25
+ * `error_code` value `INVALID_STATE`.
26
+ *
27
+ * It can take a few minutes for the changes to take effect.
28
+ */
29
+ createAccountIpAccessList(req: CreateAccountIpAccessListRequest, options?: CallOptions): Promise<CreateAccountIpAccessListResponse>;
30
+ /** Deletes an IP access list, specified by its list ID. */
31
+ deleteAccountIpAccessList(req: DeleteAccountIpAccessListRequest, options?: CallOptions): Promise<DeleteAccountIpAccessListResponse>;
32
+ /** Gets an IP access list, specified by its list ID. */
33
+ getAccountIpAccessList(req: GetAccountIpAccessListRequest, options?: CallOptions): Promise<GetAccountIpAccessListResponse>;
34
+ /** Gets all IP access lists for the specified account. */
35
+ listAccountIpAccessLists(req: ListAccountIpAccessListsRequest, options?: CallOptions): Promise<ListAccountIpAccessListsResponse>;
36
+ /**
37
+ * Replaces an IP access list, specified by its ID.
38
+ *
39
+ * A list can include allow lists and block lists. See the top of this file for a description
40
+ * of how the server treats allow lists and block lists at run time. When replacing an IP
41
+ * access list:
42
+ * * For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values,
43
+ * where one CIDR counts as a single value. Attempts to exceed that number return error 400 with `error_code`
44
+ * value `QUOTA_EXCEEDED`.
45
+ * * If the resulting list would block the calling user's current IP, error 400 is returned with `error_code`
46
+ * value `INVALID_STATE`.
47
+ * It can take a few minutes for the changes to take effect.
48
+ */
49
+ replaceAccountIpAccessList(req: ReplaceAccountIpAccessListRequest, options?: CallOptions): Promise<ReplaceAccountIpAccessListResponse>;
50
+ /**
51
+ * Updates an existing IP access list, specified by its ID.
52
+ *
53
+ * A list can include allow lists and block lists. See the top of this file for a description
54
+ * of how the server treats allow lists and block lists at run time.
55
+ *
56
+ * When updating an IP access list:
57
+ *
58
+ * * For all allow lists and block lists combined, the API supports a maximum of 1000
59
+ * IP/CIDR values, where one CIDR counts as a single value. Attempts to exceed that number
60
+ * return error 400 with `error_code` value `QUOTA_EXCEEDED`.
61
+ * * If the updated list would block the calling user's current IP, error 400 is returned
62
+ * with `error_code` value `INVALID_STATE`.
63
+ *
64
+ * It can take a few minutes for the changes to take effect.
65
+ */
66
+ updateAccountIpAccessList(req: UpdateAccountIpAccessListRequest, options?: CallOptions): Promise<UpdateAccountIpAccessListResponse>;
67
+ /**
68
+ * Creates a new network connectivity endpoint that enables private connectivity
69
+ * between your network resources and <Databricks> services.
70
+ *
71
+ * After creation, the endpoint is initially in the PENDING state. The <Databricks>
72
+ * endpoint service automatically reviews and approves the endpoint within a few
73
+ * minutes. Use the GET method to retrieve the latest endpoint state.
74
+ *
75
+ * An endpoint can be used only after it reaches the APPROVED state.
76
+ */
77
+ createEndpoint(req: CreateEndpointRequest, options?: CallOptions): Promise<Endpoint>;
78
+ /**
79
+ * Deletes a network endpoint. This will remove the endpoint configuration from <Databricks>.
80
+ * Depending on the endpoint type and use case, you may also need to delete corresponding network resources
81
+ * in your cloud provider account.
82
+ */
83
+ deleteEndpoint(req: DeleteEndpointRequest, options?: CallOptions): Promise<void>;
84
+ /** Gets details of a specific network endpoint. */
85
+ getEndpoint(req: GetEndpointRequest, options?: CallOptions): Promise<Endpoint>;
86
+ /** Lists all network connectivity endpoints for the account. */
87
+ listEndpoints(req: ListEndpointsRequest, options?: CallOptions): Promise<ListEndpointsResponse>;
88
+ listEndpointsIter(req: ListEndpointsRequest, options?: CallOptions): AsyncGenerator<Endpoint>;
89
+ /**
90
+ * Creates an IP access list for this workspace.
91
+ *
92
+ * A list can be an allow list or a block list.
93
+ * See the top of this file for a description of how the server treats allow lists and block lists at runtime.
94
+ *
95
+ * When creating or updating an IP access list:
96
+ *
97
+ * * For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values,
98
+ * where one CIDR counts as a single value. Attempts to exceed that number return error 400 with `error_code` value `QUOTA_EXCEEDED`.
99
+ * * If the new list would block the calling user's current IP, error 400 is returned with `error_code` value `INVALID_STATE`.
100
+ *
101
+ * It can take a few minutes for the changes to take effect. **Note**: Your new IP access list has no effect until you enable the feature. See [workspaceconf/setStatus](https://docs.databricks.com/api/workspace/workspaceconf/setstatus)
102
+ */
103
+ createIpAccessList(req: CreateIpAccessListRequest, options?: CallOptions): Promise<CreateIpAccessListResponse>;
104
+ /** Deletes an IP access list, specified by its list ID. */
105
+ deleteIpAccessList(req: DeleteIpAccessListRequest, options?: CallOptions): Promise<DeleteIpAccessListResponse>;
106
+ /** Gets an IP access list, specified by its list ID. */
107
+ getIpAccessList(req: GetIpAccessListRequest, options?: CallOptions): Promise<GetIpAccessListResponse>;
108
+ /** Gets all IP access lists for the specified workspace. */
109
+ listIpAccessLists(_req: ListIpAccessLists, options?: CallOptions): Promise<ListIpAccessListsResponse>;
110
+ /**
111
+ * Replaces an IP access list, specified by its ID.
112
+ *
113
+ * A list can include allow lists and block lists. See the top
114
+ * of this file for a description of how the server treats allow lists and block lists at run time. When
115
+ * replacing an IP access list:
116
+ * * For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values,
117
+ * where one CIDR counts as a single value. Attempts to exceed that number return error 400 with `error_code`
118
+ * value `QUOTA_EXCEEDED`.
119
+ * * If the resulting list would block the calling user's current IP, error 400 is returned with `error_code`
120
+ * value `INVALID_STATE`.
121
+ * It can take a few minutes for the changes to take effect. Note that your resulting IP access list has no
122
+ * effect until you enable the feature. See [workspaceconf/setStatus](https://docs.databricks.com/api/workspace/workspaceconf/setstatus).
123
+ */
124
+ replaceIpAccessList(req: ReplaceIpAccessListRequest, options?: CallOptions): Promise<ReplaceIpAccessListResponse>;
125
+ /**
126
+ * Updates an existing IP access list, specified by its ID.
127
+ *
128
+ * A list can include allow lists and block lists.
129
+ * See the top of this file for a description of how the server treats allow lists and block lists at run time.
130
+ *
131
+ * When updating an IP access list:
132
+ *
133
+ * * For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values,
134
+ * where one CIDR counts as a single value. Attempts to exceed that number return error 400 with `error_code` value `QUOTA_EXCEEDED`.
135
+ * * If the updated list would block the calling user's current IP, error 400 is returned with `error_code` value `INVALID_STATE`.
136
+ *
137
+ * It can take a few minutes for the changes to take effect. Note that your resulting IP access list has no effect until you enable
138
+ * the feature. See [workspaceconf/setStatus](https://docs.databricks.com/api/workspace/workspaceconf/setstatus).
139
+ */
140
+ updateIpAccessList(req: UpdateIpAccessListRequest, options?: CallOptions): Promise<UpdateIpAccessListResponse>;
141
+ /**
142
+ * Creates a network connectivity configuration (NCC), which provides stable Azure service
143
+ * subnets when accessing your Azure Storage accounts. You can also use a network connectivity configuration to create
144
+ * <Databricks> managed private endpoints so that <Databricks> serverless compute resources privately access your
145
+ * resources.
146
+ *
147
+ * **IMPORTANT**: After you create the network connectivity configuration, you must assign one or more workspaces to the new network connectivity configuration.
148
+ * You can share one network connectivity configuration with multiple workspaces from the same Azure region within
149
+ * the same <Databricks> account.
150
+ * See [configure serverless secure connectivity](https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security).
151
+ */
152
+ createNetworkConnectivityConfigPublic(req: CreateNetworkConnectivityConfigRequest, options?: CallOptions): Promise<NetworkConnectivityConfig>;
153
+ /** Deletes a network connectivity configuration. */
154
+ deleteNetworkConnectivityConfigPublic(req: DeleteNetworkConnectivityConfigRequest, options?: CallOptions): Promise<void>;
155
+ /** Gets a network connectivity configuration. */
156
+ getNetworkConnectivityConfigPublic(req: GetNetworkConnectivityConfigRequest, options?: CallOptions): Promise<NetworkConnectivityConfig>;
157
+ /** Gets an array of network connectivity configurations. */
158
+ listNetworkConnectivityConfigsPublic(req: ListNetworkConnectivityConfigsRequest, options?: CallOptions): Promise<ListNetworkConnectivityConfigsResponse>;
159
+ listNetworkConnectivityConfigsPublicIter(req: ListNetworkConnectivityConfigsRequest, options?: CallOptions): AsyncGenerator<NetworkConnectivityConfig>;
160
+ /**
161
+ * Create a private endpoint rule for the specified network connectivity config object.
162
+ * Once the object is created, <Databricks> asynchronously provisions a new Azure private endpoint to your
163
+ * specified Azure resource.
164
+ *
165
+ * **IMPORTANT**: You must use Azure portal or other Azure tools to approve the private endpoint to complete the
166
+ * connection. To get the information of the private endpoint created, make a `GET` request on the new private
167
+ * endpoint rule. See [serverless private link](https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security/serverless-private-link).
168
+ */
169
+ createNccPrivateEndpointRule(req: CreateNccPrivateEndpointRuleRequest, options?: CallOptions): Promise<NccPrivateEndpointRule>;
170
+ /**
171
+ * Initiates deleting a private endpoint rule. If the connection state is PENDING or EXPIRED,
172
+ * the private endpoint is immediately deleted. Otherwise, the private endpoint is deactivated
173
+ * and will be deleted after one day of deactivation. When a private endpoint is deactivated,
174
+ * the `deactivated` field is set to `true` and the private endpoint is not
175
+ * available to your serverless compute resources.
176
+ */
177
+ deleteNccPrivateEndpointRule(req: DeleteNccPrivateEndpointRuleRequest, options?: CallOptions): Promise<NccPrivateEndpointRule>;
178
+ /** Gets the private endpoint rule. */
179
+ getNccPrivateEndpointRule(req: GetNccPrivateEndpointRuleRequest, options?: CallOptions): Promise<NccPrivateEndpointRule>;
180
+ /** Gets an array of private endpoint rules. */
181
+ listNccPrivateEndpointRules(req: ListNccPrivateEndpointRulesRequest, options?: CallOptions): Promise<ListNccPrivateEndpointRulesResponse>;
182
+ listNccPrivateEndpointRulesIter(req: ListNccPrivateEndpointRulesRequest, options?: CallOptions): AsyncGenerator<NccPrivateEndpointRule>;
183
+ /** Updates a private endpoint rule. Currently only a private endpoint rule to customer-managed resources is allowed to be updated. */
184
+ updateNccPrivateEndpointRule(req: UpdateNccPrivateEndpointRuleRequest, options?: CallOptions): Promise<NccPrivateEndpointRule>;
185
+ /**
186
+ * Creates a new network policy to manage which network destinations can be accessed from the <Databricks>
187
+ * environment.
188
+ */
189
+ createNetworkPolicyRpc(req: CreateNetworkPolicyRequest, options?: CallOptions): Promise<AccountNetworkPolicy>;
190
+ /** Deletes a network policy. Cannot be called on 'default-policy'. */
191
+ deleteNetworkPolicyRpc(req: DeleteNetworkPolicyRequest, options?: CallOptions): Promise<void>;
192
+ /** Gets a network policy. */
193
+ getNetworkPolicyRpc(req: GetNetworkPolicyRequest, options?: CallOptions): Promise<AccountNetworkPolicy>;
194
+ /** Gets an array of network policies. */
195
+ listNetworkPoliciesRpc(req: ListNetworkPoliciesRequest, options?: CallOptions): Promise<ListNetworkPoliciesResponse>;
196
+ listNetworkPoliciesRpcIter(req: ListNetworkPoliciesRequest, options?: CallOptions): AsyncGenerator<AccountNetworkPolicy>;
197
+ /** Updates a network policy. This allows you to modify the configuration of a network policy. */
198
+ updateNetworkPolicyRpc(req: UpdateNetworkPolicyRequest, options?: CallOptions): Promise<AccountNetworkPolicy>;
199
+ /** Creates a <Databricks> network configuration that represents an VPC and its resources. The VPC will be used for new <Databricks> clusters. This requires a pre-existing VPC and subnets. */
200
+ createNetworkPublic(req: CreateNetworkRequest, options?: CallOptions): Promise<Network>;
201
+ /**
202
+ * Creates a private access settings configuration, which represents
203
+ * network access restrictions for workspace resources. Private access
204
+ * settings configure whether workspaces can be accessed from the public
205
+ * internet or only from private endpoints.
206
+ */
207
+ createPrivateAccessSettingsPublic(req: CreatePrivateAccessSettingsRequest, options?: CallOptions): Promise<PrivateAccessSettings>;
208
+ /**
209
+ * Creates a VPC endpoint configuration, which represents a
210
+ * [VPC endpoint](https://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints.html)
211
+ * object in AWS used to communicate privately with <Databricks> over
212
+ * [AWS PrivateLink](https://aws.amazon.com/privatelink).
213
+ *
214
+ * After you create the VPC endpoint configuration, the <Databricks>
215
+ * [endpoint service](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html)
216
+ * automatically accepts the VPC endpoint.
217
+ *
218
+ * Before configuring PrivateLink, read the
219
+ * [<Databricks> article about PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).
220
+ */
221
+ createVpcEndpointPublic(req: CreateVpcEndpointRequest, options?: CallOptions): Promise<VpcEndpoint>;
222
+ /**
223
+ * Deletes a <Databricks> network configuration, which represents a cloud VPC and its resources. You cannot delete a network that is associated with a workspace.
224
+ *
225
+ * This operation is available only if your account is on the E2 version of the platform.
226
+ */
227
+ deleteNetworkPublic(req: DeleteNetworkRequest, options?: CallOptions): Promise<Network>;
228
+ /** Deletes a <Databricks> private access settings configuration, both specified by ID. */
229
+ deletePrivateAccessSettingsPublic(req: DeletePrivateAccessSettingsRequest, options?: CallOptions): Promise<PrivateAccessSettings>;
230
+ /** Deletes a Databricks VPC endpoint configuration. You cannot delete a VPC endpoint configuration that is associated with any workspace. */
231
+ deleteVpcEndpointPublic(req: DeleteVpcEndpointRequest, options?: CallOptions): Promise<VpcEndpoint>;
232
+ /** Gets a <Databricks> network configuration, which represents a cloud VPC and its resources. */
233
+ getNetworkPublic(req: GetNetworkRequest, options?: CallOptions): Promise<Network>;
234
+ /** Gets a <Databricks> private access settings configuration, both specified by ID. */
235
+ getPrivateAccessSettingsPublic(req: GetPrivateAccessSettingsRequest, options?: CallOptions): Promise<PrivateAccessSettings>;
236
+ /**
237
+ * Gets a VPC endpoint configuration, which represents
238
+ * a [VPC endpoint](https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html)
239
+ * object in AWS used to communicate privately with <Databricks> over
240
+ * [AWS PrivateLink](https://aws.amazon.com/privatelink).
241
+ */
242
+ getVpcEndpointPublic(req: GetVpcEndpointRequest, options?: CallOptions): Promise<VpcEndpoint>;
243
+ /** Lists <Databricks> network configurations for an account. */
244
+ listNetworkPublic(req: ListNetworkRequest, options?: CallOptions): Promise<ListNetworkResponse>;
245
+ /** Lists <Databricks> private access settings for an account. */
246
+ listPrivateAccessSettingsPublic(req: ListPrivateAccessSettingsRequest, options?: CallOptions): Promise<ListPrivateAccessSettingsResponse>;
247
+ /** Lists Databricks VPC endpoint configurations for an account. */
248
+ listVpcEndpointPublic(req: ListVpcEndpointRequest, options?: CallOptions): Promise<ListVpcEndpointResponse>;
249
+ /**
250
+ * Updates an existing private access settings object, which specifies how your workspace is accessed over AWS PrivateLink. To use AWS PrivateLink, a workspace must have a private access settings object referenced by ID in the workspace's private_access_settings_id property.
251
+ * This operation completely overwrites your existing private access settings object attached to your workspaces. All workspaces attached to the private access settings are affected by any change. If public_access_enabled, private_access_level, or allowed_vpc_endpoint_ids are updated, effects of these changes might take several minutes to propagate to the workspace API.
252
+ * You can share one private access settings object with multiple workspaces in a single account. However, private access settings are specific to AWS regions, so only workspaces in the same AWS region can use a given private access settings object.
253
+ * Before configuring PrivateLink, read the <Databricks> article about PrivateLink.
254
+ */
255
+ updatePrivateAccessSettingsPublic(req: UpdatePrivateAccessSettingsRequest, options?: CallOptions): Promise<PrivateAccessSettings>;
256
+ /**
257
+ * Gets the network option for a workspace. Every workspace has exactly one network policy binding,
258
+ * with 'default-policy' used if no explicit assignment exists.
259
+ */
260
+ getWorkspaceNetworkOptionRpc(req: GetWorkspaceNetworkOptionRequest, options?: CallOptions): Promise<WorkspaceNetworkOption>;
261
+ /**
262
+ * Updates the network option for a workspace. This operation associates the workspace with the specified network policy.
263
+ * To revert to the default policy, specify 'default-policy' as the network_policy_id.
264
+ */
265
+ updateWorkspaceNetworkOptionRpc(req: UpdateWorkspaceNetworkOptionRequest, options?: CallOptions): Promise<WorkspaceNetworkOption>;
264
266
  }
267
+ //#endregion
268
+ export { NetworkingClient };
265
269
  //# sourceMappingURL=client.d.ts.map