databricks-sdk 0.55.0__py3-none-any.whl → 0.57.0__py3-none-any.whl
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.
Potentially problematic release.
This version of databricks-sdk might be problematic. Click here for more details.
- databricks/sdk/__init__.py +41 -24
- databricks/sdk/service/aibuilder.py +505 -0
- databricks/sdk/service/apps.py +14 -42
- databricks/sdk/service/billing.py +167 -220
- databricks/sdk/service/catalog.py +462 -1235
- databricks/sdk/service/cleanrooms.py +26 -43
- databricks/sdk/service/compute.py +75 -211
- databricks/sdk/service/dashboards.py +77 -511
- databricks/sdk/service/database.py +1271 -0
- databricks/sdk/service/files.py +20 -54
- databricks/sdk/service/iam.py +61 -171
- databricks/sdk/service/jobs.py +453 -68
- databricks/sdk/service/marketplace.py +46 -146
- databricks/sdk/service/ml.py +453 -477
- databricks/sdk/service/oauth2.py +17 -45
- databricks/sdk/service/pipelines.py +125 -40
- databricks/sdk/service/provisioning.py +30 -93
- databricks/sdk/service/qualitymonitorv2.py +265 -0
- databricks/sdk/service/serving.py +106 -46
- databricks/sdk/service/settings.py +1062 -390
- databricks/sdk/service/sharing.py +33 -88
- databricks/sdk/service/sql.py +292 -185
- databricks/sdk/service/vectorsearch.py +13 -43
- databricks/sdk/service/workspace.py +35 -105
- databricks/sdk/version.py +1 -1
- {databricks_sdk-0.55.0.dist-info → databricks_sdk-0.57.0.dist-info}/METADATA +1 -1
- {databricks_sdk-0.55.0.dist-info → databricks_sdk-0.57.0.dist-info}/RECORD +31 -28
- {databricks_sdk-0.55.0.dist-info → databricks_sdk-0.57.0.dist-info}/WHEEL +0 -0
- {databricks_sdk-0.55.0.dist-info → databricks_sdk-0.57.0.dist-info}/licenses/LICENSE +0 -0
- {databricks_sdk-0.55.0.dist-info → databricks_sdk-0.57.0.dist-info}/licenses/NOTICE +0 -0
- {databricks_sdk-0.55.0.dist-info → databricks_sdk-0.57.0.dist-info}/top_level.txt +0 -0
databricks/sdk/service/iam.py
CHANGED
|
@@ -2163,9 +2163,7 @@ class AccountAccessControlAPI:
|
|
|
2163
2163
|
self._api = api_client
|
|
2164
2164
|
|
|
2165
2165
|
def get_assignable_roles_for_resource(self, resource: str) -> GetAssignableRolesForResourceResponse:
|
|
2166
|
-
"""
|
|
2167
|
-
|
|
2168
|
-
Gets all the roles that can be granted on an account level resource. A role is grantable if the rule
|
|
2166
|
+
"""Gets all the roles that can be granted on an account level resource. A role is grantable if the rule
|
|
2169
2167
|
set on the resource can contain an access rule of the role.
|
|
2170
2168
|
|
|
2171
2169
|
:param resource: str
|
|
@@ -2195,9 +2193,7 @@ class AccountAccessControlAPI:
|
|
|
2195
2193
|
return GetAssignableRolesForResourceResponse.from_dict(res)
|
|
2196
2194
|
|
|
2197
2195
|
def get_rule_set(self, name: str, etag: str) -> RuleSetResponse:
|
|
2198
|
-
"""Get a rule set.
|
|
2199
|
-
|
|
2200
|
-
Get a rule set by its name. A rule set is always attached to a resource and contains a list of access
|
|
2196
|
+
"""Get a rule set by its name. A rule set is always attached to a resource and contains a list of access
|
|
2201
2197
|
rules on the said resource. Currently only a default rule set for each resource is supported.
|
|
2202
2198
|
|
|
2203
2199
|
:param name: str
|
|
@@ -2241,9 +2237,7 @@ class AccountAccessControlAPI:
|
|
|
2241
2237
|
return RuleSetResponse.from_dict(res)
|
|
2242
2238
|
|
|
2243
2239
|
def update_rule_set(self, name: str, rule_set: RuleSetUpdateRequest) -> RuleSetResponse:
|
|
2244
|
-
"""
|
|
2245
|
-
|
|
2246
|
-
Replace the rules of a rule set. First, use get to read the current version of the rule set before
|
|
2240
|
+
"""Replace the rules of a rule set. First, use get to read the current version of the rule set before
|
|
2247
2241
|
modifying it. This pattern helps prevent conflicts between concurrent updates.
|
|
2248
2242
|
|
|
2249
2243
|
:param name: str
|
|
@@ -2280,9 +2274,7 @@ class AccountAccessControlProxyAPI:
|
|
|
2280
2274
|
self._api = api_client
|
|
2281
2275
|
|
|
2282
2276
|
def get_assignable_roles_for_resource(self, resource: str) -> GetAssignableRolesForResourceResponse:
|
|
2283
|
-
"""
|
|
2284
|
-
|
|
2285
|
-
Gets all the roles that can be granted on an account level resource. A role is grantable if the rule
|
|
2277
|
+
"""Gets all the roles that can be granted on an account level resource. A role is grantable if the rule
|
|
2286
2278
|
set on the resource can contain an access rule of the role.
|
|
2287
2279
|
|
|
2288
2280
|
:param resource: str
|
|
@@ -2309,9 +2301,7 @@ class AccountAccessControlProxyAPI:
|
|
|
2309
2301
|
return GetAssignableRolesForResourceResponse.from_dict(res)
|
|
2310
2302
|
|
|
2311
2303
|
def get_rule_set(self, name: str, etag: str) -> RuleSetResponse:
|
|
2312
|
-
"""Get a rule set.
|
|
2313
|
-
|
|
2314
|
-
Get a rule set by its name. A rule set is always attached to a resource and contains a list of access
|
|
2304
|
+
"""Get a rule set by its name. A rule set is always attached to a resource and contains a list of access
|
|
2315
2305
|
rules on the said resource. Currently only a default rule set for each resource is supported.
|
|
2316
2306
|
|
|
2317
2307
|
:param name: str
|
|
@@ -2350,9 +2340,7 @@ class AccountAccessControlProxyAPI:
|
|
|
2350
2340
|
return RuleSetResponse.from_dict(res)
|
|
2351
2341
|
|
|
2352
2342
|
def update_rule_set(self, name: str, rule_set: RuleSetUpdateRequest) -> RuleSetResponse:
|
|
2353
|
-
"""
|
|
2354
|
-
|
|
2355
|
-
Replace the rules of a rule set. First, use get to read the current version of the rule set before
|
|
2343
|
+
"""Replace the rules of a rule set. First, use get to read the current version of the rule set before
|
|
2356
2344
|
modifying it. This pattern helps prevent conflicts between concurrent updates.
|
|
2357
2345
|
|
|
2358
2346
|
:param name: str
|
|
@@ -2399,9 +2387,7 @@ class AccountGroupsAPI:
|
|
|
2399
2387
|
roles: Optional[List[ComplexValue]] = None,
|
|
2400
2388
|
schemas: Optional[List[GroupSchema]] = None,
|
|
2401
2389
|
) -> Group:
|
|
2402
|
-
"""
|
|
2403
|
-
|
|
2404
|
-
Creates a group in the Databricks account with a unique name, using the supplied group details.
|
|
2390
|
+
"""Creates a group in the Databricks account with a unique name, using the supplied group details.
|
|
2405
2391
|
|
|
2406
2392
|
:param display_name: str (optional)
|
|
2407
2393
|
String that represents a human-readable group name
|
|
@@ -2454,9 +2440,7 @@ class AccountGroupsAPI:
|
|
|
2454
2440
|
return Group.from_dict(res)
|
|
2455
2441
|
|
|
2456
2442
|
def delete(self, id: str):
|
|
2457
|
-
"""
|
|
2458
|
-
|
|
2459
|
-
Deletes a group from the Databricks account.
|
|
2443
|
+
"""Deletes a group from the Databricks account.
|
|
2460
2444
|
|
|
2461
2445
|
:param id: str
|
|
2462
2446
|
Unique ID for a group in the Databricks account.
|
|
@@ -2469,9 +2453,7 @@ class AccountGroupsAPI:
|
|
|
2469
2453
|
self._api.do("DELETE", f"/api/2.0/accounts/{self._api.account_id}/scim/v2/Groups/{id}", headers=headers)
|
|
2470
2454
|
|
|
2471
2455
|
def get(self, id: str) -> Group:
|
|
2472
|
-
"""
|
|
2473
|
-
|
|
2474
|
-
Gets the information for a specific group in the Databricks account.
|
|
2456
|
+
"""Gets the information for a specific group in the Databricks account.
|
|
2475
2457
|
|
|
2476
2458
|
:param id: str
|
|
2477
2459
|
Unique ID for a group in the Databricks account.
|
|
@@ -2497,9 +2479,7 @@ class AccountGroupsAPI:
|
|
|
2497
2479
|
sort_order: Optional[ListSortOrder] = None,
|
|
2498
2480
|
start_index: Optional[int] = None,
|
|
2499
2481
|
) -> Iterator[Group]:
|
|
2500
|
-
"""
|
|
2501
|
-
|
|
2502
|
-
Gets all details of the groups associated with the Databricks account.
|
|
2482
|
+
"""Gets all details of the groups associated with the Databricks account.
|
|
2503
2483
|
|
|
2504
2484
|
:param attributes: str (optional)
|
|
2505
2485
|
Comma-separated list of attributes to return in response.
|
|
@@ -2547,7 +2527,7 @@ class AccountGroupsAPI:
|
|
|
2547
2527
|
seen = set()
|
|
2548
2528
|
query["startIndex"] = 1
|
|
2549
2529
|
if "count" not in query:
|
|
2550
|
-
query["count"] =
|
|
2530
|
+
query["count"] = 10000
|
|
2551
2531
|
while True:
|
|
2552
2532
|
json = self._api.do(
|
|
2553
2533
|
"GET", f"/api/2.0/accounts/{self._api.account_id}/scim/v2/Groups", query=query, headers=headers
|
|
@@ -2564,9 +2544,7 @@ class AccountGroupsAPI:
|
|
|
2564
2544
|
query["startIndex"] += len(json["Resources"])
|
|
2565
2545
|
|
|
2566
2546
|
def patch(self, id: str, *, operations: Optional[List[Patch]] = None, schemas: Optional[List[PatchSchema]] = None):
|
|
2567
|
-
"""
|
|
2568
|
-
|
|
2569
|
-
Partially updates the details of a group.
|
|
2547
|
+
"""Partially updates the details of a group.
|
|
2570
2548
|
|
|
2571
2549
|
:param id: str
|
|
2572
2550
|
Unique ID in the Databricks workspace.
|
|
@@ -2602,9 +2580,7 @@ class AccountGroupsAPI:
|
|
|
2602
2580
|
roles: Optional[List[ComplexValue]] = None,
|
|
2603
2581
|
schemas: Optional[List[GroupSchema]] = None,
|
|
2604
2582
|
):
|
|
2605
|
-
"""
|
|
2606
|
-
|
|
2607
|
-
Updates the details of a group by replacing the entire group entity.
|
|
2583
|
+
"""Updates the details of a group by replacing the entire group entity.
|
|
2608
2584
|
|
|
2609
2585
|
:param id: str
|
|
2610
2586
|
Databricks group ID
|
|
@@ -2674,9 +2650,7 @@ class AccountServicePrincipalsAPI:
|
|
|
2674
2650
|
roles: Optional[List[ComplexValue]] = None,
|
|
2675
2651
|
schemas: Optional[List[ServicePrincipalSchema]] = None,
|
|
2676
2652
|
) -> ServicePrincipal:
|
|
2677
|
-
"""
|
|
2678
|
-
|
|
2679
|
-
Creates a new service principal in the Databricks account.
|
|
2653
|
+
"""Creates a new service principal in the Databricks account.
|
|
2680
2654
|
|
|
2681
2655
|
:param active: bool (optional)
|
|
2682
2656
|
If this user is active
|
|
@@ -2730,9 +2704,7 @@ class AccountServicePrincipalsAPI:
|
|
|
2730
2704
|
return ServicePrincipal.from_dict(res)
|
|
2731
2705
|
|
|
2732
2706
|
def delete(self, id: str):
|
|
2733
|
-
"""Delete a service principal.
|
|
2734
|
-
|
|
2735
|
-
Delete a single service principal in the Databricks account.
|
|
2707
|
+
"""Delete a single service principal in the Databricks account.
|
|
2736
2708
|
|
|
2737
2709
|
:param id: str
|
|
2738
2710
|
Unique ID for a service principal in the Databricks account.
|
|
@@ -2747,9 +2719,7 @@ class AccountServicePrincipalsAPI:
|
|
|
2747
2719
|
)
|
|
2748
2720
|
|
|
2749
2721
|
def get(self, id: str) -> ServicePrincipal:
|
|
2750
|
-
"""
|
|
2751
|
-
|
|
2752
|
-
Gets the details for a single service principal define in the Databricks account.
|
|
2722
|
+
"""Gets the details for a single service principal define in the Databricks account.
|
|
2753
2723
|
|
|
2754
2724
|
:param id: str
|
|
2755
2725
|
Unique ID for a service principal in the Databricks account.
|
|
@@ -2777,9 +2747,7 @@ class AccountServicePrincipalsAPI:
|
|
|
2777
2747
|
sort_order: Optional[ListSortOrder] = None,
|
|
2778
2748
|
start_index: Optional[int] = None,
|
|
2779
2749
|
) -> Iterator[ServicePrincipal]:
|
|
2780
|
-
"""
|
|
2781
|
-
|
|
2782
|
-
Gets the set of service principals associated with a Databricks account.
|
|
2750
|
+
"""Gets the set of service principals associated with a Databricks account.
|
|
2783
2751
|
|
|
2784
2752
|
:param attributes: str (optional)
|
|
2785
2753
|
Comma-separated list of attributes to return in response.
|
|
@@ -2827,7 +2795,7 @@ class AccountServicePrincipalsAPI:
|
|
|
2827
2795
|
seen = set()
|
|
2828
2796
|
query["startIndex"] = 1
|
|
2829
2797
|
if "count" not in query:
|
|
2830
|
-
query["count"] =
|
|
2798
|
+
query["count"] = 10000
|
|
2831
2799
|
while True:
|
|
2832
2800
|
json = self._api.do(
|
|
2833
2801
|
"GET",
|
|
@@ -2847,9 +2815,7 @@ class AccountServicePrincipalsAPI:
|
|
|
2847
2815
|
query["startIndex"] += len(json["Resources"])
|
|
2848
2816
|
|
|
2849
2817
|
def patch(self, id: str, *, operations: Optional[List[Patch]] = None, schemas: Optional[List[PatchSchema]] = None):
|
|
2850
|
-
"""
|
|
2851
|
-
|
|
2852
|
-
Partially updates the details of a single service principal in the Databricks account.
|
|
2818
|
+
"""Partially updates the details of a single service principal in the Databricks account.
|
|
2853
2819
|
|
|
2854
2820
|
:param id: str
|
|
2855
2821
|
Unique ID in the Databricks workspace.
|
|
@@ -2888,9 +2854,7 @@ class AccountServicePrincipalsAPI:
|
|
|
2888
2854
|
roles: Optional[List[ComplexValue]] = None,
|
|
2889
2855
|
schemas: Optional[List[ServicePrincipalSchema]] = None,
|
|
2890
2856
|
):
|
|
2891
|
-
"""
|
|
2892
|
-
|
|
2893
|
-
Updates the details of a single service principal.
|
|
2857
|
+
"""Updates the details of a single service principal.
|
|
2894
2858
|
|
|
2895
2859
|
This action replaces the existing service principal with the same name.
|
|
2896
2860
|
|
|
@@ -2974,9 +2938,7 @@ class AccountUsersAPI:
|
|
|
2974
2938
|
schemas: Optional[List[UserSchema]] = None,
|
|
2975
2939
|
user_name: Optional[str] = None,
|
|
2976
2940
|
) -> User:
|
|
2977
|
-
"""
|
|
2978
|
-
|
|
2979
|
-
Creates a new user in the Databricks account. This new user will also be added to the Databricks
|
|
2941
|
+
"""Creates a new user in the Databricks account. This new user will also be added to the Databricks
|
|
2980
2942
|
account.
|
|
2981
2943
|
|
|
2982
2944
|
:param active: bool (optional)
|
|
@@ -3042,9 +3004,7 @@ class AccountUsersAPI:
|
|
|
3042
3004
|
return User.from_dict(res)
|
|
3043
3005
|
|
|
3044
3006
|
def delete(self, id: str):
|
|
3045
|
-
"""
|
|
3046
|
-
|
|
3047
|
-
Deletes a user. Deleting a user from a Databricks account also removes objects associated with the
|
|
3007
|
+
"""Deletes a user. Deleting a user from a Databricks account also removes objects associated with the
|
|
3048
3008
|
user.
|
|
3049
3009
|
|
|
3050
3010
|
:param id: str
|
|
@@ -3069,9 +3029,7 @@ class AccountUsersAPI:
|
|
|
3069
3029
|
sort_order: Optional[GetSortOrder] = None,
|
|
3070
3030
|
start_index: Optional[int] = None,
|
|
3071
3031
|
) -> User:
|
|
3072
|
-
"""
|
|
3073
|
-
|
|
3074
|
-
Gets information for a specific user in Databricks account.
|
|
3032
|
+
"""Gets information for a specific user in Databricks account.
|
|
3075
3033
|
|
|
3076
3034
|
:param id: str
|
|
3077
3035
|
Unique ID for a user in the Databricks account.
|
|
@@ -3134,9 +3092,7 @@ class AccountUsersAPI:
|
|
|
3134
3092
|
sort_order: Optional[ListSortOrder] = None,
|
|
3135
3093
|
start_index: Optional[int] = None,
|
|
3136
3094
|
) -> Iterator[User]:
|
|
3137
|
-
"""
|
|
3138
|
-
|
|
3139
|
-
Gets details for all the users associated with a Databricks account.
|
|
3095
|
+
"""Gets details for all the users associated with a Databricks account.
|
|
3140
3096
|
|
|
3141
3097
|
:param attributes: str (optional)
|
|
3142
3098
|
Comma-separated list of attributes to return in response.
|
|
@@ -3185,7 +3141,7 @@ class AccountUsersAPI:
|
|
|
3185
3141
|
seen = set()
|
|
3186
3142
|
query["startIndex"] = 1
|
|
3187
3143
|
if "count" not in query:
|
|
3188
|
-
query["count"] =
|
|
3144
|
+
query["count"] = 10000
|
|
3189
3145
|
while True:
|
|
3190
3146
|
json = self._api.do(
|
|
3191
3147
|
"GET", f"/api/2.0/accounts/{self._api.account_id}/scim/v2/Users", query=query, headers=headers
|
|
@@ -3202,9 +3158,7 @@ class AccountUsersAPI:
|
|
|
3202
3158
|
query["startIndex"] += len(json["Resources"])
|
|
3203
3159
|
|
|
3204
3160
|
def patch(self, id: str, *, operations: Optional[List[Patch]] = None, schemas: Optional[List[PatchSchema]] = None):
|
|
3205
|
-
"""
|
|
3206
|
-
|
|
3207
|
-
Partially updates a user resource by applying the supplied operations on specific user attributes.
|
|
3161
|
+
"""Partially updates a user resource by applying the supplied operations on specific user attributes.
|
|
3208
3162
|
|
|
3209
3163
|
:param id: str
|
|
3210
3164
|
Unique ID in the Databricks workspace.
|
|
@@ -3242,9 +3196,7 @@ class AccountUsersAPI:
|
|
|
3242
3196
|
schemas: Optional[List[UserSchema]] = None,
|
|
3243
3197
|
user_name: Optional[str] = None,
|
|
3244
3198
|
):
|
|
3245
|
-
"""
|
|
3246
|
-
|
|
3247
|
-
Replaces a user's information with the data supplied in request.
|
|
3199
|
+
"""Replaces a user's information with the data supplied in request.
|
|
3248
3200
|
|
|
3249
3201
|
:param id: str
|
|
3250
3202
|
Databricks user ID.
|
|
@@ -3310,9 +3262,7 @@ class CurrentUserAPI:
|
|
|
3310
3262
|
self._api = api_client
|
|
3311
3263
|
|
|
3312
3264
|
def me(self) -> User:
|
|
3313
|
-
"""Get current
|
|
3314
|
-
|
|
3315
|
-
Get details about the current method caller's identity.
|
|
3265
|
+
"""Get details about the current method caller's identity.
|
|
3316
3266
|
|
|
3317
3267
|
:returns: :class:`User`
|
|
3318
3268
|
"""
|
|
@@ -3349,9 +3299,7 @@ class GroupsAPI:
|
|
|
3349
3299
|
roles: Optional[List[ComplexValue]] = None,
|
|
3350
3300
|
schemas: Optional[List[GroupSchema]] = None,
|
|
3351
3301
|
) -> Group:
|
|
3352
|
-
"""
|
|
3353
|
-
|
|
3354
|
-
Creates a group in the Databricks workspace with a unique name, using the supplied group details.
|
|
3302
|
+
"""Creates a group in the Databricks workspace with a unique name, using the supplied group details.
|
|
3355
3303
|
|
|
3356
3304
|
:param display_name: str (optional)
|
|
3357
3305
|
String that represents a human-readable group name
|
|
@@ -3402,9 +3350,7 @@ class GroupsAPI:
|
|
|
3402
3350
|
return Group.from_dict(res)
|
|
3403
3351
|
|
|
3404
3352
|
def delete(self, id: str):
|
|
3405
|
-
"""
|
|
3406
|
-
|
|
3407
|
-
Deletes a group from the Databricks workspace.
|
|
3353
|
+
"""Deletes a group from the Databricks workspace.
|
|
3408
3354
|
|
|
3409
3355
|
:param id: str
|
|
3410
3356
|
Unique ID for a group in the Databricks workspace.
|
|
@@ -3417,9 +3363,7 @@ class GroupsAPI:
|
|
|
3417
3363
|
self._api.do("DELETE", f"/api/2.0/preview/scim/v2/Groups/{id}", headers=headers)
|
|
3418
3364
|
|
|
3419
3365
|
def get(self, id: str) -> Group:
|
|
3420
|
-
"""
|
|
3421
|
-
|
|
3422
|
-
Gets the information for a specific group in the Databricks workspace.
|
|
3366
|
+
"""Gets the information for a specific group in the Databricks workspace.
|
|
3423
3367
|
|
|
3424
3368
|
:param id: str
|
|
3425
3369
|
Unique ID for a group in the Databricks workspace.
|
|
@@ -3445,9 +3389,7 @@ class GroupsAPI:
|
|
|
3445
3389
|
sort_order: Optional[ListSortOrder] = None,
|
|
3446
3390
|
start_index: Optional[int] = None,
|
|
3447
3391
|
) -> Iterator[Group]:
|
|
3448
|
-
"""
|
|
3449
|
-
|
|
3450
|
-
Gets all details of the groups associated with the Databricks workspace.
|
|
3392
|
+
"""Gets all details of the groups associated with the Databricks workspace.
|
|
3451
3393
|
|
|
3452
3394
|
:param attributes: str (optional)
|
|
3453
3395
|
Comma-separated list of attributes to return in response.
|
|
@@ -3495,7 +3437,7 @@ class GroupsAPI:
|
|
|
3495
3437
|
seen = set()
|
|
3496
3438
|
query["startIndex"] = 1
|
|
3497
3439
|
if "count" not in query:
|
|
3498
|
-
query["count"] =
|
|
3440
|
+
query["count"] = 10000
|
|
3499
3441
|
while True:
|
|
3500
3442
|
json = self._api.do("GET", "/api/2.0/preview/scim/v2/Groups", query=query, headers=headers)
|
|
3501
3443
|
if "Resources" in json:
|
|
@@ -3510,9 +3452,7 @@ class GroupsAPI:
|
|
|
3510
3452
|
query["startIndex"] += len(json["Resources"])
|
|
3511
3453
|
|
|
3512
3454
|
def patch(self, id: str, *, operations: Optional[List[Patch]] = None, schemas: Optional[List[PatchSchema]] = None):
|
|
3513
|
-
"""
|
|
3514
|
-
|
|
3515
|
-
Partially updates the details of a group.
|
|
3455
|
+
"""Partially updates the details of a group.
|
|
3516
3456
|
|
|
3517
3457
|
:param id: str
|
|
3518
3458
|
Unique ID in the Databricks workspace.
|
|
@@ -3546,9 +3486,7 @@ class GroupsAPI:
|
|
|
3546
3486
|
roles: Optional[List[ComplexValue]] = None,
|
|
3547
3487
|
schemas: Optional[List[GroupSchema]] = None,
|
|
3548
3488
|
):
|
|
3549
|
-
"""
|
|
3550
|
-
|
|
3551
|
-
Updates the details of a group by replacing the entire group entity.
|
|
3489
|
+
"""Updates the details of a group by replacing the entire group entity.
|
|
3552
3490
|
|
|
3553
3491
|
:param id: str
|
|
3554
3492
|
Databricks group ID
|
|
@@ -3668,9 +3606,7 @@ class PermissionsAPI:
|
|
|
3668
3606
|
self._api = api_client
|
|
3669
3607
|
|
|
3670
3608
|
def get(self, request_object_type: str, request_object_id: str) -> ObjectPermissions:
|
|
3671
|
-
"""
|
|
3672
|
-
|
|
3673
|
-
Gets the permissions of an object. Objects can inherit permissions from their parent objects or root
|
|
3609
|
+
"""Gets the permissions of an object. Objects can inherit permissions from their parent objects or root
|
|
3674
3610
|
object.
|
|
3675
3611
|
|
|
3676
3612
|
:param request_object_type: str
|
|
@@ -3691,9 +3627,7 @@ class PermissionsAPI:
|
|
|
3691
3627
|
return ObjectPermissions.from_dict(res)
|
|
3692
3628
|
|
|
3693
3629
|
def get_permission_levels(self, request_object_type: str, request_object_id: str) -> GetPermissionLevelsResponse:
|
|
3694
|
-
"""
|
|
3695
|
-
|
|
3696
|
-
Gets the permission levels that a user can have on an object.
|
|
3630
|
+
"""Gets the permission levels that a user can have on an object.
|
|
3697
3631
|
|
|
3698
3632
|
:param request_object_type: str
|
|
3699
3633
|
The type of the request object. Can be one of the following: alerts, authorization, clusters,
|
|
@@ -3720,9 +3654,7 @@ class PermissionsAPI:
|
|
|
3720
3654
|
*,
|
|
3721
3655
|
access_control_list: Optional[List[AccessControlRequest]] = None,
|
|
3722
3656
|
) -> ObjectPermissions:
|
|
3723
|
-
"""
|
|
3724
|
-
|
|
3725
|
-
Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
|
|
3657
|
+
"""Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
|
|
3726
3658
|
permissions if none are specified. Objects can inherit permissions from their parent objects or root
|
|
3727
3659
|
object.
|
|
3728
3660
|
|
|
@@ -3756,9 +3688,7 @@ class PermissionsAPI:
|
|
|
3756
3688
|
*,
|
|
3757
3689
|
access_control_list: Optional[List[AccessControlRequest]] = None,
|
|
3758
3690
|
) -> ObjectPermissions:
|
|
3759
|
-
"""
|
|
3760
|
-
|
|
3761
|
-
Updates the permissions on an object. Objects can inherit permissions from their parent objects or
|
|
3691
|
+
"""Updates the permissions on an object. Objects can inherit permissions from their parent objects or
|
|
3762
3692
|
root object.
|
|
3763
3693
|
|
|
3764
3694
|
:param request_object_type: str
|
|
@@ -3808,9 +3738,7 @@ class ServicePrincipalsAPI:
|
|
|
3808
3738
|
roles: Optional[List[ComplexValue]] = None,
|
|
3809
3739
|
schemas: Optional[List[ServicePrincipalSchema]] = None,
|
|
3810
3740
|
) -> ServicePrincipal:
|
|
3811
|
-
"""
|
|
3812
|
-
|
|
3813
|
-
Creates a new service principal in the Databricks workspace.
|
|
3741
|
+
"""Creates a new service principal in the Databricks workspace.
|
|
3814
3742
|
|
|
3815
3743
|
:param active: bool (optional)
|
|
3816
3744
|
If this user is active
|
|
@@ -3862,9 +3790,7 @@ class ServicePrincipalsAPI:
|
|
|
3862
3790
|
return ServicePrincipal.from_dict(res)
|
|
3863
3791
|
|
|
3864
3792
|
def delete(self, id: str):
|
|
3865
|
-
"""Delete a service principal.
|
|
3866
|
-
|
|
3867
|
-
Delete a single service principal in the Databricks workspace.
|
|
3793
|
+
"""Delete a single service principal in the Databricks workspace.
|
|
3868
3794
|
|
|
3869
3795
|
:param id: str
|
|
3870
3796
|
Unique ID for a service principal in the Databricks workspace.
|
|
@@ -3877,9 +3803,7 @@ class ServicePrincipalsAPI:
|
|
|
3877
3803
|
self._api.do("DELETE", f"/api/2.0/preview/scim/v2/ServicePrincipals/{id}", headers=headers)
|
|
3878
3804
|
|
|
3879
3805
|
def get(self, id: str) -> ServicePrincipal:
|
|
3880
|
-
"""
|
|
3881
|
-
|
|
3882
|
-
Gets the details for a single service principal define in the Databricks workspace.
|
|
3806
|
+
"""Gets the details for a single service principal define in the Databricks workspace.
|
|
3883
3807
|
|
|
3884
3808
|
:param id: str
|
|
3885
3809
|
Unique ID for a service principal in the Databricks workspace.
|
|
@@ -3905,9 +3829,7 @@ class ServicePrincipalsAPI:
|
|
|
3905
3829
|
sort_order: Optional[ListSortOrder] = None,
|
|
3906
3830
|
start_index: Optional[int] = None,
|
|
3907
3831
|
) -> Iterator[ServicePrincipal]:
|
|
3908
|
-
"""
|
|
3909
|
-
|
|
3910
|
-
Gets the set of service principals associated with a Databricks workspace.
|
|
3832
|
+
"""Gets the set of service principals associated with a Databricks workspace.
|
|
3911
3833
|
|
|
3912
3834
|
:param attributes: str (optional)
|
|
3913
3835
|
Comma-separated list of attributes to return in response.
|
|
@@ -3955,7 +3877,7 @@ class ServicePrincipalsAPI:
|
|
|
3955
3877
|
seen = set()
|
|
3956
3878
|
query["startIndex"] = 1
|
|
3957
3879
|
if "count" not in query:
|
|
3958
|
-
query["count"] =
|
|
3880
|
+
query["count"] = 10000
|
|
3959
3881
|
while True:
|
|
3960
3882
|
json = self._api.do("GET", "/api/2.0/preview/scim/v2/ServicePrincipals", query=query, headers=headers)
|
|
3961
3883
|
if "Resources" in json:
|
|
@@ -3970,9 +3892,7 @@ class ServicePrincipalsAPI:
|
|
|
3970
3892
|
query["startIndex"] += len(json["Resources"])
|
|
3971
3893
|
|
|
3972
3894
|
def patch(self, id: str, *, operations: Optional[List[Patch]] = None, schemas: Optional[List[PatchSchema]] = None):
|
|
3973
|
-
"""
|
|
3974
|
-
|
|
3975
|
-
Partially updates the details of a single service principal in the Databricks workspace.
|
|
3895
|
+
"""Partially updates the details of a single service principal in the Databricks workspace.
|
|
3976
3896
|
|
|
3977
3897
|
:param id: str
|
|
3978
3898
|
Unique ID in the Databricks workspace.
|
|
@@ -4006,9 +3926,7 @@ class ServicePrincipalsAPI:
|
|
|
4006
3926
|
roles: Optional[List[ComplexValue]] = None,
|
|
4007
3927
|
schemas: Optional[List[ServicePrincipalSchema]] = None,
|
|
4008
3928
|
):
|
|
4009
|
-
"""
|
|
4010
|
-
|
|
4011
|
-
Updates the details of a single service principal.
|
|
3929
|
+
"""Updates the details of a single service principal.
|
|
4012
3930
|
|
|
4013
3931
|
This action replaces the existing service principal with the same name.
|
|
4014
3932
|
|
|
@@ -4087,9 +4005,7 @@ class UsersAPI:
|
|
|
4087
4005
|
schemas: Optional[List[UserSchema]] = None,
|
|
4088
4006
|
user_name: Optional[str] = None,
|
|
4089
4007
|
) -> User:
|
|
4090
|
-
"""
|
|
4091
|
-
|
|
4092
|
-
Creates a new user in the Databricks workspace. This new user will also be added to the Databricks
|
|
4008
|
+
"""Creates a new user in the Databricks workspace. This new user will also be added to the Databricks
|
|
4093
4009
|
account.
|
|
4094
4010
|
|
|
4095
4011
|
:param active: bool (optional)
|
|
@@ -4153,9 +4069,7 @@ class UsersAPI:
|
|
|
4153
4069
|
return User.from_dict(res)
|
|
4154
4070
|
|
|
4155
4071
|
def delete(self, id: str):
|
|
4156
|
-
"""
|
|
4157
|
-
|
|
4158
|
-
Deletes a user. Deleting a user from a Databricks workspace also removes objects associated with the
|
|
4072
|
+
"""Deletes a user. Deleting a user from a Databricks workspace also removes objects associated with the
|
|
4159
4073
|
user.
|
|
4160
4074
|
|
|
4161
4075
|
:param id: str
|
|
@@ -4180,9 +4094,7 @@ class UsersAPI:
|
|
|
4180
4094
|
sort_order: Optional[GetSortOrder] = None,
|
|
4181
4095
|
start_index: Optional[int] = None,
|
|
4182
4096
|
) -> User:
|
|
4183
|
-
"""
|
|
4184
|
-
|
|
4185
|
-
Gets information for a specific user in Databricks workspace.
|
|
4097
|
+
"""Gets information for a specific user in Databricks workspace.
|
|
4186
4098
|
|
|
4187
4099
|
:param id: str
|
|
4188
4100
|
Unique ID for a user in the Databricks workspace.
|
|
@@ -4233,9 +4145,7 @@ class UsersAPI:
|
|
|
4233
4145
|
return User.from_dict(res)
|
|
4234
4146
|
|
|
4235
4147
|
def get_permission_levels(self) -> GetPasswordPermissionLevelsResponse:
|
|
4236
|
-
"""
|
|
4237
|
-
|
|
4238
|
-
Gets the permission levels that a user can have on an object.
|
|
4148
|
+
"""Gets the permission levels that a user can have on an object.
|
|
4239
4149
|
|
|
4240
4150
|
:returns: :class:`GetPasswordPermissionLevelsResponse`
|
|
4241
4151
|
"""
|
|
@@ -4248,9 +4158,7 @@ class UsersAPI:
|
|
|
4248
4158
|
return GetPasswordPermissionLevelsResponse.from_dict(res)
|
|
4249
4159
|
|
|
4250
4160
|
def get_permissions(self) -> PasswordPermissions:
|
|
4251
|
-
"""
|
|
4252
|
-
|
|
4253
|
-
Gets the permissions of all passwords. Passwords can inherit permissions from their root object.
|
|
4161
|
+
"""Gets the permissions of all passwords. Passwords can inherit permissions from their root object.
|
|
4254
4162
|
|
|
4255
4163
|
:returns: :class:`PasswordPermissions`
|
|
4256
4164
|
"""
|
|
@@ -4273,9 +4181,7 @@ class UsersAPI:
|
|
|
4273
4181
|
sort_order: Optional[ListSortOrder] = None,
|
|
4274
4182
|
start_index: Optional[int] = None,
|
|
4275
4183
|
) -> Iterator[User]:
|
|
4276
|
-
"""
|
|
4277
|
-
|
|
4278
|
-
Gets details for all the users associated with a Databricks workspace.
|
|
4184
|
+
"""Gets details for all the users associated with a Databricks workspace.
|
|
4279
4185
|
|
|
4280
4186
|
:param attributes: str (optional)
|
|
4281
4187
|
Comma-separated list of attributes to return in response.
|
|
@@ -4324,7 +4230,7 @@ class UsersAPI:
|
|
|
4324
4230
|
seen = set()
|
|
4325
4231
|
query["startIndex"] = 1
|
|
4326
4232
|
if "count" not in query:
|
|
4327
|
-
query["count"] =
|
|
4233
|
+
query["count"] = 10000
|
|
4328
4234
|
while True:
|
|
4329
4235
|
json = self._api.do("GET", "/api/2.0/preview/scim/v2/Users", query=query, headers=headers)
|
|
4330
4236
|
if "Resources" in json:
|
|
@@ -4339,9 +4245,7 @@ class UsersAPI:
|
|
|
4339
4245
|
query["startIndex"] += len(json["Resources"])
|
|
4340
4246
|
|
|
4341
4247
|
def patch(self, id: str, *, operations: Optional[List[Patch]] = None, schemas: Optional[List[PatchSchema]] = None):
|
|
4342
|
-
"""
|
|
4343
|
-
|
|
4344
|
-
Partially updates a user resource by applying the supplied operations on specific user attributes.
|
|
4248
|
+
"""Partially updates a user resource by applying the supplied operations on specific user attributes.
|
|
4345
4249
|
|
|
4346
4250
|
:param id: str
|
|
4347
4251
|
Unique ID in the Databricks workspace.
|
|
@@ -4365,9 +4269,7 @@ class UsersAPI:
|
|
|
4365
4269
|
def set_permissions(
|
|
4366
4270
|
self, *, access_control_list: Optional[List[PasswordAccessControlRequest]] = None
|
|
4367
4271
|
) -> PasswordPermissions:
|
|
4368
|
-
"""
|
|
4369
|
-
|
|
4370
|
-
Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
|
|
4272
|
+
"""Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
|
|
4371
4273
|
permissions if none are specified. Objects can inherit permissions from their root object.
|
|
4372
4274
|
|
|
4373
4275
|
:param access_control_list: List[:class:`PasswordAccessControlRequest`] (optional)
|
|
@@ -4400,9 +4302,7 @@ class UsersAPI:
|
|
|
4400
4302
|
schemas: Optional[List[UserSchema]] = None,
|
|
4401
4303
|
user_name: Optional[str] = None,
|
|
4402
4304
|
):
|
|
4403
|
-
"""
|
|
4404
|
-
|
|
4405
|
-
Replaces a user's information with the data supplied in request.
|
|
4305
|
+
"""Replaces a user's information with the data supplied in request.
|
|
4406
4306
|
|
|
4407
4307
|
:param id: str
|
|
4408
4308
|
Databricks user ID.
|
|
@@ -4463,9 +4363,7 @@ class UsersAPI:
|
|
|
4463
4363
|
def update_permissions(
|
|
4464
4364
|
self, *, access_control_list: Optional[List[PasswordAccessControlRequest]] = None
|
|
4465
4365
|
) -> PasswordPermissions:
|
|
4466
|
-
"""
|
|
4467
|
-
|
|
4468
|
-
Updates the permissions on all passwords. Passwords can inherit permissions from their root object.
|
|
4366
|
+
"""Updates the permissions on all passwords. Passwords can inherit permissions from their root object.
|
|
4469
4367
|
|
|
4470
4368
|
:param access_control_list: List[:class:`PasswordAccessControlRequest`] (optional)
|
|
4471
4369
|
|
|
@@ -4491,9 +4389,7 @@ class WorkspaceAssignmentAPI:
|
|
|
4491
4389
|
self._api = api_client
|
|
4492
4390
|
|
|
4493
4391
|
def delete(self, workspace_id: int, principal_id: int):
|
|
4494
|
-
"""
|
|
4495
|
-
|
|
4496
|
-
Deletes the workspace permissions assignment in a given account and workspace for the specified
|
|
4392
|
+
"""Deletes the workspace permissions assignment in a given account and workspace for the specified
|
|
4497
4393
|
principal.
|
|
4498
4394
|
|
|
4499
4395
|
:param workspace_id: int
|
|
@@ -4515,9 +4411,7 @@ class WorkspaceAssignmentAPI:
|
|
|
4515
4411
|
)
|
|
4516
4412
|
|
|
4517
4413
|
def get(self, workspace_id: int) -> WorkspacePermissions:
|
|
4518
|
-
"""
|
|
4519
|
-
|
|
4520
|
-
Get an array of workspace permissions for the specified account and workspace.
|
|
4414
|
+
"""Get an array of workspace permissions for the specified account and workspace.
|
|
4521
4415
|
|
|
4522
4416
|
:param workspace_id: int
|
|
4523
4417
|
The workspace ID.
|
|
@@ -4537,9 +4431,7 @@ class WorkspaceAssignmentAPI:
|
|
|
4537
4431
|
return WorkspacePermissions.from_dict(res)
|
|
4538
4432
|
|
|
4539
4433
|
def list(self, workspace_id: int) -> Iterator[PermissionAssignment]:
|
|
4540
|
-
"""Get permission assignments.
|
|
4541
|
-
|
|
4542
|
-
Get the permission assignments for the specified Databricks account and Databricks workspace.
|
|
4434
|
+
"""Get the permission assignments for the specified Databricks account and Databricks workspace.
|
|
4543
4435
|
|
|
4544
4436
|
:param workspace_id: int
|
|
4545
4437
|
The workspace ID for the account.
|
|
@@ -4562,9 +4454,7 @@ class WorkspaceAssignmentAPI:
|
|
|
4562
4454
|
def update(
|
|
4563
4455
|
self, workspace_id: int, principal_id: int, *, permissions: Optional[List[WorkspacePermission]] = None
|
|
4564
4456
|
) -> PermissionAssignment:
|
|
4565
|
-
"""
|
|
4566
|
-
|
|
4567
|
-
Creates or updates the workspace permissions assignment in a given account and workspace for the
|
|
4457
|
+
"""Creates or updates the workspace permissions assignment in a given account and workspace for the
|
|
4568
4458
|
specified principal.
|
|
4569
4459
|
|
|
4570
4460
|
:param workspace_id: int
|