@pulumi/databricks 1.36.0 → 1.37.0-alpha.1713897525

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.
Files changed (314) hide show
  1. package/accessControlRuleSet.d.ts +0 -12
  2. package/accessControlRuleSet.js +0 -12
  3. package/accessControlRuleSet.js.map +1 -1
  4. package/artifactAllowlist.d.ts +0 -2
  5. package/artifactAllowlist.js +0 -2
  6. package/artifactAllowlist.js.map +1 -1
  7. package/catalog.d.ts +0 -2
  8. package/catalog.js +0 -2
  9. package/catalog.js.map +1 -1
  10. package/catalogWorkspaceBinding.d.ts +0 -2
  11. package/catalogWorkspaceBinding.js +0 -2
  12. package/catalogWorkspaceBinding.js.map +1 -1
  13. package/cluster.d.ts +0 -20
  14. package/cluster.js +0 -2
  15. package/cluster.js.map +1 -1
  16. package/clusterPolicy.d.ts +0 -2
  17. package/clusterPolicy.js +0 -2
  18. package/clusterPolicy.js.map +1 -1
  19. package/connection.d.ts +0 -4
  20. package/connection.js +0 -4
  21. package/connection.js.map +1 -1
  22. package/defaultNamespaceSetting.d.ts +0 -2
  23. package/defaultNamespaceSetting.js +0 -2
  24. package/defaultNamespaceSetting.js.map +1 -1
  25. package/entitlements.d.ts +0 -6
  26. package/entitlements.js +0 -6
  27. package/entitlements.js.map +1 -1
  28. package/externalLocation.d.ts +0 -2
  29. package/externalLocation.js +0 -2
  30. package/externalLocation.js.map +1 -1
  31. package/getAwsAssumeRolePolicy.d.ts +0 -4
  32. package/getAwsAssumeRolePolicy.js +0 -4
  33. package/getAwsAssumeRolePolicy.js.map +1 -1
  34. package/getAwsCrossAccountPolicy.d.ts +0 -4
  35. package/getAwsCrossAccountPolicy.js +0 -4
  36. package/getAwsCrossAccountPolicy.js.map +1 -1
  37. package/getAwsUnityCatalogPolicy.d.ts +0 -4
  38. package/getAwsUnityCatalogPolicy.js +0 -4
  39. package/getAwsUnityCatalogPolicy.js.map +1 -1
  40. package/getCatalogs.d.ts +0 -4
  41. package/getCatalogs.js +0 -4
  42. package/getCatalogs.js.map +1 -1
  43. package/getCluster.d.ts +0 -4
  44. package/getCluster.js +0 -4
  45. package/getCluster.js.map +1 -1
  46. package/getClusterPolicy.d.ts +0 -4
  47. package/getClusterPolicy.js +0 -4
  48. package/getClusterPolicy.js.map +1 -1
  49. package/getClusters.d.ts +0 -8
  50. package/getClusters.js +0 -8
  51. package/getClusters.js.map +1 -1
  52. package/getCurrentConfig.d.ts +0 -4
  53. package/getCurrentConfig.js +0 -4
  54. package/getCurrentConfig.js.map +1 -1
  55. package/getCurrentMetastore.d.ts +0 -4
  56. package/getCurrentMetastore.js +0 -4
  57. package/getCurrentMetastore.js.map +1 -1
  58. package/getDbfsFile.d.ts +0 -4
  59. package/getDbfsFile.js +0 -4
  60. package/getDbfsFile.js.map +1 -1
  61. package/getDbfsFilePaths.d.ts +0 -4
  62. package/getDbfsFilePaths.js +0 -4
  63. package/getDbfsFilePaths.js.map +1 -1
  64. package/getDirectory.d.ts +0 -4
  65. package/getDirectory.js +0 -4
  66. package/getDirectory.js.map +1 -1
  67. package/getExternalLocations.d.ts +0 -4
  68. package/getExternalLocations.js +0 -4
  69. package/getExternalLocations.js.map +1 -1
  70. package/getGroup.d.ts +0 -4
  71. package/getGroup.js +0 -4
  72. package/getGroup.js.map +1 -1
  73. package/getInstancePool.d.ts +0 -4
  74. package/getInstancePool.js +0 -4
  75. package/getInstancePool.js.map +1 -1
  76. package/getInstanceProfiles.d.ts +0 -4
  77. package/getInstanceProfiles.js +0 -4
  78. package/getInstanceProfiles.js.map +1 -1
  79. package/getJob.d.ts +0 -4
  80. package/getJob.js +0 -4
  81. package/getJob.js.map +1 -1
  82. package/getJobs.d.ts +0 -8
  83. package/getJobs.js +0 -8
  84. package/getJobs.js.map +1 -1
  85. package/getMetastore.d.ts +0 -4
  86. package/getMetastore.js +0 -4
  87. package/getMetastore.js.map +1 -1
  88. package/getMetastores.d.ts +0 -4
  89. package/getMetastores.js +0 -4
  90. package/getMetastores.js.map +1 -1
  91. package/getMlflowModel.d.ts +0 -8
  92. package/getMlflowModel.js +0 -8
  93. package/getMlflowModel.js.map +1 -1
  94. package/getMwsCredentials.d.ts +0 -4
  95. package/getMwsCredentials.js +0 -4
  96. package/getMwsCredentials.js.map +1 -1
  97. package/getMwsWorkspaces.d.ts +0 -4
  98. package/getMwsWorkspaces.js +0 -4
  99. package/getMwsWorkspaces.js.map +1 -1
  100. package/getNodeType.d.ts +0 -4
  101. package/getNodeType.js +0 -4
  102. package/getNodeType.js.map +1 -1
  103. package/getNotebook.d.ts +0 -4
  104. package/getNotebook.js +0 -4
  105. package/getNotebook.js.map +1 -1
  106. package/getNotebookPaths.d.ts +0 -4
  107. package/getNotebookPaths.js +0 -4
  108. package/getNotebookPaths.js.map +1 -1
  109. package/getPipelines.d.ts +0 -12
  110. package/getPipelines.js +0 -12
  111. package/getPipelines.js.map +1 -1
  112. package/getSchemas.d.ts +0 -4
  113. package/getSchemas.js +0 -4
  114. package/getSchemas.js.map +1 -1
  115. package/getServicePrincipal.d.ts +0 -4
  116. package/getServicePrincipal.js +0 -4
  117. package/getServicePrincipal.js.map +1 -1
  118. package/getShare.d.ts +0 -4
  119. package/getShare.js +0 -4
  120. package/getShare.js.map +1 -1
  121. package/getShares.d.ts +0 -4
  122. package/getShares.js +0 -4
  123. package/getShares.js.map +1 -1
  124. package/getSparkVersion.d.ts +0 -4
  125. package/getSparkVersion.js +0 -4
  126. package/getSparkVersion.js.map +1 -1
  127. package/getSqlWarehouse.d.ts +0 -8
  128. package/getSqlWarehouse.js +0 -8
  129. package/getSqlWarehouse.js.map +1 -1
  130. package/getSqlWarehouses.d.ts +0 -8
  131. package/getSqlWarehouses.js +0 -8
  132. package/getSqlWarehouses.js.map +1 -1
  133. package/getStorageCredentials.d.ts +0 -4
  134. package/getStorageCredentials.js +0 -4
  135. package/getStorageCredentials.js.map +1 -1
  136. package/getTables.d.ts +0 -4
  137. package/getTables.js +0 -4
  138. package/getTables.js.map +1 -1
  139. package/getUser.d.ts +0 -4
  140. package/getUser.js +0 -4
  141. package/getUser.js.map +1 -1
  142. package/getVolumes.d.ts +0 -4
  143. package/getVolumes.js +0 -4
  144. package/getVolumes.js.map +1 -1
  145. package/getZones.d.ts +0 -4
  146. package/getZones.js +0 -4
  147. package/getZones.js.map +1 -1
  148. package/group.d.ts +0 -8
  149. package/group.js +0 -8
  150. package/group.js.map +1 -1
  151. package/groupInstanceProfile.d.ts +0 -2
  152. package/groupInstanceProfile.js +0 -2
  153. package/groupInstanceProfile.js.map +1 -1
  154. package/groupMember.d.ts +36 -9
  155. package/groupMember.js +30 -3
  156. package/groupMember.js.map +1 -1
  157. package/groupRole.d.ts +0 -4
  158. package/groupRole.js +0 -4
  159. package/groupRole.js.map +1 -1
  160. package/instancePool.d.ts +0 -2
  161. package/instancePool.js +0 -2
  162. package/instancePool.js.map +1 -1
  163. package/instanceProfile.d.ts +0 -8
  164. package/instanceProfile.js +0 -8
  165. package/instanceProfile.js.map +1 -1
  166. package/ipAccessList.d.ts +0 -2
  167. package/ipAccessList.js +0 -2
  168. package/ipAccessList.js.map +1 -1
  169. package/job.d.ts +2 -32
  170. package/job.js.map +1 -1
  171. package/lakehouseMonitor.d.ts +0 -4
  172. package/lakehouseMonitor.js +0 -4
  173. package/lakehouseMonitor.js.map +1 -1
  174. package/library.d.ts +0 -8
  175. package/library.js +0 -8
  176. package/library.js.map +1 -1
  177. package/metastore.d.ts +0 -2
  178. package/metastore.js +0 -2
  179. package/metastore.js.map +1 -1
  180. package/metastoreAssignment.d.ts +0 -2
  181. package/metastoreAssignment.js +0 -2
  182. package/metastoreAssignment.js.map +1 -1
  183. package/metastoreDataAccess.d.ts +0 -2
  184. package/metastoreDataAccess.js +0 -2
  185. package/metastoreDataAccess.js.map +1 -1
  186. package/metastoreProvider.d.ts +0 -2
  187. package/metastoreProvider.js +0 -2
  188. package/metastoreProvider.js.map +1 -1
  189. package/mlflowExperiment.d.ts +0 -2
  190. package/mlflowExperiment.js +0 -2
  191. package/mlflowExperiment.js.map +1 -1
  192. package/mlflowModel.d.ts +0 -2
  193. package/mlflowModel.js +0 -2
  194. package/mlflowModel.js.map +1 -1
  195. package/mlflowWebhook.d.ts +0 -4
  196. package/mlflowWebhook.js +0 -4
  197. package/mlflowWebhook.js.map +1 -1
  198. package/modelServing.d.ts +0 -2
  199. package/modelServing.js +0 -2
  200. package/modelServing.js.map +1 -1
  201. package/mount.d.ts +0 -14
  202. package/mount.js +0 -14
  203. package/mount.js.map +1 -1
  204. package/mwsCustomerManagedKeys.d.ts +0 -8
  205. package/mwsCustomerManagedKeys.js +0 -8
  206. package/mwsCustomerManagedKeys.js.map +1 -1
  207. package/mwsLogDelivery.d.ts +0 -4
  208. package/mwsLogDelivery.js +0 -4
  209. package/mwsLogDelivery.js.map +1 -1
  210. package/mwsNetworks.d.ts +3 -3
  211. package/mwsPermissionAssignment.d.ts +0 -6
  212. package/mwsPermissionAssignment.js +0 -6
  213. package/mwsPermissionAssignment.js.map +1 -1
  214. package/mwsPrivateAccessSettings.d.ts +0 -6
  215. package/mwsPrivateAccessSettings.js +0 -6
  216. package/mwsPrivateAccessSettings.js.map +1 -1
  217. package/mwsWorkspaces.d.ts +0 -6
  218. package/mwsWorkspaces.js +0 -6
  219. package/mwsWorkspaces.js.map +1 -1
  220. package/onlineTable.d.ts +0 -2
  221. package/onlineTable.js +0 -2
  222. package/onlineTable.js.map +1 -1
  223. package/package.json +1 -1
  224. package/permissionAssignment.d.ts +92 -0
  225. package/permissionAssignment.js +77 -0
  226. package/permissionAssignment.js.map +1 -1
  227. package/permissions.d.ts +0 -171
  228. package/permissions.js.map +1 -1
  229. package/pipeline.d.ts +0 -2
  230. package/pipeline.js +0 -2
  231. package/pipeline.js.map +1 -1
  232. package/recipient.d.ts +0 -2
  233. package/recipient.js +0 -2
  234. package/recipient.js.map +1 -1
  235. package/registeredModel.d.ts +0 -2
  236. package/registeredModel.js +0 -2
  237. package/registeredModel.js.map +1 -1
  238. package/restrictWorkspaceAdminsSetting.d.ts +0 -2
  239. package/restrictWorkspaceAdminsSetting.js +0 -2
  240. package/restrictWorkspaceAdminsSetting.js.map +1 -1
  241. package/schema.d.ts +0 -2
  242. package/schema.js +0 -2
  243. package/schema.js.map +1 -1
  244. package/secret.d.ts +0 -2
  245. package/secret.js +0 -2
  246. package/secret.js.map +1 -1
  247. package/secretAcl.d.ts +0 -2
  248. package/secretAcl.js +0 -2
  249. package/secretAcl.js.map +1 -1
  250. package/secretScope.d.ts +0 -2
  251. package/secretScope.js +0 -2
  252. package/secretScope.js.map +1 -1
  253. package/servicePrincipal.d.ts +0 -10
  254. package/servicePrincipal.js +0 -10
  255. package/servicePrincipal.js.map +1 -1
  256. package/servicePrincipalRole.d.ts +0 -2
  257. package/servicePrincipalRole.js +0 -2
  258. package/servicePrincipalRole.js.map +1 -1
  259. package/servicePrincipalSecret.d.ts +36 -0
  260. package/servicePrincipalSecret.js +18 -0
  261. package/servicePrincipalSecret.js.map +1 -1
  262. package/sqlAlert.d.ts +0 -2
  263. package/sqlAlert.js +0 -2
  264. package/sqlAlert.js.map +1 -1
  265. package/sqlDashboard.d.ts +0 -4
  266. package/sqlDashboard.js +0 -4
  267. package/sqlDashboard.js.map +1 -1
  268. package/sqlEndpoint.d.ts +3 -5
  269. package/sqlEndpoint.js +0 -2
  270. package/sqlEndpoint.js.map +1 -1
  271. package/sqlGlobalConfig.d.ts +0 -4
  272. package/sqlGlobalConfig.js +0 -4
  273. package/sqlGlobalConfig.js.map +1 -1
  274. package/sqlPermissions.d.ts +0 -2
  275. package/sqlPermissions.js +0 -2
  276. package/sqlPermissions.js.map +1 -1
  277. package/sqlQuery.d.ts +0 -4
  278. package/sqlQuery.js +0 -4
  279. package/sqlQuery.js.map +1 -1
  280. package/sqlWidget.d.ts +0 -2
  281. package/sqlWidget.js +0 -2
  282. package/sqlWidget.js.map +1 -1
  283. package/storageCredential.d.ts +0 -6
  284. package/storageCredential.js +0 -6
  285. package/storageCredential.js.map +1 -1
  286. package/systemSchema.d.ts +0 -2
  287. package/systemSchema.js +0 -2
  288. package/systemSchema.js.map +1 -1
  289. package/token.d.ts +0 -4
  290. package/token.js +0 -4
  291. package/token.js.map +1 -1
  292. package/types/input.d.ts +26 -325
  293. package/types/output.d.ts +26 -325
  294. package/user.d.ts +0 -10
  295. package/user.js +0 -10
  296. package/user.js.map +1 -1
  297. package/userInstanceProfile.d.ts +0 -2
  298. package/userInstanceProfile.js +0 -2
  299. package/userInstanceProfile.js.map +1 -1
  300. package/userRole.d.ts +0 -4
  301. package/userRole.js +0 -4
  302. package/userRole.js.map +1 -1
  303. package/vectorSearchEndpoint.d.ts +0 -2
  304. package/vectorSearchEndpoint.js +0 -2
  305. package/vectorSearchEndpoint.js.map +1 -1
  306. package/vectorSearchIndex.d.ts +0 -2
  307. package/vectorSearchIndex.js +0 -2
  308. package/vectorSearchIndex.js.map +1 -1
  309. package/volume.d.ts +0 -2
  310. package/volume.js +0 -2
  311. package/volume.js.map +1 -1
  312. package/workspaceConf.d.ts +0 -2
  313. package/workspaceConf.js +0 -2
  314. package/workspaceConf.js.map +1 -1
