@databricks/sdk-secrets 0.0.0-dev → 0.1.0-dev.2
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.
- package/LICENSE +203 -0
- package/dist/v1/client.d.ts +297 -0
- package/dist/v1/client.d.ts.map +1 -0
- package/dist/v1/client.js +604 -0
- package/dist/v1/client.js.map +1 -0
- package/dist/v1/index.d.ts +4 -0
- package/dist/v1/index.d.ts.map +1 -0
- package/dist/v1/index.js +4 -0
- package/dist/v1/index.js.map +1 -0
- package/dist/v1/model.d.ts +189 -0
- package/dist/v1/model.d.ts.map +1 -0
- package/dist/v1/model.js +206 -0
- package/dist/v1/model.js.map +1 -0
- package/dist/v1/transport.d.ts +5 -0
- package/dist/v1/transport.d.ts.map +1 -0
- package/dist/v1/transport.js +57 -0
- package/dist/v1/transport.js.map +1 -0
- package/dist/v1/utils.d.ts +21 -0
- package/dist/v1/utils.d.ts.map +1 -0
- package/dist/v1/utils.js +113 -0
- package/dist/v1/utils.js.map +1 -0
- package/package.json +38 -4
- package/src/v1/client.ts +712 -0
- package/src/v1/index.ts +33 -0
- package/src/v1/model.ts +413 -0
- package/src/v1/transport.ts +73 -0
- package/src/v1/utils.ts +156 -0
- package/README.md +0 -1
- package/index.js +0 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
Copyright 2026 Databricks, Inc. All rights reserved.
|
|
2
|
+
|
|
3
|
+
Apache License
|
|
4
|
+
Version 2.0, January 2004
|
|
5
|
+
http://www.apache.org/licenses/
|
|
6
|
+
|
|
7
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
8
|
+
|
|
9
|
+
1. Definitions.
|
|
10
|
+
|
|
11
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
12
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
13
|
+
|
|
14
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
15
|
+
the copyright owner that is granting the License.
|
|
16
|
+
|
|
17
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
18
|
+
other entities that control, are controlled by, or are under common
|
|
19
|
+
control with that entity. For the purposes of this definition,
|
|
20
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
21
|
+
direction or management of such entity, whether by contract or
|
|
22
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
23
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
24
|
+
|
|
25
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
26
|
+
exercising permissions granted by this License.
|
|
27
|
+
|
|
28
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
29
|
+
including but not limited to software source code, documentation
|
|
30
|
+
source, and configuration files.
|
|
31
|
+
|
|
32
|
+
"Object" form shall mean any form resulting from mechanical
|
|
33
|
+
transformation or translation of a Source form, including but
|
|
34
|
+
not limited to compiled object code, generated documentation,
|
|
35
|
+
and conversions to other media types.
|
|
36
|
+
|
|
37
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
38
|
+
Object form, made available under the License, as indicated by a
|
|
39
|
+
copyright notice that is included in or attached to the work
|
|
40
|
+
(an example is provided in the Appendix below).
|
|
41
|
+
|
|
42
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
43
|
+
form, that is based on (or derived from) the Work and for which the
|
|
44
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
45
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
46
|
+
of this License, Derivative Works shall not include works that remain
|
|
47
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
48
|
+
the Work and Derivative Works thereof.
|
|
49
|
+
|
|
50
|
+
"Contribution" shall mean any work of authorship, including
|
|
51
|
+
the original version of the Work and any modifications or additions
|
|
52
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
53
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
54
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
55
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
56
|
+
means any form of electronic, verbal, or written communication sent
|
|
57
|
+
to the Licensor or its representatives, including but not limited to
|
|
58
|
+
communication on electronic mailing lists, source code control systems,
|
|
59
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
60
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
61
|
+
excluding communication that is conspicuously marked or otherwise
|
|
62
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
63
|
+
|
|
64
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
65
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
66
|
+
subsequently incorporated within the Work.
|
|
67
|
+
|
|
68
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
69
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
70
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
71
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
72
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
73
|
+
Work and such Derivative Works in Source or Object form.
|
|
74
|
+
|
|
75
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
76
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
77
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
78
|
+
(except as stated in this section) patent license to make, have made,
|
|
79
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
80
|
+
where such license applies only to those patent claims licensable
|
|
81
|
+
by such Contributor that are necessarily infringed by their
|
|
82
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
83
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
84
|
+
institute patent litigation against any entity (including a
|
|
85
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
86
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
87
|
+
or contributory patent infringement, then any patent licenses
|
|
88
|
+
granted to You under this License for that Work shall terminate
|
|
89
|
+
as of the date such litigation is filed.
|
|
90
|
+
|
|
91
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
92
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
93
|
+
modifications, and in Source or Object form, provided that You
|
|
94
|
+
meet the following conditions:
|
|
95
|
+
|
|
96
|
+
(a) You must give any other recipients of the Work or
|
|
97
|
+
Derivative Works a copy of this License; and
|
|
98
|
+
|
|
99
|
+
(b) You must cause any modified files to carry prominent notices
|
|
100
|
+
stating that You changed the files; and
|
|
101
|
+
|
|
102
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
103
|
+
that You distribute, all copyright, patent, trademark, and
|
|
104
|
+
attribution notices from the Source form of the Work,
|
|
105
|
+
excluding those notices that do not pertain to any part of
|
|
106
|
+
the Derivative Works; and
|
|
107
|
+
|
|
108
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
109
|
+
distribution, then any Derivative Works that You distribute must
|
|
110
|
+
include a readable copy of the attribution notices contained
|
|
111
|
+
within such NOTICE file, excluding those notices that do not
|
|
112
|
+
pertain to any part of the Derivative Works, in at least one
|
|
113
|
+
of the following places: within a NOTICE text file distributed
|
|
114
|
+
as part of the Derivative Works; within the Source form or
|
|
115
|
+
documentation, if provided along with the Derivative Works; or,
|
|
116
|
+
within a display generated by the Derivative Works, if and
|
|
117
|
+
wherever such third-party notices normally appear. The contents
|
|
118
|
+
of the NOTICE file are for informational purposes only and
|
|
119
|
+
do not modify the License. You may add Your own attribution
|
|
120
|
+
notices within Derivative Works that You distribute, alongside
|
|
121
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
122
|
+
that such additional attribution notices cannot be construed
|
|
123
|
+
as modifying the License.
|
|
124
|
+
|
|
125
|
+
You may add Your own copyright statement to Your modifications and
|
|
126
|
+
may provide additional or different license terms and conditions
|
|
127
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
128
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
129
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
130
|
+
the conditions stated in this License.
|
|
131
|
+
|
|
132
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
133
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
134
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
135
|
+
this License, without any additional terms or conditions.
|
|
136
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
137
|
+
the terms of any separate license agreement you may have executed
|
|
138
|
+
with Licensor regarding such Contributions.
|
|
139
|
+
|
|
140
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
141
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
142
|
+
except as required for reasonable and customary use in describing the
|
|
143
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
144
|
+
|
|
145
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
146
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
147
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
148
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
149
|
+
implied, including, without limitation, any warranties or conditions
|
|
150
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
151
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
152
|
+
appropriateness of using or redistributing the Work and assume any
|
|
153
|
+
risks associated with Your exercise of permissions under this License.
|
|
154
|
+
|
|
155
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
156
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
157
|
+
unless required by applicable law (such as deliberate and grossly
|
|
158
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
159
|
+
liable to You for damages, including any direct, indirect, special,
|
|
160
|
+
incidental, or consequential damages of any character arising as a
|
|
161
|
+
result of this License or out of the use or inability to use the
|
|
162
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
163
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
164
|
+
other commercial damages or losses), even if such Contributor
|
|
165
|
+
has been advised of the possibility of such damages.
|
|
166
|
+
|
|
167
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
168
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
169
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
170
|
+
or other liability obligations and/or rights consistent with this
|
|
171
|
+
License. However, in accepting such obligations, You may act only
|
|
172
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
173
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
174
|
+
defend, and hold each Contributor harmless for any liability
|
|
175
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
176
|
+
of your accepting any such warranty or additional liability.
|
|
177
|
+
|
|
178
|
+
END OF TERMS AND CONDITIONS
|
|
179
|
+
|
|
180
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
181
|
+
|
|
182
|
+
To apply the Apache License to your work, attach the following
|
|
183
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
184
|
+
replaced with your own identifying information. (Don't include
|
|
185
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
186
|
+
comment syntax for the file format. We also recommend that a
|
|
187
|
+
file or class name and description of purpose be included on the
|
|
188
|
+
same "printed page" as the copyright notice for easier
|
|
189
|
+
identification within third-party archives.
|
|
190
|
+
|
|
191
|
+
Copyright [yyyy] [name of copyright owner]
|
|
192
|
+
|
|
193
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
194
|
+
you may not use this file except in compliance with the License.
|
|
195
|
+
You may obtain a copy of the License at
|
|
196
|
+
|
|
197
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
|
+
|
|
199
|
+
Unless required by applicable law or agreed to in writing, software
|
|
200
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
201
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
202
|
+
See the License for the specific language governing permissions and
|
|
203
|
+
limitations under the License.
|
|
@@ -0,0 +1,297 @@
|
|
|
1
|
+
import type { CallOptions } from '@databricks/sdk-options/call';
|
|
2
|
+
import type { ClientOptions } from '@databricks/sdk-options/client';
|
|
3
|
+
import type { AclItem, CreateScopeRequest, CreateScopeRequest_Response, DeleteAclRequest, DeleteAclRequest_Response, DeleteScopeRequest, DeleteScopeRequest_Response, DeleteSecretRequest, DeleteSecretRequest_Response, GetAclRequest, GetSecretRequest, GetSecretRequest_Response, ListAclsRequest, ListAclsRequest_Response, ListScopesRequest, ListScopesRequest_Response, ListSecretsRequest, ListSecretsRequest_Response, PutAclRequest, PutAclRequest_Response, PutSecretRequest, PutSecretRequest_Response } from './model';
|
|
4
|
+
export declare class SecretsClient {
|
|
5
|
+
private readonly host;
|
|
6
|
+
private readonly workspaceId;
|
|
7
|
+
private readonly httpClient;
|
|
8
|
+
private readonly logger;
|
|
9
|
+
private readonly userAgent;
|
|
10
|
+
constructor(options: ClientOptions);
|
|
11
|
+
/**
|
|
12
|
+
* Creates a new secret scope.
|
|
13
|
+
*
|
|
14
|
+
* The scope name must consist of alphanumeric characters, dashes, underscores, and
|
|
15
|
+
* periods, and may not exceed 128 characters.
|
|
16
|
+
*
|
|
17
|
+
* Example request:
|
|
18
|
+
*
|
|
19
|
+
* .. code::
|
|
20
|
+
*
|
|
21
|
+
* {
|
|
22
|
+
* "scope": "my-simple-databricks-scope",
|
|
23
|
+
* "initial_manage_principal": "users"
|
|
24
|
+
* "scope_backend_type": "databricks|azure_keyvault",
|
|
25
|
+
* # below is only required if scope type is azure_keyvault
|
|
26
|
+
* "backend_azure_keyvault": {
|
|
27
|
+
* "resource_id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxx/providers/Microsoft.KeyVault/vaults/xxxx",
|
|
28
|
+
* "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
29
|
+
* "dns_name": "https://xxxx.vault.azure.net/",
|
|
30
|
+
* }
|
|
31
|
+
* }
|
|
32
|
+
*
|
|
33
|
+
* If ``initial_manage_principal`` is specified, the initial ACL applied to the scope is
|
|
34
|
+
* applied to the supplied principal (user or group) with ``MANAGE`` permissions.
|
|
35
|
+
* The only supported principal for this option is the group ``users``, which
|
|
36
|
+
* contains all users in the workspace. If ``initial_manage_principal`` is not specified,
|
|
37
|
+
* the initial ACL with ``MANAGE`` permission applied to the scope is assigned to the
|
|
38
|
+
* API request issuer's user identity.
|
|
39
|
+
*
|
|
40
|
+
* If ``scope_backend_type`` is ``azure_keyvault``, a secret scope is created with secrets
|
|
41
|
+
* from a given Azure KeyVault. The caller must provide the keyvault_resource_id and the tenant_id
|
|
42
|
+
* for the key vault. If ``scope_backend_type`` is ``databricks`` or is unspecified, an empty
|
|
43
|
+
* secret scope is created and stored in <Databricks>'s own storage.
|
|
44
|
+
*
|
|
45
|
+
*
|
|
46
|
+
* Throws ``RESOURCE_ALREADY_EXISTS`` if a scope with the given name already exists.
|
|
47
|
+
* Throws ``RESOURCE_LIMIT_EXCEEDED`` if maximum number of scopes in the workspace is exceeded.
|
|
48
|
+
* Throws ``INVALID_PARAMETER_VALUE`` if the scope name is invalid.
|
|
49
|
+
* Throws ``BAD_REQUEST`` if request violated constraints.
|
|
50
|
+
* Throws ``CUSTOMER_UNAUTHORIZED`` if normal user attempts to create a scope with name reserved for databricks internal usage.
|
|
51
|
+
* Throws ``UNAUTHENTICATED`` if unable to verify user access permission on Azure KeyVault
|
|
52
|
+
*/
|
|
53
|
+
createScope(req: CreateScopeRequest, options?: CallOptions): Promise<CreateScopeRequest_Response>;
|
|
54
|
+
/**
|
|
55
|
+
* Deletes the given ACL on the given scope.
|
|
56
|
+
*
|
|
57
|
+
* Users must have the ``MANAGE`` permission to invoke this API.
|
|
58
|
+
*
|
|
59
|
+
* Example request:
|
|
60
|
+
*
|
|
61
|
+
* .. code::
|
|
62
|
+
*
|
|
63
|
+
* {
|
|
64
|
+
* "scope": "my-secret-scope",
|
|
65
|
+
* "principal": "data-scientists"
|
|
66
|
+
* }
|
|
67
|
+
*
|
|
68
|
+
* Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope, principal, or ACL exists.
|
|
69
|
+
* Throws ``PERMISSION_DENIED`` if the user does not have permission to make this API call.
|
|
70
|
+
* Throws ``INVALID_PARAMETER_VALUE`` if the permission or principal is invalid.
|
|
71
|
+
*/
|
|
72
|
+
deleteAcl(req: DeleteAclRequest, options?: CallOptions): Promise<DeleteAclRequest_Response>;
|
|
73
|
+
/**
|
|
74
|
+
* Deletes a secret scope.
|
|
75
|
+
*
|
|
76
|
+
* Example request:
|
|
77
|
+
*
|
|
78
|
+
* .. code::
|
|
79
|
+
*
|
|
80
|
+
* {
|
|
81
|
+
* "scope": "my-secret-scope"
|
|
82
|
+
* }
|
|
83
|
+
*
|
|
84
|
+
* Throws ``RESOURCE_DOES_NOT_EXIST`` if the scope does not exist.
|
|
85
|
+
* Throws ``PERMISSION_DENIED`` if the user does not have permission to make this API call.
|
|
86
|
+
* Throws ``BAD_REQUEST`` if system user attempts to delete internal secret scope.
|
|
87
|
+
*/
|
|
88
|
+
deleteScope(req: DeleteScopeRequest, options?: CallOptions): Promise<DeleteScopeRequest_Response>;
|
|
89
|
+
/**
|
|
90
|
+
* Deletes the secret stored in this secret scope. You must have ``WRITE`` or ``MANAGE``
|
|
91
|
+
* permission on the Secret Scope.
|
|
92
|
+
*
|
|
93
|
+
* Example request:
|
|
94
|
+
*
|
|
95
|
+
* .. code::
|
|
96
|
+
*
|
|
97
|
+
* {
|
|
98
|
+
* "scope": "my-secret-scope",
|
|
99
|
+
* "key": "my-secret-key"
|
|
100
|
+
* }
|
|
101
|
+
*
|
|
102
|
+
* Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope or secret exists.
|
|
103
|
+
* Throws ``PERMISSION_DENIED`` if the user does not have permission to make this API call.
|
|
104
|
+
* Throws ``BAD_REQUEST`` if system user attempts to delete an internal secret, or request is made against Azure KeyVault backed scope.
|
|
105
|
+
*/
|
|
106
|
+
deleteSecret(req: DeleteSecretRequest, options?: CallOptions): Promise<DeleteSecretRequest_Response>;
|
|
107
|
+
/**
|
|
108
|
+
* Describes the details about the given ACL, such as the group and permission.
|
|
109
|
+
*
|
|
110
|
+
* Users must have the ``MANAGE`` permission to invoke this API.
|
|
111
|
+
*
|
|
112
|
+
* Example response:
|
|
113
|
+
*
|
|
114
|
+
* .. code::
|
|
115
|
+
*
|
|
116
|
+
* {
|
|
117
|
+
* "principal": "data-scientists",
|
|
118
|
+
* "permission": "READ"
|
|
119
|
+
* }
|
|
120
|
+
*
|
|
121
|
+
* Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists.
|
|
122
|
+
* Throws ``PERMISSION_DENIED`` if the user does not have permission to make this API call.
|
|
123
|
+
* Throws ``INVALID_PARAMETER_VALUE`` if the permission or principal is invalid.
|
|
124
|
+
*/
|
|
125
|
+
getAcl(req: GetAclRequest, options?: CallOptions): Promise<AclItem>;
|
|
126
|
+
/**
|
|
127
|
+
* Gets a secret for a given key and scope. This API can only be called from the DBUtils
|
|
128
|
+
* interface. Users need the READ permission to make this call.
|
|
129
|
+
*
|
|
130
|
+
* Example response:
|
|
131
|
+
*
|
|
132
|
+
* .. code::
|
|
133
|
+
*
|
|
134
|
+
* {
|
|
135
|
+
* "key": "my-string-key",
|
|
136
|
+
* "value": <bytes of the secret value>
|
|
137
|
+
* }
|
|
138
|
+
*
|
|
139
|
+
* Note that the secret value returned is in bytes. The interpretation of the bytes
|
|
140
|
+
* is determined by the caller in DBUtils and the type the data is decoded into.
|
|
141
|
+
*
|
|
142
|
+
* Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret or secret scope exists.
|
|
143
|
+
* Throws ``PERMISSION_DENIED`` if the user does not have permission to make this API call.
|
|
144
|
+
*
|
|
145
|
+
* Note: This is explicitly an undocumented API. It also doesn't need to be supported
|
|
146
|
+
* for the /preview prefix, because it's not a customer-facing API (i.e. only used
|
|
147
|
+
* for DBUtils SecretUtils to fetch secrets).
|
|
148
|
+
*
|
|
149
|
+
* Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope or secret exists.
|
|
150
|
+
* Throws ``BAD_REQUEST`` if normal user calls get secret outside of a notebook.
|
|
151
|
+
* AKV specific errors:
|
|
152
|
+
* Throws ``INVALID_PARAMETER_VALUE`` if secret name is not alphanumeric or too long.
|
|
153
|
+
* Throws ``PERMISSION_DENIED`` if secret manager cannot access AKV with 403 error
|
|
154
|
+
* Throws ``MALFORMED_REQUEST`` if secret manager cannot access AKV with any other 4xx error
|
|
155
|
+
*/
|
|
156
|
+
getSecret(req: GetSecretRequest, options?: CallOptions): Promise<GetSecretRequest_Response>;
|
|
157
|
+
/**
|
|
158
|
+
* Lists the ACLs set on the given scope.
|
|
159
|
+
*
|
|
160
|
+
* Users must have the ``MANAGE`` permission to invoke this API.
|
|
161
|
+
*
|
|
162
|
+
* Example response:
|
|
163
|
+
*
|
|
164
|
+
* .. code::
|
|
165
|
+
*
|
|
166
|
+
* {
|
|
167
|
+
* "acls": [{
|
|
168
|
+
* "principal": "admins",
|
|
169
|
+
* "permission": "MANAGE"
|
|
170
|
+
* },{
|
|
171
|
+
* "principal": "data-scientists",
|
|
172
|
+
* "permission": "READ"
|
|
173
|
+
* }]
|
|
174
|
+
* }
|
|
175
|
+
*
|
|
176
|
+
* Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists.
|
|
177
|
+
* Throws ``PERMISSION_DENIED`` if the user does not have permission to make this API call.
|
|
178
|
+
*/
|
|
179
|
+
listAcls(req: ListAclsRequest, options?: CallOptions): Promise<ListAclsRequest_Response>;
|
|
180
|
+
/**
|
|
181
|
+
* Lists all secret scopes available in the workspace.
|
|
182
|
+
*
|
|
183
|
+
* Example response:
|
|
184
|
+
*
|
|
185
|
+
* .. code::
|
|
186
|
+
*
|
|
187
|
+
* {
|
|
188
|
+
* "scopes": [{
|
|
189
|
+
* "name": "my-databricks-scope",
|
|
190
|
+
* "backend_type": "DATABRICKS"
|
|
191
|
+
* },{
|
|
192
|
+
* "name": "mount-points",
|
|
193
|
+
* "backend_type": "DATABRICKS"
|
|
194
|
+
* }]
|
|
195
|
+
* }
|
|
196
|
+
*
|
|
197
|
+
* Throws ``PERMISSION_DENIED`` if the user does not have permission to make this API call.
|
|
198
|
+
*/
|
|
199
|
+
listScopes(_req: ListScopesRequest, options?: CallOptions): Promise<ListScopesRequest_Response>;
|
|
200
|
+
/**
|
|
201
|
+
* Lists the secret keys that are stored at this scope. This is a metadata-only
|
|
202
|
+
* operation; secret data cannot be retrieved using this API. Users need the READ
|
|
203
|
+
* permission to make this call.
|
|
204
|
+
*
|
|
205
|
+
* Example response:
|
|
206
|
+
*
|
|
207
|
+
* .. code::
|
|
208
|
+
*
|
|
209
|
+
* {
|
|
210
|
+
* "secrets": [
|
|
211
|
+
* {
|
|
212
|
+
* "key": "my-string-key"",
|
|
213
|
+
* "last_updated_timestamp": "1520467595000"
|
|
214
|
+
* },
|
|
215
|
+
* {
|
|
216
|
+
* "key": "my-byte-key",
|
|
217
|
+
* "last_updated_timestamp": "1520467595000"
|
|
218
|
+
* },
|
|
219
|
+
* ]
|
|
220
|
+
* }
|
|
221
|
+
*
|
|
222
|
+
* The lastUpdatedTimestamp returned is in milliseconds since epoch.
|
|
223
|
+
*
|
|
224
|
+
* Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists.
|
|
225
|
+
* Throws ``PERMISSION_DENIED`` if the user does not have permission to make this API call.
|
|
226
|
+
*/
|
|
227
|
+
listSecrets(req: ListSecretsRequest, options?: CallOptions): Promise<ListSecretsRequest_Response>;
|
|
228
|
+
/**
|
|
229
|
+
* Creates or overwrites the ACL associated with the given principal (user or group) on the
|
|
230
|
+
* specified scope point. In general, a user or group will use the most powerful
|
|
231
|
+
* permission available to them, and permissions are ordered as follows:
|
|
232
|
+
*
|
|
233
|
+
* * ``MANAGE`` - Allowed to change ACLs, and read and write to this secret scope.
|
|
234
|
+
* * ``WRITE`` - Allowed to read and write to this secret scope.
|
|
235
|
+
* * ``READ`` - Allowed to read this secret scope and list what secrets are available.
|
|
236
|
+
*
|
|
237
|
+
* Note that in general, secret values can only be read from within a command
|
|
238
|
+
* on a cluster (for example, through a notebook). There is no API to read the actual
|
|
239
|
+
* secret value material outside of a cluster. However, the user's permission will be
|
|
240
|
+
* applied based on who is executing the command, and they must have at least READ permission.
|
|
241
|
+
*
|
|
242
|
+
* Users must have the ``MANAGE`` permission to invoke this API.
|
|
243
|
+
*
|
|
244
|
+
* Example request:
|
|
245
|
+
*
|
|
246
|
+
* .. code::
|
|
247
|
+
*
|
|
248
|
+
* {
|
|
249
|
+
* "scope": "my-secret-scope",
|
|
250
|
+
* "principal": "data-scientists",
|
|
251
|
+
* "permission": "READ"
|
|
252
|
+
* }
|
|
253
|
+
*
|
|
254
|
+
* The principal is a user or group name corresponding to an existing <Databricks>
|
|
255
|
+
* principal to be granted or revoked access.
|
|
256
|
+
*
|
|
257
|
+
* Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists.
|
|
258
|
+
* Throws ``RESOURCE_ALREADY_EXISTS`` if a permission for the principal already exists.
|
|
259
|
+
* Throws ``INVALID_PARAMETER_VALUE`` if the permission or principal is invalid.
|
|
260
|
+
* Throws ``PERMISSION_DENIED`` if the user does not have permission to make this API call.
|
|
261
|
+
*/
|
|
262
|
+
putAcl(req: PutAclRequest, options?: CallOptions): Promise<PutAclRequest_Response>;
|
|
263
|
+
/**
|
|
264
|
+
* Inserts a secret under the provided scope with the given name. If a secret already
|
|
265
|
+
* exists with the same name, this command overwrites the existing secret's value.
|
|
266
|
+
* The server encrypts the secret using the secret scope's encryption settings before
|
|
267
|
+
* storing it. You must have ``WRITE`` or ``MANAGE`` permission on the secret scope.
|
|
268
|
+
*
|
|
269
|
+
* The secret key must consist of alphanumeric characters, dashes, underscores,
|
|
270
|
+
* and periods, and cannot exceed 128 characters. The maximum allowed secret
|
|
271
|
+
* value size is 128 KB. The maximum number of secrets in a given scope is
|
|
272
|
+
* 1000.
|
|
273
|
+
*
|
|
274
|
+
* Example request:
|
|
275
|
+
*
|
|
276
|
+
* .. code::
|
|
277
|
+
*
|
|
278
|
+
* {
|
|
279
|
+
* "scope": "my-databricks-scope",
|
|
280
|
+
* "key": "my-string-key",
|
|
281
|
+
* "string_value": "foobar"
|
|
282
|
+
* }
|
|
283
|
+
*
|
|
284
|
+
* The input fields "string_value" or "bytes_value"
|
|
285
|
+
* specify the type of the secret, which will determine the value returned when
|
|
286
|
+
* the secret value is requested. Exactly one must be specified.
|
|
287
|
+
*
|
|
288
|
+
* Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists.
|
|
289
|
+
* Throws ``RESOURCE_LIMIT_EXCEEDED`` if maximum number of secrets in scope is exceeded.
|
|
290
|
+
* Throws ``INVALID_PARAMETER_VALUE`` if the request parameters are invalid.
|
|
291
|
+
* Throws ``PERMISSION_DENIED`` if the user does not have permission to make this API call.
|
|
292
|
+
* Throws ``MALFORMED_REQUEST`` if request is incorrectly formatted or conflicting.
|
|
293
|
+
* Throws ``BAD_REQUEST`` if request is made against Azure KeyVault backed scope.
|
|
294
|
+
*/
|
|
295
|
+
putSecret(req: PutSecretRequest, options?: CallOptions): Promise<PutSecretRequest_Response>;
|
|
296
|
+
}
|
|
297
|
+
//# sourceMappingURL=client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/v1/client.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,gCAAgC,CAAC;AAWlE,OAAO,KAAK,EACV,OAAO,EACP,kBAAkB,EAClB,2BAA2B,EAC3B,gBAAgB,EAChB,yBAAyB,EACzB,kBAAkB,EAClB,2BAA2B,EAC3B,mBAAmB,EACnB,4BAA4B,EAC5B,aAAa,EACb,gBAAgB,EAChB,yBAAyB,EACzB,eAAe,EACf,wBAAwB,EACxB,iBAAiB,EACjB,0BAA0B,EAC1B,kBAAkB,EAClB,2BAA2B,EAC3B,aAAa,EACb,sBAAsB,EACtB,gBAAgB,EAChB,yBAAyB,EAC1B,MAAM,SAAS,CAAC;AA2BjB,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAI9B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IACjD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAIhC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;gBAEvB,OAAO,EAAE,aAAa;IAelC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACG,WAAW,CACf,GAAG,EAAE,kBAAkB,EACvB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,2BAA2B,CAAC;IA4BvC;;;;;;;;;;;;;;;;;OAiBG;IACG,SAAS,CACb,GAAG,EAAE,gBAAgB,EACrB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,yBAAyB,CAAC;IAyBrC;;;;;;;;;;;;;;OAcG;IACG,WAAW,CACf,GAAG,EAAE,kBAAkB,EACvB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,2BAA2B,CAAC;IA4BvC;;;;;;;;;;;;;;;;OAgBG;IACG,YAAY,CAChB,GAAG,EAAE,mBAAmB,EACxB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,4BAA4B,CAAC;IA4BxC;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CAAC,GAAG,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAiCzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,SAAS,CACb,GAAG,EAAE,gBAAgB,EACrB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,yBAAyB,CAAC;IAiCrC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,QAAQ,CACZ,GAAG,EAAE,eAAe,EACpB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,wBAAwB,CAAC;IA8BpC;;;;;;;;;;;;;;;;;;OAkBG;IACG,UAAU,CACd,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,0BAA0B,CAAC;IAwBtC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,WAAW,CACf,GAAG,EAAE,kBAAkB,EACvB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,2BAA2B,CAAC;IAiCvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,MAAM,CACV,GAAG,EAAE,aAAa,EAClB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,sBAAsB,CAAC;IAyBlC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,SAAS,CACb,GAAG,EAAE,gBAAgB,EACrB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,yBAAyB,CAAC;CAwBtC"}
|