diff --git a/lib/services/keyvault/lib/keyVaultClient.d.ts b/lib/services/keyvault/lib/keyVaultClient.d.ts index a35191f185..2083732d8f 100644 --- a/lib/services/keyvault/lib/keyVaultClient.d.ts +++ b/lib/services/keyvault/lib/keyVaultClient.d.ts @@ -70,8 +70,8 @@ export default class KeyVaultClient extends AzureServiceClient { * * @param {object} [options] Optional Parameters. * - * @param {number} [options.keySize] The key size in bytes. For example, 1024 - * or 2048. + * @param {number} [options.keySize] The key size in bits. For example: 2048, + * 3072, or 4096 for RSA. * * @param {array} [options.keyOps] * @@ -122,8 +122,8 @@ export default class KeyVaultClient extends AzureServiceClient { * * @param {object} [options] Optional Parameters. * - * @param {number} [options.keySize] The key size in bytes. For example, 1024 - * or 2048. + * @param {number} [options.keySize] The key size in bits. For example: 2048, + * 3072, or 4096 for RSA. * * @param {array} [options.keyOps] * @@ -3512,7 +3512,7 @@ export default class KeyVaultClient extends AzureServiceClient { * type. * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key - * size in bytes. For example; 1024 or 2048. + * size in bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [options.certificatePolicy.keyProperties.reuseKey] * Indicates if the same key pair will be used on certificate renewal. @@ -3624,7 +3624,7 @@ export default class KeyVaultClient extends AzureServiceClient { * type. * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key - * size in bytes. For example; 1024 or 2048. + * size in bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [options.certificatePolicy.keyProperties.reuseKey] * Indicates if the same key pair will be used on certificate renewal. @@ -3765,7 +3765,7 @@ export default class KeyVaultClient extends AzureServiceClient { * type. * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key - * size in bytes. For example; 1024 or 2048. + * size in bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [options.certificatePolicy.keyProperties.reuseKey] * Indicates if the same key pair will be used on certificate renewal. @@ -3887,7 +3887,7 @@ export default class KeyVaultClient extends AzureServiceClient { * type. * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key - * size in bytes. For example; 1024 or 2048. + * size in bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [options.certificatePolicy.keyProperties.reuseKey] * Indicates if the same key pair will be used on certificate renewal. @@ -4161,7 +4161,7 @@ export default class KeyVaultClient extends AzureServiceClient { * @param {string} [certificatePolicy.keyProperties.keyType] The key type. * * @param {number} [certificatePolicy.keyProperties.keySize] The key size in - * bytes. For example; 1024 or 2048. + * bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if the * same key pair will be used on certificate renewal. @@ -4263,7 +4263,7 @@ export default class KeyVaultClient extends AzureServiceClient { * @param {string} [certificatePolicy.keyProperties.keyType] The key type. * * @param {number} [certificatePolicy.keyProperties.keySize] The key size in - * bytes. For example; 1024 or 2048. + * bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if the * same key pair will be used on certificate renewal. @@ -4392,7 +4392,7 @@ export default class KeyVaultClient extends AzureServiceClient { * type. * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key - * size in bytes. For example; 1024 or 2048. + * size in bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [options.certificatePolicy.keyProperties.reuseKey] * Indicates if the same key pair will be used on certificate renewal. @@ -4509,7 +4509,7 @@ export default class KeyVaultClient extends AzureServiceClient { * type. * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key - * size in bytes. For example; 1024 or 2048. + * size in bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [options.certificatePolicy.keyProperties.reuseKey] * Indicates if the same key pair will be used on certificate renewal. diff --git a/lib/services/keyvault/lib/keyVaultClient.js b/lib/services/keyvault/lib/keyVaultClient.js index 49a38ce192..a435f4e270 100644 --- a/lib/services/keyvault/lib/keyVaultClient.js +++ b/lib/services/keyvault/lib/keyVaultClient.js @@ -42,8 +42,8 @@ const models = require('./models'); * * @param {object} [options] Optional Parameters. * - * @param {number} [options.keySize] The key size in bytes. For example, 1024 - * or 2048. + * @param {number} [options.keySize] The key size in bits. For example: 2048, + * 3072, or 4096 for RSA. * * @param {array} [options.keyOps] * @@ -7015,7 +7015,7 @@ function _deleteCertificateIssuer(vaultBaseUrl, issuerName, options, callback) { * type. * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key - * size in bytes. For example; 1024 or 2048. + * size in bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [options.certificatePolicy.keyProperties.reuseKey] * Indicates if the same key pair will be used on certificate renewal. @@ -7296,7 +7296,7 @@ function _createCertificate(vaultBaseUrl, certificateName, options, callback) { * type. * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key - * size in bytes. For example; 1024 or 2048. + * size in bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [options.certificatePolicy.keyProperties.reuseKey] * Indicates if the same key pair will be used on certificate renewal. @@ -7888,7 +7888,7 @@ function _getCertificatePolicy(vaultBaseUrl, certificateName, options, callback) * @param {string} [certificatePolicy.keyProperties.keyType] The key type. * * @param {number} [certificatePolicy.keyProperties.keySize] The key size in - * bytes. For example; 1024 or 2048. + * bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if the * same key pair will be used on certificate renewal. @@ -8137,7 +8137,7 @@ function _updateCertificatePolicy(vaultBaseUrl, certificateName, certificatePoli * type. * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key - * size in bytes. For example; 1024 or 2048. + * size in bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [options.certificatePolicy.keyProperties.reuseKey] * Indicates if the same key pair will be used on certificate renewal. @@ -13507,8 +13507,8 @@ class KeyVaultClient extends ServiceClient { * * @param {object} [options] Optional Parameters. * - * @param {number} [options.keySize] The key size in bytes. For example, 1024 - * or 2048. + * @param {number} [options.keySize] The key size in bits. For example: 2048, + * 3072, or 4096 for RSA. * * @param {array} [options.keyOps] * @@ -13571,8 +13571,8 @@ class KeyVaultClient extends ServiceClient { * * @param {object} [options] Optional Parameters. * - * @param {number} [options.keySize] The key size in bytes. For example, 1024 - * or 2048. + * @param {number} [options.keySize] The key size in bits. For example: 2048, + * 3072, or 4096 for RSA. * * @param {array} [options.keyOps] * @@ -18056,7 +18056,7 @@ class KeyVaultClient extends ServiceClient { * type. * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key - * size in bytes. For example; 1024 or 2048. + * size in bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [options.certificatePolicy.keyProperties.reuseKey] * Indicates if the same key pair will be used on certificate renewal. @@ -18180,7 +18180,7 @@ class KeyVaultClient extends ServiceClient { * type. * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key - * size in bytes. For example; 1024 or 2048. + * size in bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [options.certificatePolicy.keyProperties.reuseKey] * Indicates if the same key pair will be used on certificate renewal. @@ -18336,7 +18336,7 @@ class KeyVaultClient extends ServiceClient { * type. * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key - * size in bytes. For example; 1024 or 2048. + * size in bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [options.certificatePolicy.keyProperties.reuseKey] * Indicates if the same key pair will be used on certificate renewal. @@ -18470,7 +18470,7 @@ class KeyVaultClient extends ServiceClient { * type. * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key - * size in bytes. For example; 1024 or 2048. + * size in bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [options.certificatePolicy.keyProperties.reuseKey] * Indicates if the same key pair will be used on certificate renewal. @@ -18813,7 +18813,7 @@ class KeyVaultClient extends ServiceClient { * @param {string} [certificatePolicy.keyProperties.keyType] The key type. * * @param {number} [certificatePolicy.keyProperties.keySize] The key size in - * bytes. For example; 1024 or 2048. + * bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if the * same key pair will be used on certificate renewal. @@ -18927,7 +18927,7 @@ class KeyVaultClient extends ServiceClient { * @param {string} [certificatePolicy.keyProperties.keyType] The key type. * * @param {number} [certificatePolicy.keyProperties.keySize] The key size in - * bytes. For example; 1024 or 2048. + * bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if the * same key pair will be used on certificate renewal. @@ -19071,7 +19071,7 @@ class KeyVaultClient extends ServiceClient { * type. * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key - * size in bytes. For example; 1024 or 2048. + * size in bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [options.certificatePolicy.keyProperties.reuseKey] * Indicates if the same key pair will be used on certificate renewal. @@ -19200,7 +19200,7 @@ class KeyVaultClient extends ServiceClient { * type. * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key - * size in bytes. For example; 1024 or 2048. + * size in bits. For example: 2048, 3072, or 4096 for RSA. * * @param {boolean} [options.certificatePolicy.keyProperties.reuseKey] * Indicates if the same key pair will be used on certificate renewal. diff --git a/lib/services/keyvault/lib/models/certificateBundle.js b/lib/services/keyvault/lib/models/certificateBundle.js index 3914d9a439..b5c0a548d6 100644 --- a/lib/services/keyvault/lib/models/certificateBundle.js +++ b/lib/services/keyvault/lib/models/certificateBundle.js @@ -30,8 +30,8 @@ class CertificateBundle { * @member {boolean} [policy.keyProperties.exportable] Indicates if the * private key can be exported. * @member {string} [policy.keyProperties.keyType] The key type. - * @member {number} [policy.keyProperties.keySize] The key size in bytes. For - * example; 1024 or 2048. + * @member {number} [policy.keyProperties.keySize] The key size in bits. For + * example: 2048, 3072, or 4096 for RSA. * @member {boolean} [policy.keyProperties.reuseKey] Indicates if the same * key pair will be used on certificate renewal. * @member {object} [policy.secretProperties] Properties of the secret diff --git a/lib/services/keyvault/lib/models/certificateCreateParameters.js b/lib/services/keyvault/lib/models/certificateCreateParameters.js index b6646ce3bf..3c6ae7ad8f 100644 --- a/lib/services/keyvault/lib/models/certificateCreateParameters.js +++ b/lib/services/keyvault/lib/models/certificateCreateParameters.js @@ -28,7 +28,7 @@ class CertificateCreateParameters { * if the private key can be exported. * @member {string} [certificatePolicy.keyProperties.keyType] The key type. * @member {number} [certificatePolicy.keyProperties.keySize] The key size in - * bytes. For example; 1024 or 2048. + * bits. For example: 2048, 3072, or 4096 for RSA. * @member {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if * the same key pair will be used on certificate renewal. * @member {object} [certificatePolicy.secretProperties] Properties of the diff --git a/lib/services/keyvault/lib/models/certificateImportParameters.js b/lib/services/keyvault/lib/models/certificateImportParameters.js index 51111dacd5..a67709fab2 100644 --- a/lib/services/keyvault/lib/models/certificateImportParameters.js +++ b/lib/services/keyvault/lib/models/certificateImportParameters.js @@ -33,7 +33,7 @@ class CertificateImportParameters { * if the private key can be exported. * @member {string} [certificatePolicy.keyProperties.keyType] The key type. * @member {number} [certificatePolicy.keyProperties.keySize] The key size in - * bytes. For example; 1024 or 2048. + * bits. For example: 2048, 3072, or 4096 for RSA. * @member {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if * the same key pair will be used on certificate renewal. * @member {object} [certificatePolicy.secretProperties] Properties of the diff --git a/lib/services/keyvault/lib/models/certificatePolicy.js b/lib/services/keyvault/lib/models/certificatePolicy.js index a7febaedeb..65f58e387c 100644 --- a/lib/services/keyvault/lib/models/certificatePolicy.js +++ b/lib/services/keyvault/lib/models/certificatePolicy.js @@ -25,8 +25,8 @@ class CertificatePolicy { * @member {boolean} [keyProperties.exportable] Indicates if the private key * can be exported. * @member {string} [keyProperties.keyType] The key type. - * @member {number} [keyProperties.keySize] The key size in bytes. For - * example; 1024 or 2048. + * @member {number} [keyProperties.keySize] The key size in bits. For + * example: 2048, 3072, or 4096 for RSA. * @member {boolean} [keyProperties.reuseKey] Indicates if the same key pair * will be used on certificate renewal. * @member {object} [secretProperties] Properties of the secret backing a diff --git a/lib/services/keyvault/lib/models/certificateUpdateParameters.js b/lib/services/keyvault/lib/models/certificateUpdateParameters.js index 81111603cf..088322c784 100644 --- a/lib/services/keyvault/lib/models/certificateUpdateParameters.js +++ b/lib/services/keyvault/lib/models/certificateUpdateParameters.js @@ -28,7 +28,7 @@ class CertificateUpdateParameters { * if the private key can be exported. * @member {string} [certificatePolicy.keyProperties.keyType] The key type. * @member {number} [certificatePolicy.keyProperties.keySize] The key size in - * bytes. For example; 1024 or 2048. + * bits. For example: 2048, 3072, or 4096 for RSA. * @member {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if * the same key pair will be used on certificate renewal. * @member {object} [certificatePolicy.secretProperties] Properties of the diff --git a/lib/services/keyvault/lib/models/index.d.ts b/lib/services/keyvault/lib/models/index.d.ts index 39302e82cd..b3d6a9887e 100644 --- a/lib/services/keyvault/lib/models/index.d.ts +++ b/lib/services/keyvault/lib/models/index.d.ts @@ -401,8 +401,8 @@ export interface CertificateIssuerItem { * * @member {boolean} [exportable] Indicates if the private key can be exported. * @member {string} [keyType] The key type. - * @member {number} [keySize] The key size in bytes. For example; 1024 or - * 2048. + * @member {number} [keySize] The key size in bits. For example: 2048, 3072, or + * 4096 for RSA. * @member {boolean} [reuseKey] Indicates if the same key pair will be used on * certificate renewal. */ @@ -547,8 +547,8 @@ export interface IssuerParameters { * @member {boolean} [keyProperties.exportable] Indicates if the private key * can be exported. * @member {string} [keyProperties.keyType] The key type. - * @member {number} [keyProperties.keySize] The key size in bytes. For example; - * 1024 or 2048. + * @member {number} [keyProperties.keySize] The key size in bits. For example: + * 2048, 3072, or 4096 for RSA. * @member {boolean} [keyProperties.reuseKey] Indicates if the same key pair * will be used on certificate renewal. * @member {object} [secretProperties] Properties of the secret backing a @@ -613,8 +613,8 @@ export interface CertificatePolicy { * @member {boolean} [policy.keyProperties.exportable] Indicates if the private * key can be exported. * @member {string} [policy.keyProperties.keyType] The key type. - * @member {number} [policy.keyProperties.keySize] The key size in bytes. For - * example; 1024 or 2048. + * @member {number} [policy.keyProperties.keySize] The key size in bits. For + * example: 2048, 3072, or 4096 for RSA. * @member {boolean} [policy.keyProperties.reuseKey] Indicates if the same key * pair will be used on certificate renewal. * @member {object} [policy.secretProperties] Properties of the secret backing @@ -910,7 +910,8 @@ export interface Contacts { * @member {string} kty The type of key to create. For valid values, see * JsonWebKeyType. Possible values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', * 'oct' - * @member {number} [keySize] The key size in bytes. For example, 1024 or 2048. + * @member {number} [keySize] The key size in bits. For example: 2048, 3072, or + * 4096 for RSA. * @member {array} [keyOps] * @member {object} [keyAttributes] * @member {string} [keyAttributes.recoveryLevel] Reflects the deletion @@ -1132,7 +1133,7 @@ export interface SecretUpdateParameters { * the private key can be exported. * @member {string} [certificatePolicy.keyProperties.keyType] The key type. * @member {number} [certificatePolicy.keyProperties.keySize] The key size in - * bytes. For example; 1024 or 2048. + * bits. For example: 2048, 3072, or 4096 for RSA. * @member {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if * the same key pair will be used on certificate renewal. * @member {object} [certificatePolicy.secretProperties] Properties of the @@ -1216,7 +1217,7 @@ export interface CertificateCreateParameters { * the private key can be exported. * @member {string} [certificatePolicy.keyProperties.keyType] The key type. * @member {number} [certificatePolicy.keyProperties.keySize] The key size in - * bytes. For example; 1024 or 2048. + * bits. For example: 2048, 3072, or 4096 for RSA. * @member {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if * the same key pair will be used on certificate renewal. * @member {object} [certificatePolicy.secretProperties] Properties of the @@ -1297,7 +1298,7 @@ export interface CertificateImportParameters { * the private key can be exported. * @member {string} [certificatePolicy.keyProperties.keyType] The key type. * @member {number} [certificatePolicy.keyProperties.keySize] The key size in - * bytes. For example; 1024 or 2048. + * bits. For example: 2048, 3072, or 4096 for RSA. * @member {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if * the same key pair will be used on certificate renewal. * @member {object} [certificatePolicy.secretProperties] Properties of the diff --git a/lib/services/keyvault/lib/models/keyCreateParameters.js b/lib/services/keyvault/lib/models/keyCreateParameters.js index f3fe1f1651..42d490277d 100644 --- a/lib/services/keyvault/lib/models/keyCreateParameters.js +++ b/lib/services/keyvault/lib/models/keyCreateParameters.js @@ -22,8 +22,8 @@ class KeyCreateParameters { * @member {string} kty The type of key to create. For valid values, see * JsonWebKeyType. Possible values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', * 'oct' - * @member {number} [keySize] The key size in bytes. For example, 1024 or - * 2048. + * @member {number} [keySize] The key size in bits. For example: 2048, 3072, + * or 4096 for RSA. * @member {array} [keyOps] * @member {object} [keyAttributes] * @member {string} [keyAttributes.recoveryLevel] Reflects the deletion diff --git a/lib/services/keyvault/lib/models/keyProperties.js b/lib/services/keyvault/lib/models/keyProperties.js index af010fb036..4a3d831573 100644 --- a/lib/services/keyvault/lib/models/keyProperties.js +++ b/lib/services/keyvault/lib/models/keyProperties.js @@ -20,8 +20,8 @@ class KeyProperties { * @member {boolean} [exportable] Indicates if the private key can be * exported. * @member {string} [keyType] The key type. - * @member {number} [keySize] The key size in bytes. For example; 1024 or - * 2048. + * @member {number} [keySize] The key size in bits. For example: 2048, 3072, + * or 4096 for RSA. * @member {boolean} [reuseKey] Indicates if the same key pair will be used * on certificate renewal. */ diff --git a/lib/services/keyvault/package.json b/lib/services/keyvault/package.json index 774bed06fd..cfb25fea47 100644 --- a/lib/services/keyvault/package.json +++ b/lib/services/keyvault/package.json @@ -4,10 +4,13 @@ "description": "KeyVaultClient Library with typescript type definitions for node", "version": "3.0.4-preview", "dependencies": { - "ms-rest": "^2.3.2", + "ms-rest": "^2.3.3", "ms-rest-azure": "^2.5.5" }, - "keywords": [ "node", "azure" ], + "keywords": [ + "node", + "azure" + ], "license": "MIT", "main": "./lib/keyVaultClient.js", "types": "./lib/keyVaultClient.d.ts",