-
Notifications
You must be signed in to change notification settings - Fork 180
/
CreateEcKeyOptions.yml
247 lines (247 loc) · 8.49 KB
/
CreateEcKeyOptions.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
245
246
247
### YamlMime:TSType
name: CreateEcKeyOptions
uid: '@azure/keyvault-keys.CreateEcKeyOptions'
package: '@azure/keyvault-keys'
summary: |-
An interface representing the optional parameters that can be
passed to <xref:@azure/keyvault-keys.KeyClient.createEcKey>
fullName: CreateEcKeyOptions
remarks: ''
isDeprecated: false
type: interface
inheritedProperties:
- name: abortSignal
uid: '@azure/keyvault-keys.CreateEcKeyOptions.abortSignal'
package: '@azure/keyvault-keys'
summary: The signal which can be used to abort requests.
fullName: abortSignal
remarks: ''
isDeprecated: false
syntax:
content: 'abortSignal?: AbortSignalLike'
return:
description: ''
type: <xref uid="@azure/abort-controller.AbortSignalLike" />
inheritanceDescription: >-
<b>Inherited From</b>
[CreateKeyOptions.abortSignal](xref:@azure/keyvault-keys.CreateKeyOptions.abortSignal)
- name: curve
uid: '@azure/keyvault-keys.CreateEcKeyOptions.curve'
package: '@azure/keyvault-keys'
summary: |-
Elliptic curve name. For valid values, see KeyCurveName.
Possible values include: 'P-256', 'P-384', 'P-521', 'P-256K'
fullName: curve
remarks: ''
isDeprecated: false
syntax:
content: 'curve?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[CreateKeyOptions.curve](xref:@azure/keyvault-keys.CreateKeyOptions.curve)
- name: enabled
uid: '@azure/keyvault-keys.CreateEcKeyOptions.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
inheritanceDescription: >-
<b>Inherited From</b>
[CreateKeyOptions.enabled](xref:@azure/keyvault-keys.CreateKeyOptions.enabled)
- name: expiresOn
uid: '@azure/keyvault-keys.CreateEcKeyOptions.expiresOn'
package: '@azure/keyvault-keys'
summary: Expiry date in UTC.
fullName: expiresOn
remarks: ''
isDeprecated: false
syntax:
content: 'expiresOn?: Date'
return:
description: ''
type: Date
inheritanceDescription: >-
<b>Inherited From</b>
[CreateKeyOptions.expiresOn](xref:@azure/keyvault-keys.CreateKeyOptions.expiresOn)
- name: exportable
uid: '@azure/keyvault-keys.CreateEcKeyOptions.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
inheritanceDescription: >-
<b>Inherited From</b>
[CreateKeyOptions.exportable](xref:@azure/keyvault-keys.CreateKeyOptions.exportable)
- name: hsm
uid: '@azure/keyvault-keys.CreateEcKeyOptions.hsm'
package: '@azure/keyvault-keys'
summary: Whether to import as a hardware key (HSM) or software key.
fullName: hsm
remarks: ''
isDeprecated: false
syntax:
content: 'hsm?: boolean'
return:
description: ''
type: boolean
inheritanceDescription: >-
<b>Inherited From</b>
[CreateKeyOptions.hsm](xref:@azure/keyvault-keys.CreateKeyOptions.hsm)
- name: keyOps
uid: '@azure/keyvault-keys.CreateEcKeyOptions.keyOps'
package: '@azure/keyvault-keys'
summary: |-
Json web key operations. For more
information on possible key operations, see KeyOperation.
fullName: keyOps
remarks: ''
isDeprecated: false
syntax:
content: 'keyOps?: string[]'
return:
description: ''
type: string[]
inheritanceDescription: >-
<b>Inherited From</b>
[CreateKeyOptions.keyOps](xref:@azure/keyvault-keys.CreateKeyOptions.keyOps)
- name: keySize
uid: '@azure/keyvault-keys.CreateEcKeyOptions.keySize'
package: '@azure/keyvault-keys'
summary: 'The key size in bits. For example: 2048, 3072, or 4096 for RSA.'
fullName: keySize
remarks: ''
isDeprecated: false
syntax:
content: 'keySize?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[CreateKeyOptions.keySize](xref:@azure/keyvault-keys.CreateKeyOptions.keySize)
- name: notBefore
uid: '@azure/keyvault-keys.CreateEcKeyOptions.notBefore'
package: '@azure/keyvault-keys'
summary: Not before date in UTC.
fullName: notBefore
remarks: ''
isDeprecated: false
syntax:
content: 'notBefore?: Date'
return:
description: ''
type: Date
inheritanceDescription: >-
<b>Inherited From</b>
[CreateKeyOptions.notBefore](xref:@azure/keyvault-keys.CreateKeyOptions.notBefore)
- name: onResponse
uid: '@azure/keyvault-keys.CreateEcKeyOptions.onResponse'
package: '@azure/keyvault-keys'
summary: |-
A function to be called each time a response is received from the server
while performing the requested operation.
May be called multiple times.
fullName: onResponse
remarks: ''
isDeprecated: false
syntax:
content: 'onResponse?: RawResponseCallback'
return:
description: ''
type: <xref uid="@azure/core-client.RawResponseCallback" />
inheritanceDescription: >-
<b>Inherited From</b>
[CreateKeyOptions.onResponse](xref:@azure/keyvault-keys.CreateKeyOptions.onResponse)
- name: releasePolicy
uid: '@azure/keyvault-keys.CreateEcKeyOptions.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" />
inheritanceDescription: >-
<b>Inherited From</b>
[CreateKeyOptions.releasePolicy](xref:@azure/keyvault-keys.CreateKeyOptions.releasePolicy)
- name: requestOptions
uid: '@azure/keyvault-keys.CreateEcKeyOptions.requestOptions'
package: '@azure/keyvault-keys'
summary: Options used when creating and sending HTTP requests for this operation.
fullName: requestOptions
remarks: ''
isDeprecated: false
syntax:
content: 'requestOptions?: OperationRequestOptions'
return:
description: ''
type: <xref uid="@azure/core-client.OperationRequestOptions" />
inheritanceDescription: >-
<b>Inherited From</b>
[CreateKeyOptions.requestOptions](xref:@azure/keyvault-keys.CreateKeyOptions.requestOptions)
- name: serializerOptions
uid: '@azure/keyvault-keys.CreateEcKeyOptions.serializerOptions'
package: '@azure/keyvault-keys'
summary: Options to override serialization/de-serialization behavior.
fullName: serializerOptions
remarks: ''
isDeprecated: false
syntax:
content: 'serializerOptions?: SerializerOptions'
return:
description: ''
type: <xref uid="@azure/core-client.SerializerOptions" />
inheritanceDescription: >-
<b>Inherited From</b>
[CreateKeyOptions.serializerOptions](xref:@azure/keyvault-keys.CreateKeyOptions.serializerOptions)
- name: tags
uid: '@azure/keyvault-keys.CreateEcKeyOptions.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}'
inheritanceDescription: >-
<b>Inherited From</b>
[CreateKeyOptions.tags](xref:@azure/keyvault-keys.CreateKeyOptions.tags)
- name: tracingOptions
uid: '@azure/keyvault-keys.CreateEcKeyOptions.tracingOptions'
package: '@azure/keyvault-keys'
summary: Options used when tracing is enabled.
fullName: tracingOptions
remarks: ''
isDeprecated: false
syntax:
content: 'tracingOptions?: OperationTracingOptions'
return:
description: ''
type: <xref uid="@azure/core-tracing.OperationTracingOptions" />
inheritanceDescription: >-
<b>Inherited From</b>
[CreateKeyOptions.tracingOptions](xref:@azure/keyvault-keys.CreateKeyOptions.tracingOptions)
extends: <xref uid="@azure/keyvault-keys.CreateKeyOptions" />