@azure/arm-keyvault-profile-2020-09-01-hybrid 1.1.1 → 2.0.0-alpha.20220321.1

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 (178) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +21 -0
  3. package/README.md +80 -83
  4. package/dist/index.js +3453 -0
  5. package/dist/index.js.map +1 -0
  6. package/dist/index.min.js +1 -0
  7. package/dist/index.min.js.map +1 -0
  8. package/dist-esm/src/index.d.ts +5 -0
  9. package/dist-esm/src/index.d.ts.map +1 -0
  10. package/dist-esm/src/index.js +12 -0
  11. package/dist-esm/src/index.js.map +1 -0
  12. package/dist-esm/src/keyVaultManagementClient.d.ts +23 -0
  13. package/dist-esm/src/keyVaultManagementClient.d.ts.map +1 -0
  14. package/dist-esm/src/keyVaultManagementClient.js +56 -0
  15. package/dist-esm/src/keyVaultManagementClient.js.map +1 -0
  16. package/dist-esm/src/lroImpl.d.ts +16 -0
  17. package/dist-esm/src/lroImpl.d.ts.map +1 -0
  18. package/dist-esm/src/lroImpl.js +29 -0
  19. package/dist-esm/src/lroImpl.js.map +1 -0
  20. package/dist-esm/src/models/index.d.ts +1008 -0
  21. package/dist-esm/src/models/index.d.ts.map +1 -0
  22. package/dist-esm/src/models/index.js +123 -0
  23. package/dist-esm/src/models/index.js.map +1 -0
  24. package/dist-esm/src/models/mappers.d.ts +48 -0
  25. package/dist-esm/src/models/mappers.d.ts.map +1 -0
  26. package/{esm → dist-esm/src}/models/mappers.js +728 -617
  27. package/dist-esm/src/models/mappers.js.map +1 -0
  28. package/dist-esm/src/models/parameters.d.ts +26 -0
  29. package/dist-esm/src/models/parameters.d.ts.map +1 -0
  30. package/dist-esm/src/models/parameters.js +220 -0
  31. package/dist-esm/src/models/parameters.js.map +1 -0
  32. package/{esm → dist-esm/src}/operations/index.d.ts +0 -0
  33. package/dist-esm/src/operations/index.d.ts.map +1 -0
  34. package/{esm → dist-esm/src}/operations/index.js +3 -5
  35. package/dist-esm/src/operations/index.js.map +1 -0
  36. package/dist-esm/src/operations/operations.d.ts +32 -0
  37. package/dist-esm/src/operations/operations.d.ts.map +1 -0
  38. package/dist-esm/src/operations/operations.js +120 -0
  39. package/dist-esm/src/operations/operations.js.map +1 -0
  40. package/dist-esm/src/operations/privateEndpointConnections.d.ts +51 -0
  41. package/dist-esm/src/operations/privateEndpointConnections.d.ts.map +1 -0
  42. package/dist-esm/src/operations/privateEndpointConnections.js +187 -0
  43. package/dist-esm/src/operations/privateEndpointConnections.js.map +1 -0
  44. package/dist-esm/src/operations/privateLinkResources.d.ts +20 -0
  45. package/dist-esm/src/operations/privateLinkResources.d.ts.map +1 -0
  46. package/dist-esm/src/operations/privateLinkResources.js +53 -0
  47. package/dist-esm/src/operations/privateLinkResources.js.map +1 -0
  48. package/dist-esm/src/operations/secrets.d.ts +72 -0
  49. package/dist-esm/src/operations/secrets.d.ts.map +1 -0
  50. package/dist-esm/src/operations/secrets.js +247 -0
  51. package/dist-esm/src/operations/secrets.js.map +1 -0
  52. package/dist-esm/src/operations/vaults.d.ts +166 -0
  53. package/dist-esm/src/operations/vaults.d.ts.map +1 -0
  54. package/dist-esm/src/operations/vaults.js +816 -0
  55. package/dist-esm/src/operations/vaults.js.map +1 -0
  56. package/dist-esm/src/operationsInterfaces/index.d.ts +6 -0
  57. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
  58. package/dist-esm/src/operationsInterfaces/index.js +13 -0
  59. package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
  60. package/dist-esm/src/operationsInterfaces/operations.d.ts +11 -0
  61. package/dist-esm/src/operationsInterfaces/operations.d.ts.map +1 -0
  62. package/dist-esm/src/operationsInterfaces/operations.js +9 -0
  63. package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
  64. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts +43 -0
  65. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts.map +1 -0
  66. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.js +9 -0
  67. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.js.map +1 -0
  68. package/dist-esm/src/operationsInterfaces/privateLinkResources.d.ts +12 -0
  69. package/dist-esm/src/operationsInterfaces/privateLinkResources.d.ts.map +1 -0
  70. package/dist-esm/src/operationsInterfaces/privateLinkResources.js +9 -0
  71. package/dist-esm/src/operationsInterfaces/privateLinkResources.js.map +1 -0
  72. package/dist-esm/src/operationsInterfaces/secrets.d.ts +45 -0
  73. package/dist-esm/src/operationsInterfaces/secrets.d.ts.map +1 -0
  74. package/dist-esm/src/operationsInterfaces/secrets.js +9 -0
  75. package/dist-esm/src/operationsInterfaces/secrets.js.map +1 -0
  76. package/dist-esm/src/operationsInterfaces/vaults.d.ts +103 -0
  77. package/dist-esm/src/operationsInterfaces/vaults.d.ts.map +1 -0
  78. package/dist-esm/src/operationsInterfaces/vaults.js +9 -0
  79. package/dist-esm/src/operationsInterfaces/vaults.js.map +1 -0
  80. package/dist-esm/test/sampleTest.d.ts +2 -0
  81. package/dist-esm/test/sampleTest.d.ts.map +1 -0
  82. package/dist-esm/test/sampleTest.js +40 -0
  83. package/dist-esm/test/sampleTest.js.map +1 -0
  84. package/package.json +74 -23
  85. package/review/arm-keyvault-profile-2020-09-01-hybrid.api.md +876 -0
  86. package/rollup.config.js +115 -30
  87. package/src/index.ts +12 -0
  88. package/src/keyVaultManagementClient.ts +84 -45
  89. package/src/lroImpl.ts +34 -0
  90. package/src/models/index.ts +849 -1276
  91. package/src/models/mappers.ts +730 -609
  92. package/src/models/parameters.ts +153 -76
  93. package/src/operations/index.ts +3 -5
  94. package/src/operations/operations.ts +87 -73
  95. package/src/operations/privateEndpointConnections.ts +174 -154
  96. package/src/operations/privateLinkResources.ts +39 -54
  97. package/src/operations/secrets.ts +215 -248
  98. package/src/operations/vaults.ts +731 -629
  99. package/src/operationsInterfaces/index.ts +13 -0
  100. package/src/operationsInterfaces/operations.ts +22 -0
  101. package/src/operationsInterfaces/privateEndpointConnections.ts +85 -0
  102. package/src/operationsInterfaces/privateLinkResources.ts +27 -0
  103. package/src/operationsInterfaces/secrets.ts +86 -0
  104. package/src/operationsInterfaces/vaults.ts +197 -0
  105. package/tsconfig.json +14 -6
  106. package/types/arm-keyvault-profile-2020-09-01-hybrid.d.ts +1360 -0
  107. package/types/tsdoc-metadata.json +11 -0
  108. package/dist/arm-keyvault-profile-2020-09-01-hybrid.js +0 -3058
  109. package/dist/arm-keyvault-profile-2020-09-01-hybrid.js.map +0 -1
  110. package/dist/arm-keyvault-profile-2020-09-01-hybrid.min.js +0 -1
  111. package/dist/arm-keyvault-profile-2020-09-01-hybrid.min.js.map +0 -1
  112. package/esm/keyVaultManagementClient.d.ts +0 -29
  113. package/esm/keyVaultManagementClient.d.ts.map +0 -1
  114. package/esm/keyVaultManagementClient.js +0 -43
  115. package/esm/keyVaultManagementClient.js.map +0 -1
  116. package/esm/keyVaultManagementClientContext.d.ts +0 -23
  117. package/esm/keyVaultManagementClientContext.d.ts.map +0 -1
  118. package/esm/keyVaultManagementClientContext.js +0 -62
  119. package/esm/keyVaultManagementClientContext.js.map +0 -1
  120. package/esm/models/index.d.ts +0 -1449
  121. package/esm/models/index.d.ts.map +0 -1
  122. package/esm/models/index.js +0 -8
  123. package/esm/models/index.js.map +0 -1
  124. package/esm/models/mappers.d.ts +0 -46
  125. package/esm/models/mappers.d.ts.map +0 -1
  126. package/esm/models/mappers.js.map +0 -1
  127. package/esm/models/operationsMappers.d.ts +0 -2
  128. package/esm/models/operationsMappers.d.ts.map +0 -1
  129. package/esm/models/operationsMappers.js +0 -9
  130. package/esm/models/operationsMappers.js.map +0 -1
  131. package/esm/models/parameters.d.ts +0 -17
  132. package/esm/models/parameters.d.ts.map +0 -1
  133. package/esm/models/parameters.js +0 -178
  134. package/esm/models/parameters.js.map +0 -1
  135. package/esm/models/privateEndpointConnectionsMappers.d.ts +0 -2
  136. package/esm/models/privateEndpointConnectionsMappers.d.ts.map +0 -1
  137. package/esm/models/privateEndpointConnectionsMappers.js +0 -9
  138. package/esm/models/privateEndpointConnectionsMappers.js.map +0 -1
  139. package/esm/models/privateLinkResourcesMappers.d.ts +0 -2
  140. package/esm/models/privateLinkResourcesMappers.d.ts.map +0 -1
  141. package/esm/models/privateLinkResourcesMappers.js +0 -9
  142. package/esm/models/privateLinkResourcesMappers.js.map +0 -1
  143. package/esm/models/secretsMappers.d.ts +0 -2
  144. package/esm/models/secretsMappers.d.ts.map +0 -1
  145. package/esm/models/secretsMappers.js +0 -9
  146. package/esm/models/secretsMappers.js.map +0 -1
  147. package/esm/models/vaultsMappers.d.ts +0 -2
  148. package/esm/models/vaultsMappers.d.ts.map +0 -1
  149. package/esm/models/vaultsMappers.js +0 -9
  150. package/esm/models/vaultsMappers.js.map +0 -1
  151. package/esm/operations/index.d.ts.map +0 -1
  152. package/esm/operations/index.js.map +0 -1
  153. package/esm/operations/operations.d.ts +0 -46
  154. package/esm/operations/operations.d.ts.map +0 -1
  155. package/esm/operations/operations.js +0 -77
  156. package/esm/operations/operations.js.map +0 -1
  157. package/esm/operations/privateEndpointConnections.d.ts +0 -91
  158. package/esm/operations/privateEndpointConnections.d.ts.map +0 -1
  159. package/esm/operations/privateEndpointConnections.js +0 -164
  160. package/esm/operations/privateEndpointConnections.js.map +0 -1
  161. package/esm/operations/privateLinkResources.d.ts +0 -34
  162. package/esm/operations/privateLinkResources.d.ts.map +0 -1
  163. package/esm/operations/privateLinkResources.js +0 -58
  164. package/esm/operations/privateLinkResources.js.map +0 -1
  165. package/esm/operations/secrets.d.ts +0 -139
  166. package/esm/operations/secrets.d.ts.map +0 -1
  167. package/esm/operations/secrets.js +0 -201
  168. package/esm/operations/secrets.js.map +0 -1
  169. package/esm/operations/vaults.d.ts +0 -317
  170. package/esm/operations/vaults.d.ts.map +0 -1
  171. package/esm/operations/vaults.js +0 -557
  172. package/esm/operations/vaults.js.map +0 -1
  173. package/src/keyVaultManagementClientContext.ts +0 -69
  174. package/src/models/operationsMappers.ts +0 -16
  175. package/src/models/privateEndpointConnectionsMappers.ts +0 -40
  176. package/src/models/privateLinkResourcesMappers.ts +0 -39
  177. package/src/models/secretsMappers.ts +0 -39
  178. package/src/models/vaultsMappers.ts +0 -45
