/
KeyClient.yml
1063 lines (842 loc) · 32 KB
/
KeyClient.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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
### YamlMime:TSType
name: KeyClient
uid: '@azure/keyvault-keys.KeyClient'
package: '@azure/keyvault-keys'
summary: >-
The KeyClient provides methods to manage
[KeyVaultKey](xref:@azure/keyvault-keys.KeyVaultKey) in the
Azure Key Vault. The client supports creating, retrieving, updating,
deleting, purging, backing up, restoring and listing KeyVaultKeys. The
client also supports listing
[DeletedKey](xref:@azure/keyvault-keys.DeletedKey) for a soft-delete enabled
Azure Key
Vault.
fullName: KeyClient
remarks: ''
isDeprecated: false
type: class
constructors:
- name: KeyClient(string, TokenCredential, KeyClientOptions)
uid: '@azure/keyvault-keys.KeyClient.constructor'
package: '@azure/keyvault-keys'
summary: |-
Creates an instance of KeyClient.
Example usage:
```ts
import { KeyClient } from "@azure/keyvault-keys";
import { DefaultAzureCredential } from "@azure/identity";
let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();
let client = new KeyClient(vaultUrl, credentials);
```
remarks: ''
isDeprecated: false
syntax:
content: >-
new KeyClient(vaultUrl: string, credential: TokenCredential,
pipelineOptions?: KeyClientOptions)
parameters:
- id: vaultUrl
type: string
description: >-
the URL of the Key Vault. It should have this shape:
`https://${your-key-vault-name}.vault.azure.net`. You should
validate that this URL references a valid Key Vault or Managed HSM
resource. See https://aka.ms/azsdk/blog/vault-uri for details.
- id: credential
type: <xref uid="@azure/core-auth.TokenCredential" />
description: >-
An object that implements the `TokenCredential` interface used to
authenticate requests to the service. Use the @azure/identity
package to create a credential that suits your needs.
- id: pipelineOptions
type: <xref uid="@azure/keyvault-keys.KeyClientOptions" />
description: >-
Pipeline options used to configure Key Vault API requests. Omit this
parameter to use the default pipeline configuration.
properties:
- name: vaultUrl
uid: '@azure/keyvault-keys.KeyClient.vaultUrl'
package: '@azure/keyvault-keys'
summary: The base URL to the vault
fullName: vaultUrl
remarks: ''
isDeprecated: false
syntax:
content: 'vaultUrl: string'
return:
description: ''
type: string
methods:
- name: backupKey(string, BackupKeyOptions)
uid: '@azure/keyvault-keys.KeyClient.backupKey'
package: '@azure/keyvault-keys'
summary: >-
Requests that a backup of the specified key be downloaded to the client.
All versions of the
key will be downloaded. This operation requires the keys/backup
permission.
Example usage:
```ts
let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
```
Backs up the specified key.
remarks: ''
isDeprecated: false
syntax:
content: >-
function backupKey(name: string, options?: BackupKeyOptions):
Promise<undefined | Uint8Array>
parameters:
- id: name
type: string
description: The name of the key.
- id: options
type: <xref uid="@azure/keyvault-keys.BackupKeyOptions" />
description: The optional parameters.
return:
description: ''
type: Promise<undefined | Uint8Array>
- name: beginDeleteKey(string, BeginDeleteKeyOptions)
uid: '@azure/keyvault-keys.KeyClient.beginDeleteKey'
package: '@azure/keyvault-keys'
summary: >-
The delete operation applies to any key stored in Azure Key Vault.
Individual versions
of a key can not be deleted, only all versions of a given key at once.
This function returns a Long Running Operation poller that allows you to
wait indefinitely until the key is deleted.
This operation requires the keys/delete permission.
Example usage:
```ts
const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const poller = await client.beginDeleteKey("MyKey");
// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginDeleteKey("MyKey", { resumeFrom: serialized });
// Waiting until it's done
const deletedKey = await poller.pollUntilDone();
console.log(deletedKey);
```
Deletes a key from a specified key vault.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDeleteKey(name: string, options?: BeginDeleteKeyOptions):
Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>
parameters:
- id: name
type: string
description: The name of the key.
- id: options
type: <xref uid="@azure/keyvault-keys.BeginDeleteKeyOptions" />
description: The optional parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/keyvault-keys.PollerLike" /><<xref
uid="@azure/keyvault-keys.PollOperationState" /><<xref
uid="@azure/keyvault-keys.DeletedKey" />>, <xref
uid="@azure/keyvault-keys.DeletedKey" />>>
- name: beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
uid: '@azure/keyvault-keys.KeyClient.beginRecoverDeletedKey'
package: '@azure/keyvault-keys'
summary: >-
Recovers the deleted key in the specified vault. This operation can only
be performed on a
soft-delete enabled vault.
This function returns a Long Running Operation poller that allows you to
wait indefinitely until the deleted key is recovered.
This operation requires the keys/recover permission.
Example usage:
```ts
const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const deletePoller = await client.beginDeleteKey("MyKey");
await deletePoller.pollUntilDone();
const poller = await client.beginRecoverDeletedKey("MyKey");
// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginRecoverDeletedKey("MyKey", { resumeFrom: serialized
});
// Waiting until it's done
const key = await poller.pollUntilDone();
console.log(key);
```
Recovers the deleted key to the latest version.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginRecoverDeletedKey(name: string, options?:
BeginRecoverDeletedKeyOptions):
Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>
parameters:
- id: name
type: string
description: The name of the deleted key.
- id: options
type: <xref uid="@azure/keyvault-keys.BeginRecoverDeletedKeyOptions" />
description: The optional parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/keyvault-keys.PollerLike" /><<xref
uid="@azure/keyvault-keys.PollOperationState" /><<xref
uid="@azure/keyvault-keys.DeletedKey" />>, <xref
uid="@azure/keyvault-keys.DeletedKey" />>>
- name: createEcKey(string, CreateEcKeyOptions)
uid: '@azure/keyvault-keys.KeyClient.createEcKey'
package: '@azure/keyvault-keys'
summary: >-
The createEcKey method creates a new elliptic curve key in Azure Key
Vault. If the named key
already exists, Azure Key Vault creates a new version of the key. It
requires the keys/create
permission.
Example usage:
```ts
let client = new KeyClient(url, credentials);
let result = await client.createEcKey("MyKey", { curve: "P-256" });
```
Creates a new key, stores it, then returns key parameters and properties
to the client.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createEcKey(name: string, options?: CreateEcKeyOptions):
Promise<KeyVaultKey>
parameters:
- id: name
type: string
description: The name of the key.
- id: options
type: <xref uid="@azure/keyvault-keys.CreateEcKeyOptions" />
description: The optional parameters.
return:
description: ''
type: Promise<<xref uid="@azure/keyvault-keys.KeyVaultKey" />>
- name: createKey(string, string, CreateKeyOptions)
uid: '@azure/keyvault-keys.KeyClient.createKey'
package: '@azure/keyvault-keys'
summary: >-
The create key operation can be used to create any key type in Azure Key
Vault. If the named key
already exists, Azure Key Vault creates a new version of the key. It
requires the keys/create
permission.
Example usage:
```ts
let client = new KeyClient(url, credentials);
// Create an elliptic-curve key:
let result = await client.createKey("MyKey", "EC");
```
Creates a new key, stores it, then returns key parameters and properties
to the client.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createKey(name: string, keyType: string, options?:
CreateKeyOptions): Promise<KeyVaultKey>
parameters:
- id: name
type: string
description: The name of the key.
- id: keyType
type: string
description: >-
The type of the key. One of the following: 'EC', 'EC-HSM', 'RSA',
'RSA-HSM', 'oct'.
- id: options
type: <xref uid="@azure/keyvault-keys.CreateKeyOptions" />
description: The optional parameters.
return:
description: ''
type: Promise<<xref uid="@azure/keyvault-keys.KeyVaultKey" />>
- name: createOctKey(string, CreateOctKeyOptions)
uid: '@azure/keyvault-keys.KeyClient.createOctKey'
package: '@azure/keyvault-keys'
summary: >-
The createOctKey method creates a new OCT key in Azure Key Vault. If the
named key
already exists, Azure Key Vault creates a new version of the key. It
requires the keys/create
permission.
Example usage:
```ts
let client = new KeyClient(url, credentials);
let result = await client.createOctKey("MyKey", { hsm: true });
```
Creates a new key, stores it, then returns key parameters and properties
to the client.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOctKey(name: string, options?: CreateOctKeyOptions):
Promise<KeyVaultKey>
parameters:
- id: name
type: string
description: The name of the key.
- id: options
type: <xref uid="@azure/keyvault-keys.CreateOctKeyOptions" />
description: The optional parameters.
return:
description: ''
type: Promise<<xref uid="@azure/keyvault-keys.KeyVaultKey" />>
- name: createRsaKey(string, CreateRsaKeyOptions)
uid: '@azure/keyvault-keys.KeyClient.createRsaKey'
package: '@azure/keyvault-keys'
summary: >-
The createRSAKey method creates a new RSA key in Azure Key Vault. If the
named key
already exists, Azure Key Vault creates a new version of the key. It
requires the keys/create
permission.
Example usage:
```ts
let client = new KeyClient(url, credentials);
let result = await client.createRsaKey("MyKey", { keySize: 2048 });
```
Creates a new key, stores it, then returns key parameters and properties
to the client.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createRsaKey(name: string, options?: CreateRsaKeyOptions):
Promise<KeyVaultKey>
parameters:
- id: name
type: string
description: The name of the key.
- id: options
type: <xref uid="@azure/keyvault-keys.CreateRsaKeyOptions" />
description: The optional parameters.
return:
description: ''
type: Promise<<xref uid="@azure/keyvault-keys.KeyVaultKey" />>
- name: getCryptographyClient(string, GetCryptographyClientOptions)
uid: '@azure/keyvault-keys.KeyClient.getCryptographyClient'
package: '@azure/keyvault-keys'
summary: >-
Gets a [CryptographyClient](xref:@azure/keyvault-keys.CryptographyClient)
for the given key.
Example usage:
```ts
let client = new KeyClient(url, credentials);
// get a cryptography client for a given key
let cryptographyClient = client.getCryptographyClient("MyKey");
```
remarks: ''
isDeprecated: false
syntax:
content: >-
function getCryptographyClient(keyName: string, options?:
GetCryptographyClientOptions): CryptographyClient
parameters:
- id: keyName
type: string
description: ''
- id: options
type: <xref uid="@azure/keyvault-keys.GetCryptographyClientOptions" />
description: ''
return:
description: >-
- A [CryptographyClient](xref:@azure/keyvault-keys.CryptographyClient)
using the same options, credentials, and http client as this
[KeyClient](xref:@azure/keyvault-keys.KeyClient)
type: <xref uid="@azure/keyvault-keys.CryptographyClient" />
- name: getDeletedKey(string, GetDeletedKeyOptions)
uid: '@azure/keyvault-keys.KeyClient.getDeletedKey'
package: '@azure/keyvault-keys'
summary: >-
The getDeletedKey method returns the specified deleted key along with its
properties.
This operation requires the keys/get permission.
Example usage:
```ts
let client = new KeyClient(url, credentials);
let key = await client.getDeletedKey("MyDeletedKey");
```
Gets the specified deleted key.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getDeletedKey(name: string, options?: GetDeletedKeyOptions):
Promise<DeletedKey>
parameters:
- id: name
type: string
description: The name of the key.
- id: options
type: <xref uid="@azure/keyvault-keys.GetDeletedKeyOptions" />
description: The optional parameters.
return:
description: ''
type: Promise<<xref uid="@azure/keyvault-keys.DeletedKey" />>
- name: getKey(string, GetKeyOptions)
uid: '@azure/keyvault-keys.KeyClient.getKey'
package: '@azure/keyvault-keys'
summary: >-
The getKey method gets a specified key and is applicable to any key stored
in Azure Key Vault.
This operation requires the keys/get permission.
Example usage:
```ts
let client = new KeyClient(url, credentials);
let key = await client.getKey("MyKey");
```
Get a specified key from a given key vault.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getKey(name: string, options?: GetKeyOptions):
Promise<KeyVaultKey>
parameters:
- id: name
type: string
description: The name of the key.
- id: options
type: <xref uid="@azure/keyvault-keys.GetKeyOptions" />
description: The optional parameters.
return:
description: ''
type: Promise<<xref uid="@azure/keyvault-keys.KeyVaultKey" />>
- name: getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)
uid: '@azure/keyvault-keys.KeyClient.getKeyRotationPolicy'
package: '@azure/keyvault-keys'
summary: |-
Gets the rotation policy of a Key Vault Key.
By default, all keys have a policy that will notify 30 days before expiry.
This operation requires the keys/get permission.
Example usage:
```ts
let client = new KeyClient(vaultUrl, credentials);
let result = await client.getKeyRotationPolicy("myKey");
```
remarks: ''
isDeprecated: false
syntax:
content: >-
function getKeyRotationPolicy(keyName: string, options?:
GetKeyRotationPolicyOptions): Promise<KeyRotationPolicy>
parameters:
- id: keyName
type: string
description: The name of the key.
- id: options
type: <xref uid="@azure/keyvault-keys.GetKeyRotationPolicyOptions" />
description: The optional parameters.
return:
description: ''
type: Promise<<xref uid="@azure/keyvault-keys.KeyRotationPolicy" />>
- name: getRandomBytes(number, GetRandomBytesOptions)
uid: '@azure/keyvault-keys.KeyClient.getRandomBytes'
package: '@azure/keyvault-keys'
summary: >-
Gets the requested number of bytes containing random values from a managed
HSM.
This operation requires the managedHsm/rng permission.
Example usage:
```ts
let client = new KeyClient(vaultUrl, credentials);
let { bytes } = await client.getRandomBytes(10);
```
remarks: ''
isDeprecated: false
syntax:
content: >-
function getRandomBytes(count: number, options?: GetRandomBytesOptions):
Promise<Uint8Array>
parameters:
- id: count
type: number
description: The number of bytes to generate between 1 and 128 inclusive.
- id: options
type: <xref uid="@azure/keyvault-keys.GetRandomBytesOptions" />
description: The optional parameters.
return:
description: ''
type: Promise<Uint8Array>
- name: importKey(string, JsonWebKey_2, ImportKeyOptions)
uid: '@azure/keyvault-keys.KeyClient.importKey'
package: '@azure/keyvault-keys'
summary: >-
The import key operation may be used to import any key type into an Azure
Key Vault. If the
named key already exists, Azure Key Vault creates a new version of the
key. This operation
requires the keys/import permission.
Example usage:
```ts
let client = new KeyClient(url, credentials);
// Key contents in myKeyContents
let result = await client.importKey("MyKey", myKeyContents);
```
Imports an externally created key, stores it, and returns key parameters
and properties
to the client.
remarks: ''
isDeprecated: false
syntax:
content: >-
function importKey(name: string, key: JsonWebKey_2, options?:
ImportKeyOptions): Promise<KeyVaultKey>
parameters:
- id: name
type: string
description: Name for the imported key.
- id: key
type: <xref uid="@azure/keyvault-keys.JsonWebKey" />
description: The JSON web key.
- id: options
type: <xref uid="@azure/keyvault-keys.ImportKeyOptions" />
description: The optional parameters.
return:
description: ''
type: Promise<<xref uid="@azure/keyvault-keys.KeyVaultKey" />>
- name: listDeletedKeys(ListDeletedKeysOptions)
uid: '@azure/keyvault-keys.KeyClient.listDeletedKeys'
package: '@azure/keyvault-keys'
summary: >-
Iterates the deleted keys in the vault. The full key identifier and
properties are provided
in the response. No values are returned for the keys. This operations
requires the keys/list permission.
Example usage:
```ts
let client = new KeyClient(url, credentials);
for await (const deletedKey of client.listDeletedKeys()) {
console.log("deleted key: ", deletedKey);
}
```
List all keys in the vault
remarks: ''
isDeprecated: false
syntax:
content: >-
function listDeletedKeys(options?: ListDeletedKeysOptions):
PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>
parameters:
- id: options
type: <xref uid="@azure/keyvault-keys.ListDeletedKeysOptions" />
description: The optional parameters.
return:
description: ''
type: >-
<xref uid="@azure/keyvault-keys.PagedAsyncIterableIterator"
/><<xref uid="@azure/keyvault-keys.DeletedKey" />, <xref
uid="@azure/keyvault-keys.DeletedKey" />[], <xref
uid="@azure/keyvault-keys.PageSettings" />>
- name: listPropertiesOfKeys(ListPropertiesOfKeysOptions)
uid: '@azure/keyvault-keys.KeyClient.listPropertiesOfKeys'
package: '@azure/keyvault-keys'
summary: >-
Iterates the latest version of all keys in the vault. The full key
identifier and properties are provided
in the response. No values are returned for the keys. This operations
requires the keys/list permission.
Example usage:
```ts
let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeys()) {
const key = await client.getKey(keyProperties.name);
console.log("key: ", key);
}
```
List all keys in the vault
remarks: ''
isDeprecated: false
syntax:
content: >-
function listPropertiesOfKeys(options?: ListPropertiesOfKeysOptions):
PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>
parameters:
- id: options
type: <xref uid="@azure/keyvault-keys.ListPropertiesOfKeysOptions" />
description: The optional parameters.
return:
description: ''
type: >-
<xref uid="@azure/keyvault-keys.PagedAsyncIterableIterator"
/><<xref uid="@azure/keyvault-keys.KeyProperties" />, <xref
uid="@azure/keyvault-keys.KeyProperties" />[], <xref
uid="@azure/keyvault-keys.PageSettings" />>
- name: listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)
uid: '@azure/keyvault-keys.KeyClient.listPropertiesOfKeyVersions'
package: '@azure/keyvault-keys'
summary: >-
Iterates all versions of the given key in the vault. The full key
identifier, properties, and tags are provided
in the response. This operation requires the keys/list permission.
Example usage:
```ts
let client = new KeyClient(url, credentials);
for await (const keyProperties of
client.listPropertiesOfKeyVersions("MyKey")) {
const key = await client.getKey(keyProperties.name);
console.log("key version: ", key);
}
```
remarks: ''
isDeprecated: false
syntax:
content: >-
function listPropertiesOfKeyVersions(name: string, options?:
ListPropertiesOfKeyVersionsOptions):
PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>
parameters:
- id: name
type: string
description: Name of the key to fetch versions for
- id: options
type: >-
<xref uid="@azure/keyvault-keys.ListPropertiesOfKeyVersionsOptions"
/>
description: The optional parameters.
return:
description: ''
type: >-
<xref uid="@azure/keyvault-keys.PagedAsyncIterableIterator"
/><<xref uid="@azure/keyvault-keys.KeyProperties" />, <xref
uid="@azure/keyvault-keys.KeyProperties" />[], <xref
uid="@azure/keyvault-keys.PageSettings" />>
- name: purgeDeletedKey(string, PurgeDeletedKeyOptions)
uid: '@azure/keyvault-keys.KeyClient.purgeDeletedKey'
package: '@azure/keyvault-keys'
summary: >-
The purge deleted key operation removes the key permanently, without the
possibility of
recovery. This operation can only be enabled on a soft-delete enabled
vault. This operation
requires the keys/purge permission.
Example usage:
```ts
const client = new KeyClient(url, credentials);
const deletePoller = await client.beginDeleteKey("MyKey")
await deletePoller.pollUntilDone();
await client.purgeDeletedKey("MyKey");
```
Permanently deletes the specified key.
remarks: ''
isDeprecated: false
syntax:
content: >-
function purgeDeletedKey(name: string, options?:
PurgeDeletedKeyOptions): Promise<void>
parameters:
- id: name
type: string
description: The name of the key.
- id: options
type: <xref uid="@azure/keyvault-keys.PurgeDeletedKeyOptions" />
description: The optional parameters.
return:
description: ''
type: Promise<void>
- name: releaseKey(string, string, ReleaseKeyOptions)
uid: '@azure/keyvault-keys.KeyClient.releaseKey'
package: '@azure/keyvault-keys'
summary: >-
Releases a key from a managed HSM.
The release key operation is applicable to all key types. The operation
requires the key to be marked exportable and the keys/release permission.
Example usage:
```ts
let client = new KeyClient(vaultUrl, credentials);
let result = await client.releaseKey("myKey", target)
```
remarks: ''
isDeprecated: false
syntax:
content: >-
function releaseKey(name: string, targetAttestationToken: string,
options?: ReleaseKeyOptions): Promise<ReleaseKeyResult>
parameters:
- id: name
type: string
description: The name of the key.
- id: targetAttestationToken
type: string
description: The attestation assertion for the target of the key release.
- id: options
type: <xref uid="@azure/keyvault-keys.ReleaseKeyOptions" />
description: The optional parameters.
return:
description: ''
type: Promise<<xref uid="@azure/keyvault-keys.ReleaseKeyResult" />>
- name: restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)
uid: '@azure/keyvault-keys.KeyClient.restoreKeyBackup'
package: '@azure/keyvault-keys'
summary: >-
Restores a backed up key, and all its versions, to a vault. This operation
requires the
keys/restore permission.
Example usage:
```ts
let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
// ...
let key = await client.restoreKeyBackup(backupContents);
```
Restores a backed up key to a vault.
remarks: ''
isDeprecated: false
syntax:
content: >-
function restoreKeyBackup(backup: Uint8Array, options?:
RestoreKeyBackupOptions): Promise<KeyVaultKey>
parameters:
- id: backup
type: Uint8Array
description: The backup blob associated with a key bundle.
- id: options
type: <xref uid="@azure/keyvault-keys.RestoreKeyBackupOptions" />
description: The optional parameters.
return:
description: ''
type: Promise<<xref uid="@azure/keyvault-keys.KeyVaultKey" />>
- name: rotateKey(string, RotateKeyOptions)
uid: '@azure/keyvault-keys.KeyClient.rotateKey'
package: '@azure/keyvault-keys'
summary: >-
Rotates the key based on the key policy by generating a new version of the
key. This operation requires the keys/rotate permission.
Example usage:
```ts
let client = new KeyClient(vaultUrl, credentials);
let key = await client.rotateKey("MyKey");
```
remarks: ''
isDeprecated: false
syntax:
content: >-
function rotateKey(name: string, options?: RotateKeyOptions):
Promise<KeyVaultKey>
parameters:
- id: name
type: string
description: The name of the key to rotate.
- id: options
type: <xref uid="@azure/keyvault-keys.RotateKeyOptions" />
description: The optional parameters.
return:
description: ''
type: Promise<<xref uid="@azure/keyvault-keys.KeyVaultKey" />>
- name: updateKeyProperties(string, string, UpdateKeyPropertiesOptions)
uid: '@azure/keyvault-keys.KeyClient.updateKeyProperties'
package: '@azure/keyvault-keys'
summary: >-
The updateKeyProperties method changes specified properties of an existing
stored key. Properties that
are not specified in the request are left unchanged. The value of a key
itself cannot be
changed. This operation requires the keys/set permission.
Example usage:
```ts
let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName,
key.properties.version, { enabled: false });
```
Updates the properties associated with a specified key in a given key
vault.
remarks: ''
isDeprecated: false
syntax:
content: >-
function updateKeyProperties(name: string, keyVersion: string, options?:
UpdateKeyPropertiesOptions): Promise<KeyVaultKey>
parameters:
- id: name
type: string
description: The name of the key.
- id: keyVersion
type: string
description: The version of the key.
- id: options
type: <xref uid="@azure/keyvault-keys.UpdateKeyPropertiesOptions" />
description: The optional parameters.
return:
description: ''
type: Promise<<xref uid="@azure/keyvault-keys.KeyVaultKey" />>
- name: updateKeyProperties(string, UpdateKeyPropertiesOptions)
uid: '@azure/keyvault-keys.KeyClient.updateKeyProperties_1'
package: '@azure/keyvault-keys'
summary: >-
The updateKeyProperties method changes specified properties of the latest
version of an existing stored key. Properties that
are not specified in the request are left unchanged. The value of a key
itself cannot be
changed. This operation requires the keys/set permission.
Example usage:
```ts