/
KeyProperties.yml
244 lines (234 loc) · 6.79 KB
/
KeyProperties.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
### YamlMime:TSType
name: KeyProperties
uid: '@azure/keyvault-keys.KeyProperties'
package: '@azure/keyvault-keys'
summary: >-
An interface representing the Properties of
[KeyVaultKey](xref:@azure/keyvault-keys.KeyVaultKey)
fullName: KeyProperties
remarks: ''
isDeprecated: false
type: interface
properties:
- name: createdOn
uid: '@azure/keyvault-keys.KeyProperties.createdOn'
package: '@azure/keyvault-keys'
summary: |-
Creation time in UTC.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
fullName: createdOn
remarks: ''
isDeprecated: false
syntax:
content: 'createdOn?: Date'
return:
description: ''
type: Date
- name: enabled
uid: '@azure/keyvault-keys.KeyProperties.enabled'
package: '@azure/keyvault-keys'
summary: Determines whether the object is enabled.
fullName: enabled
remarks: ''
isDeprecated: false
syntax:
content: 'enabled?: boolean'
return:
description: ''
type: boolean
- name: expiresOn
uid: '@azure/keyvault-keys.KeyProperties.expiresOn'
package: '@azure/keyvault-keys'
summary: Expiry date in UTC.
fullName: expiresOn
remarks: ''
isDeprecated: false
syntax:
content: 'expiresOn?: Date'
return:
description: ''
type: Date
- name: exportable
uid: '@azure/keyvault-keys.KeyProperties.exportable'
package: '@azure/keyvault-keys'
summary: Indicates whether the private key can be exported.
fullName: exportable
remarks: ''
isDeprecated: false
syntax:
content: 'exportable?: boolean'
return:
description: ''
type: boolean
- name: hsmPlatform
uid: '@azure/keyvault-keys.KeyProperties.hsmPlatform'
package: '@azure/keyvault-keys'
summary: >-
The underlying HSM Platform.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: hsmPlatform
remarks: ''
isDeprecated: false
syntax:
content: 'hsmPlatform?: string'
return:
description: ''
type: string
- name: id
uid: '@azure/keyvault-keys.KeyProperties.id'
package: '@azure/keyvault-keys'
summary: Key identifier.
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id?: string'
return:
description: ''
type: string
- name: managed
uid: '@azure/keyvault-keys.KeyProperties.managed'
package: '@azure/keyvault-keys'
summary: |-
True if the secret's lifetime is managed by
key vault. If this is a secret backing a certificate, then managed will be
true.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
fullName: managed
remarks: ''
isDeprecated: false
syntax:
content: 'managed?: boolean'
return:
description: ''
type: boolean
- name: name
uid: '@azure/keyvault-keys.KeyProperties.name'
package: '@azure/keyvault-keys'
summary: The name of the key.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name: string'
return:
description: ''
type: string
- name: notBefore
uid: '@azure/keyvault-keys.KeyProperties.notBefore'
package: '@azure/keyvault-keys'
summary: Not before date in UTC.
fullName: notBefore
remarks: ''
isDeprecated: false
syntax:
content: 'notBefore?: Date'
return:
description: ''
type: Date
- name: recoverableDays
uid: '@azure/keyvault-keys.KeyProperties.recoverableDays'
package: '@azure/keyvault-keys'
summary: >-
The retention dates of the softDelete data.
The value should be `>=7` and `<=90` when softDelete enabled.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
fullName: recoverableDays
remarks: ''
isDeprecated: false
syntax:
content: 'recoverableDays?: number'
return:
description: ''
type: number
- name: recoveryLevel
uid: '@azure/keyvault-keys.KeyProperties.recoveryLevel'
package: '@azure/keyvault-keys'
summary: >-
Reflects the deletion recovery level currently in effect for keys in the
current vault.
If it contains 'Purgeable' the key can be permanently deleted by a
privileged
user; otherwise, only the system can purge the key, at the end of the
retention interval. Possible values include: 'Purgeable',
'Recoverable+Purgeable', 'Recoverable',
'Recoverable+ProtectedSubscription'
**NOTE: This property will not be serialized. It can only be populated by
the server.**
fullName: recoveryLevel
remarks: ''
isDeprecated: false
syntax:
content: 'recoveryLevel?: string'
return:
description: ''
type: string
- name: releasePolicy
uid: '@azure/keyvault-keys.KeyProperties.releasePolicy'
package: '@azure/keyvault-keys'
summary: >-
A [KeyReleasePolicy](xref:@azure/keyvault-keys.KeyReleasePolicy) object
specifying the rules under which the key can be exported.
fullName: releasePolicy
remarks: ''
isDeprecated: false
syntax:
content: 'releasePolicy?: KeyReleasePolicy'
return:
description: ''
type: <xref uid="@azure/keyvault-keys.KeyReleasePolicy" />
- name: tags
uid: '@azure/keyvault-keys.KeyProperties.tags'
package: '@azure/keyvault-keys'
summary: Application specific metadata in the form of key-value pairs.
fullName: tags
remarks: ''
isDeprecated: false
syntax:
content: 'tags?: {[propertyName: string]: string}'
return:
description: ''
type: '{[propertyName: string]: string}'
- name: updatedOn
uid: '@azure/keyvault-keys.KeyProperties.updatedOn'
package: '@azure/keyvault-keys'
summary: |-
Last updated time in UTC.
**NOTE: This property will not be serialized. It can only be populated by
the server.**
fullName: updatedOn
remarks: ''
isDeprecated: false
syntax:
content: 'updatedOn?: Date'
return:
description: ''
type: Date
- name: vaultUrl
uid: '@azure/keyvault-keys.KeyProperties.vaultUrl'
package: '@azure/keyvault-keys'
summary: The vault URI.
fullName: vaultUrl
remarks: ''
isDeprecated: false
syntax:
content: 'vaultUrl: string'
return:
description: ''
type: string
- name: version
uid: '@azure/keyvault-keys.KeyProperties.version'
package: '@azure/keyvault-keys'
summary: The version of the key. May be undefined.
fullName: version
remarks: ''
isDeprecated: false
syntax:
content: 'version?: string'
return:
description: ''
type: string