package/types/output.d.ts CHANGED
@@ -41,7 +41,6 @@ export interface ClusterAutoscale {
41
41
  *
42
42
  * The following example demonstrates how to create an single node cluster:
43
43
  *
44
- * <!--Start PulumiCodeChooser -->
45
44
  * ```typescript
46
45
  * import * as pulumi from "@pulumi/pulumi";
47
46
  * import * as databricks from "@pulumi/databricks";
@@ -66,7 +65,6 @@ export interface ClusterAutoscale {
66
65
  * },
67
66
  * });
68
67
  * ```
69
- * <!--End PulumiCodeChooser -->
70
68
  */
71
69
  maxWorkers?: number;
72
70
  /**
@@ -134,39 +132,15 @@ export interface ClusterClusterLogConf {
134
132
  s3?: outputs.ClusterClusterLogConfS3;
135
133
  }
136
134
  export interface ClusterClusterLogConfDbfs {
137
- /**
138
- * S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.
139
- */
140
135
  destination: string;
141
136
  }
142
137
  export interface ClusterClusterLogConfS3 {
143
- /**
144
- * Set canned access control list, e.g. `bucket-owner-full-control`. If `cannedCal` is set, the cluster instance profile must have `s3:PutObjectAcl` permission on the destination bucket and prefix. The full list of possible canned ACLs can be found [here](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl). By default, only the object owner gets full control. If you are using a cross-account role for writing data, you may want to set `bucket-owner-full-control` to make bucket owners able to read the logs.
145
- */
146
138
  cannedAcl?: string;
147
- /**
148
- * S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.
149
- */
150
139
  destination: string;
151
- /**
152
- * Enable server-side encryption, false by default.
153
- */
154
140
  enableEncryption?: boolean;
155
- /**
156
- * The encryption type, it could be `sse-s3` or `sse-kms`. It is used only when encryption is enabled, and the default type is `sse-s3`.
157
- */
158
141
  encryptionType?: string;
159
- /**
160
- * S3 endpoint, e.g. <https://s3-us-west-2.amazonaws.com>. Either `region` or `endpoint` needs to be set. If both are set, the endpoint is used.
161
- */
162
142
  endpoint?: string;
163
- /**
164
- * KMS key used if encryption is enabled and encryption type is set to `sse-kms`.
165
- */
166
143
  kmsKey?: string;
167
- /**
168
- * S3 region, e.g. `us-west-2`. Either `region` or `endpoint` must be set. If both are set, the endpoint is used.
169
- */
170
144
  region?: string;
171
145
  }