@@ -0,0 +1,1360 @@
1
+ import * as coreAuth from '@azure/core-auth';
2
+ import * as coreClient from '@azure/core-client';
3
+ import { PagedAsyncIterableIterator } from '@azure/core-paging';
4
+ import { PollerLike } from '@azure/core-lro';
5
+ import { PollOperationState } from '@azure/core-lro';
6
+
7
+ /** An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. */
8
+ export declare interface AccessPolicyEntry {
9
+ /** The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. */
10
+ tenantId: string;
11
+ /** The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies. */
12
+ objectId: string;
13
+ /** Application ID of the client making request on behalf of a principal */
14
+ applicationId?: string;
15
+ /** Permissions the identity has for keys, secrets and certificates. */
16
+ permissions: Permissions_2;
17
+ }
18
+
19
+ /** Defines values for AccessPolicyUpdateKind. */
20
+ export declare type AccessPolicyUpdateKind = "add" | "replace" | "remove";
21
+
22
+ /** The object attributes managed by the KeyVault service. */
23
+ export declare interface Attributes {
24
+ /** Determines whether the object is enabled. */
25
+ enabled?: boolean;
26
+ /** Not before date in seconds since 1970-01-01T00:00:00Z. */
27
+ notBefore?: Date;
28
+ /** Expiry date in seconds since 1970-01-01T00:00:00Z. */
29
+ expires?: Date;
30
+ /**
31
+ * Creation time in seconds since 1970-01-01T00:00:00Z.
32
+ * NOTE: This property will not be serialized. It can only be populated by the server.
33
+ */
34
+ readonly created?: Date;
35
+ /**
36
+ * Last updated time in seconds since 1970-01-01T00:00:00Z.
37
+ * NOTE: This property will not be serialized. It can only be populated by the server.
38
+ */
39
+ readonly updated?: Date;
40
+ }
41
+
42
+ /**
43
+ * Defines values for CertificatePermissions. \
44
+ * {@link KnownCertificatePermissions} can be used interchangeably with CertificatePermissions,
45
+ * this enum contains the known values that the service supports.
46
+ * ### Known values supported by the service
47
+ * **all** \
48
+ * **get** \
49
+ * **list** \
50
+ * **delete** \
51
+ * **create** \
52
+ * **import** \
53
+ * **update** \
54
+ * **managecontacts** \
55
+ * **getissuers** \
56
+ * **listissuers** \
57
+ * **setissuers** \
58
+ * **deleteissuers** \
59
+ * **manageissuers** \
60
+ * **recover** \
61
+ * **purge** \
62
+ * **backup** \
63
+ * **restore**
64
+ */
65
+ export declare type CertificatePermissions = string;
66
+
67
+ /** The CheckNameAvailability operation response. */
68
+ export declare interface CheckNameAvailabilityResult {
69
+ /**
70
+ * A boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used.
71
+ * NOTE: This property will not be serialized. It can only be populated by the server.
72
+ */
73
+ readonly nameAvailable?: boolean;
74
+ /**
75
+ * The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false.
76
+ * NOTE: This property will not be serialized. It can only be populated by the server.
77
+ */
78
+ readonly reason?: Reason;
79
+ /**
80
+ * An error message explaining the Reason value in more detail.
81
+ * NOTE: This property will not be serialized. It can only be populated by the server.
82
+ */
83
+ readonly message?: string;
84
+ }
85
+
86
+ /** An error response from Key Vault resource provider */
87
+ export declare interface CloudError {
88
+ /** An error response from Key Vault resource provider */
89
+ error?: CloudErrorBody;
90
+ }
91
+
92
+ /** An error response from Key Vault resource provider */
93
+ export declare interface CloudErrorBody {
94
+ /** Error code. This is a mnemonic that can be consumed programmatically. */
95
+ code?: string;
96
+ /** User friendly error message. The message is typically localized and may vary with service version. */
97
+ message?: string;
98
+ }
99
+
100
+ /** Defines values for CreateMode. */
101
+ export declare type CreateMode = "recover" | "default";
102
+
103
+ /** Deleted vault information with extended details. */
104
+ export declare interface DeletedVault {
105
+ /**
106
+ * The resource ID for the deleted key vault.
107
+ * NOTE: This property will not be serialized. It can only be populated by the server.
108
+ */
109
+ readonly id?: string;
110
+ /**
111
+ * The name of the key vault.
112
+ * NOTE: This property will not be serialized. It can only be populated by the server.
113
+ */
114
+ readonly name?: string;
115
+ /**
116
+ * The resource type of the key vault.
117
+ * NOTE: This property will not be serialized. It can only be populated by the server.
118
+ */
119
+ readonly type?: string;
120
+ /** Properties of the vault */
121
+ properties?: DeletedVaultProperties;
122
+ }
123
+
124
+ /** List of vaults */
125
+ export declare interface DeletedVaultListResult {
126
+ /** The list of deleted vaults. */
127
+ value?: DeletedVault[];
128
+ /** The URL to get the next set of deleted vaults. */
129
+ nextLink?: string;
130
+ }
131
+
132
+ /** Properties of the deleted vault. */
133
+ export declare interface DeletedVaultProperties {
134
+ /**
135
+ * The resource id of the original vault.
136
+ * NOTE: This property will not be serialized. It can only be populated by the server.
137
+ */
138
+ readonly vaultId?: string;
139
+ /**
140
+ * The location of the original vault.
141
+ * NOTE: This property will not be serialized. It can only be populated by the server.
142
+ */
143
+ readonly location?: string;
144
+ /**
145
+ * The deleted date.
146
+ * NOTE: This property will not be serialized. It can only be populated by the server.
147
+ */
148
+ readonly deletionDate?: Date;
149
+ /**
150
+ * The scheduled purged date.
151
+ * NOTE: This property will not be serialized. It can only be populated by the server.
152
+ */
153
+ readonly scheduledPurgeDate?: Date;
154
+ /**
155
+ * Tags of the original vault.
156
+ * NOTE: This property will not be serialized. It can only be populated by the server.
157
+ */
158
+ readonly tags?: {
159
+ [propertyName: string]: string;
160
+ };
161
+ /**
162
+ * Purge protection status of the original vault.
163
+ * NOTE: This property will not be serialized. It can only be populated by the server.
164
+ */
165
+ readonly purgeProtectionEnabled?: boolean;
166
+ }
167
+
168
+ /** Type of operation: get, read, delete, etc. */
169
+ export declare interface DimensionProperties {
170
+ /** Name of dimension. */
171
+ name?: string;
172
+ /** Display name of dimension. */
173
+ displayName?: string;
174
+ /** Property to specify whether the dimension should be exported for shoebox. */
175
+ toBeExportedForShoebox?: boolean;
176
+ }
177
+
178
+ /** A rule governing the accessibility of a vault from a specific ip address or ip range. */
179
+ export declare interface IPRule {
180
+ /** An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78). */
181
+ value: string;
182
+ }
183
+
184
+ /**
185
+ * Defines values for KeyPermissions. \
186
+ * {@link KnownKeyPermissions} can be used interchangeably with KeyPermissions,
187
+ * this enum contains the known values that the service supports.
188
+ * ### Known values supported by the service
189
+ * **all** \
190
+ * **encrypt** \
191
+ * **decrypt** \
192
+ * **wrapKey** \
193
+ * **unwrapKey** \
194
+ * **sign** \
195
+ * **verify** \
196
+ * **get** \
197
+ * **list** \
198
+ * **create** \
199
+ * **update** \
200
+ * **import** \
201
+ * **delete** \
202
+ * **backup** \
203
+ * **restore** \
204
+ * **recover** \
205
+ * **purge**
206
+ */
207
+ export declare type KeyPermissions = string;
208
+
209
+ export declare class KeyVaultManagementClient extends coreClient.ServiceClient {
210
+ $host: string;
211
+ apiVersion: string;
212
+ subscriptionId: string;
213
+ /**
214
+ * Initializes a new instance of the KeyVaultManagementClient class.
215
+ * @param credentials Subscription credentials which uniquely identify client subscription.
216
+ * @param subscriptionId Subscription credentials which uniquely identify Microsoft Azure subscription.
217
+ * The subscription ID forms part of the URI for every service call.
218
+ * @param options The parameter options
219
+ */
220
+ constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: KeyVaultManagementClientOptionalParams);
221
+ vaults: Vaults;
222
+ privateEndpointConnections: PrivateEndpointConnections;
223
+ privateLinkResources: PrivateLinkResources;
224
+ operations: Operations;
225
+ secrets: Secrets;
226
+ }
227
+
228
+ /** Optional parameters. */
229
+ export declare interface KeyVaultManagementClientOptionalParams extends coreClient.ServiceClientOptions {
230
+ /** server parameter */
231
+ $host?: string;
232
+ /** Api Version */
233
+ apiVersion?: string;
234
+ /** Overrides client endpoint. */
235
+ endpoint?: string;
236
+ }
237
+
238
+ /** Known values of {@link CertificatePermissions} that the service accepts. */
239
+ export declare enum KnownCertificatePermissions {
240
+ All = "all",
241
+ Get = "get",
242
+ List = "list",
243
+ Delete = "delete",
244
+ Create = "create",
245
+ Import = "import",
246
+ Update = "update",
247
+ Managecontacts = "managecontacts",
248
+ Getissuers = "getissuers",
249
+ Listissuers = "listissuers",
250
+ Setissuers = "setissuers",
251
+ Deleteissuers = "deleteissuers",
252
+ Manageissuers = "manageissuers",
253
+ Recover = "recover",
254
+ Purge = "purge",
255
+ Backup = "backup",
256
+ Restore = "restore"
257
+ }
258
+
259
+ /** Known values of {@link KeyPermissions} that the service accepts. */
260
+ export declare enum KnownKeyPermissions {
261
+ All = "all",
262
+ Encrypt = "encrypt",
263
+ Decrypt = "decrypt",
264
+ WrapKey = "wrapKey",
265
+ UnwrapKey = "unwrapKey",
266
+ Sign = "sign",
267
+ Verify = "verify",
268
+ Get = "get",
269
+ List = "list",
270
+ Create = "create",
271
+ Update = "update",
272
+ Import = "import",
273
+ Delete = "delete",
274
+ Backup = "backup",
275
+ Restore = "restore",
276
+ Recover = "recover",
277
+ Purge = "purge"
278
+ }
279
+
280
+ /** Known values of {@link NetworkRuleAction} that the service accepts. */
281
+ export declare enum KnownNetworkRuleAction {
282
+ Allow = "Allow",
283
+ Deny = "Deny"
284
+ }
285
+
286
+ /** Known values of {@link NetworkRuleBypassOptions} that the service accepts. */
287
+ export declare enum KnownNetworkRuleBypassOptions {
288
+ AzureServices = "AzureServices",
289
+ None = "None"
290
+ }
291
+
292
+ /** Known values of {@link PrivateEndpointConnectionProvisioningState} that the service accepts. */
293
+ export declare enum KnownPrivateEndpointConnectionProvisioningState {
294
+ Succeeded = "Succeeded",
295
+ Creating = "Creating",
296
+ Updating = "Updating",
297
+ Deleting = "Deleting",
298
+ Failed = "Failed",
299
+ Disconnected = "Disconnected"
300
+ }
301
+
302
+ /** Known values of {@link PrivateEndpointServiceConnectionStatus} that the service accepts. */
303
+ export declare enum KnownPrivateEndpointServiceConnectionStatus {
304
+ Pending = "Pending",
305
+ Approved = "Approved",
306
+ Rejected = "Rejected",
307
+ Disconnected = "Disconnected"
308
+ }
309
+
310
+ /** Known values of {@link SecretPermissions} that the service accepts. */
311
+ export declare enum KnownSecretPermissions {
312
+ All = "all",
313
+ Get = "get",
314
+ List = "list",
315
+ Set = "set",
316
+ Delete = "delete",
317
+ Backup = "backup",
318
+ Restore = "restore",
319
+ Recover = "recover",
320
+ Purge = "purge"
321
+ }
322
+
323
+ /** Known values of {@link SkuFamily} that the service accepts. */
324
+ export declare enum KnownSkuFamily {
325
+ A = "A"
326
+ }
327
+
328
+ /** Known values of {@link StoragePermissions} that the service accepts. */
329
+ export declare enum KnownStoragePermissions {
330
+ All = "all",
331
+ Get = "get",
332
+ List = "list",
333
+ Delete = "delete",
334
+ Set = "set",
335
+ Update = "update",
336
+ Regeneratekey = "regeneratekey",
337
+ Recover = "recover",
338
+ Purge = "purge",
339
+ Backup = "backup",
340
+ Restore = "restore",
341
+ Setsas = "setsas",
342
+ Listsas = "listsas",
343
+ Getsas = "getsas",
344
+ Deletesas = "deletesas"
345
+ }
346
+
347
+ /** Known values of {@link VaultProvisioningState} that the service accepts. */
348
+ export declare enum KnownVaultProvisioningState {
349
+ Succeeded = "Succeeded",
350
+ RegisteringDns = "RegisteringDns"
351
+ }
352
+
353
+ /** Log specification of operation. */
354
+ export declare interface LogSpecification {
355
+ /** Name of log specification. */
356
+ name?: string;
357
+ /** Display name of log specification. */
358
+ displayName?: string;
359
+ /** Blob duration of specification. */
360
+ blobDuration?: string;
361
+ }
362
+
363
+ /** Metric specification of operation. */
364
+ export declare interface MetricSpecification {
365
+ /** Name of metric specification. */
366
+ name?: string;
367
+ /** Display name of Metric specification. */
368
+ displayName?: string;
369
+ /** Display description of Metric specification. */
370
+ displayDescription?: string;
371
+ /** The metric unit. Possible values include: 'Bytes', 'Count', 'Milliseconds'. */
372
+ unit?: string;
373
+ /** The metric aggregation type. Possible values include: 'Average', 'Count', 'Total'. */
374
+ aggregationType?: string;
375
+ /** The supported aggregation types for the metrics. */
376
+ supportedAggregationTypes?: string[];
377
+ /** The supported time grain types for the metrics. */
378
+ supportedTimeGrainTypes?: string[];
379
+ /** The metric lock aggregation type. */
380
+ lockAggregationType?: string;
381
+ /** The dimensions of metric */
382
+ dimensions?: DimensionProperties[];
383
+ /** Property to specify whether to fill gap with zero. */
384
+ fillGapWithZero?: boolean;
385
+ /** The internal metric name. */
386
+ internalMetricName?: string;
387
+ }
388
+
389
+ /**
390
+ * Defines values for NetworkRuleAction. \
391
+ * {@link KnownNetworkRuleAction} can be used interchangeably with NetworkRuleAction,
392
+ * this enum contains the known values that the service supports.
393
+ * ### Known values supported by the service
394
+ * **Allow** \
395
+ * **Deny**
396
+ */
397
+ export declare type NetworkRuleAction = string;
398
+
399
+ /**
400
+ * Defines values for NetworkRuleBypassOptions. \
401
+ * {@link KnownNetworkRuleBypassOptions} can be used interchangeably with NetworkRuleBypassOptions,
402
+ * this enum contains the known values that the service supports.
403
+ * ### Known values supported by the service
404
+ * **AzureServices** \
405
+ * **None**
406
+ */
407
+ export declare type NetworkRuleBypassOptions = string;
408
+
409
+ /** A set of rules governing the network accessibility of a vault. */
410
+ export declare interface NetworkRuleSet {
411
+ /** Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'. */
412
+ bypass?: NetworkRuleBypassOptions;
413
+ /** The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. */
414
+ defaultAction?: NetworkRuleAction;
415
+ /** The list of IP address rules. */
416
+ ipRules?: IPRule[];
417
+ /** The list of virtual network rules. */
418
+ virtualNetworkRules?: VirtualNetworkRule[];
419
+ }
420
+
421
+ /** Key Vault REST API operation definition. */
422
+ export declare interface Operation {
423
+ /** Operation name: {provider}/{resource}/{operation} */
424
+ name?: string;
425
+ /** Display metadata associated with the operation. */
426
+ display?: OperationDisplay;
427
+ /** The origin of operations. */
428
+ origin?: string;
429
+ /** Property to specify whether the action is a data action. */
430
+ isDataAction?: boolean;
431
+ /** One property of operation, include metric specifications. */
432
+ serviceSpecification?: ServiceSpecification;
433
+ }
434
+
435
+ /** Display metadata associated with the operation. */
436
+ export declare interface OperationDisplay {
437
+ /** Service provider: Microsoft Key Vault. */
438
+ provider?: string;
439
+ /** Resource on which the operation is performed etc. */
440
+ resource?: string;
441
+ /** Type of operation: get, read, delete, etc. */
442
+ operation?: string;
443
+ /** Description of operation. */
444
+ description?: string;
445
+ }
446
+
447
+ /** Result of the request to list Storage operations. It contains a list of operations and a URL link to get the next set of results. */
448
+ export declare interface OperationListResult {
449
+ /** List of Storage operations supported by the Storage resource provider. */
450
+ value?: Operation[];
451
+ /** The URL to get the next set of operations. */
452
+ nextLink?: string;
453
+ }
454
+
455
+ /** Interface representing a Operations. */
456
+ export declare interface Operations {
457
+ /**
458
+ * Lists all of the available Key Vault Rest API operations.
459
+ * @param options The options parameters.
460
+ */
461
+ list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
462
+ }
463
+
464
+ /** Optional parameters. */
465
+ export declare interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
466
+ }
467
+
468
+ /** Contains response data for the listNext operation. */
469
+ export declare type OperationsListNextResponse = OperationListResult;
470
+
471
+ /** Optional parameters. */
472
+ export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
473
+ }
474
+
475
+ /** Contains response data for the list operation. */
476
+ export declare type OperationsListResponse = OperationListResult;
477
+
478
+ /** Permissions the identity has for keys, secrets, certificates and storage. */
479
+ declare interface Permissions_2 {
480
+ /** Permissions to keys */
481
+ keys?: KeyPermissions[];
482
+ /** Permissions to secrets */
483
+ secrets?: SecretPermissions[];
484
+ /** Permissions to certificates */
485
+ certificates?: CertificatePermissions[];
486
+ /** Permissions to storage accounts */
487
+ storage?: StoragePermissions[];
488
+ }
489
+ export { Permissions_2 as Permissions }
490
+
491
+ /** Private endpoint object properties. */
492
+ export declare interface PrivateEndpoint {
493
+ /**
494
+ * Full identifier of the private endpoint resource.
495
+ * NOTE: This property will not be serialized. It can only be populated by the server.
496
+ */
497
+ readonly id?: string;
498
+ }
499
+
500
+ /** Private endpoint connection resource. */
501
+ export declare type PrivateEndpointConnection = Resource & {
502
+ /** Modified whenever there is a change in the state of private endpoint connection. */
503
+ etag?: string;
504
+ /** Properties of the private endpoint object. */
505
+ privateEndpoint?: PrivateEndpoint;
506
+ /** Approval state of the private link connection. */
507
+ privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
508
+ /**
509
+ * Provisioning state of the private endpoint connection.
510
+ * NOTE: This property will not be serialized. It can only be populated by the server.
511
+ */
512
+ readonly provisioningState?: PrivateEndpointConnectionProvisioningState;
513
+ };
514
+
515
+ /** Private endpoint connection item. */
516
+ export declare interface PrivateEndpointConnectionItem {
517
+ /** Id of private endpoint connection. */
518
+ id?: string;
519
+ /** Modified whenever there is a change in the state of private endpoint connection. */
520
+ etag?: string;
521
+ /** Properties of the private endpoint object. */
522
+ privateEndpoint?: PrivateEndpoint;
523
+ /** Approval state of the private link connection. */
524
+ privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
525
+ /**
526
+ * Provisioning state of the private endpoint connection.
527
+ * NOTE: This property will not be serialized. It can only be populated by the server.
528
+ */
529
+ readonly provisioningState?: PrivateEndpointConnectionProvisioningState;
530
+ }
531
+
532
+ /**
533
+ * Defines values for PrivateEndpointConnectionProvisioningState. \
534
+ * {@link KnownPrivateEndpointConnectionProvisioningState} can be used interchangeably with PrivateEndpointConnectionProvisioningState,
535
+ * this enum contains the known values that the service supports.
536
+ * ### Known values supported by the service
537
+ * **Succeeded** \
538
+ * **Creating** \
539
+ * **Updating** \
540
+ * **Deleting** \
541
+ * **Failed** \
542
+ * **Disconnected**
543
+ */
544
+ export declare type PrivateEndpointConnectionProvisioningState = string;
545
+
546
+ /** Interface representing a PrivateEndpointConnections. */
547
+ export declare interface PrivateEndpointConnections {
548
+ /**
549
+ * Gets the specified private endpoint connection associated with the key vault.
550
+ * @param resourceGroupName Name of the resource group that contains the key vault.
551
+ * @param vaultName The name of the key vault.
552
+ * @param privateEndpointConnectionName Name of the private endpoint connection associated with the key
553
+ * vault.
554
+ * @param options The options parameters.
555
+ */
556
+ get(resourceGroupName: string, vaultName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnectionsGetResponse>;
557
+ /**
558
+ * Updates the specified private endpoint connection associated with the key vault.
559
+ * @param resourceGroupName Name of the resource group that contains the key vault.
560
+ * @param vaultName The name of the key vault.
561
+ * @param privateEndpointConnectionName Name of the private endpoint connection associated with the key
562
+ * vault.
563
+ * @param properties The intended state of private endpoint connection.
564
+ * @param options The options parameters.
565
+ */
566
+ put(resourceGroupName: string, vaultName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsPutOptionalParams): Promise<PrivateEndpointConnectionsPutResponse>;
567
+ /**
568
+ * Deletes the specified private endpoint connection associated with the key vault.
569
+ * @param resourceGroupName Name of the resource group that contains the key vault.
570
+ * @param vaultName The name of the key vault.
571
+ * @param privateEndpointConnectionName Name of the private endpoint connection associated with the key
572
+ * vault.
573
+ * @param options The options parameters.
574
+ */
575
+ beginDelete(resourceGroupName: string, vaultName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnectionsDeleteResponse>, PrivateEndpointConnectionsDeleteResponse>>;
576
+ /**
577
+ * Deletes the specified private endpoint connection associated with the key vault.
578
+ * @param resourceGroupName Name of the resource group that contains the key vault.
579
+ * @param vaultName The name of the key vault.
580
+ * @param privateEndpointConnectionName Name of the private endpoint connection associated with the key
581
+ * vault.
582
+ * @param options The options parameters.
583
+ */
584
+ beginDeleteAndWait(resourceGroupName: string, vaultName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PrivateEndpointConnectionsDeleteResponse>;
585
+ }
586
+
587
+ /** Defines headers for PrivateEndpointConnections_delete operation. */
588
+ export declare interface PrivateEndpointConnectionsDeleteHeaders {
589
+ /** The recommended number of seconds to wait before calling the URI specified in the location header. */
590
+ retryAfter?: number;
591
+ /** The URI to poll for completion status. */
592
+ location?: string;
593
+ }
594
+
595
+ /** Optional parameters. */
596
+ export declare interface PrivateEndpointConnectionsDeleteOptionalParams extends coreClient.OperationOptions {
597
+ /** Delay to wait until next poll, in milliseconds. */
598
+ updateIntervalInMs?: number;
599
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
600
+ resumeFrom?: string;
601
+ }
602
+
603
+ /** Contains response data for the delete operation. */
604
+ export declare type PrivateEndpointConnectionsDeleteResponse = PrivateEndpointConnection;
605
+
606
+ /** Optional parameters. */
607
+ export declare interface PrivateEndpointConnectionsGetOptionalParams extends coreClient.OperationOptions {
608
+ }
609
+
610
+ /** Contains response data for the get operation. */
611
+ export declare type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnection;
612
+
613
+ /** Defines headers for PrivateEndpointConnections_put operation. */
614
+ export declare interface PrivateEndpointConnectionsPutHeaders {
615
+ /** (specified only if operation does not finish synchronously) The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. */
616
+ retryAfter?: number;
617
+ /** (specified only if operation does not finish synchronously) The URI to poll for completion status. The response of this URI may be synchronous or asynchronous. */
618
+ azureAsyncOperation?: string;
619
+ }
620
+
621
+ /** Optional parameters. */
622
+ export declare interface PrivateEndpointConnectionsPutOptionalParams extends coreClient.OperationOptions {
623
+ }
624
+
625
+ /** Contains response data for the put operation. */
626
+ export declare type PrivateEndpointConnectionsPutResponse = PrivateEndpointConnectionsPutHeaders & PrivateEndpointConnection;
627
+
628
+ /**
629
+ * Defines values for PrivateEndpointServiceConnectionStatus. \
630
+ * {@link KnownPrivateEndpointServiceConnectionStatus} can be used interchangeably with PrivateEndpointServiceConnectionStatus,
631
+ * this enum contains the known values that the service supports.
632
+ * ### Known values supported by the service
633
+ * **Pending** \
634
+ * **Approved** \
635
+ * **Rejected** \
636
+ * **Disconnected**
637
+ */
638
+ export declare type PrivateEndpointServiceConnectionStatus = string;
639
+
640
+ /** A private link resource */
641
+ export declare type PrivateLinkResource = Resource & {
642
+ /**
643
+ * Group identifier of private link resource.
644
+ * NOTE: This property will not be serialized. It can only be populated by the server.
645
+ */
646
+ readonly groupId?: string;
647
+ /**
648
+ * Required member names of private link resource.
649
+ * NOTE: This property will not be serialized. It can only be populated by the server.
650
+ */
651
+ readonly requiredMembers?: string[];
652
+ /** Required DNS zone names of the the private link resource. */
653
+ requiredZoneNames?: string[];
654
+ };
655
+
656
+ /** A list of private link resources */
657
+ export declare interface PrivateLinkResourceListResult {
658
+ /** Array of private link resources */
659
+ value?: PrivateLinkResource[];
660
+ }
661
+
662
+ /** Interface representing a PrivateLinkResources. */
663
+ export declare interface PrivateLinkResources {
664
+ /**
665
+ * Gets the private link resources supported for the key vault.
666
+ * @param resourceGroupName Name of the resource group that contains the key vault.
667
+ * @param vaultName The name of the key vault.
668
+ * @param options The options parameters.
669
+ */
670
+ listByVault(resourceGroupName: string, vaultName: string, options?: PrivateLinkResourcesListByVaultOptionalParams): Promise<PrivateLinkResourcesListByVaultResponse>;
671
+ }
672
+
673
+ /** Optional parameters. */
674
+ export declare interface PrivateLinkResourcesListByVaultOptionalParams extends coreClient.OperationOptions {
675
+ }
676
+
677
+ /** Contains response data for the listByVault operation. */
678
+ export declare type PrivateLinkResourcesListByVaultResponse = PrivateLinkResourceListResult;
679
+
680
+ /** An object that represents the approval state of the private link connection. */
681
+ export declare interface PrivateLinkServiceConnectionState {
682
+ /** Indicates whether the connection has been approved, rejected or removed by the key vault owner. */
683
+ status?: PrivateEndpointServiceConnectionStatus;
684
+ /** The reason for approval or rejection. */
685
+ description?: string;
686
+ /** A message indicating if changes on the service provider require any updates on the consumer. */
687
+ actionsRequired?: string;
688
+ }
689
+
690
+ /** Defines values for Reason. */
691
+ export declare type Reason = "AccountNameInvalid" | "AlreadyExists";
692
+
693
+ /** Key Vault resource */
694
+ export declare interface Resource {
695
+ /**
696
+ * Fully qualified identifier of the key vault resource.
697
+ * NOTE: This property will not be serialized. It can only be populated by the server.
698
+ */
699
+ readonly id?: string;
700
+ /**
701
+ * Name of the key vault resource.
702
+ * NOTE: This property will not be serialized. It can only be populated by the server.
703
+ */
704
+ readonly name?: string;
705
+ /**
706
+ * Resource type of the key vault resource.
707
+ * NOTE: This property will not be serialized. It can only be populated by the server.
708
+ */
709
+ readonly type?: string;
710
+ /**
711
+ * Azure location of the key vault resource.
712
+ * NOTE: This property will not be serialized. It can only be populated by the server.
713
+ */
714
+ readonly location?: string;
715
+ /**
716
+ * Tags assigned to the key vault resource.
717
+ * NOTE: This property will not be serialized. It can only be populated by the server.
718
+ */
719
+ readonly tags?: {
720
+ [propertyName: string]: string;
721
+ };
722
+ }
723
+
724
+ /** List of vault resources. */
725
+ export declare interface ResourceListResult {
726
+ /** The list of vault resources. */
727
+ value?: Resource[];
728
+ /** The URL to get the next set of vault resources. */
729
+ nextLink?: string;
730
+ }
731
+
732
+ /** Resource information with extended details. */
733
+ export declare type Secret = Resource & {
734
+ /** Properties of the secret */
735
+ properties: SecretProperties;
736
+ };
737
+
738
+ /** The secret management attributes. */
739
+ export declare type SecretAttributes = Attributes & {};
740
+
741
+ /** Parameters for creating or updating a secret */
742
+ export declare interface SecretCreateOrUpdateParameters {
743
+ /** The tags that will be assigned to the secret. */
744
+ tags?: {
745
+ [propertyName: string]: string;
746
+ };
747
+ /** Properties of the secret */
748
+ properties: SecretProperties;
749
+ }
750
+
751
+ /** List of secrets */
752
+ export declare interface SecretListResult {
753
+ /** The list of secrets. */
754
+ value?: Secret[];
755
+ /** The URL to get the next set of secrets. */
756
+ nextLink?: string;
757
+ }
758
+
759
+ /** Parameters for patching a secret */
760
+ export declare interface SecretPatchParameters {
761
+ /** The tags that will be assigned to the secret. */
762
+ tags?: {
763
+ [propertyName: string]: string;
764
+ };
765
+ /** Properties of the secret */
766
+ properties?: SecretPatchProperties;
767
+ }
768
+
769
+ /** Properties of the secret */
770
+ export declare interface SecretPatchProperties {
771
+ /** The value of the secret. */
772
+ value?: string;
773
+ /** The content type of the secret. */
774
+ contentType?: string;
775
+ /** The attributes of the secret. */
776
+ attributes?: SecretAttributes;
777
+ }
778
+
779
+ /**
780
+ * Defines values for SecretPermissions. \
781
+ * {@link KnownSecretPermissions} can be used interchangeably with SecretPermissions,
782
+ * this enum contains the known values that the service supports.
783
+ * ### Known values supported by the service
784
+ * **all** \
785
+ * **get** \
786
+ * **list** \
787
+ * **set** \
788
+ * **delete** \
789
+ * **backup** \
790
+ * **restore** \
791
+ * **recover** \
792
+ * **purge**
793
+ */
794
+ export declare type SecretPermissions = string;
795
+
796
+ /** Properties of the secret */
797
+ export declare interface SecretProperties {
798
+ /** The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets. */
799
+ value?: string;
800
+ /** The content type of the secret. */
801
+ contentType?: string;
802
+ /** The attributes of the secret. */
803
+ attributes?: SecretAttributes;
804
+ /**
805
+ * The URI to retrieve the current version of the secret.
806
+ * NOTE: This property will not be serialized. It can only be populated by the server.
807
+ */
808
+ readonly secretUri?: string;
809
+ /**
810
+ * The URI to retrieve the specific version of the secret.
811
+ * NOTE: This property will not be serialized. It can only be populated by the server.
812
+ */
813
+ readonly secretUriWithVersion?: string;
814
+ }
815
+
816
+ /** Interface representing a Secrets. */
817
+ export declare interface Secrets {
818
+ /**
819
+ * The List operation gets information about the secrets in a vault. NOTE: This API is intended for
820
+ * internal use in ARM deployments. Users should use the data-plane REST service for interaction with
821
+ * vault secrets.
822
+ * @param resourceGroupName The name of the Resource Group to which the vault belongs.
823
+ * @param vaultName The name of the vault.
824
+ * @param options The options parameters.
825
+ */
826
+ list(resourceGroupName: string, vaultName: string, options?: SecretsListOptionalParams): PagedAsyncIterableIterator<Secret>;
827
+ /**
828
+ * Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended
829
+ * for internal use in ARM deployments. Users should use the data-plane REST service for interaction
830
+ * with vault secrets.
831
+ * @param resourceGroupName The name of the Resource Group to which the vault belongs.
832
+ * @param vaultName Name of the vault
833
+ * @param secretName Name of the secret
834
+ * @param parameters Parameters to create or update the secret
835
+ * @param options The options parameters.
836
+ */
837
+ createOrUpdate(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretCreateOrUpdateParameters, options?: SecretsCreateOrUpdateOptionalParams): Promise<SecretsCreateOrUpdateResponse>;
838
+ /**
839
+ * Update a secret in the specified subscription. NOTE: This API is intended for internal use in ARM
840
+ * deployments. Users should use the data-plane REST service for interaction with vault secrets.
841
+ * @param resourceGroupName The name of the Resource Group to which the vault belongs.
842
+ * @param vaultName Name of the vault
843
+ * @param secretName Name of the secret
844
+ * @param parameters Parameters to patch the secret
845
+ * @param options The options parameters.
846
+ */
847
+ update(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretPatchParameters, options?: SecretsUpdateOptionalParams): Promise<SecretsUpdateResponse>;
848
+ /**
849
+ * Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users
850
+ * should use the data-plane REST service for interaction with vault secrets.
851
+ * @param resourceGroupName The name of the Resource Group to which the vault belongs.
852
+ * @param vaultName The name of the vault.
853
+ * @param secretName The name of the secret.
854
+ * @param options The options parameters.
855
+ */
856
+ get(resourceGroupName: string, vaultName: string, secretName: string, options?: SecretsGetOptionalParams): Promise<SecretsGetResponse>;
857
+ }
858
+
859
+ /** Optional parameters. */
860
+ export declare interface SecretsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
861
+ }
862
+
863
+ /** Contains response data for the createOrUpdate operation. */
864
+ export declare type SecretsCreateOrUpdateResponse = Secret;
865
+
866
+ /** Optional parameters. */
867
+ export declare interface SecretsGetOptionalParams extends coreClient.OperationOptions {
868
+ }
869
+
870
+ /** Contains response data for the get operation. */
871
+ export declare type SecretsGetResponse = Secret;
872
+
873
+ /** Optional parameters. */
874
+ export declare interface SecretsListNextOptionalParams extends coreClient.OperationOptions {
875
+ /** Maximum number of results to return. */
876
+ top?: number;
877
+ }
878
+
879
+ /** Contains response data for the listNext operation. */
880
+ export declare type SecretsListNextResponse = SecretListResult;
881
+
882
+ /** Optional parameters. */
883
+ export declare interface SecretsListOptionalParams extends coreClient.OperationOptions {
884
+ /** Maximum number of results to return. */
885
+ top?: number;
886
+ }
887
+
888
+ /** Contains response data for the list operation. */
889
+ export declare type SecretsListResponse = SecretListResult;
890
+
891
+ /** Optional parameters. */
892
+ export declare interface SecretsUpdateOptionalParams extends coreClient.OperationOptions {
893
+ }
894
+
895
+ /** Contains response data for the update operation. */
896
+ export declare type SecretsUpdateResponse = Secret;
897
+
898
+ /** One property of operation, include log specifications. */
899
+ export declare interface ServiceSpecification {
900
+ /** Log specifications of operation. */
901
+ logSpecifications?: LogSpecification[];
902
+ /** Metric specifications of operation. */
903
+ metricSpecifications?: MetricSpecification[];
904
+ }
905
+
906
+ /** SKU details */
907
+ export declare interface Sku {
908
+ /** SKU family name */
909
+ family: SkuFamily;
910
+ /** SKU name to specify whether the key vault is a standard vault or a premium vault. */
911
+ name: SkuName;
912
+ }
913
+
914
+ /**
915
+ * Defines values for SkuFamily. \
916
+ * {@link KnownSkuFamily} can be used interchangeably with SkuFamily,
917
+ * this enum contains the known values that the service supports.
918
+ * ### Known values supported by the service
919
+ * **A**
920
+ */
921
+ export declare type SkuFamily = string;
922
+
923
+ /** Defines values for SkuName. */
924
+ export declare type SkuName = "standard" | "premium";
925
+
926
+ /**
927
+ * Defines values for StoragePermissions. \
928
+ * {@link KnownStoragePermissions} can be used interchangeably with StoragePermissions,
929
+ * this enum contains the known values that the service supports.
930
+ * ### Known values supported by the service
931
+ * **all** \
932
+ * **get** \
933
+ * **list** \
934
+ * **delete** \
935
+ * **set** \
936
+ * **update** \
937
+ * **regeneratekey** \
938
+ * **recover** \
939
+ * **purge** \
940
+ * **backup** \
941
+ * **restore** \
942
+ * **setsas** \
943
+ * **listsas** \
944
+ * **getsas** \
945
+ * **deletesas**
946
+ */
947
+ export declare type StoragePermissions = string;
948
+
949
+ /** Resource information with extended details. */
950
+ export declare interface Vault {
951
+ /**
952
+ * Fully qualified identifier of the key vault resource.
953
+ * NOTE: This property will not be serialized. It can only be populated by the server.
954
+ */
955
+ readonly id?: string;
956
+ /**
957
+ * Name of the key vault resource.
958
+ * NOTE: This property will not be serialized. It can only be populated by the server.
959
+ */
960
+ readonly name?: string;
961
+ /**
962
+ * Resource type of the key vault resource.
963
+ * NOTE: This property will not be serialized. It can only be populated by the server.
964
+ */
965
+ readonly type?: string;
966
+ /** Azure location of the key vault resource. */
967
+ location?: string;
968
+ /** Tags assigned to the key vault resource. */
969
+ tags?: {
970
+ [propertyName: string]: string;
971
+ };
972
+ /** Properties of the vault */
973
+ properties: VaultProperties;
974
+ }
975
+
976
+ /** Parameters for updating the access policy in a vault */
977
+ export declare interface VaultAccessPolicyParameters {
978
+ /**
979
+ * The resource id of the access policy.
980
+ * NOTE: This property will not be serialized. It can only be populated by the server.
981
+ */
982
+ readonly id?: string;
983
+ /**
984
+ * The resource name of the access policy.
985
+ * NOTE: This property will not be serialized. It can only be populated by the server.
986
+ */
987
+ readonly name?: string;
988
+ /**
989
+ * The resource name of the access policy.
990
+ * NOTE: This property will not be serialized. It can only be populated by the server.
991
+ */
992
+ readonly type?: string;
993
+ /**
994
+ * The resource type of the access policy.
995
+ * NOTE: This property will not be serialized. It can only be populated by the server.
996
+ */
997
+ readonly location?: string;
998
+ /** Properties of the access policy */
999
+ properties: VaultAccessPolicyProperties;
1000
+ }
1001
+
1002
+ /** Properties of the vault access policy */
1003
+ export declare interface VaultAccessPolicyProperties {
1004
+ /** An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. */
1005
+ accessPolicies: AccessPolicyEntry[];
1006
+ }
1007
+
1008
+ /** The parameters used to check the availability of the vault name. */
1009
+ export declare interface VaultCheckNameAvailabilityParameters {
1010
+ /** The vault name. */
1011
+ name: string;
1012
+ /** The type of resource, Microsoft.KeyVault/vaults */
1013
+ type: "Microsoft.KeyVault/vaults";
1014
+ }
1015
+
1016
+ /** Parameters for creating or updating a vault */
1017
+ export declare interface VaultCreateOrUpdateParameters {
1018
+ /** The supported Azure location where the key vault should be created. */
1019
+ location: string;
1020
+ /** The tags that will be assigned to the key vault. */
1021
+ tags?: {
1022
+ [propertyName: string]: string;
1023
+ };
1024
+ /** Properties of the vault */
1025
+ properties: VaultProperties;
1026
+ }
1027
+
1028
+ /** List of vaults */
1029
+ export declare interface VaultListResult {
1030
+ /** The list of vaults. */
1031
+ value?: Vault[];
1032
+ /** The URL to get the next set of vaults. */
1033
+ nextLink?: string;
1034
+ }
1035
+
1036
+ /** Parameters for creating or updating a vault */
1037
+ export declare interface VaultPatchParameters {
1038
+ /** The tags that will be assigned to the key vault. */
1039
+ tags?: {
1040
+ [propertyName: string]: string;
1041
+ };
1042
+ /** Properties of the vault */
1043
+ properties?: VaultPatchProperties;
1044
+ }
1045
+
1046
+ /** Properties of the vault */
1047
+ export declare interface VaultPatchProperties {
1048
+ /** The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. */
1049
+ tenantId?: string;
1050
+ /** SKU details */
1051
+ sku?: Sku;
1052
+ /** An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. */
1053
+ accessPolicies?: AccessPolicyEntry[];
1054
+ /** Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. */
1055
+ enabledForDeployment?: boolean;
1056
+ /** Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. */
1057
+ enabledForDiskEncryption?: boolean;
1058
+ /** Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. */
1059
+ enabledForTemplateDeployment?: boolean;
1060
+ /** Property to specify whether the 'soft delete' functionality is enabled for this key vault. Once set to true, it cannot be reverted to false. */
1061
+ enableSoftDelete?: boolean;
1062
+ /** Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change. */
1063
+ enableRbacAuthorization?: boolean;
1064
+ /** softDelete data retention days. It accepts >=7 and <=90. */
1065
+ softDeleteRetentionInDays?: number;
1066
+ /** The vault's create mode to indicate whether the vault need to be recovered or not. */
1067
+ createMode?: CreateMode;
1068
+ /** Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value. */
1069
+ enablePurgeProtection?: boolean;
1070
+ /** A collection of rules governing the accessibility of the vault from specific network locations. */
1071
+ networkAcls?: NetworkRuleSet;
1072
+ }
1073
+
1074
+ /** Properties of the vault */
1075
+ export declare interface VaultProperties {
1076
+ /** The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. */
1077
+ tenantId: string;
1078
+ /** SKU details */
1079
+ sku: Sku;
1080
+ /** An array of 0 to 1024 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. When `createMode` is set to `recover`, access policies are not required. Otherwise, access policies are required. */
1081
+ accessPolicies?: AccessPolicyEntry[];
1082
+ /** The URI of the vault for performing operations on keys and secrets. This property is readonly */
1083
+ vaultUri?: string;
1084
+ /**
1085
+ * The resource id of HSM Pool.
1086
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1087
+ */
1088
+ readonly hsmPoolResourceId?: string;
1089
+ /** Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. */
1090
+ enabledForDeployment?: boolean;
1091
+ /** Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. */
1092
+ enabledForDiskEncryption?: boolean;
1093
+ /** Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. */
1094
+ enabledForTemplateDeployment?: boolean;
1095
+ /** Property to specify whether the 'soft delete' functionality is enabled for this key vault. If it's not set to any value(true or false) when creating new key vault, it will be set to true by default. Once set to true, it cannot be reverted to false. */
1096
+ enableSoftDelete?: boolean;
1097
+ /** softDelete data retention days. It accepts >=7 and <=90. */
1098
+ softDeleteRetentionInDays?: number;
1099
+ /** Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC. */
1100
+ enableRbacAuthorization?: boolean;
1101
+ /** The vault's create mode to indicate whether the vault need to be recovered or not. */
1102
+ createMode?: CreateMode;
1103
+ /** Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value. */
1104
+ enablePurgeProtection?: boolean;
1105
+ /** Rules governing the accessibility of the key vault from specific network locations. */
1106
+ networkAcls?: NetworkRuleSet;
1107
+ /** Provisioning state of the vault. */
1108
+ provisioningState?: VaultProvisioningState;
1109
+ /**
1110
+ * List of private endpoint connections associated with the key vault.
1111
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1112
+ */
1113
+ readonly privateEndpointConnections?: PrivateEndpointConnectionItem[];
1114
+ }
1115
+
1116
+ /**
1117
+ * Defines values for VaultProvisioningState. \
1118
+ * {@link KnownVaultProvisioningState} can be used interchangeably with VaultProvisioningState,
1119
+ * this enum contains the known values that the service supports.
1120
+ * ### Known values supported by the service
1121
+ * **Succeeded** \
1122
+ * **RegisteringDns**
1123
+ */
1124
+ export declare type VaultProvisioningState = string;
1125
+
1126
+ /** Interface representing a Vaults. */
1127
+ export declare interface Vaults {
1128
+ /**
1129
+ * The List operation gets information about the vaults associated with the subscription and within the
1130
+ * specified resource group.
1131
+ * @param resourceGroupName The name of the Resource Group to which the vault belongs.
1132
+ * @param options The options parameters.
1133
+ */
1134
+ listByResourceGroup(resourceGroupName: string, options?: VaultsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Vault>;
1135
+ /**
1136
+ * The List operation gets information about the vaults associated with the subscription.
1137
+ * @param options The options parameters.
1138
+ */
1139
+ listBySubscription(options?: VaultsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Vault>;
1140
+ /**
1141
+ * Gets information about the deleted vaults in a subscription.
1142
+ * @param options The options parameters.
1143
+ */
1144
+ listDeleted(options?: VaultsListDeletedOptionalParams): PagedAsyncIterableIterator<DeletedVault>;
1145
+ /**
1146
+ * The List operation gets information about the vaults associated with the subscription.
1147
+ * @param options The options parameters.
1148
+ */
1149
+ list(options?: VaultsListOptionalParams): PagedAsyncIterableIterator<Resource>;
1150
+ /**
1151
+ * Create or update a key vault in the specified subscription.
1152
+ * @param resourceGroupName The name of the Resource Group to which the server belongs.
1153
+ * @param vaultName Name of the vault
1154
+ * @param parameters Parameters to create or update the vault
1155
+ * @param options The options parameters.
1156
+ */
1157
+ beginCreateOrUpdate(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: VaultsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VaultsCreateOrUpdateResponse>, VaultsCreateOrUpdateResponse>>;
1158
+ /**
1159
+ * Create or update a key vault in the specified subscription.
1160
+ * @param resourceGroupName The name of the Resource Group to which the server belongs.
1161
+ * @param vaultName Name of the vault
1162
+ * @param parameters Parameters to create or update the vault
1163
+ * @param options The options parameters.
1164
+ */
1165
+ beginCreateOrUpdateAndWait(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: VaultsCreateOrUpdateOptionalParams): Promise<VaultsCreateOrUpdateResponse>;
1166
+ /**
1167
+ * Update a key vault in the specified subscription.
1168
+ * @param resourceGroupName The name of the Resource Group to which the server belongs.
1169
+ * @param vaultName Name of the vault
1170
+ * @param parameters Parameters to patch the vault
1171
+ * @param options The options parameters.
1172
+ */
1173
+ update(resourceGroupName: string, vaultName: string, parameters: VaultPatchParameters, options?: VaultsUpdateOptionalParams): Promise<VaultsUpdateResponse>;
1174
+ /**
1175
+ * Deletes the specified Azure key vault.
1176
+ * @param resourceGroupName The name of the Resource Group to which the vault belongs.
1177
+ * @param vaultName The name of the vault to delete
1178
+ * @param options The options parameters.
1179
+ */
1180
+ delete(resourceGroupName: string, vaultName: string, options?: VaultsDeleteOptionalParams): Promise<void>;
1181
+ /**
1182
+ * Gets the specified Azure key vault.
1183
+ * @param resourceGroupName The name of the Resource Group to which the vault belongs.
1184
+ * @param vaultName The name of the vault.
1185
+ * @param options The options parameters.
1186
+ */
1187
+ get(resourceGroupName: string, vaultName: string, options?: VaultsGetOptionalParams): Promise<VaultsGetResponse>;
1188
+ /**
1189
+ * Update access policies in a key vault in the specified subscription.
1190
+ * @param resourceGroupName The name of the Resource Group to which the vault belongs.
1191
+ * @param vaultName Name of the vault
1192
+ * @param operationKind Name of the operation
1193
+ * @param parameters Access policy to merge into the vault
1194
+ * @param options The options parameters.
1195
+ */
1196
+ updateAccessPolicy(resourceGroupName: string, vaultName: string, operationKind: AccessPolicyUpdateKind, parameters: VaultAccessPolicyParameters, options?: VaultsUpdateAccessPolicyOptionalParams): Promise<VaultsUpdateAccessPolicyResponse>;
1197
+ /**
1198
+ * Gets the deleted Azure key vault.
1199
+ * @param vaultName The name of the vault.
1200
+ * @param location The location of the deleted vault.
1201
+ * @param options The options parameters.
1202
+ */
1203
+ getDeleted(vaultName: string, location: string, options?: VaultsGetDeletedOptionalParams): Promise<VaultsGetDeletedResponse>;
1204
+ /**
1205
+ * Permanently deletes the specified vault. aka Purges the deleted Azure key vault.
1206
+ * @param vaultName The name of the soft-deleted vault.
1207
+ * @param location The location of the soft-deleted vault.
1208
+ * @param options The options parameters.
1209
+ */
1210
+ beginPurgeDeleted(vaultName: string, location: string, options?: VaultsPurgeDeletedOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
1211
+ /**
1212
+ * Permanently deletes the specified vault. aka Purges the deleted Azure key vault.
1213
+ * @param vaultName The name of the soft-deleted vault.
1214
+ * @param location The location of the soft-deleted vault.
1215
+ * @param options The options parameters.
1216
+ */
1217
+ beginPurgeDeletedAndWait(vaultName: string, location: string, options?: VaultsPurgeDeletedOptionalParams): Promise<void>;
1218
+ /**
1219
+ * Checks that the vault name is valid and is not already in use.
1220
+ * @param vaultName The name of the vault.
1221
+ * @param options The options parameters.
1222
+ */
1223
+ checkNameAvailability(vaultName: VaultCheckNameAvailabilityParameters, options?: VaultsCheckNameAvailabilityOptionalParams): Promise<VaultsCheckNameAvailabilityResponse>;
1224
+ }
1225
+
1226
+ /** Optional parameters. */
1227
+ export declare interface VaultsCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
1228
+ }
1229
+
1230
+ /** Contains response data for the checkNameAvailability operation. */
1231
+ export declare type VaultsCheckNameAvailabilityResponse = CheckNameAvailabilityResult;
1232
+
1233
+ /** Optional parameters. */
1234
+ export declare interface VaultsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
1235
+ /** Delay to wait until next poll, in milliseconds. */
1236
+ updateIntervalInMs?: number;
1237
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1238
+ resumeFrom?: string;
1239
+ }
1240
+
1241
+ /** Contains response data for the createOrUpdate operation. */
1242
+ export declare type VaultsCreateOrUpdateResponse = Vault;
1243
+
1244
+ /** Optional parameters. */
1245
+ export declare interface VaultsDeleteOptionalParams extends coreClient.OperationOptions {
1246
+ }
1247
+
1248
+ /** Optional parameters. */
1249
+ export declare interface VaultsGetDeletedOptionalParams extends coreClient.OperationOptions {
1250
+ }
1251
+
1252
+ /** Contains response data for the getDeleted operation. */
1253
+ export declare type VaultsGetDeletedResponse = DeletedVault;
1254
+
1255
+ /** Optional parameters. */
1256
+ export declare interface VaultsGetOptionalParams extends coreClient.OperationOptions {
1257
+ }
1258
+
1259
+ /** Contains response data for the get operation. */
1260
+ export declare type VaultsGetResponse = Vault;
1261
+
1262
+ /** Optional parameters. */
1263
+ export declare interface VaultsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
1264
+ /** Maximum number of results to return. */
1265
+ top?: number;
1266
+ }
1267
+
1268
+ /** Contains response data for the listByResourceGroupNext operation. */
1269
+ export declare type VaultsListByResourceGroupNextResponse = VaultListResult;
1270
+
1271
+ /** Optional parameters. */
1272
+ export declare interface VaultsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
1273
+ /** Maximum number of results to return. */
1274
+ top?: number;
1275
+ }
1276
+
1277
+ /** Contains response data for the listByResourceGroup operation. */
1278
+ export declare type VaultsListByResourceGroupResponse = VaultListResult;
1279
+
1280
+ /** Optional parameters. */
1281
+ export declare interface VaultsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
1282
+ /** Maximum number of results to return. */
1283
+ top?: number;
1284
+ }
1285
+
1286
+ /** Contains response data for the listBySubscriptionNext operation. */
1287
+ export declare type VaultsListBySubscriptionNextResponse = VaultListResult;
1288
+
1289
+ /** Optional parameters. */
1290
+ export declare interface VaultsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
1291
+ /** Maximum number of results to return. */
1292
+ top?: number;
1293
+ }
1294
+
1295
+ /** Contains response data for the listBySubscription operation. */
1296
+ export declare type VaultsListBySubscriptionResponse = VaultListResult;
1297
+
1298
+ /** Optional parameters. */
1299
+ export declare interface VaultsListDeletedNextOptionalParams extends coreClient.OperationOptions {
1300
+ }
1301
+
1302
+ /** Contains response data for the listDeletedNext operation. */
1303
+ export declare type VaultsListDeletedNextResponse = DeletedVaultListResult;
1304
+
1305
+ /** Optional parameters. */
1306
+ export declare interface VaultsListDeletedOptionalParams extends coreClient.OperationOptions {
1307
+ }
1308
+
1309
+ /** Contains response data for the listDeleted operation. */
1310
+ export declare type VaultsListDeletedResponse = DeletedVaultListResult;
1311
+
1312
+ /** Optional parameters. */
1313
+ export declare interface VaultsListNextOptionalParams extends coreClient.OperationOptions {
1314
+ /** Maximum number of results to return. */
1315
+ top?: number;
1316
+ }
1317
+
1318
+ /** Contains response data for the listNext operation. */
1319
+ export declare type VaultsListNextResponse = ResourceListResult;
1320
+
1321
+ /** Optional parameters. */
1322
+ export declare interface VaultsListOptionalParams extends coreClient.OperationOptions {
1323
+ /** Maximum number of results to return. */
1324
+ top?: number;
1325
+ }
1326
+
1327
+ /** Contains response data for the list operation. */
1328
+ export declare type VaultsListResponse = ResourceListResult;
1329
+
1330
+ /** Optional parameters. */
1331
+ export declare interface VaultsPurgeDeletedOptionalParams extends coreClient.OperationOptions {
1332
+ /** Delay to wait until next poll, in milliseconds. */
1333
+ updateIntervalInMs?: number;
1334
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1335
+ resumeFrom?: string;
1336
+ }
1337
+
1338
+ /** Optional parameters. */
1339
+ export declare interface VaultsUpdateAccessPolicyOptionalParams extends coreClient.OperationOptions {
1340
+ }
1341
+
1342
+ /** Contains response data for the updateAccessPolicy operation. */
1343
+ export declare type VaultsUpdateAccessPolicyResponse = VaultAccessPolicyParameters;
1344
+
1345
+ /** Optional parameters. */
1346
+ export declare interface VaultsUpdateOptionalParams extends coreClient.OperationOptions {
1347
+ }
1348
+
1349
+ /** Contains response data for the update operation. */
1350
+ export declare type VaultsUpdateResponse = Vault;
1351
+
1352
+ /** A rule governing the accessibility of a vault from a specific virtual network. */
1353
+ export declare interface VirtualNetworkRule {
1354
+ /** Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. */
1355
+ id: string;
1356
+ /** Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured. */
1357
+ ignoreMissingVnetServiceEndpoint?: boolean;
1358
+ }
1359
+
1360
+ export { }