|
13 | 13 | const models = require('./index');
|
14 | 14 |
|
15 | 15 | /**
|
16 |
| - * @class |
17 |
| - * Initializes a new instance of the Encryption class. |
18 |
| - * @constructor |
19 | 16 | * The encryption settings on the storage account.
|
20 | 17 | *
|
21 |
| - * @member {object} [services] List of services which support encryption. |
22 |
| - * |
23 |
| - * @member {object} [services.blob] The encryption function of the blob storage |
24 |
| - * service. |
25 |
| - * |
26 |
| - * @member {boolean} [services.blob.enabled] A boolean indicating whether or |
27 |
| - * not the service encrypts the data as it is stored. |
28 |
| - * |
29 |
| - * @member {date} [services.blob.lastEnabledTime] Gets a rough estimate of the |
30 |
| - * date/time when the encryption was last enabled by the user. Only returned |
31 |
| - * when encryption is enabled. There might be some unencrypted blobs which were |
32 |
| - * written after this time, as it is just a rough estimate. |
33 |
| - * |
34 |
| - * @member {object} [services.file] The encryption function of the file storage |
35 |
| - * service. |
36 |
| - * |
37 |
| - * @member {boolean} [services.file.enabled] A boolean indicating whether or |
38 |
| - * not the service encrypts the data as it is stored. |
39 |
| - * |
40 |
| - * @member {date} [services.file.lastEnabledTime] Gets a rough estimate of the |
41 |
| - * date/time when the encryption was last enabled by the user. Only returned |
42 |
| - * when encryption is enabled. There might be some unencrypted blobs which were |
43 |
| - * written after this time, as it is just a rough estimate. |
44 |
| - * |
45 |
| - * @member {object} [services.table] The encryption function of the table |
46 |
| - * storage service. |
47 |
| - * |
48 |
| - * @member {boolean} [services.table.enabled] A boolean indicating whether or |
49 |
| - * not the service encrypts the data as it is stored. |
50 |
| - * |
51 |
| - * @member {date} [services.table.lastEnabledTime] Gets a rough estimate of the |
52 |
| - * date/time when the encryption was last enabled by the user. Only returned |
53 |
| - * when encryption is enabled. There might be some unencrypted blobs which were |
54 |
| - * written after this time, as it is just a rough estimate. |
55 |
| - * |
56 |
| - * @member {object} [services.queue] The encryption function of the queue |
57 |
| - * storage service. |
58 |
| - * |
59 |
| - * @member {boolean} [services.queue.enabled] A boolean indicating whether or |
60 |
| - * not the service encrypts the data as it is stored. |
61 |
| - * |
62 |
| - * @member {date} [services.queue.lastEnabledTime] Gets a rough estimate of the |
63 |
| - * date/time when the encryption was last enabled by the user. Only returned |
64 |
| - * when encryption is enabled. There might be some unencrypted blobs which were |
65 |
| - * written after this time, as it is just a rough estimate. |
66 |
| - * |
67 |
| - * @member {string} keySource The encryption keySource (provider). Possible |
68 |
| - * values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault. Possible |
69 |
| - * values include: 'Microsoft.Storage', 'Microsoft.Keyvault'. Default value: |
70 |
| - * 'Microsoft.Storage' . |
71 |
| - * |
72 |
| - * @member {object} [keyVaultProperties] Properties provided by key vault. |
73 |
| - * |
74 |
| - * @member {string} [keyVaultProperties.keyName] The name of KeyVault key. |
75 |
| - * |
76 |
| - * @member {string} [keyVaultProperties.keyVersion] The version of KeyVault |
77 |
| - * key. |
78 |
| - * |
79 |
| - * @member {string} [keyVaultProperties.keyVaultUri] The Uri of KeyVault. |
80 |
| - * |
81 | 18 | */
|
82 | 19 | class Encryption {
|
| 20 | + /** |
| 21 | + * Create a Encryption. |
| 22 | + * @member {object} [services] List of services which support encryption. |
| 23 | + * @member {object} [services.blob] The encryption function of the blob |
| 24 | + * storage service. |
| 25 | + * @member {boolean} [services.blob.enabled] A boolean indicating whether or |
| 26 | + * not the service encrypts the data as it is stored. |
| 27 | + * @member {date} [services.blob.lastEnabledTime] Gets a rough estimate of |
| 28 | + * the date/time when the encryption was last enabled by the user. Only |
| 29 | + * returned when encryption is enabled. There might be some unencrypted blobs |
| 30 | + * which were written after this time, as it is just a rough estimate. |
| 31 | + * @member {object} [services.file] The encryption function of the file |
| 32 | + * storage service. |
| 33 | + * @member {boolean} [services.file.enabled] A boolean indicating whether or |
| 34 | + * not the service encrypts the data as it is stored. |
| 35 | + * @member {date} [services.file.lastEnabledTime] Gets a rough estimate of |
| 36 | + * the date/time when the encryption was last enabled by the user. Only |
| 37 | + * returned when encryption is enabled. There might be some unencrypted blobs |
| 38 | + * which were written after this time, as it is just a rough estimate. |
| 39 | + * @member {object} [services.table] The encryption function of the table |
| 40 | + * storage service. |
| 41 | + * @member {boolean} [services.table.enabled] A boolean indicating whether or |
| 42 | + * not the service encrypts the data as it is stored. |
| 43 | + * @member {date} [services.table.lastEnabledTime] Gets a rough estimate of |
| 44 | + * the date/time when the encryption was last enabled by the user. Only |
| 45 | + * returned when encryption is enabled. There might be some unencrypted blobs |
| 46 | + * which were written after this time, as it is just a rough estimate. |
| 47 | + * @member {object} [services.queue] The encryption function of the queue |
| 48 | + * storage service. |
| 49 | + * @member {boolean} [services.queue.enabled] A boolean indicating whether or |
| 50 | + * not the service encrypts the data as it is stored. |
| 51 | + * @member {date} [services.queue.lastEnabledTime] Gets a rough estimate of |
| 52 | + * the date/time when the encryption was last enabled by the user. Only |
| 53 | + * returned when encryption is enabled. There might be some unencrypted blobs |
| 54 | + * which were written after this time, as it is just a rough estimate. |
| 55 | + * @member {string} keySource The encryption keySource (provider). Possible |
| 56 | + * values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault. |
| 57 | + * Possible values include: 'Microsoft.Storage', 'Microsoft.Keyvault'. |
| 58 | + * Default value: 'Microsoft.Storage' . |
| 59 | + * @member {object} [keyVaultProperties] Properties provided by key vault. |
| 60 | + * @member {string} [keyVaultProperties.keyName] The name of KeyVault key. |
| 61 | + * @member {string} [keyVaultProperties.keyVersion] The version of KeyVault |
| 62 | + * key. |
| 63 | + * @member {string} [keyVaultProperties.keyVaultUri] The Uri of KeyVault. |
| 64 | + */ |
83 | 65 | constructor() {
|
84 | 66 | }
|
85 | 67 |
|
|
0 commit comments