172
146
  export interface ClusterClusterMountInfo {
@@ -175,7 +149,6 @@ export interface ClusterClusterMountInfo {
175
149
  *
176
150
  * For example, you can mount Azure Data Lake Storage container using the following code:
177
151
  *
178
- * <!--Start PulumiCodeChooser -->
179
152
  * ```typescript
180
153
  * import * as pulumi from "@pulumi/pulumi";
181
154
  * import * as databricks from "@pulumi/databricks";
@@ -191,7 +164,6 @@ export interface ClusterClusterMountInfo {
191
164
  * localMountDirPath: "/mnt/nfs-test",
192
165
  * }]});
193
166
  * ```
194
- * <!--End PulumiCodeChooser -->
195
167
  */
196
168
  localMountDirPath: string;
197
169
  /**
@@ -219,7 +191,6 @@ export interface ClusterDockerImage {
219
191
  *
220
192
  * Example usage with azurerm_container_registry, that you can adapt to your specific use-case:
221
193
  *
222
- * <!--Start PulumiCodeChooser -->
223
194
  * ```typescript
224
195
  * import * as pulumi from "@pulumi/pulumi";
225
196
  * import * as databricks from "@pulumi/databricks";
@@ -237,7 +208,6 @@ export interface ClusterDockerImage {
237
208
  * },
238
209
  * }});
239
210
  * ```
240
- * <!--End PulumiCodeChooser -->
241
211
  */
242
212
  basicAuth?: outputs.ClusterDockerImageBasicAuth;
243
213
  /**
@@ -288,69 +258,30 @@ export interface ClusterInitScript {
288
258
  workspace?: outputs.ClusterInitScriptWorkspace;
289
259
  }
290
260
  export interface ClusterInitScriptAbfss {
291
- /**
292
- * S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.
293
- */
294
261
  destination: string;
295
262
  }
296
263
  export interface ClusterInitScriptDbfs {
297
- /**
298
- * S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.
299
- */
300
264
  destination: string;
301
265
  }
302
266
  export interface ClusterInitScriptFile {
303
- /**
304
- * S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.
305
- */
306
267
  destination: string;
307
268
  }
308
269
  export interface ClusterInitScriptGcs {
309
- /**
310
- * S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.
311
- */
312
270
  destination: string;
313
271
  }
314
272
  export interface ClusterInitScriptS3 {
315
- /**
316
- * Set canned access control list, e.g. `bucket-owner-full-control`. If `cannedCal` is set, the cluster instance profile must have `s3:PutObjectAcl` permission on the destination bucket and prefix. The full list of possible canned ACLs can be found [here](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl). By default, only the object owner gets full control. If you are using a cross-account role for writing data, you may want to set `bucket-owner-full-control` to make bucket owners able to read the logs.
317
- */
318
273
  cannedAcl?: string;
319
- /**
320
- * S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.
321
- */
322
274
  destination: string;
323
- /**
324
- * Enable server-side encryption, false by default.
325
- */
326
275
  enableEncryption?: boolean;
327
- /**
328
- * The encryption type, it could be `sse-s3` or `sse-kms`. It is used only when encryption is enabled, and the default type is `sse-s3`.
329
- */
330
276
  encryptionType?: string;
331
- /**
332
- * S3 endpoint, e.g. <https://s3-us-west-2.amazonaws.com>. Either `region` or `endpoint` needs to be set. If both are set, the endpoint is used.
333
- */
334
277
  endpoint?: string;
335
- /**
336
- * KMS key used if encryption is enabled and encryption type is set to `sse-kms`.
337
- */
338
278
  kmsKey?: string;
339
- /**
340
- * S3 region, e.g. `us-west-2`. Either `region` or `endpoint` must be set. If both are set, the endpoint is used.
341
- */
342
279
  region?: string;
343
280
  }
344
281
  export interface ClusterInitScriptVolumes {
345
- /**
346
- * S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.
347
- */
348
282
  destination: string;
349
283
  }
350
284
  export interface ClusterInitScriptWorkspace {
351
- /**
352
- * S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.
353
- */
354
285
  destination: string;
355
286
  }
356
287
  export interface ClusterLibrary {
@@ -402,7 +333,6 @@ export interface ClusterWorkloadTypeClients {
402
333
  /**
403
334
  * boolean flag defining if it's possible to run Databricks Jobs on this cluster. Default: `true`.
404
335
  *
405
- * <!--Start PulumiCodeChooser -->
406
336
  * ```typescript
407
337
  * import * as pulumi from "@pulumi/pulumi";
408
338
  * import * as databricks from "@pulumi/databricks";
@@ -414,7 +344,6 @@ export interface ClusterWorkloadTypeClients {
414
344
  * },
415
345
  * }});
416
346
  * ```
417
- * <!--End PulumiCodeChooser -->
418
347
  */
419
348
  jobs?: boolean;
420
349
  /**
@@ -2389,7 +2318,6 @@ export interface InstancePoolPreloadedDockerImage {
2389
2318
  *
2390
2319
  * Example usage with azurerm_container_registry, that you can adapt to your specific use-case:
2391
2320
  *
2392
- * <!--Start PulumiCodeChooser -->
2393
2321
  * ```typescript
2394
2322
  * import * as pulumi from "@pulumi/pulumi";
2395
2323
  * import * as databricks from "@pulumi/databricks";
@@ -2407,7 +2335,6 @@ export interface InstancePoolPreloadedDockerImage {
2407
2335
  * },
2408
2336
  * }]});
2409
2337
  * ```
2410
- * <!--End PulumiCodeChooser -->
2411
2338
  */
2412
2339
  basicAuth?: outputs.InstancePoolPreloadedDockerImageBasicAuth;
2413
2340
  /**
@@ -2464,25 +2391,10 @@ export interface JobDeployment {
2464
2391
  metadataFilePath?: string;
2465
2392
  }
2466
2393
  export interface JobEmailNotifications {
2467
- /**
2468
- * (Bool) don't send alert for skipped runs. (It's recommended to use the corresponding setting in the `notificationSettings` configuration block).
2469
- */
2470
2394
  noAlertForSkippedRuns?: boolean;
2471
- /**
2472
- * (List) list of emails to notify when the duration of a run exceeds the threshold specified by the `RUN_DURATION_SECONDS` metric in the `health` block.
2473
- */
2474
2395
  onDurationWarningThresholdExceededs?: string[];
2475
- /**
2476
- * (List) list of emails to notify when the run fails.
2477
- */
2478
2396
  onFailures?: string[];
2479
- /**
2480
- * (List) list of emails to notify when the run starts.
2481
- */
2482
2397
  onStarts?: string[];
2483
- /**
2484
- * (List) list of emails to notify when the run completes successfully.
2485
- */
2486
2398
  onSuccesses?: string[];
2487
2399
  }
2488
2400
  export interface JobEnvironment {
@@ -2533,9 +2445,7 @@ export interface JobHealthRule {
2533
2445
  */
2534
2446
  metric?: string;
2535
2447
  /**
2536
- * The string specifying the operation used to compare operands. Currently, following operators are supported: `EQUAL_TO`, `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `NOT_EQUAL`. (Check the [API docs](https://docs.databricks.com/api/workspace/jobs/create) for the latest information).
2537
- *
2538
- * This task does not require a cluster to execute and does not support retries or notifications.
2448
+ * string specifying the operation used to evaluate the given metric. The only supported operation is `GREATER_THAN`.
2539
2449
  */
2540
2450
  op?: string;
2541
2451
  /**
@@ -2638,7 +2548,7 @@ export interface JobJobClusterNewClusterClusterMountInfoNetworkFilesystemInfo {
2638
2548
  export interface JobJobClusterNewClusterDockerImage {
2639
2549
  basicAuth?: outputs.JobJobClusterNewClusterDockerImageBasicAuth;
2640
2550
  /**
2641
- * URL of the Git repository to use.
2551
+ * URL of the job on the given workspace
2642
2552
  */
2643
2553
  url: string;
2644
2554
  }
@@ -2660,9 +2570,6 @@ export interface JobJobClusterNewClusterInitScript {
2660
2570
  * @deprecated For init scripts use 'volumes', 'workspace' or cloud storage location instead of 'dbfs'.
2661
2571
  */
2662
2572
  dbfs?: outputs.JobJobClusterNewClusterInitScriptDbfs;
2663
- /**
2664
- * block consisting of single string fields:
2665
- */
2666
2573
  file?: outputs.JobJobClusterNewClusterInitScriptFile;
2667
2574
  gcs?: outputs.JobJobClusterNewClusterInitScriptGcs;
2668
2575
  s3?: outputs.JobJobClusterNewClusterInitScriptS3;
@@ -2809,7 +2716,7 @@ export interface JobNewClusterClusterMountInfoNetworkFilesystemInfo {
2809
2716
  export interface JobNewClusterDockerImage {
2810
2717
  basicAuth?: outputs.JobNewClusterDockerImageBasicAuth;
2811
2718
  /**
2812
- * URL of the Git repository to use.
2719
+ * URL of the job on the given workspace
2813
2720
  */
2814
2721
  url: string;
2815
2722
  }
@@ -2831,9 +2738,6 @@ export interface JobNewClusterInitScript {
2831
2738
  * @deprecated For init scripts use 'volumes', 'workspace' or cloud storage location instead of 'dbfs'.
2832
2739
  */
2833
2740
  dbfs?: outputs.JobNewClusterInitScriptDbfs;
2834
- /**
2835
- * block consisting of single string fields:
2836
- */
2837
2741
  file?: outputs.JobNewClusterInitScriptFile;
2838
2742
  gcs?: outputs.JobNewClusterInitScriptGcs;
2839
2743
  s3?: outputs.JobNewClusterInitScriptS3;
@@ -2958,7 +2862,6 @@ export interface JobRunAs {
2958
2862
  *
2959
2863
  * Example:
2960
2864
  *
2961
- * <!--Start PulumiCodeChooser -->
2962
2865
  * ```typescript
2963
2866
  * import * as pulumi from "@pulumi/pulumi";
2964
2867
  * import * as databricks from "@pulumi/databricks";
@@ -2967,7 +2870,6 @@ export interface JobRunAs {
2967
2870
  * servicePrincipalName: "8d23ae77-912e-4a19-81e4-b9c3f5cc9349",
2968
2871
  * }});
2969
2872
  * ```
2970
- * <!--End PulumiCodeChooser -->
2971
2873
  */
2972
2874
  servicePrincipalName?: string;
2973
2875
  /**
@@ -3054,9 +2956,6 @@ export interface JobTask {
3054
2956
  * block described below that specifies health conditions for a given task.
3055
2957
  */
3056
2958
  health?: outputs.JobTaskHealth;
3057
- /**
3058
- * Identifier that can be referenced in `task` block, so that cluster is shared between tasks
3059
- */
3060
2959
  jobClusterKey?: string;
3061
2960
  /**
3062
2961
  * (Set) An optional list of libraries to be installed on the cluster that will execute the job.
@@ -3070,9 +2969,6 @@ export interface JobTask {
3070
2969
  * (Integer) An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried.
3071
2970
  */
3072
2971
  minRetryIntervalMillis?: number;
3073
- /**
3074
- * Same set of parameters as for databricks.Cluster resource.
3075
- */
3076
2972
  newCluster?: outputs.JobTaskNewCluster;
3077
2973
  notebookTask?: outputs.JobTaskNotebookTask;
3078
2974
  /**
@@ -3169,25 +3065,10 @@ export interface JobTaskDependsOn {
3169
3065
  taskKey: string;
3170
3066
  }
3171
3067
  export interface JobTaskEmailNotifications {
3172
- /**
3173
- * (Bool) don't send alert for skipped runs. (It's recommended to use the corresponding setting in the `notificationSettings` configuration block).
3174
- */
3175
3068
  noAlertForSkippedRuns?: boolean;
3176
- /**
3177
- * (List) list of emails to notify when the duration of a run exceeds the threshold specified by the `RUN_DURATION_SECONDS` metric in the `health` block.
3178
- */
3179
3069
  onDurationWarningThresholdExceededs?: string[];
3180
- /**
3181
- * (List) list of emails to notify when the run fails.
3182
- */
3183
3070
  onFailures?: string[];
3184
- /**
3185
- * (List) list of emails to notify when the run starts.
3186
- */
3187
3071
  onStarts?: string[];
3188
- /**
3189
- * (List) list of emails to notify when the run completes successfully.
3190
- */
3191
3072
  onSuccesses?: string[];
3192
3073
  }
3193
3074
  export interface JobTaskForEachTask {
@@ -3225,9 +3106,6 @@ export interface JobTaskForEachTaskTask {
3225
3106
  * block described below that specifies health conditions for a given task.
3226
3107
  */
3227
3108
  health?: outputs.JobTaskForEachTaskTaskHealth;
3228
- /**
3229
- * Identifier that can be referenced in `task` block, so that cluster is shared between tasks
3230
- */
3231
3109
  jobClusterKey?: string;
3232
3110
  /**
3233
3111
  * (Set) An optional list of libraries to be installed on the cluster that will execute the job.
@@ -3241,9 +3119,6 @@ export interface JobTaskForEachTaskTask {
3241
3119
  * (Integer) An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried.
3242
3120
  */
3243
3121
  minRetryIntervalMillis?: number;
3244
- /**
3245
- * Same set of parameters as for databricks.Cluster resource.
3246
- */
3247
3122
  newCluster?: outputs.JobTaskForEachTaskTaskNewCluster;
3248
3123
  notebookTask?: outputs.JobTaskForEachTaskTaskNotebookTask;
3249
3124
  /**
@@ -3340,25 +3215,10 @@ export interface JobTaskForEachTaskTaskDependsOn {
3340
3215
  taskKey: string;
3341
3216
  }
3342
3217
  export interface JobTaskForEachTaskTaskEmailNotifications {
3343
- /**
3344
- * (Bool) don't send alert for skipped runs. (It's recommended to use the corresponding setting in the `notificationSettings` configuration block).
3345
- */
3346
3218
  noAlertForSkippedRuns?: boolean;
3347
- /**
3348
- * (List) list of emails to notify when the duration of a run exceeds the threshold specified by the `RUN_DURATION_SECONDS` metric in the `health` block.
3349
- */
3350
3219
  onDurationWarningThresholdExceededs?: string[];
3351
- /**
3352
- * (List) list of emails to notify when the run fails.
3353
- */
3354
3220
  onFailures?: string[];
3355
- /**
3356
- * (List) list of emails to notify when the run starts.
3357
- */
3358
3221
  onStarts?: string[];
3359
- /**
3360
- * (List) list of emails to notify when the run completes successfully.
3361
- */
3362
3222
  onSuccesses?: string[];
3363
3223
  }
3364
3224
  export interface JobTaskForEachTaskTaskHealth {
@@ -3373,9 +3233,7 @@ export interface JobTaskForEachTaskTaskHealthRule {
3373
3233
  */
3374
3234
  metric?: string;
3375
3235
  /**
3376
- * The string specifying the operation used to compare operands. Currently, following operators are supported: `EQUAL_TO`, `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `NOT_EQUAL`. (Check the [API docs](https://docs.databricks.com/api/workspace/jobs/create) for the latest information).
3377
- *
3378
- * This task does not require a cluster to execute and does not support retries or notifications.
3236
+ * string specifying the operation used to evaluate the given metric. The only supported operation is `GREATER_THAN`.
3379
3237
  */
3380
3238
  op?: string;
3381
3239
  /**
@@ -3489,7 +3347,7 @@ export interface JobTaskForEachTaskTaskNewClusterClusterMountInfoNetworkFilesyst
3489
3347
  export interface JobTaskForEachTaskTaskNewClusterDockerImage {
3490
3348
  basicAuth?: outputs.JobTaskForEachTaskTaskNewClusterDockerImageBasicAuth;
3491
3349
  /**
3492
- * URL of the Git repository to use.
3350
+ * URL of the job on the given workspace
3493
3351
  */
3494
3352
  url: string;
3495
3353
  }
@@ -3508,9 +3366,6 @@ export interface JobTaskForEachTaskTaskNewClusterGcpAttributes {
3508
3366
  export interface JobTaskForEachTaskTaskNewClusterInitScript {
3509
3367
  abfss?: outputs.JobTaskForEachTaskTaskNewClusterInitScriptAbfss;
3510
3368
  dbfs?: outputs.JobTaskForEachTaskTaskNewClusterInitScriptDbfs;
3511
- /**
3512
- * block consisting of single string fields:
3513
- */
3514
3369
  file?: outputs.JobTaskForEachTaskTaskNewClusterInitScriptFile;
3515
3370
  gcs?: outputs.JobTaskForEachTaskTaskNewClusterInitScriptGcs;
3516
3371
  s3?: outputs.JobTaskForEachTaskTaskNewClusterInitScriptS3;
@@ -3704,9 +3559,6 @@ export interface JobTaskForEachTaskTaskSqlTaskAlert {
3704
3559
  }
3705
3560
  export interface JobTaskForEachTaskTaskSqlTaskAlertSubscription {
3706
3561
  destinationId?: string;
3707
- /**
3708
- * The email of an active workspace user. Non-admin users can only set this field to their own email.
3709
- */
3710
3562
  userName?: string;
3711
3563
  }
3712
3564
  export interface JobTaskForEachTaskTaskSqlTaskDashboard {
@@ -3729,9 +3581,6 @@ export interface JobTaskForEachTaskTaskSqlTaskDashboard {
3729
3581
  }
3730
3582
  export interface JobTaskForEachTaskTaskSqlTaskDashboardSubscription {
3731
3583
  destinationId?: string;
3732
- /**
3733
- * The email of an active workspace user. Non-admin users can only set this field to their own email.
3734
- */
3735
3584
  userName?: string;
3736
3585
  }
3737
3586
  export interface JobTaskForEachTaskTaskSqlTaskFile {
@@ -3740,7 +3589,6 @@ export interface JobTaskForEachTaskTaskSqlTaskFile {
3740
3589
  *
3741
3590
  * Example
3742
3591
  *
3743
- * <!--Start PulumiCodeChooser -->
3744
3592
  * ```typescript
3745
3593
  * import * as pulumi from "@pulumi/pulumi";
3746
3594
  * import * as databricks from "@pulumi/databricks";
@@ -3784,11 +3632,10 @@ export interface JobTaskForEachTaskTaskSqlTaskFile {
3784
3632
  * ],
3785
3633
  * });
3786
3634
  * ```
3787
- * <!--End PulumiCodeChooser -->
3788
3635
  */
3789
3636
  path: string;
3790
3637
  /**
3791
- * The source of the project. Possible values are `WORKSPACE` and `GIT`. Defaults to `GIT` if a `gitSource` block is present in the job definition.
3638
+ * The source of the project. Possible values are `WORKSPACE` and `GIT`.
3792
3639
  */
3793
3640
  source?: string;
3794
3641
  }
@@ -3819,33 +3666,25 @@ export interface JobTaskForEachTaskTaskWebhookNotifications {
3819
3666
  }
3820
3667
  export interface JobTaskForEachTaskTaskWebhookNotificationsOnDurationWarningThresholdExceeded {
3821
3668
  /**
3822
- * ID of the system notification that is notified when an event defined in `webhookNotifications` is triggered.
3823
- *
3824
- * > **Note** The following configuration blocks can be standalone or nested inside a `task` block
3669
+ * ID of the job
3825
3670
  */
3826
3671
  id: string;
3827
3672
  }
3828
3673
  export interface JobTaskForEachTaskTaskWebhookNotificationsOnFailure {
3829
3674
  /**
3830
- * ID of the system notification that is notified when an event defined in `webhookNotifications` is triggered.
3831
- *
3832
- * > **Note** The following configuration blocks can be standalone or nested inside a `task` block
3675
+ * ID of the job
3833
3676
  */
3834
3677
  id: string;
3835
3678
  }
3836
3679
  export interface JobTaskForEachTaskTaskWebhookNotificationsOnStart {
3837
3680
  /**
3838
- * ID of the system notification that is notified when an event defined in `webhookNotifications` is triggered.
3839
- *
3840
- * > **Note** The following configuration blocks can be standalone or nested inside a `task` block
3681
+ * ID of the job
3841
3682
  */
3842
3683
  id: string;
3843
3684
  }
3844
3685
  export interface JobTaskForEachTaskTaskWebhookNotificationsOnSuccess {
3845
3686
  /**
3846
- * ID of the system notification that is notified when an event defined in `webhookNotifications` is triggered.
3847
- *
3848
- * > **Note** The following configuration blocks can be standalone or nested inside a `task` block
3687
+ * ID of the job
3849
3688
  */
3850
3689
  id: string;
3851
3690
  }
@@ -3861,9 +3700,7 @@ export interface JobTaskHealthRule {
3861
3700
  */
3862
3701
  metric?: string;
3863
3702
  /**
3864
- * The string specifying the operation used to compare operands. Currently, following operators are supported: `EQUAL_TO`, `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `NOT_EQUAL`. (Check the [API docs](https://docs.databricks.com/api/workspace/jobs/create) for the latest information).
3865
- *
3866
- * This task does not require a cluster to execute and does not support retries or notifications.
3703
+ * string specifying the operation used to evaluate the given metric. The only supported operation is `GREATER_THAN`.
3867
3704
  */
3868
3705
  op?: string;
3869
3706
  /**
@@ -3977,7 +3814,7 @@ export interface JobTaskNewClusterClusterMountInfoNetworkFilesystemInfo {
3977
3814
  export interface JobTaskNewClusterDockerImage {
3978
3815
  basicAuth?: outputs.JobTaskNewClusterDockerImageBasicAuth;
3979
3816
  /**
3980
- * URL of the Git repository to use.
3817
+ * URL of the job on the given workspace
3981
3818
  */
3982
3819
  url: string;
3983
3820
  }
@@ -3999,9 +3836,6 @@ export interface JobTaskNewClusterInitScript {
3999
3836
  * @deprecated For init scripts use 'volumes', 'workspace' or cloud storage location instead of 'dbfs'.
4000
3837
  */
4001
3838
  dbfs?: outputs.JobTaskNewClusterInitScriptDbfs;
4002
- /**
4003
- * block consisting of single string fields:
4004
- */
4005
3839
  file?: outputs.JobTaskNewClusterInitScriptFile;
4006
3840
  gcs?: outputs.JobTaskNewClusterInitScriptGcs;
4007
3841
  s3?: outputs.JobTaskNewClusterInitScriptS3;
@@ -4195,9 +4029,6 @@ export interface JobTaskSqlTaskAlert {
4195
4029
  }
4196
4030
  export interface JobTaskSqlTaskAlertSubscription {
4197
4031
  destinationId?: string;
4198
- /**
4199
- * The email of an active workspace user. Non-admin users can only set this field to their own email.
4200
- */
4201
4032
  userName?: string;
4202
4033
  }
4203
4034
  export interface JobTaskSqlTaskDashboard {
@@ -4220,9 +4051,6 @@ export interface JobTaskSqlTaskDashboard {
4220
4051
  }
4221
4052
  export interface JobTaskSqlTaskDashboardSubscription {
4222
4053
  destinationId?: string;
4223
- /**
4224
- * The email of an active workspace user. Non-admin users can only set this field to their own email.
4225
- */
4226
4054
  userName?: string;
4227
4055
  }
4228
4056
  export interface JobTaskSqlTaskFile {
@@ -4231,7 +4059,6 @@ export interface JobTaskSqlTaskFile {
4231
4059
  *
4232
4060
  * Example
4233
4061
  *
4234
- * <!--Start PulumiCodeChooser -->
4235
4062
  * ```typescript
4236
4063
  * import * as pulumi from "@pulumi/pulumi";
4237
4064
  * import * as databricks from "@pulumi/databricks";
@@ -4275,11 +4102,10 @@ export interface JobTaskSqlTaskFile {
4275
4102
  * ],
4276
4103
  * });
4277
4104
  * ```
4278
- * <!--End PulumiCodeChooser -->
4279
4105
  */
4280
4106
  path: string;
4281
4107
  /**
4282
- * The source of the project. Possible values are `WORKSPACE` and `GIT`. Defaults to `GIT` if a `gitSource` block is present in the job definition.
4108
+ * The source of the project. Possible values are `WORKSPACE` and `GIT`.
4283
4109
  */
4284
4110
  source?: string;
4285
4111
  }
@@ -4310,33 +4136,25 @@ export interface JobTaskWebhookNotifications {
4310
4136
  }
4311
4137
  export interface JobTaskWebhookNotificationsOnDurationWarningThresholdExceeded {
4312
4138
  /**
4313
- * ID of the system notification that is notified when an event defined in `webhookNotifications` is triggered.
4314
- *
4315
- * > **Note** The following configuration blocks can be standalone or nested inside a `task` block
4139
+ * ID of the job
4316
4140
  */
4317
4141
  id: string;
4318
4142
  }
4319
4143
  export interface JobTaskWebhookNotificationsOnFailure {
4320
4144
  /**
4321
- * ID of the system notification that is notified when an event defined in `webhookNotifications` is triggered.
4322
- *
4323
- * > **Note** The following configuration blocks can be standalone or nested inside a `task` block
4145
+ * ID of the job
4324
4146
  */
4325
4147
  id: string;
4326
4148
  }
4327
4149
  export interface JobTaskWebhookNotificationsOnStart {
4328
4150
  /**
4329
- * ID of the system notification that is notified when an event defined in `webhookNotifications` is triggered.
4330
- *
4331
- * > **Note** The following configuration blocks can be standalone or nested inside a `task` block
4151
+ * ID of the job
4332
4152
  */
4333
4153
  id: string;
4334
4154
  }
4335
4155
  export interface JobTaskWebhookNotificationsOnSuccess {
4336
4156
  /**
4337
- * ID of the system notification that is notified when an event defined in `webhookNotifications` is triggered.
4338
- *
4339
- * > **Note** The following configuration blocks can be standalone or nested inside a `task` block
4157
+ * ID of the job
4340
4158
  */
4341
4159
  id: string;
4342
4160
  }
@@ -4360,7 +4178,7 @@ export interface JobTriggerFileArrival {
4360
4178
  */
4361
4179
  minTimeBetweenTriggersSeconds?: number;
4362
4180
  /**
4363
- * URL of the Git repository to use.
4181
+ * string with URL under the Unity Catalog external location that will be monitored for new files. Please note that have a trailing slash character (`/`).
4364
4182
  */
4365
4183
  url: string;
4366
4184
  /**
@@ -4410,33 +4228,25 @@ export interface JobWebhookNotifications {
4410
4228
  }
4411
4229
  export interface JobWebhookNotificationsOnDurationWarningThresholdExceeded {
4412
4230
  /**
4413
- * ID of the system notification that is notified when an event defined in `webhookNotifications` is triggered.
4414
- *
4415
- * > **Note** The following configuration blocks can be standalone or nested inside a `task` block
4231
+ * ID of the job
4416
4232
  */
4417
4233
  id: string;
4418
4234
  }
4419
4235
  export interface JobWebhookNotificationsOnFailure {
4420
4236
  /**
4421
- * ID of the system notification that is notified when an event defined in `webhookNotifications` is triggered.
4422
- *
4423
- * > **Note** The following configuration blocks can be standalone or nested inside a `task` block
4237
+ * ID of the job
4424
4238
  */
4425
4239
  id: string;
4426
4240
  }
4427
4241
  export interface JobWebhookNotificationsOnStart {
4428
4242
  /**
4429
- * ID of the system notification that is notified when an event defined in `webhookNotifications` is triggered.
4430
- *
4431
- * > **Note** The following configuration blocks can be standalone or nested inside a `task` block
4243
+ * ID of the job
4432
4244
  */
4433
4245
  id: string;
4434
4246
  }
4435
4247
  export interface JobWebhookNotificationsOnSuccess {
4436
4248
  /**
4437
- * ID of the system notification that is notified when an event defined in `webhookNotifications` is triggered.
4438
- *
4439
- * > **Note** The following configuration blocks can be standalone or nested inside a `task` block
4249
+ * ID of the job
4440
4250
  */
4441
4251
  id: string;
4442
4252
  }
@@ -4680,7 +4490,7 @@ export interface ModelServingConfigServedEntity {
4680
4490
  */
4681
4491
  minProvisionedThroughput?: number;
4682
4492
  /**
4683
- * The name of the external model.
4493
+ * The name of a served entity. It must be unique across an endpoint. A served entity name can consist of alphanumeric characters, dashes, and underscores. If not specified for an external model, this field defaults to `external_model.name`, with '.' and ':' replaced with '-', and if not specified for other entities, it defaults to -.
4684
4494
  */
4685
4495
  name: string;
4686
4496
  /**
@@ -4718,7 +4528,7 @@ export interface ModelServingConfigServedEntityExternalModel {
4718
4528
  */
4719
4529
  databricksModelServingConfig?: outputs.ModelServingConfigServedEntityExternalModelDatabricksModelServingConfig;
4720
4530
  /**
4721
- * The name of the model serving endpoint. This field is required and must be unique across a workspace. An endpoint name can consist of alphanumeric characters, dashes, and underscores. NOTE: Changing this name will delete the existing endpoint and create a new endpoint with the update name.
4531
+ * The name of the external model.
4722
4532
  */
4723
4533
  name: string;
4724
4534
  /**
@@ -4739,82 +4549,33 @@ export interface ModelServingConfigServedEntityExternalModel {
4739
4549
  task: string;
4740
4550
  }
4741
4551
  export interface ModelServingConfigServedEntityExternalModelAi21labsConfig {
4742
- /**
4743
- * The Databricks secret key reference for an AI21Labs API key.
4744
- */
4745
4552
  ai21labsApiKey: string;
4746
4553
  }
4747
4554
  export interface ModelServingConfigServedEntityExternalModelAmazonBedrockConfig {
4748
- /**
4749
- * The Databricks secret key reference for an AWS Access Key ID with permissions to interact with Bedrock services.
4750
- */
4751
4555
  awsAccessKeyId: string;
4752
- /**
4753
- * The AWS region to use. Bedrock has to be enabled there.
4754
- */
4755
4556
  awsRegion: string;
4756
- /**
4757
- * The Databricks secret key reference for an AWS Secret Access Key paired with the access key ID, with permissions to interact with Bedrock services.
4758
- */
4759
4557
  awsSecretAccessKey: string;
4760
- /**
4761
- * The underlying provider in Amazon Bedrock. Supported values (case insensitive) include: `Anthropic`, `Cohere`, `AI21Labs`, `Amazon`.
4762
- */
4763
4558
  bedrockProvider: string;
4764
4559
  }
4765
4560
  export interface ModelServingConfigServedEntityExternalModelAnthropicConfig {
4766
- /**
4767
- * The Databricks secret key reference for an Anthropic API key.
4768
- * The Databricks secret key reference for an Anthropic API key.
4769
- */
4770
4561
  anthropicApiKey: string;
4771
4562
  }
4772
4563
  export interface ModelServingConfigServedEntityExternalModelCohereConfig {
4773
- /**
4774
- * The Databricks secret key reference for a Cohere API key.
4775
- */
4776
4564
  cohereApiKey: string;
4777
4565
  }
4778
4566
  export interface ModelServingConfigServedEntityExternalModelDatabricksModelServingConfig {
4779
- /**
4780
- * The Databricks secret key reference for a Databricks API token that corresponds to a user or service principal with Can Query access to the model serving endpoint pointed to by this external model.
4781
- */
4782
4567
  databricksApiToken: string;
4783
- /**
4784
- * The URL of the Databricks workspace containing the model serving endpoint pointed to by this external model.
4785
- */
4786
4568
  databricksWorkspaceUrl: string;
4787
4569
  }
4788
4570
  export interface ModelServingConfigServedEntityExternalModelOpenaiConfig {
4789
- /**
4790
- * This is the base URL for the OpenAI API (default: "https://api.openai.com/v1"). For Azure OpenAI, this field is required, and is the base URL for the Azure OpenAI API service provided by Azure.
4791
- */
4792
4571
  openaiApiBase?: string;
4793
- /**
4794
- * The Databricks secret key reference for an OpenAI or Azure OpenAI API key.
4795
- */
4796
4572
  openaiApiKey: string;
4797
- /**
4798
- * This is an optional field to specify the type of OpenAI API to use. For Azure OpenAI, this field is required, and adjust this parameter to represent the preferred security access validation protocol. For access token validation, use azure. For authentication using Azure Active Directory (Azure AD) use, azuread.
4799
- */
4800
4573
  openaiApiType?: string;
4801
- /**
4802
- * This is an optional field to specify the OpenAI API version. For Azure OpenAI, this field is required, and is the version of the Azure OpenAI service to utilize, specified by a date.
4803
- */
4804
4574
  openaiApiVersion?: string;
4805
- /**
4806
- * This field is only required for Azure OpenAI and is the name of the deployment resource for the Azure OpenAI service.
4807
- */
4808
4575
  openaiDeploymentName?: string;
4809
- /**
4810
- * This is an optional field to specify the organization in OpenAI or Azure OpenAI.
4811
- */
4812
4576
  openaiOrganization?: string;
4813
4577
  }
4814
4578
  export interface ModelServingConfigServedEntityExternalModelPalmConfig {
4815
- /**
4816
- * The Databricks secret key reference for a PaLM API key.
4817
- */
4818
4579
  palmApiKey: string;
4819
4580
  }
4820
4581
  export interface ModelServingConfigServedModel {
@@ -5008,9 +4769,6 @@ export interface MwsWorkspacesCloudResourceContainer {
5008
4769
  gcp: outputs.MwsWorkspacesCloudResourceContainerGcp;
5009
4770
  }
5010
4771
  export interface MwsWorkspacesCloudResourceContainerGcp {
5011
- /**
5012
- * The Google Cloud project ID, which the workspace uses to instantiate cloud resources for your workspace.
5013
- */
5014
4772
  projectId: string;
5015
4773
  }
5016
4774
  export interface MwsWorkspacesExternalCustomerInfo {
@@ -5129,23 +4887,9 @@ export interface OnlineTableStatusTriggeredUpdateStatusTriggeredUpdateProgress {
5129
4887
  totalRowCount?: number;
5130
4888
  }
5131
4889
  export interface PermissionsAccessControl {
5132
- /**
5133
- * name of the group. We recommend setting permissions on groups.
5134
- */
5135
4890
  groupName?: string;
5136
- /**
5137
- * permission level according to specific resource. See examples above for the reference.
5138
- *
5139
- * Exactly one of the below arguments is required:
5140
- */
5141
4891
  permissionLevel: string;
5142
- /**
5143
- * Application ID of the service_principal.
5144
- */
5145
4892
  servicePrincipalName?: string;
5146
- /**
5147
- * name of the user.
5148
- */
5149
4893
  userName?: string;
5150
4894
  }
5151
4895
  export interface PipelineCluster {
@@ -5297,9 +5041,6 @@ export interface PipelineNotification {
5297
5041
  emailRecipients: string[];
5298
5042
  }
5299
5043
  export interface RecipientIpAccessList {
5300
- /**
5301
- * Allowed IP Addresses in CIDR notation. Limit of 100.
5302
- */
5303
5044
  allowedIpAddresses?: string[];
5304
5045
  }
5305
5046
  export interface RecipientPropertiesKvpairs {
@@ -5398,9 +5139,6 @@ export interface ShareObject {
5398
5139
  status: string;
5399
5140
  }
5400
5141
  export interface ShareObjectPartition {
5401
- /**
5402
- * The value of the partition column. When this value is not set, it means null value. When this field is set, field `recipientPropertyKey` can not be set.
5403
- */
5404
5142
  values: outputs.ShareObjectPartitionValue[];
5405
5143
  }
5406
5144
  export interface ShareObjectPartitionValue {
@@ -5493,6 +5231,8 @@ export interface SqlPermissionsPrivilegeAssignment {
5493
5231
  /**
5494
5232
  * set of available privilege names in upper case.
5495
5233
  *
5234
+ *
5235
+ * [Available](https://docs.databricks.com/security/access-control/table-acls/object-privileges.html) privilege names are:
5496
5236
  * [Available](https://docs.databricks.com/security/access-control/table-acls/object-privileges.html) privilege names are:
5497
5237
  */
5498
5238
  privileges: string[];
@@ -5524,16 +5264,10 @@ export interface SqlQueryParameter {
5524
5264
  title?: string;
5525
5265
  }
5526
5266
  export interface SqlQueryParameterDate {
5527
- /**
5528
- * The default value for this parameter.
5529
- */
5530
5267
  value: string;
5531
5268
  }
5532
5269
  export interface SqlQueryParameterDateRange {
5533
5270
  range?: outputs.SqlQueryParameterDateRangeRange;
5534
- /**
5535
- * The default value for this parameter.
5536
- */
5537
5271
  value?: string;
5538
5272
  }
5539
5273
  export interface SqlQueryParameterDateRangeRange {
@@ -5541,16 +5275,10 @@ export interface SqlQueryParameterDateRangeRange {
5541
5275
  start: string;
5542
5276
  }
5543
5277
  export interface SqlQueryParameterDatetime {
5544
- /**
5545
- * The default value for this parameter.
5546
- */
5547
5278
  value: string;
5548
5279
  }
5549
5280
  export interface SqlQueryParameterDatetimeRange {
5550
5281
  range?: outputs.SqlQueryParameterDatetimeRangeRange;
5551
- /**
5552
- * The default value for this parameter.
5553
- */
5554
5282
  value?: string;
5555
5283
  }
5556
5284
  export interface SqlQueryParameterDatetimeRangeRange {
@@ -5558,16 +5286,10 @@ export interface SqlQueryParameterDatetimeRangeRange {
5558
5286
  start: string;
5559
5287
  }
5560
5288
  export interface SqlQueryParameterDatetimesec {
5561
- /**
5562
- * The default value for this parameter.
5563
- */
5564
5289
  value: string;
5565
5290
  }
5566
5291
  export interface SqlQueryParameterDatetimesecRange {
5567
5292
  range?: outputs.SqlQueryParameterDatetimesecRangeRange;
5568
- /**
5569
- * The default value for this parameter.
5570
- */
5571
5293
  value?: string;
5572
5294
  }
5573
5295
  export interface SqlQueryParameterDatetimesecRangeRange {
@@ -5577,9 +5299,6 @@ export interface SqlQueryParameterDatetimesecRangeRange {
5577
5299
  export interface SqlQueryParameterEnum {
5578
5300
  multiple?: outputs.SqlQueryParameterEnumMultiple;
5579
5301
  options: string[];
5580
- /**
5581
- * The default value for this parameter.
5582
- */
5583
5302
  value?: string;
5584
5303
  values?: string[];
5585
5304
  }
@@ -5589,17 +5308,11 @@ export interface SqlQueryParameterEnumMultiple {
5589
5308
  suffix?: string;
5590
5309
  }
5591
5310
  export interface SqlQueryParameterNumber {
5592
- /**
5593
- * The default value for this parameter.
5594
- */
5595
5311
  value: number;
5596
5312
  }
5597
5313
  export interface SqlQueryParameterQuery {
5598
5314
  multiple?: outputs.SqlQueryParameterQueryMultiple;
5599
5315
  queryId: string;
5600
- /**
5601
- * The default value for this parameter.
5602
- */
5603
5316
  value?: string;
5604
5317
  values?: string[];
5605
5318
  }
@@ -5609,9 +5322,6 @@ export interface SqlQueryParameterQueryMultiple {
5609
5322
  suffix?: string;
5610
5323
  }
5611
5324
  export interface SqlQueryParameterText {
5612
- /**
5613
- * The default value for this parameter.
5614
- */
5615
5325
  value: string;
5616
5326
  }
5617
5327
  export interface SqlQuerySchedule {
@@ -5751,17 +5461,11 @@ export interface VectorSearchIndexDeltaSyncIndexSpec {
5751
5461
  * array of objects representing columns that contain the embedding source. Each entry consists of:
5752
5462
  */
5753
5463
  embeddingSourceColumns?: outputs.VectorSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn[];
5754
- /**
5755
- * array of objects representing columns that contain the embedding vectors. Each entry consists of:
5756
- */
5757
5464
  embeddingVectorColumns?: outputs.VectorSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn[];
5758
5465
  /**
5759
5466
  * ID of the associated Delta Live Table pipeline.
5760
5467
  */
5761
5468
  pipelineId: string;
5762
- /**
5763
- * Pipeline execution mode. Possible values are:
5764
- */
5765
5469
  pipelineType?: string;
5766
5470
  /**
5767
5471
  * The name of the source table.
@@ -5793,9 +5497,6 @@ export interface VectorSearchIndexDirectAccessIndexSpec {
5793
5497
  * array of objects representing columns that contain the embedding source. Each entry consists of:
5794
5498
  */
5795
5499
  embeddingSourceColumns?: outputs.VectorSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn[];
5796
- /**
5797
- * array of objects representing columns that contain the embedding vectors. Each entry consists of:
5798
- */
5799
5500
  embeddingVectorColumns?: outputs.VectorSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn[];
5800
5501
  /**
5801
5502
  * The schema of the index in JSON format. Check the [API documentation](https://docs.databricks.com/api/workspace/vectorsearchindexes/createindex#direct_access_index_spec-schema_json) for a list of supported data types.