@azure/provisioning-keyvault 1.0.0-beta.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.
- package/CHANGELOG.md +7 -0
- package/LICENSE +21 -0
- package/README.md +29 -0
- package/dist/browser/deleted-managed-hsm.d.ts +33 -0
- package/dist/browser/deleted-managed-hsm.d.ts.map +1 -0
- package/dist/browser/deleted-managed-hsm.js +68 -0
- package/dist/browser/deleted-managed-hsm.js.map +1 -0
- package/dist/browser/deleted-vault.d.ts +33 -0
- package/dist/browser/deleted-vault.d.ts.map +1 -0
- package/dist/browser/deleted-vault.js +68 -0
- package/dist/browser/deleted-vault.js.map +1 -0
- package/dist/browser/index.d.ts +6 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/dist/browser/index.js +8 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/browser/key-vault.d.ts +326 -0
- package/dist/browser/key-vault.d.ts.map +1 -0
- package/dist/browser/key-vault.js +482 -0
- package/dist/browser/key-vault.js.map +1 -0
- package/dist/browser/managed-hsm.d.ts +263 -0
- package/dist/browser/managed-hsm.d.ts.map +1 -0
- package/dist/browser/managed-hsm.js +374 -0
- package/dist/browser/managed-hsm.js.map +1 -0
- package/dist/browser/package.json +8 -0
- package/dist/browser/types.d.ts +2404 -0
- package/dist/browser/types.d.ts.map +1 -0
- package/dist/browser/types.js +472 -0
- package/dist/browser/types.js.map +1 -0
- package/dist/commonjs/deleted-managed-hsm.d.ts +33 -0
- package/dist/commonjs/deleted-managed-hsm.d.ts.map +1 -0
- package/dist/commonjs/deleted-managed-hsm.js +91 -0
- package/dist/commonjs/deleted-managed-hsm.js.map +7 -0
- package/dist/commonjs/deleted-vault.d.ts +33 -0
- package/dist/commonjs/deleted-vault.d.ts.map +1 -0
- package/dist/commonjs/deleted-vault.js +91 -0
- package/dist/commonjs/deleted-vault.js.map +7 -0
- package/dist/commonjs/index.d.ts +6 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +66 -0
- package/dist/commonjs/index.js.map +7 -0
- package/dist/commonjs/key-vault.d.ts +326 -0
- package/dist/commonjs/key-vault.d.ts.map +1 -0
- package/dist/commonjs/key-vault.js +510 -0
- package/dist/commonjs/key-vault.js.map +7 -0
- package/dist/commonjs/managed-hsm.d.ts +263 -0
- package/dist/commonjs/managed-hsm.d.ts.map +1 -0
- package/dist/commonjs/managed-hsm.js +400 -0
- package/dist/commonjs/managed-hsm.js.map +7 -0
- package/dist/commonjs/package.json +8 -0
- package/dist/commonjs/tsdoc-metadata.json +11 -0
- package/dist/commonjs/types.d.ts +2404 -0
- package/dist/commonjs/types.d.ts.map +1 -0
- package/dist/commonjs/types.js +586 -0
- package/dist/commonjs/types.js.map +7 -0
- package/dist/esm/deleted-managed-hsm.d.ts +33 -0
- package/dist/esm/deleted-managed-hsm.d.ts.map +1 -0
- package/dist/esm/deleted-managed-hsm.js +68 -0
- package/dist/esm/deleted-managed-hsm.js.map +1 -0
- package/dist/esm/deleted-vault.d.ts +33 -0
- package/dist/esm/deleted-vault.d.ts.map +1 -0
- package/dist/esm/deleted-vault.js +68 -0
- package/dist/esm/deleted-vault.js.map +1 -0
- package/dist/esm/index.d.ts +6 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +8 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/key-vault.d.ts +326 -0
- package/dist/esm/key-vault.d.ts.map +1 -0
- package/dist/esm/key-vault.js +482 -0
- package/dist/esm/key-vault.js.map +1 -0
- package/dist/esm/managed-hsm.d.ts +263 -0
- package/dist/esm/managed-hsm.d.ts.map +1 -0
- package/dist/esm/managed-hsm.js +374 -0
- package/dist/esm/managed-hsm.js.map +1 -0
- package/dist/esm/package.json +8 -0
- package/dist/esm/types.d.ts +2404 -0
- package/dist/esm/types.d.ts.map +1 -0
- package/dist/esm/types.js +472 -0
- package/dist/esm/types.js.map +1 -0
- package/package.json +105 -0
|
@@ -0,0 +1,2404 @@
|
|
|
1
|
+
import type { Expression, ExpressionOrValue } from "@azure/provisioning-core";
|
|
2
|
+
import { type FlatModelShape, type InputArray, type InputOf, type InputRecord } from "@azure/provisioning-core/internal";
|
|
3
|
+
/**
|
|
4
|
+
* The vault's create mode to indicate whether the vault need to be recovered or not.
|
|
5
|
+
*/
|
|
6
|
+
export type CreateMode = "recover" | "default";
|
|
7
|
+
/**
|
|
8
|
+
* The type of action.
|
|
9
|
+
*/
|
|
10
|
+
export type KeyRotationPolicyActionType = "rotate" | "notify";
|
|
11
|
+
/**
|
|
12
|
+
* SKU of the managed HSM Pool
|
|
13
|
+
*/
|
|
14
|
+
export type ManagedHsmSkuName = "Standard_B1" | "Custom_B32" | "Custom_B6" | "Custom_C42" | "Custom_C10";
|
|
15
|
+
/**
|
|
16
|
+
* SKU name to specify whether the key vault is a standard vault or a premium vault.
|
|
17
|
+
*/
|
|
18
|
+
export type SkuName = "standard" | "premium";
|
|
19
|
+
/**
|
|
20
|
+
* 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.
|
|
21
|
+
*/
|
|
22
|
+
export interface AccessPolicyEntry {
|
|
23
|
+
/**
|
|
24
|
+
* Application ID of the client making request on behalf of a principal
|
|
25
|
+
*/
|
|
26
|
+
applicationId?: string;
|
|
27
|
+
/**
|
|
28
|
+
* 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.
|
|
29
|
+
*/
|
|
30
|
+
objectId: string;
|
|
31
|
+
/**
|
|
32
|
+
* Permissions the identity has for keys, secrets and certificates.
|
|
33
|
+
*/
|
|
34
|
+
permissions: Permissions;
|
|
35
|
+
/**
|
|
36
|
+
* The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
|
|
37
|
+
*/
|
|
38
|
+
tenantId: string;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Input type for 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.
|
|
42
|
+
*/
|
|
43
|
+
export interface AccessPolicyEntryInput extends InputOf<AccessPolicyEntry> {
|
|
44
|
+
/**
|
|
45
|
+
* Application ID of the client making request on behalf of a principal
|
|
46
|
+
*/
|
|
47
|
+
applicationId?: ExpressionOrValue<string> | undefined;
|
|
48
|
+
/**
|
|
49
|
+
* 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.
|
|
50
|
+
*/
|
|
51
|
+
objectId: ExpressionOrValue<string>;
|
|
52
|
+
/**
|
|
53
|
+
* Permissions the identity has for keys, secrets and certificates.
|
|
54
|
+
*/
|
|
55
|
+
permissions: PermissionsInput;
|
|
56
|
+
/**
|
|
57
|
+
* The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
|
|
58
|
+
*/
|
|
59
|
+
tenantId: ExpressionOrValue<string>;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* View type for 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.
|
|
63
|
+
*/
|
|
64
|
+
export type AccessPolicyEntryView = AccessPolicyEntryInput;
|
|
65
|
+
export declare const accessPolicyEntryShape: FlatModelShape;
|
|
66
|
+
export interface Action {
|
|
67
|
+
/**
|
|
68
|
+
* The type of action.
|
|
69
|
+
*/
|
|
70
|
+
type?: KeyRotationPolicyActionType;
|
|
71
|
+
}
|
|
72
|
+
export interface ActionInput extends InputOf<Action> {
|
|
73
|
+
/**
|
|
74
|
+
* The type of action.
|
|
75
|
+
*/
|
|
76
|
+
type?: ExpressionOrValue<KeyRotationPolicyActionType> | undefined;
|
|
77
|
+
}
|
|
78
|
+
export type ActionView = ActionInput;
|
|
79
|
+
export declare const actionShape: FlatModelShape;
|
|
80
|
+
/**
|
|
81
|
+
* Properties of the deleted managed HSM.
|
|
82
|
+
*/
|
|
83
|
+
export interface DeletedManagedHsmProperties {
|
|
84
|
+
/**
|
|
85
|
+
* The deleted date.
|
|
86
|
+
*/
|
|
87
|
+
deletionDate?: Date;
|
|
88
|
+
/**
|
|
89
|
+
* The location of the original managed HSM.
|
|
90
|
+
*/
|
|
91
|
+
location?: string;
|
|
92
|
+
/**
|
|
93
|
+
* The resource id of the original managed HSM.
|
|
94
|
+
*/
|
|
95
|
+
mhsmId?: string;
|
|
96
|
+
/**
|
|
97
|
+
* Purge protection status of the original managed HSM.
|
|
98
|
+
*/
|
|
99
|
+
purgeProtectionEnabled?: boolean;
|
|
100
|
+
/**
|
|
101
|
+
* The scheduled purged date.
|
|
102
|
+
*/
|
|
103
|
+
scheduledPurgeDate?: Date;
|
|
104
|
+
/**
|
|
105
|
+
* Tags of the original managed HSM.
|
|
106
|
+
*/
|
|
107
|
+
tags?: Record<string, string>;
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Input type for Properties of the deleted managed HSM.
|
|
111
|
+
*/
|
|
112
|
+
export interface DeletedManagedHsmPropertiesInput extends InputOf<DeletedManagedHsmProperties> {
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* View type for Properties of the deleted managed HSM.
|
|
116
|
+
*/
|
|
117
|
+
export interface DeletedManagedHsmPropertiesView extends InputOf<DeletedManagedHsmProperties> {
|
|
118
|
+
/**
|
|
119
|
+
* Read-only output: The deleted date.
|
|
120
|
+
*/
|
|
121
|
+
readonly deletionDate?: Expression<Date> | undefined;
|
|
122
|
+
/**
|
|
123
|
+
* Read-only output: The location of the original managed HSM.
|
|
124
|
+
*/
|
|
125
|
+
readonly location?: Expression<string> | undefined;
|
|
126
|
+
/**
|
|
127
|
+
* Read-only output: The resource id of the original managed HSM.
|
|
128
|
+
*/
|
|
129
|
+
readonly mhsmId?: Expression<string> | undefined;
|
|
130
|
+
/**
|
|
131
|
+
* Read-only output: Purge protection status of the original managed HSM.
|
|
132
|
+
*/
|
|
133
|
+
readonly purgeProtectionEnabled?: Expression<boolean> | undefined;
|
|
134
|
+
/**
|
|
135
|
+
* Read-only output: The scheduled purged date.
|
|
136
|
+
*/
|
|
137
|
+
readonly scheduledPurgeDate?: Expression<Date> | undefined;
|
|
138
|
+
/**
|
|
139
|
+
* Read-only output: Tags of the original managed HSM.
|
|
140
|
+
*/
|
|
141
|
+
readonly tags?: Expression<Record<string, string>> | undefined;
|
|
142
|
+
}
|
|
143
|
+
export declare const deletedManagedHsmPropertiesShape: FlatModelShape;
|
|
144
|
+
/**
|
|
145
|
+
* Properties of the deleted vault.
|
|
146
|
+
*/
|
|
147
|
+
export interface DeletedVaultProperties {
|
|
148
|
+
/**
|
|
149
|
+
* The deleted date.
|
|
150
|
+
*/
|
|
151
|
+
deletionDate?: Date;
|
|
152
|
+
/**
|
|
153
|
+
* The location of the original vault.
|
|
154
|
+
*/
|
|
155
|
+
location?: string;
|
|
156
|
+
/**
|
|
157
|
+
* Purge protection status of the original vault.
|
|
158
|
+
*/
|
|
159
|
+
purgeProtectionEnabled?: boolean;
|
|
160
|
+
/**
|
|
161
|
+
* The scheduled purged date.
|
|
162
|
+
*/
|
|
163
|
+
scheduledPurgeDate?: Date;
|
|
164
|
+
/**
|
|
165
|
+
* Tags of the original vault.
|
|
166
|
+
*/
|
|
167
|
+
tags?: Record<string, string>;
|
|
168
|
+
/**
|
|
169
|
+
* The resource id of the original vault.
|
|
170
|
+
*/
|
|
171
|
+
vaultId?: string;
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Input type for Properties of the deleted vault.
|
|
175
|
+
*/
|
|
176
|
+
export interface DeletedVaultPropertiesInput extends InputOf<DeletedVaultProperties> {
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* View type for Properties of the deleted vault.
|
|
180
|
+
*/
|
|
181
|
+
export interface DeletedVaultPropertiesView extends InputOf<DeletedVaultProperties> {
|
|
182
|
+
/**
|
|
183
|
+
* Read-only output: The deleted date.
|
|
184
|
+
*/
|
|
185
|
+
readonly deletionDate?: Expression<Date> | undefined;
|
|
186
|
+
/**
|
|
187
|
+
* Read-only output: The location of the original vault.
|
|
188
|
+
*/
|
|
189
|
+
readonly location?: Expression<string> | undefined;
|
|
190
|
+
/**
|
|
191
|
+
* Read-only output: Purge protection status of the original vault.
|
|
192
|
+
*/
|
|
193
|
+
readonly purgeProtectionEnabled?: Expression<boolean> | undefined;
|
|
194
|
+
/**
|
|
195
|
+
* Read-only output: The scheduled purged date.
|
|
196
|
+
*/
|
|
197
|
+
readonly scheduledPurgeDate?: Expression<Date> | undefined;
|
|
198
|
+
/**
|
|
199
|
+
* Read-only output: Tags of the original vault.
|
|
200
|
+
*/
|
|
201
|
+
readonly tags?: Expression<Record<string, string>> | undefined;
|
|
202
|
+
/**
|
|
203
|
+
* Read-only output: The resource id of the original vault.
|
|
204
|
+
*/
|
|
205
|
+
readonly vaultId?: Expression<string> | undefined;
|
|
206
|
+
}
|
|
207
|
+
export declare const deletedVaultPropertiesShape: FlatModelShape;
|
|
208
|
+
/**
|
|
209
|
+
* A rule governing the accessibility of a vault from a specific ip address or ip range.
|
|
210
|
+
*/
|
|
211
|
+
export interface IpRule {
|
|
212
|
+
/**
|
|
213
|
+
* 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).
|
|
214
|
+
*/
|
|
215
|
+
value: string;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* Input type for A rule governing the accessibility of a vault from a specific ip address or ip range.
|
|
219
|
+
*/
|
|
220
|
+
export interface IpRuleInput extends InputOf<IpRule> {
|
|
221
|
+
/**
|
|
222
|
+
* 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).
|
|
223
|
+
*/
|
|
224
|
+
value: ExpressionOrValue<string>;
|
|
225
|
+
}
|
|
226
|
+
/**
|
|
227
|
+
* View type for A rule governing the accessibility of a vault from a specific ip address or ip range.
|
|
228
|
+
*/
|
|
229
|
+
export type IpRuleView = IpRuleInput;
|
|
230
|
+
export declare const ipRuleShape: FlatModelShape;
|
|
231
|
+
/**
|
|
232
|
+
* The object attributes managed by the Azure Key Vault service.
|
|
233
|
+
*/
|
|
234
|
+
export interface KeyAttributes {
|
|
235
|
+
/**
|
|
236
|
+
* Creation time in seconds since 1970-01-01T00:00:00Z.
|
|
237
|
+
*/
|
|
238
|
+
created?: number;
|
|
239
|
+
/**
|
|
240
|
+
* Determines whether or not the object is enabled.
|
|
241
|
+
*/
|
|
242
|
+
enabled?: boolean;
|
|
243
|
+
/**
|
|
244
|
+
* Expiry date in seconds since 1970-01-01T00:00:00Z.
|
|
245
|
+
*/
|
|
246
|
+
expires?: number;
|
|
247
|
+
/**
|
|
248
|
+
* Indicates if the private key can be exported.
|
|
249
|
+
*/
|
|
250
|
+
exportable?: boolean;
|
|
251
|
+
/**
|
|
252
|
+
* Not before date in seconds since 1970-01-01T00:00:00Z.
|
|
253
|
+
*/
|
|
254
|
+
notBefore?: number;
|
|
255
|
+
/**
|
|
256
|
+
* The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
|
|
257
|
+
*/
|
|
258
|
+
recoveryLevel?: DeletionRecoveryLevel;
|
|
259
|
+
/**
|
|
260
|
+
* Last updated time in seconds since 1970-01-01T00:00:00Z.
|
|
261
|
+
*/
|
|
262
|
+
updated?: number;
|
|
263
|
+
}
|
|
264
|
+
/**
|
|
265
|
+
* Input type for The object attributes managed by the Azure Key Vault service.
|
|
266
|
+
*/
|
|
267
|
+
export interface KeyAttributesInput extends InputOf<KeyAttributes> {
|
|
268
|
+
/**
|
|
269
|
+
* Determines whether or not the object is enabled.
|
|
270
|
+
*/
|
|
271
|
+
enabled?: ExpressionOrValue<boolean> | undefined;
|
|
272
|
+
/**
|
|
273
|
+
* Expiry date in seconds since 1970-01-01T00:00:00Z.
|
|
274
|
+
*/
|
|
275
|
+
expires?: ExpressionOrValue<number> | undefined;
|
|
276
|
+
/**
|
|
277
|
+
* Indicates if the private key can be exported.
|
|
278
|
+
*/
|
|
279
|
+
exportable?: ExpressionOrValue<boolean> | undefined;
|
|
280
|
+
/**
|
|
281
|
+
* Not before date in seconds since 1970-01-01T00:00:00Z.
|
|
282
|
+
*/
|
|
283
|
+
notBefore?: ExpressionOrValue<number> | undefined;
|
|
284
|
+
}
|
|
285
|
+
/**
|
|
286
|
+
* View type for The object attributes managed by the Azure Key Vault service.
|
|
287
|
+
*/
|
|
288
|
+
export interface KeyAttributesView extends InputOf<KeyAttributes> {
|
|
289
|
+
/**
|
|
290
|
+
* Read-only output: Creation time in seconds since 1970-01-01T00:00:00Z.
|
|
291
|
+
*/
|
|
292
|
+
readonly created?: Expression<number> | undefined;
|
|
293
|
+
/**
|
|
294
|
+
* Determines whether or not the object is enabled.
|
|
295
|
+
*/
|
|
296
|
+
enabled?: ExpressionOrValue<boolean> | undefined;
|
|
297
|
+
/**
|
|
298
|
+
* Expiry date in seconds since 1970-01-01T00:00:00Z.
|
|
299
|
+
*/
|
|
300
|
+
expires?: ExpressionOrValue<number> | undefined;
|
|
301
|
+
/**
|
|
302
|
+
* Indicates if the private key can be exported.
|
|
303
|
+
*/
|
|
304
|
+
exportable?: ExpressionOrValue<boolean> | undefined;
|
|
305
|
+
/**
|
|
306
|
+
* Not before date in seconds since 1970-01-01T00:00:00Z.
|
|
307
|
+
*/
|
|
308
|
+
notBefore?: ExpressionOrValue<number> | undefined;
|
|
309
|
+
/**
|
|
310
|
+
* Read-only output: The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
|
|
311
|
+
*/
|
|
312
|
+
readonly recoveryLevel?: Expression<DeletionRecoveryLevel> | undefined;
|
|
313
|
+
/**
|
|
314
|
+
* Read-only output: Last updated time in seconds since 1970-01-01T00:00:00Z.
|
|
315
|
+
*/
|
|
316
|
+
readonly updated?: Expression<number> | undefined;
|
|
317
|
+
}
|
|
318
|
+
export declare const keyAttributesShape: FlatModelShape;
|
|
319
|
+
/**
|
|
320
|
+
* The properties of the key.
|
|
321
|
+
*/
|
|
322
|
+
export interface KeyProperties {
|
|
323
|
+
/**
|
|
324
|
+
* The attributes of the key.
|
|
325
|
+
*/
|
|
326
|
+
attributes?: KeyAttributes;
|
|
327
|
+
/**
|
|
328
|
+
* The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256
|
|
329
|
+
*/
|
|
330
|
+
curveName?: JsonWebKeyCurveName;
|
|
331
|
+
keyOps?: JsonWebKeyOperation[];
|
|
332
|
+
/**
|
|
333
|
+
* The key size in bits. For example: 2048, 3072, or 4096 for RSA. Default for RSA and RSA-HSM keys is 2048. Exception made for bring your own key (BYOK), key exchange keys default to 4096.
|
|
334
|
+
*/
|
|
335
|
+
keySize?: number;
|
|
336
|
+
/**
|
|
337
|
+
* The URI to retrieve the current version of the key.
|
|
338
|
+
*/
|
|
339
|
+
keyUri?: string;
|
|
340
|
+
/**
|
|
341
|
+
* The URI to retrieve the specific version of the key.
|
|
342
|
+
*/
|
|
343
|
+
keyUriWithVersion?: string;
|
|
344
|
+
/**
|
|
345
|
+
* The type of the key. For valid values, see JsonWebKeyType.
|
|
346
|
+
*/
|
|
347
|
+
kty?: JsonWebKeyType;
|
|
348
|
+
/**
|
|
349
|
+
* Key release policy in response. It will be used for both output and input. Omitted if empty
|
|
350
|
+
*/
|
|
351
|
+
releasePolicy?: KeyReleasePolicy;
|
|
352
|
+
/**
|
|
353
|
+
* Key rotation policy in response. It will be used for both output and input. Omitted if empty
|
|
354
|
+
*/
|
|
355
|
+
rotationPolicy?: RotationPolicy;
|
|
356
|
+
}
|
|
357
|
+
/**
|
|
358
|
+
* Input type for The properties of the key.
|
|
359
|
+
*/
|
|
360
|
+
export interface KeyPropertiesInput extends InputOf<KeyProperties> {
|
|
361
|
+
/**
|
|
362
|
+
* The attributes of the key.
|
|
363
|
+
*/
|
|
364
|
+
attributes?: KeyAttributesInput | undefined;
|
|
365
|
+
/**
|
|
366
|
+
* The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256
|
|
367
|
+
*/
|
|
368
|
+
curveName?: ExpressionOrValue<JsonWebKeyCurveName> | undefined;
|
|
369
|
+
keyOps?: InputArray<ExpressionOrValue<JsonWebKeyOperation>, JsonWebKeyOperation[]> | undefined;
|
|
370
|
+
/**
|
|
371
|
+
* The key size in bits. For example: 2048, 3072, or 4096 for RSA. Default for RSA and RSA-HSM keys is 2048. Exception made for bring your own key (BYOK), key exchange keys default to 4096.
|
|
372
|
+
*/
|
|
373
|
+
keySize?: ExpressionOrValue<number> | undefined;
|
|
374
|
+
/**
|
|
375
|
+
* The type of the key. For valid values, see JsonWebKeyType.
|
|
376
|
+
*/
|
|
377
|
+
kty?: ExpressionOrValue<JsonWebKeyType> | undefined;
|
|
378
|
+
/**
|
|
379
|
+
* Key release policy in response. It will be used for both output and input. Omitted if empty
|
|
380
|
+
*/
|
|
381
|
+
releasePolicy?: KeyReleasePolicyInput | undefined;
|
|
382
|
+
/**
|
|
383
|
+
* Key rotation policy in response. It will be used for both output and input. Omitted if empty
|
|
384
|
+
*/
|
|
385
|
+
rotationPolicy?: RotationPolicyInput | undefined;
|
|
386
|
+
}
|
|
387
|
+
/**
|
|
388
|
+
* View type for The properties of the key.
|
|
389
|
+
*/
|
|
390
|
+
export interface KeyPropertiesView extends InputOf<KeyProperties> {
|
|
391
|
+
/**
|
|
392
|
+
* The attributes of the key.
|
|
393
|
+
*/
|
|
394
|
+
attributes?: KeyAttributesView | undefined;
|
|
395
|
+
/**
|
|
396
|
+
* The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256
|
|
397
|
+
*/
|
|
398
|
+
curveName?: ExpressionOrValue<JsonWebKeyCurveName> | undefined;
|
|
399
|
+
keyOps?: InputArray<ExpressionOrValue<JsonWebKeyOperation>, JsonWebKeyOperation[]> | undefined;
|
|
400
|
+
/**
|
|
401
|
+
* The key size in bits. For example: 2048, 3072, or 4096 for RSA. Default for RSA and RSA-HSM keys is 2048. Exception made for bring your own key (BYOK), key exchange keys default to 4096.
|
|
402
|
+
*/
|
|
403
|
+
keySize?: ExpressionOrValue<number> | undefined;
|
|
404
|
+
/**
|
|
405
|
+
* Read-only output: The URI to retrieve the current version of the key.
|
|
406
|
+
*/
|
|
407
|
+
readonly keyUri?: Expression<string> | undefined;
|
|
408
|
+
/**
|
|
409
|
+
* Read-only output: The URI to retrieve the specific version of the key.
|
|
410
|
+
*/
|
|
411
|
+
readonly keyUriWithVersion?: Expression<string> | undefined;
|
|
412
|
+
/**
|
|
413
|
+
* The type of the key. For valid values, see JsonWebKeyType.
|
|
414
|
+
*/
|
|
415
|
+
kty?: ExpressionOrValue<JsonWebKeyType> | undefined;
|
|
416
|
+
/**
|
|
417
|
+
* Key release policy in response. It will be used for both output and input. Omitted if empty
|
|
418
|
+
*/
|
|
419
|
+
releasePolicy?: KeyReleasePolicyView | undefined;
|
|
420
|
+
/**
|
|
421
|
+
* Key rotation policy in response. It will be used for both output and input. Omitted if empty
|
|
422
|
+
*/
|
|
423
|
+
rotationPolicy?: RotationPolicyView | undefined;
|
|
424
|
+
}
|
|
425
|
+
export declare const keyPropertiesShape: FlatModelShape;
|
|
426
|
+
export interface KeyReleasePolicy {
|
|
427
|
+
/**
|
|
428
|
+
* Content type and version of key release policy
|
|
429
|
+
*/
|
|
430
|
+
contentType?: string;
|
|
431
|
+
/**
|
|
432
|
+
* Blob encoding the policy rules under which the key can be released.
|
|
433
|
+
*/
|
|
434
|
+
data?: Uint8Array;
|
|
435
|
+
}
|
|
436
|
+
export interface KeyReleasePolicyInput extends InputOf<KeyReleasePolicy> {
|
|
437
|
+
/**
|
|
438
|
+
* Content type and version of key release policy
|
|
439
|
+
*/
|
|
440
|
+
contentType?: ExpressionOrValue<string> | undefined;
|
|
441
|
+
/**
|
|
442
|
+
* Blob encoding the policy rules under which the key can be released.
|
|
443
|
+
*/
|
|
444
|
+
data?: ExpressionOrValue<Uint8Array> | undefined;
|
|
445
|
+
}
|
|
446
|
+
export type KeyReleasePolicyView = KeyReleasePolicyInput;
|
|
447
|
+
export declare const keyReleasePolicyShape: FlatModelShape;
|
|
448
|
+
export interface KeyRotationPolicyAttributes {
|
|
449
|
+
/**
|
|
450
|
+
* Creation time in seconds since 1970-01-01T00:00:00Z.
|
|
451
|
+
*/
|
|
452
|
+
created?: number;
|
|
453
|
+
/**
|
|
454
|
+
* The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'.
|
|
455
|
+
*/
|
|
456
|
+
expiryTime?: string;
|
|
457
|
+
/**
|
|
458
|
+
* Last updated time in seconds since 1970-01-01T00:00:00Z.
|
|
459
|
+
*/
|
|
460
|
+
updated?: number;
|
|
461
|
+
}
|
|
462
|
+
export interface KeyRotationPolicyAttributesInput extends InputOf<KeyRotationPolicyAttributes> {
|
|
463
|
+
/**
|
|
464
|
+
* The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'.
|
|
465
|
+
*/
|
|
466
|
+
expiryTime?: ExpressionOrValue<string> | undefined;
|
|
467
|
+
}
|
|
468
|
+
export interface KeyRotationPolicyAttributesView extends InputOf<KeyRotationPolicyAttributes> {
|
|
469
|
+
/**
|
|
470
|
+
* Read-only output: Creation time in seconds since 1970-01-01T00:00:00Z.
|
|
471
|
+
*/
|
|
472
|
+
readonly created?: Expression<number> | undefined;
|
|
473
|
+
/**
|
|
474
|
+
* The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'.
|
|
475
|
+
*/
|
|
476
|
+
expiryTime?: ExpressionOrValue<string> | undefined;
|
|
477
|
+
/**
|
|
478
|
+
* Read-only output: Last updated time in seconds since 1970-01-01T00:00:00Z.
|
|
479
|
+
*/
|
|
480
|
+
readonly updated?: Expression<number> | undefined;
|
|
481
|
+
}
|
|
482
|
+
export declare const keyRotationPolicyAttributesShape: FlatModelShape;
|
|
483
|
+
export interface LifetimeAction {
|
|
484
|
+
/**
|
|
485
|
+
* The action of key rotation policy lifetimeAction.
|
|
486
|
+
*/
|
|
487
|
+
action?: Action;
|
|
488
|
+
/**
|
|
489
|
+
* The trigger of key rotation policy lifetimeAction.
|
|
490
|
+
*/
|
|
491
|
+
trigger?: Trigger;
|
|
492
|
+
}
|
|
493
|
+
export interface LifetimeActionInput extends InputOf<LifetimeAction> {
|
|
494
|
+
/**
|
|
495
|
+
* The action of key rotation policy lifetimeAction.
|
|
496
|
+
*/
|
|
497
|
+
action?: ActionInput | undefined;
|
|
498
|
+
/**
|
|
499
|
+
* The trigger of key rotation policy lifetimeAction.
|
|
500
|
+
*/
|
|
501
|
+
trigger?: TriggerInput | undefined;
|
|
502
|
+
}
|
|
503
|
+
export type LifetimeActionView = LifetimeActionInput;
|
|
504
|
+
export declare const lifetimeActionShape: FlatModelShape;
|
|
505
|
+
export interface ManagedHsmAction {
|
|
506
|
+
/**
|
|
507
|
+
* The type of action.
|
|
508
|
+
*/
|
|
509
|
+
type?: KeyRotationPolicyActionType;
|
|
510
|
+
}
|
|
511
|
+
export interface ManagedHsmActionInput extends InputOf<ManagedHsmAction> {
|
|
512
|
+
/**
|
|
513
|
+
* The type of action.
|
|
514
|
+
*/
|
|
515
|
+
type?: ExpressionOrValue<KeyRotationPolicyActionType> | undefined;
|
|
516
|
+
}
|
|
517
|
+
export type ManagedHsmActionView = ManagedHsmActionInput;
|
|
518
|
+
export declare const managedHsmActionShape: FlatModelShape;
|
|
519
|
+
/**
|
|
520
|
+
* The object attributes managed by the Azure Key Vault service.
|
|
521
|
+
*/
|
|
522
|
+
export interface ManagedHsmKeyAttributes {
|
|
523
|
+
/**
|
|
524
|
+
* Creation time in seconds since 1970-01-01T00:00:00Z.
|
|
525
|
+
*/
|
|
526
|
+
created?: number;
|
|
527
|
+
/**
|
|
528
|
+
* Determines whether or not the object is enabled.
|
|
529
|
+
*/
|
|
530
|
+
enabled?: boolean;
|
|
531
|
+
/**
|
|
532
|
+
* Expiry date in seconds since 1970-01-01T00:00:00Z.
|
|
533
|
+
*/
|
|
534
|
+
expires?: number;
|
|
535
|
+
/**
|
|
536
|
+
* Indicates if the private key can be exported.
|
|
537
|
+
*/
|
|
538
|
+
exportable?: boolean;
|
|
539
|
+
/**
|
|
540
|
+
* Not before date in seconds since 1970-01-01T00:00:00Z.
|
|
541
|
+
*/
|
|
542
|
+
notBefore?: number;
|
|
543
|
+
/**
|
|
544
|
+
* The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
|
|
545
|
+
*/
|
|
546
|
+
recoveryLevel?: DeletionRecoveryLevel;
|
|
547
|
+
/**
|
|
548
|
+
* Last updated time in seconds since 1970-01-01T00:00:00Z.
|
|
549
|
+
*/
|
|
550
|
+
updated?: number;
|
|
551
|
+
}
|
|
552
|
+
/**
|
|
553
|
+
* Input type for The object attributes managed by the Azure Key Vault service.
|
|
554
|
+
*/
|
|
555
|
+
export interface ManagedHsmKeyAttributesInput extends InputOf<ManagedHsmKeyAttributes> {
|
|
556
|
+
/**
|
|
557
|
+
* Determines whether or not the object is enabled.
|
|
558
|
+
*/
|
|
559
|
+
enabled?: ExpressionOrValue<boolean> | undefined;
|
|
560
|
+
/**
|
|
561
|
+
* Expiry date in seconds since 1970-01-01T00:00:00Z.
|
|
562
|
+
*/
|
|
563
|
+
expires?: ExpressionOrValue<number> | undefined;
|
|
564
|
+
/**
|
|
565
|
+
* Indicates if the private key can be exported.
|
|
566
|
+
*/
|
|
567
|
+
exportable?: ExpressionOrValue<boolean> | undefined;
|
|
568
|
+
/**
|
|
569
|
+
* Not before date in seconds since 1970-01-01T00:00:00Z.
|
|
570
|
+
*/
|
|
571
|
+
notBefore?: ExpressionOrValue<number> | undefined;
|
|
572
|
+
}
|
|
573
|
+
/**
|
|
574
|
+
* View type for The object attributes managed by the Azure Key Vault service.
|
|
575
|
+
*/
|
|
576
|
+
export interface ManagedHsmKeyAttributesView extends InputOf<ManagedHsmKeyAttributes> {
|
|
577
|
+
/**
|
|
578
|
+
* Read-only output: Creation time in seconds since 1970-01-01T00:00:00Z.
|
|
579
|
+
*/
|
|
580
|
+
readonly created?: Expression<number> | undefined;
|
|
581
|
+
/**
|
|
582
|
+
* Determines whether or not the object is enabled.
|
|
583
|
+
*/
|
|
584
|
+
enabled?: ExpressionOrValue<boolean> | undefined;
|
|
585
|
+
/**
|
|
586
|
+
* Expiry date in seconds since 1970-01-01T00:00:00Z.
|
|
587
|
+
*/
|
|
588
|
+
expires?: ExpressionOrValue<number> | undefined;
|
|
589
|
+
/**
|
|
590
|
+
* Indicates if the private key can be exported.
|
|
591
|
+
*/
|
|
592
|
+
exportable?: ExpressionOrValue<boolean> | undefined;
|
|
593
|
+
/**
|
|
594
|
+
* Not before date in seconds since 1970-01-01T00:00:00Z.
|
|
595
|
+
*/
|
|
596
|
+
notBefore?: ExpressionOrValue<number> | undefined;
|
|
597
|
+
/**
|
|
598
|
+
* Read-only output: The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
|
|
599
|
+
*/
|
|
600
|
+
readonly recoveryLevel?: Expression<DeletionRecoveryLevel> | undefined;
|
|
601
|
+
/**
|
|
602
|
+
* Read-only output: Last updated time in seconds since 1970-01-01T00:00:00Z.
|
|
603
|
+
*/
|
|
604
|
+
readonly updated?: Expression<number> | undefined;
|
|
605
|
+
}
|
|
606
|
+
export declare const managedHsmKeyAttributesShape: FlatModelShape;
|
|
607
|
+
/**
|
|
608
|
+
* The properties of the key.
|
|
609
|
+
*/
|
|
610
|
+
export interface ManagedHsmKeyProperties {
|
|
611
|
+
/**
|
|
612
|
+
* The attributes of the key.
|
|
613
|
+
*/
|
|
614
|
+
attributes?: ManagedHsmKeyAttributes;
|
|
615
|
+
/**
|
|
616
|
+
* The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256
|
|
617
|
+
*/
|
|
618
|
+
curveName?: JsonWebKeyCurveName;
|
|
619
|
+
keyOps?: JsonWebKeyOperation[];
|
|
620
|
+
/**
|
|
621
|
+
* The key size in bits. For example: 2048, 3072, or 4096 for RSA. Default for RSA and RSA-HSM keys is 2048. Exception made for bring your own key (BYOK), key exchange keys default to 4096.
|
|
622
|
+
*/
|
|
623
|
+
keySize?: number;
|
|
624
|
+
/**
|
|
625
|
+
* The URI to retrieve the current version of the key.
|
|
626
|
+
*/
|
|
627
|
+
keyUri?: string;
|
|
628
|
+
/**
|
|
629
|
+
* The URI to retrieve the specific version of the key.
|
|
630
|
+
*/
|
|
631
|
+
keyUriWithVersion?: string;
|
|
632
|
+
/**
|
|
633
|
+
* The type of the key. For valid values, see JsonWebKeyType.
|
|
634
|
+
*/
|
|
635
|
+
kty?: JsonWebKeyType;
|
|
636
|
+
/**
|
|
637
|
+
* Key release policy in response. It will be used for both output and input. Omitted if empty
|
|
638
|
+
*/
|
|
639
|
+
releasePolicy?: ManagedHsmKeyReleasePolicy;
|
|
640
|
+
/**
|
|
641
|
+
* Key rotation policy in response. It will be used for both output and input. Omitted if empty
|
|
642
|
+
*/
|
|
643
|
+
rotationPolicy?: ManagedHsmRotationPolicy;
|
|
644
|
+
}
|
|
645
|
+
/**
|
|
646
|
+
* Input type for The properties of the key.
|
|
647
|
+
*/
|
|
648
|
+
export interface ManagedHsmKeyPropertiesInput extends InputOf<ManagedHsmKeyProperties> {
|
|
649
|
+
/**
|
|
650
|
+
* The attributes of the key.
|
|
651
|
+
*/
|
|
652
|
+
attributes?: ManagedHsmKeyAttributesInput | undefined;
|
|
653
|
+
/**
|
|
654
|
+
* The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256
|
|
655
|
+
*/
|
|
656
|
+
curveName?: ExpressionOrValue<JsonWebKeyCurveName> | undefined;
|
|
657
|
+
keyOps?: InputArray<ExpressionOrValue<JsonWebKeyOperation>, JsonWebKeyOperation[]> | undefined;
|
|
658
|
+
/**
|
|
659
|
+
* The key size in bits. For example: 2048, 3072, or 4096 for RSA. Default for RSA and RSA-HSM keys is 2048. Exception made for bring your own key (BYOK), key exchange keys default to 4096.
|
|
660
|
+
*/
|
|
661
|
+
keySize?: ExpressionOrValue<number> | undefined;
|
|
662
|
+
/**
|
|
663
|
+
* The type of the key. For valid values, see JsonWebKeyType.
|
|
664
|
+
*/
|
|
665
|
+
kty?: ExpressionOrValue<JsonWebKeyType> | undefined;
|
|
666
|
+
/**
|
|
667
|
+
* Key release policy in response. It will be used for both output and input. Omitted if empty
|
|
668
|
+
*/
|
|
669
|
+
releasePolicy?: ManagedHsmKeyReleasePolicyInput | undefined;
|
|
670
|
+
/**
|
|
671
|
+
* Key rotation policy in response. It will be used for both output and input. Omitted if empty
|
|
672
|
+
*/
|
|
673
|
+
rotationPolicy?: ManagedHsmRotationPolicyInput | undefined;
|
|
674
|
+
}
|
|
675
|
+
/**
|
|
676
|
+
* View type for The properties of the key.
|
|
677
|
+
*/
|
|
678
|
+
export interface ManagedHsmKeyPropertiesView extends InputOf<ManagedHsmKeyProperties> {
|
|
679
|
+
/**
|
|
680
|
+
* The attributes of the key.
|
|
681
|
+
*/
|
|
682
|
+
attributes?: ManagedHsmKeyAttributesView | undefined;
|
|
683
|
+
/**
|
|
684
|
+
* The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256
|
|
685
|
+
*/
|
|
686
|
+
curveName?: ExpressionOrValue<JsonWebKeyCurveName> | undefined;
|
|
687
|
+
keyOps?: InputArray<ExpressionOrValue<JsonWebKeyOperation>, JsonWebKeyOperation[]> | undefined;
|
|
688
|
+
/**
|
|
689
|
+
* The key size in bits. For example: 2048, 3072, or 4096 for RSA. Default for RSA and RSA-HSM keys is 2048. Exception made for bring your own key (BYOK), key exchange keys default to 4096.
|
|
690
|
+
*/
|
|
691
|
+
keySize?: ExpressionOrValue<number> | undefined;
|
|
692
|
+
/**
|
|
693
|
+
* Read-only output: The URI to retrieve the current version of the key.
|
|
694
|
+
*/
|
|
695
|
+
readonly keyUri?: Expression<string> | undefined;
|
|
696
|
+
/**
|
|
697
|
+
* Read-only output: The URI to retrieve the specific version of the key.
|
|
698
|
+
*/
|
|
699
|
+
readonly keyUriWithVersion?: Expression<string> | undefined;
|
|
700
|
+
/**
|
|
701
|
+
* The type of the key. For valid values, see JsonWebKeyType.
|
|
702
|
+
*/
|
|
703
|
+
kty?: ExpressionOrValue<JsonWebKeyType> | undefined;
|
|
704
|
+
/**
|
|
705
|
+
* Key release policy in response. It will be used for both output and input. Omitted if empty
|
|
706
|
+
*/
|
|
707
|
+
releasePolicy?: ManagedHsmKeyReleasePolicyView | undefined;
|
|
708
|
+
/**
|
|
709
|
+
* Key rotation policy in response. It will be used for both output and input. Omitted if empty
|
|
710
|
+
*/
|
|
711
|
+
rotationPolicy?: ManagedHsmRotationPolicyView | undefined;
|
|
712
|
+
}
|
|
713
|
+
export declare const managedHsmKeyPropertiesShape: FlatModelShape;
|
|
714
|
+
export interface ManagedHsmKeyReleasePolicy {
|
|
715
|
+
/**
|
|
716
|
+
* Content type and version of key release policy
|
|
717
|
+
*/
|
|
718
|
+
contentType?: string;
|
|
719
|
+
/**
|
|
720
|
+
* Blob encoding the policy rules under which the key can be released.
|
|
721
|
+
*/
|
|
722
|
+
data?: Uint8Array;
|
|
723
|
+
}
|
|
724
|
+
export interface ManagedHsmKeyReleasePolicyInput extends InputOf<ManagedHsmKeyReleasePolicy> {
|
|
725
|
+
/**
|
|
726
|
+
* Content type and version of key release policy
|
|
727
|
+
*/
|
|
728
|
+
contentType?: ExpressionOrValue<string> | undefined;
|
|
729
|
+
/**
|
|
730
|
+
* Blob encoding the policy rules under which the key can be released.
|
|
731
|
+
*/
|
|
732
|
+
data?: ExpressionOrValue<Uint8Array> | undefined;
|
|
733
|
+
}
|
|
734
|
+
export type ManagedHsmKeyReleasePolicyView = ManagedHsmKeyReleasePolicyInput;
|
|
735
|
+
export declare const managedHsmKeyReleasePolicyShape: FlatModelShape;
|
|
736
|
+
export interface ManagedHsmKeyRotationPolicyAttributes {
|
|
737
|
+
/**
|
|
738
|
+
* Creation time in seconds since 1970-01-01T00:00:00Z.
|
|
739
|
+
*/
|
|
740
|
+
created?: number;
|
|
741
|
+
/**
|
|
742
|
+
* The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'.
|
|
743
|
+
*/
|
|
744
|
+
expiryTime?: string;
|
|
745
|
+
/**
|
|
746
|
+
* Last updated time in seconds since 1970-01-01T00:00:00Z.
|
|
747
|
+
*/
|
|
748
|
+
updated?: number;
|
|
749
|
+
}
|
|
750
|
+
export interface ManagedHsmKeyRotationPolicyAttributesInput extends InputOf<ManagedHsmKeyRotationPolicyAttributes> {
|
|
751
|
+
/**
|
|
752
|
+
* The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'.
|
|
753
|
+
*/
|
|
754
|
+
expiryTime?: ExpressionOrValue<string> | undefined;
|
|
755
|
+
}
|
|
756
|
+
export interface ManagedHsmKeyRotationPolicyAttributesView extends InputOf<ManagedHsmKeyRotationPolicyAttributes> {
|
|
757
|
+
/**
|
|
758
|
+
* Read-only output: Creation time in seconds since 1970-01-01T00:00:00Z.
|
|
759
|
+
*/
|
|
760
|
+
readonly created?: Expression<number> | undefined;
|
|
761
|
+
/**
|
|
762
|
+
* The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'.
|
|
763
|
+
*/
|
|
764
|
+
expiryTime?: ExpressionOrValue<string> | undefined;
|
|
765
|
+
/**
|
|
766
|
+
* Read-only output: Last updated time in seconds since 1970-01-01T00:00:00Z.
|
|
767
|
+
*/
|
|
768
|
+
readonly updated?: Expression<number> | undefined;
|
|
769
|
+
}
|
|
770
|
+
export declare const managedHsmKeyRotationPolicyAttributesShape: FlatModelShape;
|
|
771
|
+
export interface ManagedHsmLifetimeAction {
|
|
772
|
+
/**
|
|
773
|
+
* The action of key rotation policy lifetimeAction.
|
|
774
|
+
*/
|
|
775
|
+
action?: ManagedHsmAction;
|
|
776
|
+
/**
|
|
777
|
+
* The trigger of key rotation policy lifetimeAction.
|
|
778
|
+
*/
|
|
779
|
+
trigger?: ManagedHsmTrigger;
|
|
780
|
+
}
|
|
781
|
+
export interface ManagedHsmLifetimeActionInput extends InputOf<ManagedHsmLifetimeAction> {
|
|
782
|
+
/**
|
|
783
|
+
* The action of key rotation policy lifetimeAction.
|
|
784
|
+
*/
|
|
785
|
+
action?: ManagedHsmActionInput | undefined;
|
|
786
|
+
/**
|
|
787
|
+
* The trigger of key rotation policy lifetimeAction.
|
|
788
|
+
*/
|
|
789
|
+
trigger?: ManagedHsmTriggerInput | undefined;
|
|
790
|
+
}
|
|
791
|
+
export type ManagedHsmLifetimeActionView = ManagedHsmLifetimeActionInput;
|
|
792
|
+
export declare const managedHsmLifetimeActionShape: FlatModelShape;
|
|
793
|
+
/**
|
|
794
|
+
* Properties of the managed HSM Pool
|
|
795
|
+
*/
|
|
796
|
+
export interface ManagedHsmProperties {
|
|
797
|
+
/**
|
|
798
|
+
* The create mode to indicate whether the resource is being created or is being recovered from a deleted resource.
|
|
799
|
+
*/
|
|
800
|
+
createMode?: CreateMode;
|
|
801
|
+
/**
|
|
802
|
+
* Property specifying whether protection against purge is enabled for this managed HSM pool. Setting this property to true activates protection against purge for this managed HSM pool and its content - only the Managed HSM service may initiate a hard, irrecoverable deletion. Enabling this functionality is irreversible.
|
|
803
|
+
*/
|
|
804
|
+
enablePurgeProtection?: boolean;
|
|
805
|
+
/**
|
|
806
|
+
* Property to specify whether the 'soft delete' functionality is enabled for this managed HSM pool. Soft delete is enabled by default for all managed HSMs and is immutable.
|
|
807
|
+
*/
|
|
808
|
+
enableSoftDelete?: boolean;
|
|
809
|
+
/**
|
|
810
|
+
* The URI of the managed hsm pool for performing operations on keys.
|
|
811
|
+
*/
|
|
812
|
+
hsmUri?: string;
|
|
813
|
+
/**
|
|
814
|
+
* Array of initial administrators object ids for this managed hsm pool.
|
|
815
|
+
*/
|
|
816
|
+
initialAdminObjectIds?: string[];
|
|
817
|
+
/**
|
|
818
|
+
* Rules governing the accessibility of the key vault from specific network locations.
|
|
819
|
+
*/
|
|
820
|
+
networkAcls?: MhsmNetworkRuleSet;
|
|
821
|
+
/**
|
|
822
|
+
* List of private endpoint connections associated with the managed hsm pool.
|
|
823
|
+
*/
|
|
824
|
+
privateEndpointConnections?: MhsmPrivateEndpointConnectionItem[];
|
|
825
|
+
/**
|
|
826
|
+
* Control permission to the managed HSM from public networks.
|
|
827
|
+
*/
|
|
828
|
+
publicNetworkAccess?: PublicNetworkAccess;
|
|
829
|
+
/**
|
|
830
|
+
* List of all regions associated with the managed hsm pool.
|
|
831
|
+
*/
|
|
832
|
+
regions?: MhsmGeoReplicatedRegion[];
|
|
833
|
+
/**
|
|
834
|
+
* The scheduled purge date in UTC.
|
|
835
|
+
*/
|
|
836
|
+
scheduledPurgeDate?: Date;
|
|
837
|
+
/**
|
|
838
|
+
* Managed HSM security domain properties.
|
|
839
|
+
*/
|
|
840
|
+
securityDomainProperties?: ManagedHsmSecurityDomainProperties;
|
|
841
|
+
/**
|
|
842
|
+
* Soft deleted data retention days. When you delete an HSM or a key, it will remain recoverable for the configured retention period or for a default period of 90 days. It accepts values between 7 and 90.
|
|
843
|
+
*/
|
|
844
|
+
softDeleteRetentionInDays?: number;
|
|
845
|
+
/**
|
|
846
|
+
* Resource Status Message.
|
|
847
|
+
*/
|
|
848
|
+
statusMessage?: string;
|
|
849
|
+
/**
|
|
850
|
+
* The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool.
|
|
851
|
+
*/
|
|
852
|
+
tenantId?: string;
|
|
853
|
+
}
|
|
854
|
+
/**
|
|
855
|
+
* Input type for Properties of the managed HSM Pool
|
|
856
|
+
*/
|
|
857
|
+
export interface ManagedHsmPropertiesInput extends InputOf<ManagedHsmProperties> {
|
|
858
|
+
/**
|
|
859
|
+
* The create mode to indicate whether the resource is being created or is being recovered from a deleted resource.
|
|
860
|
+
*/
|
|
861
|
+
createMode?: ExpressionOrValue<CreateMode> | undefined;
|
|
862
|
+
/**
|
|
863
|
+
* Property specifying whether protection against purge is enabled for this managed HSM pool. Setting this property to true activates protection against purge for this managed HSM pool and its content - only the Managed HSM service may initiate a hard, irrecoverable deletion. Enabling this functionality is irreversible.
|
|
864
|
+
*/
|
|
865
|
+
enablePurgeProtection?: ExpressionOrValue<boolean> | undefined;
|
|
866
|
+
/**
|
|
867
|
+
* Property to specify whether the 'soft delete' functionality is enabled for this managed HSM pool. Soft delete is enabled by default for all managed HSMs and is immutable.
|
|
868
|
+
*/
|
|
869
|
+
enableSoftDelete?: ExpressionOrValue<boolean> | undefined;
|
|
870
|
+
/**
|
|
871
|
+
* Array of initial administrators object ids for this managed hsm pool.
|
|
872
|
+
*/
|
|
873
|
+
initialAdminObjectIds?: InputArray<ExpressionOrValue<string>, string[]> | undefined;
|
|
874
|
+
/**
|
|
875
|
+
* Rules governing the accessibility of the key vault from specific network locations.
|
|
876
|
+
*/
|
|
877
|
+
networkAcls?: MhsmNetworkRuleSetInput | undefined;
|
|
878
|
+
/**
|
|
879
|
+
* Control permission to the managed HSM from public networks.
|
|
880
|
+
*/
|
|
881
|
+
publicNetworkAccess?: ExpressionOrValue<PublicNetworkAccess> | undefined;
|
|
882
|
+
/**
|
|
883
|
+
* List of all regions associated with the managed hsm pool.
|
|
884
|
+
*/
|
|
885
|
+
regions?: InputArray<MhsmGeoReplicatedRegionInput, MhsmGeoReplicatedRegion[]> | undefined;
|
|
886
|
+
/**
|
|
887
|
+
* Soft deleted data retention days. When you delete an HSM or a key, it will remain recoverable for the configured retention period or for a default period of 90 days. It accepts values between 7 and 90.
|
|
888
|
+
*/
|
|
889
|
+
softDeleteRetentionInDays?: ExpressionOrValue<number> | undefined;
|
|
890
|
+
/**
|
|
891
|
+
* The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool.
|
|
892
|
+
*/
|
|
893
|
+
tenantId?: ExpressionOrValue<string> | undefined;
|
|
894
|
+
}
|
|
895
|
+
/**
|
|
896
|
+
* View type for Properties of the managed HSM Pool
|
|
897
|
+
*/
|
|
898
|
+
export interface ManagedHsmPropertiesView extends InputOf<ManagedHsmProperties> {
|
|
899
|
+
/**
|
|
900
|
+
* The create mode to indicate whether the resource is being created or is being recovered from a deleted resource.
|
|
901
|
+
*/
|
|
902
|
+
createMode?: ExpressionOrValue<CreateMode> | undefined;
|
|
903
|
+
/**
|
|
904
|
+
* Property specifying whether protection against purge is enabled for this managed HSM pool. Setting this property to true activates protection against purge for this managed HSM pool and its content - only the Managed HSM service may initiate a hard, irrecoverable deletion. Enabling this functionality is irreversible.
|
|
905
|
+
*/
|
|
906
|
+
enablePurgeProtection?: ExpressionOrValue<boolean> | undefined;
|
|
907
|
+
/**
|
|
908
|
+
* Property to specify whether the 'soft delete' functionality is enabled for this managed HSM pool. Soft delete is enabled by default for all managed HSMs and is immutable.
|
|
909
|
+
*/
|
|
910
|
+
enableSoftDelete?: ExpressionOrValue<boolean> | undefined;
|
|
911
|
+
/**
|
|
912
|
+
* Read-only output: The URI of the managed hsm pool for performing operations on keys.
|
|
913
|
+
*/
|
|
914
|
+
readonly hsmUri?: Expression<string> | undefined;
|
|
915
|
+
/**
|
|
916
|
+
* Array of initial administrators object ids for this managed hsm pool.
|
|
917
|
+
*/
|
|
918
|
+
initialAdminObjectIds?: InputArray<ExpressionOrValue<string>, string[]> | undefined;
|
|
919
|
+
/**
|
|
920
|
+
* Rules governing the accessibility of the key vault from specific network locations.
|
|
921
|
+
*/
|
|
922
|
+
networkAcls?: MhsmNetworkRuleSetView | undefined;
|
|
923
|
+
/**
|
|
924
|
+
* Read-only output: List of private endpoint connections associated with the managed hsm pool.
|
|
925
|
+
*/
|
|
926
|
+
readonly privateEndpointConnections?: Expression<MhsmPrivateEndpointConnectionItem[]> | undefined;
|
|
927
|
+
/**
|
|
928
|
+
* Control permission to the managed HSM from public networks.
|
|
929
|
+
*/
|
|
930
|
+
publicNetworkAccess?: ExpressionOrValue<PublicNetworkAccess> | undefined;
|
|
931
|
+
/**
|
|
932
|
+
* List of all regions associated with the managed hsm pool.
|
|
933
|
+
*/
|
|
934
|
+
regions?: InputArray<MhsmGeoReplicatedRegionView, MhsmGeoReplicatedRegion[]> | undefined;
|
|
935
|
+
/**
|
|
936
|
+
* Read-only output: The scheduled purge date in UTC.
|
|
937
|
+
*/
|
|
938
|
+
readonly scheduledPurgeDate?: Expression<Date> | undefined;
|
|
939
|
+
/**
|
|
940
|
+
* Read-only output: Managed HSM security domain properties.
|
|
941
|
+
*/
|
|
942
|
+
readonly securityDomainProperties?: Expression<ManagedHsmSecurityDomainProperties> | undefined;
|
|
943
|
+
/**
|
|
944
|
+
* Soft deleted data retention days. When you delete an HSM or a key, it will remain recoverable for the configured retention period or for a default period of 90 days. It accepts values between 7 and 90.
|
|
945
|
+
*/
|
|
946
|
+
softDeleteRetentionInDays?: ExpressionOrValue<number> | undefined;
|
|
947
|
+
/**
|
|
948
|
+
* Read-only output: Resource Status Message.
|
|
949
|
+
*/
|
|
950
|
+
readonly statusMessage?: Expression<string> | undefined;
|
|
951
|
+
/**
|
|
952
|
+
* The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool.
|
|
953
|
+
*/
|
|
954
|
+
tenantId?: ExpressionOrValue<string> | undefined;
|
|
955
|
+
}
|
|
956
|
+
export declare const managedHsmPropertiesShape: FlatModelShape;
|
|
957
|
+
export interface ManagedHsmRotationPolicy {
|
|
958
|
+
/**
|
|
959
|
+
* The attributes of key rotation policy.
|
|
960
|
+
*/
|
|
961
|
+
attributes?: ManagedHsmKeyRotationPolicyAttributes;
|
|
962
|
+
/**
|
|
963
|
+
* The lifetimeActions for key rotation action.
|
|
964
|
+
*/
|
|
965
|
+
lifetimeActions?: ManagedHsmLifetimeAction[];
|
|
966
|
+
}
|
|
967
|
+
export interface ManagedHsmRotationPolicyInput extends InputOf<ManagedHsmRotationPolicy> {
|
|
968
|
+
/**
|
|
969
|
+
* The attributes of key rotation policy.
|
|
970
|
+
*/
|
|
971
|
+
attributes?: ManagedHsmKeyRotationPolicyAttributesInput | undefined;
|
|
972
|
+
/**
|
|
973
|
+
* The lifetimeActions for key rotation action.
|
|
974
|
+
*/
|
|
975
|
+
lifetimeActions?: InputArray<ManagedHsmLifetimeActionInput, ManagedHsmLifetimeAction[]> | undefined;
|
|
976
|
+
}
|
|
977
|
+
export interface ManagedHsmRotationPolicyView extends InputOf<ManagedHsmRotationPolicy> {
|
|
978
|
+
/**
|
|
979
|
+
* The attributes of key rotation policy.
|
|
980
|
+
*/
|
|
981
|
+
attributes?: ManagedHsmKeyRotationPolicyAttributesView | undefined;
|
|
982
|
+
/**
|
|
983
|
+
* The lifetimeActions for key rotation action.
|
|
984
|
+
*/
|
|
985
|
+
lifetimeActions?: InputArray<ManagedHsmLifetimeActionView, ManagedHsmLifetimeAction[]> | undefined;
|
|
986
|
+
}
|
|
987
|
+
export declare const managedHsmRotationPolicyShape: FlatModelShape;
|
|
988
|
+
/**
|
|
989
|
+
* The security domain properties of the managed hsm.
|
|
990
|
+
*/
|
|
991
|
+
export interface ManagedHsmSecurityDomainProperties {
|
|
992
|
+
/**
|
|
993
|
+
* Activation Status
|
|
994
|
+
*/
|
|
995
|
+
activationStatus?: ActivationStatus;
|
|
996
|
+
/**
|
|
997
|
+
* Activation Status Message.
|
|
998
|
+
*/
|
|
999
|
+
activationStatusMessage?: string;
|
|
1000
|
+
}
|
|
1001
|
+
/**
|
|
1002
|
+
* Input type for The security domain properties of the managed hsm.
|
|
1003
|
+
*/
|
|
1004
|
+
export interface ManagedHsmSecurityDomainPropertiesInput extends InputOf<ManagedHsmSecurityDomainProperties> {
|
|
1005
|
+
}
|
|
1006
|
+
/**
|
|
1007
|
+
* View type for The security domain properties of the managed hsm.
|
|
1008
|
+
*/
|
|
1009
|
+
export interface ManagedHsmSecurityDomainPropertiesView extends InputOf<ManagedHsmSecurityDomainProperties> {
|
|
1010
|
+
/**
|
|
1011
|
+
* Read-only output: Activation Status
|
|
1012
|
+
*/
|
|
1013
|
+
readonly activationStatus?: Expression<ActivationStatus> | undefined;
|
|
1014
|
+
/**
|
|
1015
|
+
* Read-only output: Activation Status Message.
|
|
1016
|
+
*/
|
|
1017
|
+
readonly activationStatusMessage?: Expression<string> | undefined;
|
|
1018
|
+
}
|
|
1019
|
+
export declare const managedHsmSecurityDomainPropertiesShape: FlatModelShape;
|
|
1020
|
+
/**
|
|
1021
|
+
* SKU details
|
|
1022
|
+
*/
|
|
1023
|
+
export interface ManagedHsmSku {
|
|
1024
|
+
/**
|
|
1025
|
+
* SKU Family of the managed HSM Pool
|
|
1026
|
+
*/
|
|
1027
|
+
family: ManagedHsmSkuFamily;
|
|
1028
|
+
/**
|
|
1029
|
+
* SKU of the managed HSM Pool
|
|
1030
|
+
*/
|
|
1031
|
+
name: ManagedHsmSkuName;
|
|
1032
|
+
}
|
|
1033
|
+
/**
|
|
1034
|
+
* Input type for SKU details
|
|
1035
|
+
*/
|
|
1036
|
+
export interface ManagedHsmSkuInput extends InputOf<ManagedHsmSku> {
|
|
1037
|
+
/**
|
|
1038
|
+
* SKU Family of the managed HSM Pool
|
|
1039
|
+
*/
|
|
1040
|
+
family: ExpressionOrValue<ManagedHsmSkuFamily>;
|
|
1041
|
+
/**
|
|
1042
|
+
* SKU of the managed HSM Pool
|
|
1043
|
+
*/
|
|
1044
|
+
name: ExpressionOrValue<ManagedHsmSkuName>;
|
|
1045
|
+
}
|
|
1046
|
+
/**
|
|
1047
|
+
* View type for SKU details
|
|
1048
|
+
*/
|
|
1049
|
+
export type ManagedHsmSkuView = ManagedHsmSkuInput;
|
|
1050
|
+
export declare const managedHsmSkuShape: FlatModelShape;
|
|
1051
|
+
export interface ManagedHsmTrigger {
|
|
1052
|
+
/**
|
|
1053
|
+
* The time duration after key creation to rotate the key. It only applies to rotate. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'.
|
|
1054
|
+
*/
|
|
1055
|
+
timeAfterCreate?: string;
|
|
1056
|
+
/**
|
|
1057
|
+
* The time duration before key expiring to rotate or notify. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'.
|
|
1058
|
+
*/
|
|
1059
|
+
timeBeforeExpiry?: string;
|
|
1060
|
+
}
|
|
1061
|
+
export interface ManagedHsmTriggerInput extends InputOf<ManagedHsmTrigger> {
|
|
1062
|
+
/**
|
|
1063
|
+
* The time duration after key creation to rotate the key. It only applies to rotate. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'.
|
|
1064
|
+
*/
|
|
1065
|
+
timeAfterCreate?: ExpressionOrValue<string> | undefined;
|
|
1066
|
+
/**
|
|
1067
|
+
* The time duration before key expiring to rotate or notify. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'.
|
|
1068
|
+
*/
|
|
1069
|
+
timeBeforeExpiry?: ExpressionOrValue<string> | undefined;
|
|
1070
|
+
}
|
|
1071
|
+
export type ManagedHsmTriggerView = ManagedHsmTriggerInput;
|
|
1072
|
+
export declare const managedHsmTriggerShape: FlatModelShape;
|
|
1073
|
+
/**
|
|
1074
|
+
* Managed service identity (system assigned and/or user assigned identities)
|
|
1075
|
+
*/
|
|
1076
|
+
export interface ManagedServiceIdentity {
|
|
1077
|
+
/**
|
|
1078
|
+
* The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
|
|
1079
|
+
*/
|
|
1080
|
+
principalId?: string;
|
|
1081
|
+
/**
|
|
1082
|
+
* The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
|
|
1083
|
+
*/
|
|
1084
|
+
tenantId?: string;
|
|
1085
|
+
/**
|
|
1086
|
+
* The type of managed identity assigned to this resource.
|
|
1087
|
+
*/
|
|
1088
|
+
type: ManagedServiceIdentityType;
|
|
1089
|
+
/**
|
|
1090
|
+
* The identities assigned to this resource by the user.
|
|
1091
|
+
*/
|
|
1092
|
+
userAssignedIdentities?: Record<string, UserAssignedIdentity | null>;
|
|
1093
|
+
}
|
|
1094
|
+
/**
|
|
1095
|
+
* Input type for Managed service identity (system assigned and/or user assigned identities)
|
|
1096
|
+
*/
|
|
1097
|
+
export interface ManagedServiceIdentityInput extends InputOf<ManagedServiceIdentity> {
|
|
1098
|
+
/**
|
|
1099
|
+
* The type of managed identity assigned to this resource.
|
|
1100
|
+
*/
|
|
1101
|
+
type: ExpressionOrValue<ManagedServiceIdentityType>;
|
|
1102
|
+
/**
|
|
1103
|
+
* The identities assigned to this resource by the user.
|
|
1104
|
+
*/
|
|
1105
|
+
userAssignedIdentities?: InputRecord<UserAssignedIdentityInput | ExpressionOrValue<null>, Record<string, UserAssignedIdentity | null>> | undefined;
|
|
1106
|
+
}
|
|
1107
|
+
/**
|
|
1108
|
+
* View type for Managed service identity (system assigned and/or user assigned identities)
|
|
1109
|
+
*/
|
|
1110
|
+
export interface ManagedServiceIdentityView extends InputOf<ManagedServiceIdentity> {
|
|
1111
|
+
/**
|
|
1112
|
+
* Read-only output: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
|
|
1113
|
+
*/
|
|
1114
|
+
readonly principalId?: Expression<string> | undefined;
|
|
1115
|
+
/**
|
|
1116
|
+
* Read-only output: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
|
|
1117
|
+
*/
|
|
1118
|
+
readonly tenantId?: Expression<string> | undefined;
|
|
1119
|
+
/**
|
|
1120
|
+
* The type of managed identity assigned to this resource.
|
|
1121
|
+
*/
|
|
1122
|
+
type: ExpressionOrValue<ManagedServiceIdentityType>;
|
|
1123
|
+
/**
|
|
1124
|
+
* The identities assigned to this resource by the user.
|
|
1125
|
+
*/
|
|
1126
|
+
userAssignedIdentities?: InputRecord<UserAssignedIdentityView | ExpressionOrValue<null>, Record<string, UserAssignedIdentity | null>> | undefined;
|
|
1127
|
+
}
|
|
1128
|
+
export declare const managedServiceIdentityShape: FlatModelShape;
|
|
1129
|
+
/**
|
|
1130
|
+
* A region that this managed HSM Pool has been extended to.
|
|
1131
|
+
*/
|
|
1132
|
+
export interface MhsmGeoReplicatedRegion {
|
|
1133
|
+
/**
|
|
1134
|
+
* A boolean value that indicates whether the region is the primary region or a secondary region.
|
|
1135
|
+
*/
|
|
1136
|
+
isPrimary?: boolean;
|
|
1137
|
+
/**
|
|
1138
|
+
* Name of the geo replicated region.
|
|
1139
|
+
*/
|
|
1140
|
+
name?: string;
|
|
1141
|
+
}
|
|
1142
|
+
/**
|
|
1143
|
+
* Input type for A region that this managed HSM Pool has been extended to.
|
|
1144
|
+
*/
|
|
1145
|
+
export interface MhsmGeoReplicatedRegionInput extends InputOf<MhsmGeoReplicatedRegion> {
|
|
1146
|
+
/**
|
|
1147
|
+
* A boolean value that indicates whether the region is the primary region or a secondary region.
|
|
1148
|
+
*/
|
|
1149
|
+
isPrimary?: ExpressionOrValue<boolean> | undefined;
|
|
1150
|
+
/**
|
|
1151
|
+
* Name of the geo replicated region.
|
|
1152
|
+
*/
|
|
1153
|
+
name?: ExpressionOrValue<string> | undefined;
|
|
1154
|
+
}
|
|
1155
|
+
/**
|
|
1156
|
+
* View type for A region that this managed HSM Pool has been extended to.
|
|
1157
|
+
*/
|
|
1158
|
+
export type MhsmGeoReplicatedRegionView = MhsmGeoReplicatedRegionInput;
|
|
1159
|
+
export declare const mhsmGeoReplicatedRegionShape: FlatModelShape;
|
|
1160
|
+
/**
|
|
1161
|
+
* A rule governing the accessibility of a managed HSM pool from a specific IP address or IP range.
|
|
1162
|
+
*/
|
|
1163
|
+
export interface MhsmipRule {
|
|
1164
|
+
/**
|
|
1165
|
+
* 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).
|
|
1166
|
+
*/
|
|
1167
|
+
value: string;
|
|
1168
|
+
}
|
|
1169
|
+
/**
|
|
1170
|
+
* Input type for A rule governing the accessibility of a managed HSM pool from a specific IP address or IP range.
|
|
1171
|
+
*/
|
|
1172
|
+
export interface MhsmipRuleInput extends InputOf<MhsmipRule> {
|
|
1173
|
+
/**
|
|
1174
|
+
* 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).
|
|
1175
|
+
*/
|
|
1176
|
+
value: ExpressionOrValue<string>;
|
|
1177
|
+
}
|
|
1178
|
+
/**
|
|
1179
|
+
* View type for A rule governing the accessibility of a managed HSM pool from a specific IP address or IP range.
|
|
1180
|
+
*/
|
|
1181
|
+
export type MhsmipRuleView = MhsmipRuleInput;
|
|
1182
|
+
export declare const mhsmipRuleShape: FlatModelShape;
|
|
1183
|
+
/**
|
|
1184
|
+
* A set of rules governing the network accessibility of a managed hsm pool.
|
|
1185
|
+
*/
|
|
1186
|
+
export interface MhsmNetworkRuleSet {
|
|
1187
|
+
/**
|
|
1188
|
+
* Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.
|
|
1189
|
+
*/
|
|
1190
|
+
bypass?: NetworkRuleBypassOptions;
|
|
1191
|
+
/**
|
|
1192
|
+
* The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.
|
|
1193
|
+
*/
|
|
1194
|
+
defaultAction?: NetworkRuleAction;
|
|
1195
|
+
/**
|
|
1196
|
+
* The list of IP address rules.
|
|
1197
|
+
*/
|
|
1198
|
+
ipRules?: MhsmipRule[];
|
|
1199
|
+
/**
|
|
1200
|
+
* The list of service tags.
|
|
1201
|
+
*/
|
|
1202
|
+
serviceTags?: MhsmServiceTagRule[];
|
|
1203
|
+
/**
|
|
1204
|
+
* The list of virtual network rules.
|
|
1205
|
+
*/
|
|
1206
|
+
virtualNetworkRules?: MhsmVirtualNetworkRule[];
|
|
1207
|
+
}
|
|
1208
|
+
/**
|
|
1209
|
+
* Input type for A set of rules governing the network accessibility of a managed hsm pool.
|
|
1210
|
+
*/
|
|
1211
|
+
export interface MhsmNetworkRuleSetInput extends InputOf<MhsmNetworkRuleSet> {
|
|
1212
|
+
/**
|
|
1213
|
+
* Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.
|
|
1214
|
+
*/
|
|
1215
|
+
bypass?: ExpressionOrValue<NetworkRuleBypassOptions> | undefined;
|
|
1216
|
+
/**
|
|
1217
|
+
* The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.
|
|
1218
|
+
*/
|
|
1219
|
+
defaultAction?: ExpressionOrValue<NetworkRuleAction> | undefined;
|
|
1220
|
+
/**
|
|
1221
|
+
* The list of IP address rules.
|
|
1222
|
+
*/
|
|
1223
|
+
ipRules?: InputArray<MhsmipRuleInput, MhsmipRule[]> | undefined;
|
|
1224
|
+
/**
|
|
1225
|
+
* The list of service tags.
|
|
1226
|
+
*/
|
|
1227
|
+
serviceTags?: InputArray<MhsmServiceTagRuleInput, MhsmServiceTagRule[]> | undefined;
|
|
1228
|
+
/**
|
|
1229
|
+
* The list of virtual network rules.
|
|
1230
|
+
*/
|
|
1231
|
+
virtualNetworkRules?: InputArray<MhsmVirtualNetworkRuleInput, MhsmVirtualNetworkRule[]> | undefined;
|
|
1232
|
+
}
|
|
1233
|
+
/**
|
|
1234
|
+
* View type for A set of rules governing the network accessibility of a managed hsm pool.
|
|
1235
|
+
*/
|
|
1236
|
+
export type MhsmNetworkRuleSetView = MhsmNetworkRuleSetInput;
|
|
1237
|
+
export declare const mhsmNetworkRuleSetShape: FlatModelShape;
|
|
1238
|
+
/**
|
|
1239
|
+
* Private endpoint object properties.
|
|
1240
|
+
*/
|
|
1241
|
+
export interface MhsmPrivateEndpoint {
|
|
1242
|
+
}
|
|
1243
|
+
/**
|
|
1244
|
+
* Input type for Private endpoint object properties.
|
|
1245
|
+
*/
|
|
1246
|
+
export interface MhsmPrivateEndpointInput extends InputOf<MhsmPrivateEndpoint> {
|
|
1247
|
+
}
|
|
1248
|
+
/**
|
|
1249
|
+
* View type for Private endpoint object properties.
|
|
1250
|
+
*/
|
|
1251
|
+
export type MhsmPrivateEndpointView = MhsmPrivateEndpointInput;
|
|
1252
|
+
export declare const mhsmPrivateEndpointShape: FlatModelShape;
|
|
1253
|
+
/**
|
|
1254
|
+
* Private endpoint connection item.
|
|
1255
|
+
*/
|
|
1256
|
+
export interface MhsmPrivateEndpointConnectionItem {
|
|
1257
|
+
/**
|
|
1258
|
+
* Private endpoint connection properties.
|
|
1259
|
+
*/
|
|
1260
|
+
properties?: MhsmPrivateEndpointConnectionProperties;
|
|
1261
|
+
}
|
|
1262
|
+
/**
|
|
1263
|
+
* Input type for Private endpoint connection item.
|
|
1264
|
+
*/
|
|
1265
|
+
export interface MhsmPrivateEndpointConnectionItemInput extends InputOf<MhsmPrivateEndpointConnectionItem> {
|
|
1266
|
+
}
|
|
1267
|
+
/**
|
|
1268
|
+
* View type for Private endpoint connection item.
|
|
1269
|
+
*/
|
|
1270
|
+
export interface MhsmPrivateEndpointConnectionItemView extends InputOf<MhsmPrivateEndpointConnectionItem> {
|
|
1271
|
+
/**
|
|
1272
|
+
* Read-only output: Private endpoint connection properties.
|
|
1273
|
+
*/
|
|
1274
|
+
readonly properties?: Expression<MhsmPrivateEndpointConnectionProperties> | undefined;
|
|
1275
|
+
}
|
|
1276
|
+
export declare const mhsmPrivateEndpointConnectionItemShape: FlatModelShape;
|
|
1277
|
+
/**
|
|
1278
|
+
* Properties of the private endpoint connection resource.
|
|
1279
|
+
*/
|
|
1280
|
+
export interface MhsmPrivateEndpointConnectionProperties {
|
|
1281
|
+
/**
|
|
1282
|
+
* Properties of the private endpoint object.
|
|
1283
|
+
*/
|
|
1284
|
+
privateEndpoint?: MhsmPrivateEndpoint;
|
|
1285
|
+
/**
|
|
1286
|
+
* Approval state of the private link connection.
|
|
1287
|
+
*/
|
|
1288
|
+
privateLinkServiceConnectionState?: MhsmPrivateLinkServiceConnectionState;
|
|
1289
|
+
}
|
|
1290
|
+
/**
|
|
1291
|
+
* Input type for Properties of the private endpoint connection resource.
|
|
1292
|
+
*/
|
|
1293
|
+
export interface MhsmPrivateEndpointConnectionPropertiesInput extends InputOf<MhsmPrivateEndpointConnectionProperties> {
|
|
1294
|
+
/**
|
|
1295
|
+
* Properties of the private endpoint object.
|
|
1296
|
+
*/
|
|
1297
|
+
privateEndpoint?: MhsmPrivateEndpointInput | undefined;
|
|
1298
|
+
/**
|
|
1299
|
+
* Approval state of the private link connection.
|
|
1300
|
+
*/
|
|
1301
|
+
privateLinkServiceConnectionState?: MhsmPrivateLinkServiceConnectionStateInput | undefined;
|
|
1302
|
+
}
|
|
1303
|
+
/**
|
|
1304
|
+
* View type for Properties of the private endpoint connection resource.
|
|
1305
|
+
*/
|
|
1306
|
+
export type MhsmPrivateEndpointConnectionPropertiesView = MhsmPrivateEndpointConnectionPropertiesInput;
|
|
1307
|
+
export declare const mhsmPrivateEndpointConnectionPropertiesShape: FlatModelShape;
|
|
1308
|
+
/**
|
|
1309
|
+
* An object that represents the approval state of the private link connection.
|
|
1310
|
+
*/
|
|
1311
|
+
export interface MhsmPrivateLinkServiceConnectionState {
|
|
1312
|
+
/**
|
|
1313
|
+
* A message indicating if changes on the service provider require any updates on the consumer.
|
|
1314
|
+
*/
|
|
1315
|
+
actionsRequired?: ActionsRequired;
|
|
1316
|
+
/**
|
|
1317
|
+
* The reason for approval or rejection.
|
|
1318
|
+
*/
|
|
1319
|
+
description?: string;
|
|
1320
|
+
/**
|
|
1321
|
+
* Indicates whether the connection has been approved, rejected or removed by the key vault owner.
|
|
1322
|
+
*/
|
|
1323
|
+
status?: PrivateEndpointServiceConnectionStatus;
|
|
1324
|
+
}
|
|
1325
|
+
/**
|
|
1326
|
+
* Input type for An object that represents the approval state of the private link connection.
|
|
1327
|
+
*/
|
|
1328
|
+
export interface MhsmPrivateLinkServiceConnectionStateInput extends InputOf<MhsmPrivateLinkServiceConnectionState> {
|
|
1329
|
+
/**
|
|
1330
|
+
* A message indicating if changes on the service provider require any updates on the consumer.
|
|
1331
|
+
*/
|
|
1332
|
+
actionsRequired?: ExpressionOrValue<ActionsRequired> | undefined;
|
|
1333
|
+
/**
|
|
1334
|
+
* The reason for approval or rejection.
|
|
1335
|
+
*/
|
|
1336
|
+
description?: ExpressionOrValue<string> | undefined;
|
|
1337
|
+
/**
|
|
1338
|
+
* Indicates whether the connection has been approved, rejected or removed by the key vault owner.
|
|
1339
|
+
*/
|
|
1340
|
+
status?: ExpressionOrValue<PrivateEndpointServiceConnectionStatus> | undefined;
|
|
1341
|
+
}
|
|
1342
|
+
/**
|
|
1343
|
+
* View type for An object that represents the approval state of the private link connection.
|
|
1344
|
+
*/
|
|
1345
|
+
export type MhsmPrivateLinkServiceConnectionStateView = MhsmPrivateLinkServiceConnectionStateInput;
|
|
1346
|
+
export declare const mhsmPrivateLinkServiceConnectionStateShape: FlatModelShape;
|
|
1347
|
+
/**
|
|
1348
|
+
* A rule governing the accessibility of a managed hsm pool from a specific service tags.
|
|
1349
|
+
*/
|
|
1350
|
+
export interface MhsmServiceTagRule {
|
|
1351
|
+
/**
|
|
1352
|
+
* Name of the service tag.
|
|
1353
|
+
*/
|
|
1354
|
+
tag: string;
|
|
1355
|
+
}
|
|
1356
|
+
/**
|
|
1357
|
+
* Input type for A rule governing the accessibility of a managed hsm pool from a specific service tags.
|
|
1358
|
+
*/
|
|
1359
|
+
export interface MhsmServiceTagRuleInput extends InputOf<MhsmServiceTagRule> {
|
|
1360
|
+
/**
|
|
1361
|
+
* Name of the service tag.
|
|
1362
|
+
*/
|
|
1363
|
+
tag: ExpressionOrValue<string>;
|
|
1364
|
+
}
|
|
1365
|
+
/**
|
|
1366
|
+
* View type for A rule governing the accessibility of a managed hsm pool from a specific service tags.
|
|
1367
|
+
*/
|
|
1368
|
+
export type MhsmServiceTagRuleView = MhsmServiceTagRuleInput;
|
|
1369
|
+
export declare const mhsmServiceTagRuleShape: FlatModelShape;
|
|
1370
|
+
/**
|
|
1371
|
+
* A rule governing the accessibility of a managed hsm pool from a specific virtual network.
|
|
1372
|
+
*/
|
|
1373
|
+
export interface MhsmVirtualNetworkRule {
|
|
1374
|
+
/**
|
|
1375
|
+
* Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.
|
|
1376
|
+
*/
|
|
1377
|
+
id: string;
|
|
1378
|
+
}
|
|
1379
|
+
/**
|
|
1380
|
+
* Input type for A rule governing the accessibility of a managed hsm pool from a specific virtual network.
|
|
1381
|
+
*/
|
|
1382
|
+
export interface MhsmVirtualNetworkRuleInput extends InputOf<MhsmVirtualNetworkRule> {
|
|
1383
|
+
/**
|
|
1384
|
+
* Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.
|
|
1385
|
+
*/
|
|
1386
|
+
id: ExpressionOrValue<string>;
|
|
1387
|
+
}
|
|
1388
|
+
/**
|
|
1389
|
+
* View type for A rule governing the accessibility of a managed hsm pool from a specific virtual network.
|
|
1390
|
+
*/
|
|
1391
|
+
export type MhsmVirtualNetworkRuleView = MhsmVirtualNetworkRuleInput;
|
|
1392
|
+
export declare const mhsmVirtualNetworkRuleShape: FlatModelShape;
|
|
1393
|
+
/**
|
|
1394
|
+
* A set of rules governing the network accessibility of a vault.
|
|
1395
|
+
*/
|
|
1396
|
+
export interface NetworkRuleSet {
|
|
1397
|
+
/**
|
|
1398
|
+
* Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.
|
|
1399
|
+
*/
|
|
1400
|
+
bypass?: NetworkRuleBypassOptions;
|
|
1401
|
+
/**
|
|
1402
|
+
* The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.
|
|
1403
|
+
*/
|
|
1404
|
+
defaultAction?: NetworkRuleAction;
|
|
1405
|
+
/**
|
|
1406
|
+
* The list of IP address rules.
|
|
1407
|
+
*/
|
|
1408
|
+
ipRules?: IpRule[];
|
|
1409
|
+
/**
|
|
1410
|
+
* The list of virtual network rules.
|
|
1411
|
+
*/
|
|
1412
|
+
virtualNetworkRules?: VirtualNetworkRule[];
|
|
1413
|
+
}
|
|
1414
|
+
/**
|
|
1415
|
+
* Input type for A set of rules governing the network accessibility of a vault.
|
|
1416
|
+
*/
|
|
1417
|
+
export interface NetworkRuleSetInput extends InputOf<NetworkRuleSet> {
|
|
1418
|
+
/**
|
|
1419
|
+
* Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.
|
|
1420
|
+
*/
|
|
1421
|
+
bypass?: ExpressionOrValue<NetworkRuleBypassOptions> | undefined;
|
|
1422
|
+
/**
|
|
1423
|
+
* The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.
|
|
1424
|
+
*/
|
|
1425
|
+
defaultAction?: ExpressionOrValue<NetworkRuleAction> | undefined;
|
|
1426
|
+
/**
|
|
1427
|
+
* The list of IP address rules.
|
|
1428
|
+
*/
|
|
1429
|
+
ipRules?: InputArray<IpRuleInput, IpRule[]> | undefined;
|
|
1430
|
+
/**
|
|
1431
|
+
* The list of virtual network rules.
|
|
1432
|
+
*/
|
|
1433
|
+
virtualNetworkRules?: InputArray<VirtualNetworkRuleInput, VirtualNetworkRule[]> | undefined;
|
|
1434
|
+
}
|
|
1435
|
+
/**
|
|
1436
|
+
* View type for A set of rules governing the network accessibility of a vault.
|
|
1437
|
+
*/
|
|
1438
|
+
export type NetworkRuleSetView = NetworkRuleSetInput;
|
|
1439
|
+
export declare const networkRuleSetShape: FlatModelShape;
|
|
1440
|
+
/**
|
|
1441
|
+
* Permissions the identity has for keys, secrets, certificates and storage.
|
|
1442
|
+
*/
|
|
1443
|
+
export interface Permissions {
|
|
1444
|
+
/**
|
|
1445
|
+
* Permissions to certificates
|
|
1446
|
+
*/
|
|
1447
|
+
certificates?: CertificatePermissions[];
|
|
1448
|
+
/**
|
|
1449
|
+
* Permissions to keys
|
|
1450
|
+
*/
|
|
1451
|
+
keys?: KeyPermissions[];
|
|
1452
|
+
/**
|
|
1453
|
+
* Permissions to secrets
|
|
1454
|
+
*/
|
|
1455
|
+
secrets?: SecretPermissions[];
|
|
1456
|
+
/**
|
|
1457
|
+
* Permissions to storage accounts
|
|
1458
|
+
*/
|
|
1459
|
+
storage?: StoragePermissions[];
|
|
1460
|
+
}
|
|
1461
|
+
/**
|
|
1462
|
+
* Input type for Permissions the identity has for keys, secrets, certificates and storage.
|
|
1463
|
+
*/
|
|
1464
|
+
export interface PermissionsInput extends InputOf<Permissions> {
|
|
1465
|
+
/**
|
|
1466
|
+
* Permissions to certificates
|
|
1467
|
+
*/
|
|
1468
|
+
certificates?: InputArray<ExpressionOrValue<CertificatePermissions>, CertificatePermissions[]> | undefined;
|
|
1469
|
+
/**
|
|
1470
|
+
* Permissions to keys
|
|
1471
|
+
*/
|
|
1472
|
+
keys?: InputArray<ExpressionOrValue<KeyPermissions>, KeyPermissions[]> | undefined;
|
|
1473
|
+
/**
|
|
1474
|
+
* Permissions to secrets
|
|
1475
|
+
*/
|
|
1476
|
+
secrets?: InputArray<ExpressionOrValue<SecretPermissions>, SecretPermissions[]> | undefined;
|
|
1477
|
+
/**
|
|
1478
|
+
* Permissions to storage accounts
|
|
1479
|
+
*/
|
|
1480
|
+
storage?: InputArray<ExpressionOrValue<StoragePermissions>, StoragePermissions[]> | undefined;
|
|
1481
|
+
}
|
|
1482
|
+
/**
|
|
1483
|
+
* View type for Permissions the identity has for keys, secrets, certificates and storage.
|
|
1484
|
+
*/
|
|
1485
|
+
export type PermissionsView = PermissionsInput;
|
|
1486
|
+
export declare const permissionsShape: FlatModelShape;
|
|
1487
|
+
/**
|
|
1488
|
+
* Private endpoint object properties.
|
|
1489
|
+
*/
|
|
1490
|
+
export interface PrivateEndpoint {
|
|
1491
|
+
}
|
|
1492
|
+
/**
|
|
1493
|
+
* Input type for Private endpoint object properties.
|
|
1494
|
+
*/
|
|
1495
|
+
export interface PrivateEndpointInput extends InputOf<PrivateEndpoint> {
|
|
1496
|
+
}
|
|
1497
|
+
/**
|
|
1498
|
+
* View type for Private endpoint object properties.
|
|
1499
|
+
*/
|
|
1500
|
+
export type PrivateEndpointView = PrivateEndpointInput;
|
|
1501
|
+
export declare const privateEndpointShape: FlatModelShape;
|
|
1502
|
+
/**
|
|
1503
|
+
* Private endpoint connection item.
|
|
1504
|
+
*/
|
|
1505
|
+
export interface PrivateEndpointConnectionItem {
|
|
1506
|
+
/**
|
|
1507
|
+
* Private endpoint connection properties.
|
|
1508
|
+
*/
|
|
1509
|
+
properties?: PrivateEndpointConnectionProperties;
|
|
1510
|
+
}
|
|
1511
|
+
/**
|
|
1512
|
+
* Input type for Private endpoint connection item.
|
|
1513
|
+
*/
|
|
1514
|
+
export interface PrivateEndpointConnectionItemInput extends InputOf<PrivateEndpointConnectionItem> {
|
|
1515
|
+
}
|
|
1516
|
+
/**
|
|
1517
|
+
* View type for Private endpoint connection item.
|
|
1518
|
+
*/
|
|
1519
|
+
export interface PrivateEndpointConnectionItemView extends InputOf<PrivateEndpointConnectionItem> {
|
|
1520
|
+
/**
|
|
1521
|
+
* Read-only output: Private endpoint connection properties.
|
|
1522
|
+
*/
|
|
1523
|
+
readonly properties?: Expression<PrivateEndpointConnectionProperties> | undefined;
|
|
1524
|
+
}
|
|
1525
|
+
export declare const privateEndpointConnectionItemShape: FlatModelShape;
|
|
1526
|
+
/**
|
|
1527
|
+
* Properties of the private endpoint connection resource.
|
|
1528
|
+
*/
|
|
1529
|
+
export interface PrivateEndpointConnectionProperties {
|
|
1530
|
+
/**
|
|
1531
|
+
* Properties of the private endpoint object.
|
|
1532
|
+
*/
|
|
1533
|
+
privateEndpoint?: PrivateEndpoint;
|
|
1534
|
+
/**
|
|
1535
|
+
* Approval state of the private link connection.
|
|
1536
|
+
*/
|
|
1537
|
+
privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
|
|
1538
|
+
}
|
|
1539
|
+
/**
|
|
1540
|
+
* Input type for Properties of the private endpoint connection resource.
|
|
1541
|
+
*/
|
|
1542
|
+
export interface PrivateEndpointConnectionPropertiesInput extends InputOf<PrivateEndpointConnectionProperties> {
|
|
1543
|
+
/**
|
|
1544
|
+
* Properties of the private endpoint object.
|
|
1545
|
+
*/
|
|
1546
|
+
privateEndpoint?: PrivateEndpointInput | undefined;
|
|
1547
|
+
/**
|
|
1548
|
+
* Approval state of the private link connection.
|
|
1549
|
+
*/
|
|
1550
|
+
privateLinkServiceConnectionState?: PrivateLinkServiceConnectionStateInput | undefined;
|
|
1551
|
+
}
|
|
1552
|
+
/**
|
|
1553
|
+
* View type for Properties of the private endpoint connection resource.
|
|
1554
|
+
*/
|
|
1555
|
+
export type PrivateEndpointConnectionPropertiesView = PrivateEndpointConnectionPropertiesInput;
|
|
1556
|
+
export declare const privateEndpointConnectionPropertiesShape: FlatModelShape;
|
|
1557
|
+
/**
|
|
1558
|
+
* An object that represents the approval state of the private link connection.
|
|
1559
|
+
*/
|
|
1560
|
+
export interface PrivateLinkServiceConnectionState {
|
|
1561
|
+
/**
|
|
1562
|
+
* A message indicating if changes on the service provider require any updates on the consumer.
|
|
1563
|
+
*/
|
|
1564
|
+
actionsRequired?: ActionsRequired;
|
|
1565
|
+
/**
|
|
1566
|
+
* The reason for approval or rejection.
|
|
1567
|
+
*/
|
|
1568
|
+
description?: string;
|
|
1569
|
+
/**
|
|
1570
|
+
* Indicates whether the connection has been approved, rejected or removed by the key vault owner.
|
|
1571
|
+
*/
|
|
1572
|
+
status?: PrivateEndpointServiceConnectionStatus;
|
|
1573
|
+
}
|
|
1574
|
+
/**
|
|
1575
|
+
* Input type for An object that represents the approval state of the private link connection.
|
|
1576
|
+
*/
|
|
1577
|
+
export interface PrivateLinkServiceConnectionStateInput extends InputOf<PrivateLinkServiceConnectionState> {
|
|
1578
|
+
/**
|
|
1579
|
+
* A message indicating if changes on the service provider require any updates on the consumer.
|
|
1580
|
+
*/
|
|
1581
|
+
actionsRequired?: ExpressionOrValue<ActionsRequired> | undefined;
|
|
1582
|
+
/**
|
|
1583
|
+
* The reason for approval or rejection.
|
|
1584
|
+
*/
|
|
1585
|
+
description?: ExpressionOrValue<string> | undefined;
|
|
1586
|
+
/**
|
|
1587
|
+
* Indicates whether the connection has been approved, rejected or removed by the key vault owner.
|
|
1588
|
+
*/
|
|
1589
|
+
status?: ExpressionOrValue<PrivateEndpointServiceConnectionStatus> | undefined;
|
|
1590
|
+
}
|
|
1591
|
+
/**
|
|
1592
|
+
* View type for An object that represents the approval state of the private link connection.
|
|
1593
|
+
*/
|
|
1594
|
+
export type PrivateLinkServiceConnectionStateView = PrivateLinkServiceConnectionStateInput;
|
|
1595
|
+
export declare const privateLinkServiceConnectionStateShape: FlatModelShape;
|
|
1596
|
+
export interface RotationPolicy {
|
|
1597
|
+
/**
|
|
1598
|
+
* The attributes of key rotation policy.
|
|
1599
|
+
*/
|
|
1600
|
+
attributes?: KeyRotationPolicyAttributes;
|
|
1601
|
+
/**
|
|
1602
|
+
* The lifetimeActions for key rotation action.
|
|
1603
|
+
*/
|
|
1604
|
+
lifetimeActions?: LifetimeAction[];
|
|
1605
|
+
}
|
|
1606
|
+
export interface RotationPolicyInput extends InputOf<RotationPolicy> {
|
|
1607
|
+
/**
|
|
1608
|
+
* The attributes of key rotation policy.
|
|
1609
|
+
*/
|
|
1610
|
+
attributes?: KeyRotationPolicyAttributesInput | undefined;
|
|
1611
|
+
/**
|
|
1612
|
+
* The lifetimeActions for key rotation action.
|
|
1613
|
+
*/
|
|
1614
|
+
lifetimeActions?: InputArray<LifetimeActionInput, LifetimeAction[]> | undefined;
|
|
1615
|
+
}
|
|
1616
|
+
export interface RotationPolicyView extends InputOf<RotationPolicy> {
|
|
1617
|
+
/**
|
|
1618
|
+
* The attributes of key rotation policy.
|
|
1619
|
+
*/
|
|
1620
|
+
attributes?: KeyRotationPolicyAttributesView | undefined;
|
|
1621
|
+
/**
|
|
1622
|
+
* The lifetimeActions for key rotation action.
|
|
1623
|
+
*/
|
|
1624
|
+
lifetimeActions?: InputArray<LifetimeActionView, LifetimeAction[]> | undefined;
|
|
1625
|
+
}
|
|
1626
|
+
export declare const rotationPolicyShape: FlatModelShape;
|
|
1627
|
+
/**
|
|
1628
|
+
* The secret management attributes.
|
|
1629
|
+
*/
|
|
1630
|
+
export interface SecretAttributes {
|
|
1631
|
+
/**
|
|
1632
|
+
* Creation time in seconds since 1970-01-01T00:00:00Z.
|
|
1633
|
+
*/
|
|
1634
|
+
created?: Date;
|
|
1635
|
+
/**
|
|
1636
|
+
* Determines whether the object is enabled.
|
|
1637
|
+
*/
|
|
1638
|
+
enabled?: boolean;
|
|
1639
|
+
/**
|
|
1640
|
+
* Expiry date in seconds since 1970-01-01T00:00:00Z.
|
|
1641
|
+
*/
|
|
1642
|
+
expires?: Date;
|
|
1643
|
+
/**
|
|
1644
|
+
* Not before date in seconds since 1970-01-01T00:00:00Z.
|
|
1645
|
+
*/
|
|
1646
|
+
notBefore?: Date;
|
|
1647
|
+
/**
|
|
1648
|
+
* Last updated time in seconds since 1970-01-01T00:00:00Z.
|
|
1649
|
+
*/
|
|
1650
|
+
updated?: Date;
|
|
1651
|
+
}
|
|
1652
|
+
/**
|
|
1653
|
+
* Input type for The secret management attributes.
|
|
1654
|
+
*/
|
|
1655
|
+
export interface SecretAttributesInput extends InputOf<SecretAttributes> {
|
|
1656
|
+
/**
|
|
1657
|
+
* Determines whether the object is enabled.
|
|
1658
|
+
*/
|
|
1659
|
+
enabled?: ExpressionOrValue<boolean> | undefined;
|
|
1660
|
+
/**
|
|
1661
|
+
* Expiry date in seconds since 1970-01-01T00:00:00Z.
|
|
1662
|
+
*/
|
|
1663
|
+
expires?: ExpressionOrValue<Date> | undefined;
|
|
1664
|
+
/**
|
|
1665
|
+
* Not before date in seconds since 1970-01-01T00:00:00Z.
|
|
1666
|
+
*/
|
|
1667
|
+
notBefore?: ExpressionOrValue<Date> | undefined;
|
|
1668
|
+
}
|
|
1669
|
+
/**
|
|
1670
|
+
* View type for The secret management attributes.
|
|
1671
|
+
*/
|
|
1672
|
+
export interface SecretAttributesView extends InputOf<SecretAttributes> {
|
|
1673
|
+
/**
|
|
1674
|
+
* Read-only output: Creation time in seconds since 1970-01-01T00:00:00Z.
|
|
1675
|
+
*/
|
|
1676
|
+
readonly created?: Expression<Date> | undefined;
|
|
1677
|
+
/**
|
|
1678
|
+
* Determines whether the object is enabled.
|
|
1679
|
+
*/
|
|
1680
|
+
enabled?: ExpressionOrValue<boolean> | undefined;
|
|
1681
|
+
/**
|
|
1682
|
+
* Expiry date in seconds since 1970-01-01T00:00:00Z.
|
|
1683
|
+
*/
|
|
1684
|
+
expires?: ExpressionOrValue<Date> | undefined;
|
|
1685
|
+
/**
|
|
1686
|
+
* Not before date in seconds since 1970-01-01T00:00:00Z.
|
|
1687
|
+
*/
|
|
1688
|
+
notBefore?: ExpressionOrValue<Date> | undefined;
|
|
1689
|
+
/**
|
|
1690
|
+
* Read-only output: Last updated time in seconds since 1970-01-01T00:00:00Z.
|
|
1691
|
+
*/
|
|
1692
|
+
readonly updated?: Expression<Date> | undefined;
|
|
1693
|
+
}
|
|
1694
|
+
export declare const secretAttributesShape: FlatModelShape;
|
|
1695
|
+
/**
|
|
1696
|
+
* Properties of the secret
|
|
1697
|
+
*/
|
|
1698
|
+
export interface SecretProperties {
|
|
1699
|
+
/**
|
|
1700
|
+
* The attributes of the secret.
|
|
1701
|
+
*/
|
|
1702
|
+
attributes?: SecretAttributes;
|
|
1703
|
+
/**
|
|
1704
|
+
* The content type of the secret.
|
|
1705
|
+
*/
|
|
1706
|
+
contentType?: string;
|
|
1707
|
+
/**
|
|
1708
|
+
* The URI to retrieve the current version of the secret.
|
|
1709
|
+
*/
|
|
1710
|
+
secretUri?: string;
|
|
1711
|
+
/**
|
|
1712
|
+
* The URI to retrieve the specific version of the secret.
|
|
1713
|
+
*/
|
|
1714
|
+
secretUriWithVersion?: string;
|
|
1715
|
+
/**
|
|
1716
|
+
* 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.
|
|
1717
|
+
*/
|
|
1718
|
+
value?: string;
|
|
1719
|
+
}
|
|
1720
|
+
/**
|
|
1721
|
+
* Input type for Properties of the secret
|
|
1722
|
+
*/
|
|
1723
|
+
export interface SecretPropertiesInput extends InputOf<SecretProperties> {
|
|
1724
|
+
/**
|
|
1725
|
+
* The attributes of the secret.
|
|
1726
|
+
*/
|
|
1727
|
+
attributes?: SecretAttributesInput | undefined;
|
|
1728
|
+
/**
|
|
1729
|
+
* The content type of the secret.
|
|
1730
|
+
*/
|
|
1731
|
+
contentType?: ExpressionOrValue<string> | undefined;
|
|
1732
|
+
/**
|
|
1733
|
+
* 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.
|
|
1734
|
+
*/
|
|
1735
|
+
value?: ExpressionOrValue<string> | undefined;
|
|
1736
|
+
}
|
|
1737
|
+
/**
|
|
1738
|
+
* View type for Properties of the secret
|
|
1739
|
+
*/
|
|
1740
|
+
export interface SecretPropertiesView extends InputOf<SecretProperties> {
|
|
1741
|
+
/**
|
|
1742
|
+
* The attributes of the secret.
|
|
1743
|
+
*/
|
|
1744
|
+
attributes?: SecretAttributesView | undefined;
|
|
1745
|
+
/**
|
|
1746
|
+
* The content type of the secret.
|
|
1747
|
+
*/
|
|
1748
|
+
contentType?: ExpressionOrValue<string> | undefined;
|
|
1749
|
+
/**
|
|
1750
|
+
* Read-only output: The URI to retrieve the current version of the secret.
|
|
1751
|
+
*/
|
|
1752
|
+
readonly secretUri?: Expression<string> | undefined;
|
|
1753
|
+
/**
|
|
1754
|
+
* Read-only output: The URI to retrieve the specific version of the secret.
|
|
1755
|
+
*/
|
|
1756
|
+
readonly secretUriWithVersion?: Expression<string> | undefined;
|
|
1757
|
+
/**
|
|
1758
|
+
* 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.
|
|
1759
|
+
*/
|
|
1760
|
+
value?: ExpressionOrValue<string> | undefined;
|
|
1761
|
+
}
|
|
1762
|
+
export declare const secretPropertiesShape: FlatModelShape;
|
|
1763
|
+
/**
|
|
1764
|
+
* SKU details
|
|
1765
|
+
*/
|
|
1766
|
+
export interface Sku {
|
|
1767
|
+
/**
|
|
1768
|
+
* SKU family name
|
|
1769
|
+
*/
|
|
1770
|
+
family: SkuFamily;
|
|
1771
|
+
/**
|
|
1772
|
+
* SKU name to specify whether the key vault is a standard vault or a premium vault.
|
|
1773
|
+
*/
|
|
1774
|
+
name: SkuName;
|
|
1775
|
+
}
|
|
1776
|
+
/**
|
|
1777
|
+
* Input type for SKU details
|
|
1778
|
+
*/
|
|
1779
|
+
export interface SkuInput extends InputOf<Sku> {
|
|
1780
|
+
/**
|
|
1781
|
+
* SKU family name
|
|
1782
|
+
*/
|
|
1783
|
+
family: ExpressionOrValue<SkuFamily>;
|
|
1784
|
+
/**
|
|
1785
|
+
* SKU name to specify whether the key vault is a standard vault or a premium vault.
|
|
1786
|
+
*/
|
|
1787
|
+
name: ExpressionOrValue<SkuName>;
|
|
1788
|
+
}
|
|
1789
|
+
/**
|
|
1790
|
+
* View type for SKU details
|
|
1791
|
+
*/
|
|
1792
|
+
export type SkuView = SkuInput;
|
|
1793
|
+
export declare const skuShape: FlatModelShape;
|
|
1794
|
+
export interface Trigger {
|
|
1795
|
+
/**
|
|
1796
|
+
* The time duration after key creation to rotate the key. It only applies to rotate. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'.
|
|
1797
|
+
*/
|
|
1798
|
+
timeAfterCreate?: string;
|
|
1799
|
+
/**
|
|
1800
|
+
* The time duration before key expiring to rotate or notify. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'.
|
|
1801
|
+
*/
|
|
1802
|
+
timeBeforeExpiry?: string;
|
|
1803
|
+
}
|
|
1804
|
+
export interface TriggerInput extends InputOf<Trigger> {
|
|
1805
|
+
/**
|
|
1806
|
+
* The time duration after key creation to rotate the key. It only applies to rotate. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'.
|
|
1807
|
+
*/
|
|
1808
|
+
timeAfterCreate?: ExpressionOrValue<string> | undefined;
|
|
1809
|
+
/**
|
|
1810
|
+
* The time duration before key expiring to rotate or notify. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'.
|
|
1811
|
+
*/
|
|
1812
|
+
timeBeforeExpiry?: ExpressionOrValue<string> | undefined;
|
|
1813
|
+
}
|
|
1814
|
+
export type TriggerView = TriggerInput;
|
|
1815
|
+
export declare const triggerShape: FlatModelShape;
|
|
1816
|
+
/**
|
|
1817
|
+
* User assigned identity properties
|
|
1818
|
+
*/
|
|
1819
|
+
export interface UserAssignedIdentity {
|
|
1820
|
+
/**
|
|
1821
|
+
* The client ID of the assigned identity.
|
|
1822
|
+
*/
|
|
1823
|
+
clientId?: string;
|
|
1824
|
+
/**
|
|
1825
|
+
* The principal ID of the assigned identity.
|
|
1826
|
+
*/
|
|
1827
|
+
principalId?: string;
|
|
1828
|
+
}
|
|
1829
|
+
/**
|
|
1830
|
+
* Input type for User assigned identity properties
|
|
1831
|
+
*/
|
|
1832
|
+
export interface UserAssignedIdentityInput extends InputOf<UserAssignedIdentity> {
|
|
1833
|
+
}
|
|
1834
|
+
/**
|
|
1835
|
+
* View type for User assigned identity properties
|
|
1836
|
+
*/
|
|
1837
|
+
export interface UserAssignedIdentityView extends InputOf<UserAssignedIdentity> {
|
|
1838
|
+
/**
|
|
1839
|
+
* Read-only output: The client ID of the assigned identity.
|
|
1840
|
+
*/
|
|
1841
|
+
readonly clientId?: Expression<string> | undefined;
|
|
1842
|
+
/**
|
|
1843
|
+
* Read-only output: The principal ID of the assigned identity.
|
|
1844
|
+
*/
|
|
1845
|
+
readonly principalId?: Expression<string> | undefined;
|
|
1846
|
+
}
|
|
1847
|
+
export declare const userAssignedIdentityShape: FlatModelShape;
|
|
1848
|
+
/**
|
|
1849
|
+
* Properties of the vault access policy
|
|
1850
|
+
*/
|
|
1851
|
+
export interface VaultAccessPolicyProperties {
|
|
1852
|
+
/**
|
|
1853
|
+
* 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.
|
|
1854
|
+
*/
|
|
1855
|
+
accessPolicies: AccessPolicyEntry[];
|
|
1856
|
+
}
|
|
1857
|
+
/**
|
|
1858
|
+
* Input type for Properties of the vault access policy
|
|
1859
|
+
*/
|
|
1860
|
+
export interface VaultAccessPolicyPropertiesInput extends InputOf<VaultAccessPolicyProperties> {
|
|
1861
|
+
/**
|
|
1862
|
+
* 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.
|
|
1863
|
+
*/
|
|
1864
|
+
accessPolicies: InputArray<AccessPolicyEntryInput, AccessPolicyEntry[]>;
|
|
1865
|
+
}
|
|
1866
|
+
/**
|
|
1867
|
+
* View type for Properties of the vault access policy
|
|
1868
|
+
*/
|
|
1869
|
+
export type VaultAccessPolicyPropertiesView = VaultAccessPolicyPropertiesInput;
|
|
1870
|
+
export declare const vaultAccessPolicyPropertiesShape: FlatModelShape;
|
|
1871
|
+
/**
|
|
1872
|
+
* Properties of the vault
|
|
1873
|
+
*/
|
|
1874
|
+
export interface VaultProperties {
|
|
1875
|
+
/**
|
|
1876
|
+
* 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.
|
|
1877
|
+
*/
|
|
1878
|
+
accessPolicies?: AccessPolicyEntry[];
|
|
1879
|
+
/**
|
|
1880
|
+
* The vault's create mode to indicate whether the vault need to be recovered or not.
|
|
1881
|
+
*/
|
|
1882
|
+
createMode?: CreateMode;
|
|
1883
|
+
/**
|
|
1884
|
+
* Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
|
|
1885
|
+
*/
|
|
1886
|
+
enabledForDeployment?: boolean;
|
|
1887
|
+
/**
|
|
1888
|
+
* Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
|
|
1889
|
+
*/
|
|
1890
|
+
enabledForDiskEncryption?: boolean;
|
|
1891
|
+
/**
|
|
1892
|
+
* Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
|
|
1893
|
+
*/
|
|
1894
|
+
enabledForTemplateDeployment?: boolean;
|
|
1895
|
+
/**
|
|
1896
|
+
* 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.
|
|
1897
|
+
*/
|
|
1898
|
+
enablePurgeProtection?: boolean;
|
|
1899
|
+
/**
|
|
1900
|
+
* 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.
|
|
1901
|
+
*/
|
|
1902
|
+
enableRbacAuthorization?: boolean;
|
|
1903
|
+
/**
|
|
1904
|
+
* 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.
|
|
1905
|
+
*/
|
|
1906
|
+
enableSoftDelete?: boolean;
|
|
1907
|
+
/**
|
|
1908
|
+
* The resource id of HSM Pool.
|
|
1909
|
+
*/
|
|
1910
|
+
hsmPoolResourceId?: string;
|
|
1911
|
+
/**
|
|
1912
|
+
* Rules governing the accessibility of the key vault from specific network locations.
|
|
1913
|
+
*/
|
|
1914
|
+
networkAcls?: NetworkRuleSet;
|
|
1915
|
+
/**
|
|
1916
|
+
* List of private endpoint connections associated with the key vault.
|
|
1917
|
+
*/
|
|
1918
|
+
privateEndpointConnections?: PrivateEndpointConnectionItem[];
|
|
1919
|
+
/**
|
|
1920
|
+
* Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules.
|
|
1921
|
+
*/
|
|
1922
|
+
publicNetworkAccess?: string;
|
|
1923
|
+
/**
|
|
1924
|
+
* SKU details
|
|
1925
|
+
*/
|
|
1926
|
+
sku: Sku;
|
|
1927
|
+
/**
|
|
1928
|
+
* softDelete data retention days. It accepts \>=7 and \<=90.
|
|
1929
|
+
*/
|
|
1930
|
+
softDeleteRetentionInDays?: number;
|
|
1931
|
+
/**
|
|
1932
|
+
* The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
|
|
1933
|
+
*/
|
|
1934
|
+
tenantId: string;
|
|
1935
|
+
/**
|
|
1936
|
+
* The URI of the vault for performing operations on keys and secrets.
|
|
1937
|
+
*/
|
|
1938
|
+
vaultUri?: string;
|
|
1939
|
+
}
|
|
1940
|
+
/**
|
|
1941
|
+
* Input type for Properties of the vault
|
|
1942
|
+
*/
|
|
1943
|
+
export interface VaultPropertiesInput extends InputOf<VaultProperties> {
|
|
1944
|
+
/**
|
|
1945
|
+
* 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.
|
|
1946
|
+
*/
|
|
1947
|
+
accessPolicies?: InputArray<AccessPolicyEntryInput, AccessPolicyEntry[]> | undefined;
|
|
1948
|
+
/**
|
|
1949
|
+
* The vault's create mode to indicate whether the vault need to be recovered or not.
|
|
1950
|
+
*/
|
|
1951
|
+
createMode?: ExpressionOrValue<CreateMode> | undefined;
|
|
1952
|
+
/**
|
|
1953
|
+
* Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
|
|
1954
|
+
*/
|
|
1955
|
+
enabledForDeployment?: ExpressionOrValue<boolean> | undefined;
|
|
1956
|
+
/**
|
|
1957
|
+
* Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
|
|
1958
|
+
*/
|
|
1959
|
+
enabledForDiskEncryption?: ExpressionOrValue<boolean> | undefined;
|
|
1960
|
+
/**
|
|
1961
|
+
* Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
|
|
1962
|
+
*/
|
|
1963
|
+
enabledForTemplateDeployment?: ExpressionOrValue<boolean> | undefined;
|
|
1964
|
+
/**
|
|
1965
|
+
* 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.
|
|
1966
|
+
*/
|
|
1967
|
+
enablePurgeProtection?: ExpressionOrValue<boolean> | undefined;
|
|
1968
|
+
/**
|
|
1969
|
+
* 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.
|
|
1970
|
+
*/
|
|
1971
|
+
enableRbacAuthorization?: ExpressionOrValue<boolean> | undefined;
|
|
1972
|
+
/**
|
|
1973
|
+
* 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.
|
|
1974
|
+
*/
|
|
1975
|
+
enableSoftDelete?: ExpressionOrValue<boolean> | undefined;
|
|
1976
|
+
/**
|
|
1977
|
+
* Rules governing the accessibility of the key vault from specific network locations.
|
|
1978
|
+
*/
|
|
1979
|
+
networkAcls?: NetworkRuleSetInput | undefined;
|
|
1980
|
+
/**
|
|
1981
|
+
* Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules.
|
|
1982
|
+
*/
|
|
1983
|
+
publicNetworkAccess?: ExpressionOrValue<string> | undefined;
|
|
1984
|
+
/**
|
|
1985
|
+
* SKU details
|
|
1986
|
+
*/
|
|
1987
|
+
sku: SkuInput;
|
|
1988
|
+
/**
|
|
1989
|
+
* softDelete data retention days. It accepts \>=7 and \<=90.
|
|
1990
|
+
*/
|
|
1991
|
+
softDeleteRetentionInDays?: ExpressionOrValue<number> | undefined;
|
|
1992
|
+
/**
|
|
1993
|
+
* The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
|
|
1994
|
+
*/
|
|
1995
|
+
tenantId: ExpressionOrValue<string>;
|
|
1996
|
+
/**
|
|
1997
|
+
* The URI of the vault for performing operations on keys and secrets.
|
|
1998
|
+
*/
|
|
1999
|
+
vaultUri?: ExpressionOrValue<string> | undefined;
|
|
2000
|
+
}
|
|
2001
|
+
/**
|
|
2002
|
+
* View type for Properties of the vault
|
|
2003
|
+
*/
|
|
2004
|
+
export interface VaultPropertiesView extends InputOf<VaultProperties> {
|
|
2005
|
+
/**
|
|
2006
|
+
* 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.
|
|
2007
|
+
*/
|
|
2008
|
+
accessPolicies?: InputArray<AccessPolicyEntryView, AccessPolicyEntry[]> | undefined;
|
|
2009
|
+
/**
|
|
2010
|
+
* The vault's create mode to indicate whether the vault need to be recovered or not.
|
|
2011
|
+
*/
|
|
2012
|
+
createMode?: ExpressionOrValue<CreateMode> | undefined;
|
|
2013
|
+
/**
|
|
2014
|
+
* Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
|
|
2015
|
+
*/
|
|
2016
|
+
enabledForDeployment?: ExpressionOrValue<boolean> | undefined;
|
|
2017
|
+
/**
|
|
2018
|
+
* Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
|
|
2019
|
+
*/
|
|
2020
|
+
enabledForDiskEncryption?: ExpressionOrValue<boolean> | undefined;
|
|
2021
|
+
/**
|
|
2022
|
+
* Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
|
|
2023
|
+
*/
|
|
2024
|
+
enabledForTemplateDeployment?: ExpressionOrValue<boolean> | undefined;
|
|
2025
|
+
/**
|
|
2026
|
+
* 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.
|
|
2027
|
+
*/
|
|
2028
|
+
enablePurgeProtection?: ExpressionOrValue<boolean> | undefined;
|
|
2029
|
+
/**
|
|
2030
|
+
* 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.
|
|
2031
|
+
*/
|
|
2032
|
+
enableRbacAuthorization?: ExpressionOrValue<boolean> | undefined;
|
|
2033
|
+
/**
|
|
2034
|
+
* 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.
|
|
2035
|
+
*/
|
|
2036
|
+
enableSoftDelete?: ExpressionOrValue<boolean> | undefined;
|
|
2037
|
+
/**
|
|
2038
|
+
* Read-only output: The resource id of HSM Pool.
|
|
2039
|
+
*/
|
|
2040
|
+
readonly hsmPoolResourceId?: Expression<string> | undefined;
|
|
2041
|
+
/**
|
|
2042
|
+
* Rules governing the accessibility of the key vault from specific network locations.
|
|
2043
|
+
*/
|
|
2044
|
+
networkAcls?: NetworkRuleSetView | undefined;
|
|
2045
|
+
/**
|
|
2046
|
+
* Read-only output: List of private endpoint connections associated with the key vault.
|
|
2047
|
+
*/
|
|
2048
|
+
readonly privateEndpointConnections?: Expression<PrivateEndpointConnectionItem[]> | undefined;
|
|
2049
|
+
/**
|
|
2050
|
+
* Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules.
|
|
2051
|
+
*/
|
|
2052
|
+
publicNetworkAccess?: ExpressionOrValue<string> | undefined;
|
|
2053
|
+
/**
|
|
2054
|
+
* SKU details
|
|
2055
|
+
*/
|
|
2056
|
+
sku: SkuView;
|
|
2057
|
+
/**
|
|
2058
|
+
* softDelete data retention days. It accepts \>=7 and \<=90.
|
|
2059
|
+
*/
|
|
2060
|
+
softDeleteRetentionInDays?: ExpressionOrValue<number> | undefined;
|
|
2061
|
+
/**
|
|
2062
|
+
* The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
|
|
2063
|
+
*/
|
|
2064
|
+
tenantId: ExpressionOrValue<string>;
|
|
2065
|
+
/**
|
|
2066
|
+
* The URI of the vault for performing operations on keys and secrets.
|
|
2067
|
+
*/
|
|
2068
|
+
vaultUri?: ExpressionOrValue<string> | undefined;
|
|
2069
|
+
}
|
|
2070
|
+
export declare const vaultPropertiesShape: FlatModelShape;
|
|
2071
|
+
/**
|
|
2072
|
+
* A rule governing the accessibility of a vault from a specific virtual network.
|
|
2073
|
+
*/
|
|
2074
|
+
export interface VirtualNetworkRule {
|
|
2075
|
+
/**
|
|
2076
|
+
* Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.
|
|
2077
|
+
*/
|
|
2078
|
+
id: string;
|
|
2079
|
+
/**
|
|
2080
|
+
* Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured.
|
|
2081
|
+
*/
|
|
2082
|
+
ignoreMissingVnetServiceEndpoint?: boolean;
|
|
2083
|
+
}
|
|
2084
|
+
/**
|
|
2085
|
+
* Input type for A rule governing the accessibility of a vault from a specific virtual network.
|
|
2086
|
+
*/
|
|
2087
|
+
export interface VirtualNetworkRuleInput extends InputOf<VirtualNetworkRule> {
|
|
2088
|
+
/**
|
|
2089
|
+
* Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.
|
|
2090
|
+
*/
|
|
2091
|
+
id: ExpressionOrValue<string>;
|
|
2092
|
+
/**
|
|
2093
|
+
* Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured.
|
|
2094
|
+
*/
|
|
2095
|
+
ignoreMissingVnetServiceEndpoint?: ExpressionOrValue<boolean> | undefined;
|
|
2096
|
+
}
|
|
2097
|
+
/**
|
|
2098
|
+
* View type for A rule governing the accessibility of a vault from a specific virtual network.
|
|
2099
|
+
*/
|
|
2100
|
+
export type VirtualNetworkRuleView = VirtualNetworkRuleInput;
|
|
2101
|
+
export declare const virtualNetworkRuleShape: FlatModelShape;
|
|
2102
|
+
/**
|
|
2103
|
+
* A message indicating if changes on the service provider require any updates on the consumer.
|
|
2104
|
+
*
|
|
2105
|
+
* Known values:
|
|
2106
|
+
*
|
|
2107
|
+
* - `"None"`
|
|
2108
|
+
*/
|
|
2109
|
+
export type ActionsRequired = string;
|
|
2110
|
+
/**
|
|
2111
|
+
* Activation Status
|
|
2112
|
+
*
|
|
2113
|
+
* Known values:
|
|
2114
|
+
*
|
|
2115
|
+
* - `"Active"`: The managed HSM Pool is active.
|
|
2116
|
+
*
|
|
2117
|
+
* - `"NotActivated"`: The managed HSM Pool is not yet activated.
|
|
2118
|
+
*
|
|
2119
|
+
* - `"Unknown"`: An unknown error occurred while activating managed hsm.
|
|
2120
|
+
*
|
|
2121
|
+
* - `"Failed"`: Failed to activate managed hsm.
|
|
2122
|
+
*/
|
|
2123
|
+
export type ActivationStatus = string;
|
|
2124
|
+
/**
|
|
2125
|
+
* Known values:
|
|
2126
|
+
*
|
|
2127
|
+
* - `"all"`
|
|
2128
|
+
*
|
|
2129
|
+
* - `"get"`
|
|
2130
|
+
*
|
|
2131
|
+
* - `"list"`
|
|
2132
|
+
*
|
|
2133
|
+
* - `"delete"`
|
|
2134
|
+
*
|
|
2135
|
+
* - `"create"`
|
|
2136
|
+
*
|
|
2137
|
+
* - `"import"`
|
|
2138
|
+
*
|
|
2139
|
+
* - `"update"`
|
|
2140
|
+
*
|
|
2141
|
+
* - `"managecontacts"`
|
|
2142
|
+
*
|
|
2143
|
+
* - `"getissuers"`
|
|
2144
|
+
*
|
|
2145
|
+
* - `"listissuers"`
|
|
2146
|
+
*
|
|
2147
|
+
* - `"setissuers"`
|
|
2148
|
+
*
|
|
2149
|
+
* - `"deleteissuers"`
|
|
2150
|
+
*
|
|
2151
|
+
* - `"manageissuers"`
|
|
2152
|
+
*
|
|
2153
|
+
* - `"recover"`
|
|
2154
|
+
*
|
|
2155
|
+
* - `"purge"`
|
|
2156
|
+
*
|
|
2157
|
+
* - `"backup"`
|
|
2158
|
+
*
|
|
2159
|
+
* - `"restore"`
|
|
2160
|
+
*/
|
|
2161
|
+
export type CertificatePermissions = string;
|
|
2162
|
+
/**
|
|
2163
|
+
* The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
|
|
2164
|
+
*
|
|
2165
|
+
* Known values:
|
|
2166
|
+
*
|
|
2167
|
+
* - `"Purgeable"`
|
|
2168
|
+
*
|
|
2169
|
+
* - `"Recoverable+Purgeable"`
|
|
2170
|
+
*
|
|
2171
|
+
* - `"Recoverable"`
|
|
2172
|
+
*
|
|
2173
|
+
* - `"Recoverable+ProtectedSubscription"`
|
|
2174
|
+
*/
|
|
2175
|
+
export type DeletionRecoveryLevel = string;
|
|
2176
|
+
/**
|
|
2177
|
+
* The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256
|
|
2178
|
+
*
|
|
2179
|
+
* Known values:
|
|
2180
|
+
*
|
|
2181
|
+
* - `"P-256"`
|
|
2182
|
+
*
|
|
2183
|
+
* - `"P-384"`
|
|
2184
|
+
*
|
|
2185
|
+
* - `"P-521"`
|
|
2186
|
+
*
|
|
2187
|
+
* - `"P-256K"`
|
|
2188
|
+
*/
|
|
2189
|
+
export type JsonWebKeyCurveName = string;
|
|
2190
|
+
/**
|
|
2191
|
+
* The permitted JSON web key operations of the key. For more information, see JsonWebKeyOperation.
|
|
2192
|
+
*
|
|
2193
|
+
* Known values:
|
|
2194
|
+
*
|
|
2195
|
+
* - `"encrypt"`
|
|
2196
|
+
*
|
|
2197
|
+
* - `"decrypt"`
|
|
2198
|
+
*
|
|
2199
|
+
* - `"sign"`
|
|
2200
|
+
*
|
|
2201
|
+
* - `"verify"`
|
|
2202
|
+
*
|
|
2203
|
+
* - `"wrapKey"`
|
|
2204
|
+
*
|
|
2205
|
+
* - `"unwrapKey"`
|
|
2206
|
+
*
|
|
2207
|
+
* - `"import"`
|
|
2208
|
+
*
|
|
2209
|
+
* - `"release"`
|
|
2210
|
+
*/
|
|
2211
|
+
export type JsonWebKeyOperation = string;
|
|
2212
|
+
/**
|
|
2213
|
+
* The type of the key. For valid values, see JsonWebKeyType.
|
|
2214
|
+
*
|
|
2215
|
+
* Known values:
|
|
2216
|
+
*
|
|
2217
|
+
* - `"EC"`
|
|
2218
|
+
*
|
|
2219
|
+
* - `"EC-HSM"`
|
|
2220
|
+
*
|
|
2221
|
+
* - `"RSA"`
|
|
2222
|
+
*
|
|
2223
|
+
* - `"RSA-HSM"`
|
|
2224
|
+
*/
|
|
2225
|
+
export type JsonWebKeyType = string;
|
|
2226
|
+
/**
|
|
2227
|
+
* Known values:
|
|
2228
|
+
*
|
|
2229
|
+
* - `"all"`
|
|
2230
|
+
*
|
|
2231
|
+
* - `"encrypt"`
|
|
2232
|
+
*
|
|
2233
|
+
* - `"decrypt"`
|
|
2234
|
+
*
|
|
2235
|
+
* - `"wrapKey"`
|
|
2236
|
+
*
|
|
2237
|
+
* - `"unwrapKey"`
|
|
2238
|
+
*
|
|
2239
|
+
* - `"sign"`
|
|
2240
|
+
*
|
|
2241
|
+
* - `"verify"`
|
|
2242
|
+
*
|
|
2243
|
+
* - `"get"`
|
|
2244
|
+
*
|
|
2245
|
+
* - `"list"`
|
|
2246
|
+
*
|
|
2247
|
+
* - `"create"`
|
|
2248
|
+
*
|
|
2249
|
+
* - `"update"`
|
|
2250
|
+
*
|
|
2251
|
+
* - `"import"`
|
|
2252
|
+
*
|
|
2253
|
+
* - `"delete"`
|
|
2254
|
+
*
|
|
2255
|
+
* - `"backup"`
|
|
2256
|
+
*
|
|
2257
|
+
* - `"restore"`
|
|
2258
|
+
*
|
|
2259
|
+
* - `"recover"`
|
|
2260
|
+
*
|
|
2261
|
+
* - `"purge"`
|
|
2262
|
+
*
|
|
2263
|
+
* - `"release"`
|
|
2264
|
+
*
|
|
2265
|
+
* - `"rotate"`
|
|
2266
|
+
*
|
|
2267
|
+
* - `"getrotationpolicy"`
|
|
2268
|
+
*
|
|
2269
|
+
* - `"setrotationpolicy"`
|
|
2270
|
+
*/
|
|
2271
|
+
export type KeyPermissions = string;
|
|
2272
|
+
/**
|
|
2273
|
+
* SKU Family of the managed HSM Pool
|
|
2274
|
+
*
|
|
2275
|
+
* Known values:
|
|
2276
|
+
*
|
|
2277
|
+
* - `"B"`
|
|
2278
|
+
*
|
|
2279
|
+
* - `"C"`
|
|
2280
|
+
*/
|
|
2281
|
+
export type ManagedHsmSkuFamily = string;
|
|
2282
|
+
/**
|
|
2283
|
+
* Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
|
|
2284
|
+
*
|
|
2285
|
+
* Known values:
|
|
2286
|
+
*
|
|
2287
|
+
* - `"None"`: No managed identity.
|
|
2288
|
+
*
|
|
2289
|
+
* - `"SystemAssigned"`: System assigned managed identity.
|
|
2290
|
+
*
|
|
2291
|
+
* - `"UserAssigned"`: User assigned managed identity.
|
|
2292
|
+
*
|
|
2293
|
+
* - `"SystemAssigned,UserAssigned"`: System and user assigned managed identity.
|
|
2294
|
+
*/
|
|
2295
|
+
export type ManagedServiceIdentityType = string;
|
|
2296
|
+
/**
|
|
2297
|
+
* The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.
|
|
2298
|
+
*
|
|
2299
|
+
* Known values:
|
|
2300
|
+
*
|
|
2301
|
+
* - `"Allow"`
|
|
2302
|
+
*
|
|
2303
|
+
* - `"Deny"`
|
|
2304
|
+
*/
|
|
2305
|
+
export type NetworkRuleAction = string;
|
|
2306
|
+
/**
|
|
2307
|
+
* Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.
|
|
2308
|
+
*
|
|
2309
|
+
* Known values:
|
|
2310
|
+
*
|
|
2311
|
+
* - `"AzureServices"`
|
|
2312
|
+
*
|
|
2313
|
+
* - `"None"`
|
|
2314
|
+
*/
|
|
2315
|
+
export type NetworkRuleBypassOptions = string;
|
|
2316
|
+
/**
|
|
2317
|
+
* The private endpoint connection status.
|
|
2318
|
+
*
|
|
2319
|
+
* Known values:
|
|
2320
|
+
*
|
|
2321
|
+
* - `"Pending"`
|
|
2322
|
+
*
|
|
2323
|
+
* - `"Approved"`
|
|
2324
|
+
*
|
|
2325
|
+
* - `"Rejected"`
|
|
2326
|
+
*
|
|
2327
|
+
* - `"Disconnected"`
|
|
2328
|
+
*/
|
|
2329
|
+
export type PrivateEndpointServiceConnectionStatus = string;
|
|
2330
|
+
/**
|
|
2331
|
+
* Control permission to the managed HSM from public networks.
|
|
2332
|
+
*
|
|
2333
|
+
* Known values:
|
|
2334
|
+
*
|
|
2335
|
+
* - `"Enabled"`
|
|
2336
|
+
*
|
|
2337
|
+
* - `"Disabled"`
|
|
2338
|
+
*/
|
|
2339
|
+
export type PublicNetworkAccess = string;
|
|
2340
|
+
/**
|
|
2341
|
+
* Known values:
|
|
2342
|
+
*
|
|
2343
|
+
* - `"all"`
|
|
2344
|
+
*
|
|
2345
|
+
* - `"get"`
|
|
2346
|
+
*
|
|
2347
|
+
* - `"list"`
|
|
2348
|
+
*
|
|
2349
|
+
* - `"set"`
|
|
2350
|
+
*
|
|
2351
|
+
* - `"delete"`
|
|
2352
|
+
*
|
|
2353
|
+
* - `"backup"`
|
|
2354
|
+
*
|
|
2355
|
+
* - `"restore"`
|
|
2356
|
+
*
|
|
2357
|
+
* - `"recover"`
|
|
2358
|
+
*
|
|
2359
|
+
* - `"purge"`
|
|
2360
|
+
*/
|
|
2361
|
+
export type SecretPermissions = string;
|
|
2362
|
+
/**
|
|
2363
|
+
* SKU family name
|
|
2364
|
+
*
|
|
2365
|
+
* Known values:
|
|
2366
|
+
*
|
|
2367
|
+
* - `"A"`
|
|
2368
|
+
*/
|
|
2369
|
+
export type SkuFamily = string;
|
|
2370
|
+
/**
|
|
2371
|
+
* Known values:
|
|
2372
|
+
*
|
|
2373
|
+
* - `"all"`
|
|
2374
|
+
*
|
|
2375
|
+
* - `"get"`
|
|
2376
|
+
*
|
|
2377
|
+
* - `"list"`
|
|
2378
|
+
*
|
|
2379
|
+
* - `"delete"`
|
|
2380
|
+
*
|
|
2381
|
+
* - `"set"`
|
|
2382
|
+
*
|
|
2383
|
+
* - `"update"`
|
|
2384
|
+
*
|
|
2385
|
+
* - `"regeneratekey"`
|
|
2386
|
+
*
|
|
2387
|
+
* - `"recover"`
|
|
2388
|
+
*
|
|
2389
|
+
* - `"purge"`
|
|
2390
|
+
*
|
|
2391
|
+
* - `"backup"`
|
|
2392
|
+
*
|
|
2393
|
+
* - `"restore"`
|
|
2394
|
+
*
|
|
2395
|
+
* - `"setsas"`
|
|
2396
|
+
*
|
|
2397
|
+
* - `"listsas"`
|
|
2398
|
+
*
|
|
2399
|
+
* - `"getsas"`
|
|
2400
|
+
*
|
|
2401
|
+
* - `"deletesas"`
|
|
2402
|
+
*/
|
|
2403
|
+
export type StoragePermissions = string;
|
|
2404
|
+
//# sourceMappingURL=types.d.ts.map
|