diff --git a/lib/services/keyvault/lib/lib/keyVaultClient.d.ts b/lib/services/keyvault/lib/lib/keyVaultClient.d.ts index 865776225d..93d6346684 100644 --- a/lib/services/keyvault/lib/lib/keyVaultClient.d.ts +++ b/lib/services/keyvault/lib/lib/keyVaultClient.d.ts @@ -190,8 +190,9 @@ export default class KeyVaultClient extends AzureServiceClient { * * @param {string} [key.kid] Key identifier. * - * @param {string} [key.kty] JsonWebKey key type (kty). Possible values - * include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' + * @param {string} [key.kty] JsonWebKey Key Type (kty), as defined in + * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible + * values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {array} [key.keyOps] * @@ -269,8 +270,9 @@ export default class KeyVaultClient extends AzureServiceClient { * * @param {string} [key.kid] Key identifier. * - * @param {string} [key.kty] JsonWebKey key type (kty). Possible values - * include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' + * @param {string} [key.kty] JsonWebKey Key Type (kty), as defined in + * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible + * values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {array} [key.keyOps] * @@ -3514,8 +3516,9 @@ export default class KeyVaultClient extends AzureServiceClient { * @param {boolean} [options.certificatePolicy.keyProperties.exportable] * Indicates if the private key can be exported. * - * @param {string} [options.certificatePolicy.keyProperties.keyType] The key - * type. + * @param {string} [options.certificatePolicy.keyProperties.kty] The type of + * key pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key * size in bits. For example: 2048, 3072, or 4096 for RSA. @@ -3631,8 +3634,9 @@ export default class KeyVaultClient extends AzureServiceClient { * @param {boolean} [options.certificatePolicy.keyProperties.exportable] * Indicates if the private key can be exported. * - * @param {string} [options.certificatePolicy.keyProperties.keyType] The key - * type. + * @param {string} [options.certificatePolicy.keyProperties.kty] The type of + * key pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key * size in bits. For example: 2048, 3072, or 4096 for RSA. @@ -3777,8 +3781,9 @@ export default class KeyVaultClient extends AzureServiceClient { * @param {boolean} [options.certificatePolicy.keyProperties.exportable] * Indicates if the private key can be exported. * - * @param {string} [options.certificatePolicy.keyProperties.keyType] The key - * type. + * @param {string} [options.certificatePolicy.keyProperties.kty] The type of + * key pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key * size in bits. For example: 2048, 3072, or 4096 for RSA. @@ -3904,8 +3909,9 @@ export default class KeyVaultClient extends AzureServiceClient { * @param {boolean} [options.certificatePolicy.keyProperties.exportable] * Indicates if the private key can be exported. * - * @param {string} [options.certificatePolicy.keyProperties.keyType] The key - * type. + * @param {string} [options.certificatePolicy.keyProperties.kty] The type of + * key pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key * size in bits. For example: 2048, 3072, or 4096 for RSA. @@ -4184,7 +4190,9 @@ export default class KeyVaultClient extends AzureServiceClient { * @param {boolean} [certificatePolicy.keyProperties.exportable] Indicates if * the private key can be exported. * - * @param {string} [certificatePolicy.keyProperties.keyType] The key type. + * @param {string} [certificatePolicy.keyProperties.kty] The type of key pair + * to be used for the certificate. Possible values include: 'EC', 'EC-HSM', + * 'RSA', 'RSA-HSM', 'oct' * * @param {number} [certificatePolicy.keyProperties.keySize] The key size in * bits. For example: 2048, 3072, or 4096 for RSA. @@ -4291,7 +4299,9 @@ export default class KeyVaultClient extends AzureServiceClient { * @param {boolean} [certificatePolicy.keyProperties.exportable] Indicates if * the private key can be exported. * - * @param {string} [certificatePolicy.keyProperties.keyType] The key type. + * @param {string} [certificatePolicy.keyProperties.kty] The type of key pair + * to be used for the certificate. Possible values include: 'EC', 'EC-HSM', + * 'RSA', 'RSA-HSM', 'oct' * * @param {number} [certificatePolicy.keyProperties.keySize] The key size in * bits. For example: 2048, 3072, or 4096 for RSA. @@ -4424,8 +4434,9 @@ export default class KeyVaultClient extends AzureServiceClient { * @param {boolean} [options.certificatePolicy.keyProperties.exportable] * Indicates if the private key can be exported. * - * @param {string} [options.certificatePolicy.keyProperties.keyType] The key - * type. + * @param {string} [options.certificatePolicy.keyProperties.kty] The type of + * key pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key * size in bits. For example: 2048, 3072, or 4096 for RSA. @@ -4546,8 +4557,9 @@ export default class KeyVaultClient extends AzureServiceClient { * @param {boolean} [options.certificatePolicy.keyProperties.exportable] * Indicates if the private key can be exported. * - * @param {string} [options.certificatePolicy.keyProperties.keyType] The key - * type. + * @param {string} [options.certificatePolicy.keyProperties.kty] The type of + * key pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key * size in bits. For example: 2048, 3072, or 4096 for RSA. diff --git a/lib/services/keyvault/lib/lib/keyVaultClient.js b/lib/services/keyvault/lib/lib/keyVaultClient.js index 36ac99d5c6..6695464bc7 100644 --- a/lib/services/keyvault/lib/lib/keyVaultClient.js +++ b/lib/services/keyvault/lib/lib/keyVaultClient.js @@ -277,8 +277,9 @@ function _createKey(vaultBaseUrl, keyName, kty, options, callback) { * * @param {string} [key.kid] Key identifier. * - * @param {string} [key.kty] JsonWebKey key type (kty). Possible values - * include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' + * @param {string} [key.kty] JsonWebKey Key Type (kty), as defined in + * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible + * values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {array} [key.keyOps] * @@ -7021,8 +7022,9 @@ function _deleteCertificateIssuer(vaultBaseUrl, issuerName, options, callback) { * @param {boolean} [options.certificatePolicy.keyProperties.exportable] * Indicates if the private key can be exported. * - * @param {string} [options.certificatePolicy.keyProperties.keyType] The key - * type. + * @param {string} [options.certificatePolicy.keyProperties.kty] The type of + * key pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key * size in bits. For example: 2048, 3072, or 4096 for RSA. @@ -7307,8 +7309,9 @@ function _createCertificate(vaultBaseUrl, certificateName, options, callback) { * @param {boolean} [options.certificatePolicy.keyProperties.exportable] * Indicates if the private key can be exported. * - * @param {string} [options.certificatePolicy.keyProperties.keyType] The key - * type. + * @param {string} [options.certificatePolicy.keyProperties.kty] The type of + * key pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key * size in bits. For example: 2048, 3072, or 4096 for RSA. @@ -7905,7 +7908,9 @@ function _getCertificatePolicy(vaultBaseUrl, certificateName, options, callback) * @param {boolean} [certificatePolicy.keyProperties.exportable] Indicates if * the private key can be exported. * - * @param {string} [certificatePolicy.keyProperties.keyType] The key type. + * @param {string} [certificatePolicy.keyProperties.kty] The type of key pair + * to be used for the certificate. Possible values include: 'EC', 'EC-HSM', + * 'RSA', 'RSA-HSM', 'oct' * * @param {number} [certificatePolicy.keyProperties.keySize] The key size in * bits. For example: 2048, 3072, or 4096 for RSA. @@ -8158,8 +8163,9 @@ function _updateCertificatePolicy(vaultBaseUrl, certificateName, certificatePoli * @param {boolean} [options.certificatePolicy.keyProperties.exportable] * Indicates if the private key can be exported. * - * @param {string} [options.certificatePolicy.keyProperties.keyType] The key - * type. + * @param {string} [options.certificatePolicy.keyProperties.kty] The type of + * key pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key * size in bits. For example: 2048, 3072, or 4096 for RSA. @@ -15732,8 +15738,9 @@ class KeyVaultClient extends ServiceClient { * * @param {string} [key.kid] Key identifier. * - * @param {string} [key.kty] JsonWebKey key type (kty). Possible values - * include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' + * @param {string} [key.kty] JsonWebKey Key Type (kty), as defined in + * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible + * values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {array} [key.keyOps] * @@ -15823,8 +15830,9 @@ class KeyVaultClient extends ServiceClient { * * @param {string} [key.kid] Key identifier. * - * @param {string} [key.kty] JsonWebKey key type (kty). Possible values - * include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' + * @param {string} [key.kty] JsonWebKey Key Type (kty), as defined in + * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible + * values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {array} [key.keyOps] * @@ -20136,8 +20144,9 @@ class KeyVaultClient extends ServiceClient { * @param {boolean} [options.certificatePolicy.keyProperties.exportable] * Indicates if the private key can be exported. * - * @param {string} [options.certificatePolicy.keyProperties.keyType] The key - * type. + * @param {string} [options.certificatePolicy.keyProperties.kty] The type of + * key pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key * size in bits. For example: 2048, 3072, or 4096 for RSA. @@ -20265,8 +20274,9 @@ class KeyVaultClient extends ServiceClient { * @param {boolean} [options.certificatePolicy.keyProperties.exportable] * Indicates if the private key can be exported. * - * @param {string} [options.certificatePolicy.keyProperties.keyType] The key - * type. + * @param {string} [options.certificatePolicy.keyProperties.kty] The type of + * key pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key * size in bits. For example: 2048, 3072, or 4096 for RSA. @@ -20426,8 +20436,9 @@ class KeyVaultClient extends ServiceClient { * @param {boolean} [options.certificatePolicy.keyProperties.exportable] * Indicates if the private key can be exported. * - * @param {string} [options.certificatePolicy.keyProperties.keyType] The key - * type. + * @param {string} [options.certificatePolicy.keyProperties.kty] The type of + * key pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key * size in bits. For example: 2048, 3072, or 4096 for RSA. @@ -20565,8 +20576,9 @@ class KeyVaultClient extends ServiceClient { * @param {boolean} [options.certificatePolicy.keyProperties.exportable] * Indicates if the private key can be exported. * - * @param {string} [options.certificatePolicy.keyProperties.keyType] The key - * type. + * @param {string} [options.certificatePolicy.keyProperties.kty] The type of + * key pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key * size in bits. For example: 2048, 3072, or 4096 for RSA. @@ -20914,7 +20926,9 @@ class KeyVaultClient extends ServiceClient { * @param {boolean} [certificatePolicy.keyProperties.exportable] Indicates if * the private key can be exported. * - * @param {string} [certificatePolicy.keyProperties.keyType] The key type. + * @param {string} [certificatePolicy.keyProperties.kty] The type of key pair + * to be used for the certificate. Possible values include: 'EC', 'EC-HSM', + * 'RSA', 'RSA-HSM', 'oct' * * @param {number} [certificatePolicy.keyProperties.keySize] The key size in * bits. For example: 2048, 3072, or 4096 for RSA. @@ -21033,7 +21047,9 @@ class KeyVaultClient extends ServiceClient { * @param {boolean} [certificatePolicy.keyProperties.exportable] Indicates if * the private key can be exported. * - * @param {string} [certificatePolicy.keyProperties.keyType] The key type. + * @param {string} [certificatePolicy.keyProperties.kty] The type of key pair + * to be used for the certificate. Possible values include: 'EC', 'EC-HSM', + * 'RSA', 'RSA-HSM', 'oct' * * @param {number} [certificatePolicy.keyProperties.keySize] The key size in * bits. For example: 2048, 3072, or 4096 for RSA. @@ -21181,8 +21197,9 @@ class KeyVaultClient extends ServiceClient { * @param {boolean} [options.certificatePolicy.keyProperties.exportable] * Indicates if the private key can be exported. * - * @param {string} [options.certificatePolicy.keyProperties.keyType] The key - * type. + * @param {string} [options.certificatePolicy.keyProperties.kty] The type of + * key pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key * size in bits. For example: 2048, 3072, or 4096 for RSA. @@ -21315,8 +21332,9 @@ class KeyVaultClient extends ServiceClient { * @param {boolean} [options.certificatePolicy.keyProperties.exportable] * Indicates if the private key can be exported. * - * @param {string} [options.certificatePolicy.keyProperties.keyType] The key - * type. + * @param {string} [options.certificatePolicy.keyProperties.kty] The type of + * key pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * * @param {number} [options.certificatePolicy.keyProperties.keySize] The key * size in bits. For example: 2048, 3072, or 4096 for RSA. diff --git a/lib/services/keyvault/lib/lib/models/certificateBundle.js b/lib/services/keyvault/lib/lib/models/certificateBundle.js index 2f5e93d919..29d351999d 100644 --- a/lib/services/keyvault/lib/lib/models/certificateBundle.js +++ b/lib/services/keyvault/lib/lib/models/certificateBundle.js @@ -29,7 +29,9 @@ class CertificateBundle { * certificate. * @member {boolean} [policy.keyProperties.exportable] Indicates if the * private key can be exported. - * @member {string} [policy.keyProperties.keyType] The key type. + * @member {string} [policy.keyProperties.kty] The type of key pair to be + * used for the certificate. Possible values include: 'EC', 'EC-HSM', 'RSA', + * 'RSA-HSM', 'oct' * @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 diff --git a/lib/services/keyvault/lib/lib/models/certificateCreateParameters.js b/lib/services/keyvault/lib/lib/models/certificateCreateParameters.js index de147b183d..0f47b7577d 100644 --- a/lib/services/keyvault/lib/lib/models/certificateCreateParameters.js +++ b/lib/services/keyvault/lib/lib/models/certificateCreateParameters.js @@ -26,7 +26,9 @@ class CertificateCreateParameters { * backing a certificate. * @member {boolean} [certificatePolicy.keyProperties.exportable] Indicates * if the private key can be exported. - * @member {string} [certificatePolicy.keyProperties.keyType] The key type. + * @member {string} [certificatePolicy.keyProperties.kty] The type of key + * pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * @member {number} [certificatePolicy.keyProperties.keySize] The key size in * bits. For example: 2048, 3072, or 4096 for RSA. * @member {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if diff --git a/lib/services/keyvault/lib/lib/models/certificateImportParameters.js b/lib/services/keyvault/lib/lib/models/certificateImportParameters.js index 6e9af5bd79..a3a62d7ff6 100644 --- a/lib/services/keyvault/lib/lib/models/certificateImportParameters.js +++ b/lib/services/keyvault/lib/lib/models/certificateImportParameters.js @@ -31,7 +31,9 @@ class CertificateImportParameters { * backing a certificate. * @member {boolean} [certificatePolicy.keyProperties.exportable] Indicates * if the private key can be exported. - * @member {string} [certificatePolicy.keyProperties.keyType] The key type. + * @member {string} [certificatePolicy.keyProperties.kty] The type of key + * pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * @member {number} [certificatePolicy.keyProperties.keySize] The key size in * bits. For example: 2048, 3072, or 4096 for RSA. * @member {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if diff --git a/lib/services/keyvault/lib/lib/models/certificatePolicy.js b/lib/services/keyvault/lib/lib/models/certificatePolicy.js index 1c545b3f22..cf6fa2c537 100644 --- a/lib/services/keyvault/lib/lib/models/certificatePolicy.js +++ b/lib/services/keyvault/lib/lib/models/certificatePolicy.js @@ -24,7 +24,9 @@ class CertificatePolicy { * certificate. * @member {boolean} [keyProperties.exportable] Indicates if the private key * can be exported. - * @member {string} [keyProperties.keyType] The key type. + * @member {string} [keyProperties.kty] The type of key pair to be used for + * the certificate. Possible values include: 'EC', 'EC-HSM', 'RSA', + * 'RSA-HSM', 'oct' * @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 diff --git a/lib/services/keyvault/lib/lib/models/certificateUpdateParameters.js b/lib/services/keyvault/lib/lib/models/certificateUpdateParameters.js index 8aaae2b43d..d7c9a98e08 100644 --- a/lib/services/keyvault/lib/lib/models/certificateUpdateParameters.js +++ b/lib/services/keyvault/lib/lib/models/certificateUpdateParameters.js @@ -26,7 +26,9 @@ class CertificateUpdateParameters { * backing a certificate. * @member {boolean} [certificatePolicy.keyProperties.exportable] Indicates * if the private key can be exported. - * @member {string} [certificatePolicy.keyProperties.keyType] The key type. + * @member {string} [certificatePolicy.keyProperties.kty] The type of key + * pair to be used for the certificate. Possible values include: 'EC', + * 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * @member {number} [certificatePolicy.keyProperties.keySize] The key size in * bits. For example: 2048, 3072, or 4096 for RSA. * @member {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if diff --git a/lib/services/keyvault/lib/lib/models/index.d.ts b/lib/services/keyvault/lib/lib/models/index.d.ts index 657c759a1e..46ad7fd963 100644 --- a/lib/services/keyvault/lib/lib/models/index.d.ts +++ b/lib/services/keyvault/lib/lib/models/index.d.ts @@ -43,8 +43,9 @@ export interface Attributes { * As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 * * @member {string} [kid] Key identifier. - * @member {string} [kty] JsonWebKey key type (kty). Possible values include: - * 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' + * @member {string} [kty] JsonWebKey Key Type (kty), as defined in + * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible + * values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * @member {array} [keyOps] * @member {buffer} [n] RSA modulus. * @member {buffer} [e] RSA public exponent. @@ -107,8 +108,9 @@ export interface KeyAttributes extends Attributes { * * @member {object} [key] The Json web key. * @member {string} [key.kid] Key identifier. - * @member {string} [key.kty] JsonWebKey key type (kty). Possible values - * include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' + * @member {string} [key.kty] JsonWebKey Key Type (kty), as defined in + * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible + * values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * @member {array} [key.keyOps] * @member {buffer} [key.n] RSA modulus. * @member {buffer} [key.e] RSA public exponent. @@ -413,7 +415,8 @@ export interface CertificateIssuerItem { * Properties of the key pair backing a certificate. * * @member {boolean} [exportable] Indicates if the private key can be exported. - * @member {string} [keyType] The key type. + * @member {string} [kty] The type of key pair to be used for the certificate. + * Possible values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * @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 @@ -421,7 +424,7 @@ export interface CertificateIssuerItem { */ export interface KeyProperties { exportable?: boolean; - keyType?: string; + kty?: string; keySize?: number; reuseKey?: boolean; } @@ -563,7 +566,9 @@ export interface IssuerParameters { * certificate. * @member {boolean} [keyProperties.exportable] Indicates if the private key * can be exported. - * @member {string} [keyProperties.keyType] The key type. + * @member {string} [keyProperties.kty] The type of key pair to be used for the + * certificate. Possible values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', + * 'oct' * @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 @@ -632,7 +637,9 @@ export interface CertificatePolicy { * certificate. * @member {boolean} [policy.keyProperties.exportable] Indicates if the private * key can be exported. - * @member {string} [policy.keyProperties.keyType] The key type. + * @member {string} [policy.keyProperties.kty] The type of key pair to be used + * for the certificate. Possible values include: 'EC', 'EC-HSM', 'RSA', + * 'RSA-HSM', 'oct' * @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 @@ -971,8 +978,9 @@ export interface KeyCreateParameters { * software key. * @member {object} key The Json web key * @member {string} [key.kid] Key identifier. - * @member {string} [key.kty] JsonWebKey key type (kty). Possible values - * include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' + * @member {string} [key.kty] JsonWebKey Key Type (kty), as defined in + * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible + * values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * @member {array} [key.keyOps] * @member {buffer} [key.n] RSA modulus. * @member {buffer} [key.e] RSA public exponent. @@ -1157,7 +1165,9 @@ export interface SecretUpdateParameters { * backing a certificate. * @member {boolean} [certificatePolicy.keyProperties.exportable] Indicates if * the private key can be exported. - * @member {string} [certificatePolicy.keyProperties.keyType] The key type. + * @member {string} [certificatePolicy.keyProperties.kty] The type of key pair + * to be used for the certificate. Possible values include: 'EC', 'EC-HSM', + * 'RSA', 'RSA-HSM', 'oct' * @member {number} [certificatePolicy.keyProperties.keySize] The key size in * bits. For example: 2048, 3072, or 4096 for RSA. * @member {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if @@ -1245,7 +1255,9 @@ export interface CertificateCreateParameters { * backing a certificate. * @member {boolean} [certificatePolicy.keyProperties.exportable] Indicates if * the private key can be exported. - * @member {string} [certificatePolicy.keyProperties.keyType] The key type. + * @member {string} [certificatePolicy.keyProperties.kty] The type of key pair + * to be used for the certificate. Possible values include: 'EC', 'EC-HSM', + * 'RSA', 'RSA-HSM', 'oct' * @member {number} [certificatePolicy.keyProperties.keySize] The key size in * bits. For example: 2048, 3072, or 4096 for RSA. * @member {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if @@ -1330,7 +1342,9 @@ export interface CertificateImportParameters { * backing a certificate. * @member {boolean} [certificatePolicy.keyProperties.exportable] Indicates if * the private key can be exported. - * @member {string} [certificatePolicy.keyProperties.keyType] The key type. + * @member {string} [certificatePolicy.keyProperties.kty] The type of key pair + * to be used for the certificate. Possible values include: 'EC', 'EC-HSM', + * 'RSA', 'RSA-HSM', 'oct' * @member {number} [certificatePolicy.keyProperties.keySize] The key size in * bits. For example: 2048, 3072, or 4096 for RSA. * @member {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if diff --git a/lib/services/keyvault/lib/lib/models/jsonWebKey.js b/lib/services/keyvault/lib/lib/models/jsonWebKey.js index 5c0b221573..d752e16f16 100644 --- a/lib/services/keyvault/lib/lib/models/jsonWebKey.js +++ b/lib/services/keyvault/lib/lib/models/jsonWebKey.js @@ -18,8 +18,9 @@ class JsonWebKey { /** * Create a JsonWebKey. * @member {string} [kid] Key identifier. - * @member {string} [kty] JsonWebKey key type (kty). Possible values include: - * 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' + * @member {string} [kty] JsonWebKey Key Type (kty), as defined in + * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. + * Possible values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * @member {array} [keyOps] * @member {buffer} [n] RSA modulus. * @member {buffer} [e] RSA public exponent. diff --git a/lib/services/keyvault/lib/lib/models/keyBundle.js b/lib/services/keyvault/lib/lib/models/keyBundle.js index 2c554e4c9e..a9ee518957 100644 --- a/lib/services/keyvault/lib/lib/models/keyBundle.js +++ b/lib/services/keyvault/lib/lib/models/keyBundle.js @@ -21,8 +21,9 @@ class KeyBundle { * Create a KeyBundle. * @member {object} [key] The Json web key. * @member {string} [key.kid] Key identifier. - * @member {string} [key.kty] JsonWebKey key type (kty). Possible values - * include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' + * @member {string} [key.kty] JsonWebKey Key Type (kty), as defined in + * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. + * Possible values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * @member {array} [key.keyOps] * @member {buffer} [key.n] RSA modulus. * @member {buffer} [key.e] RSA public exponent. diff --git a/lib/services/keyvault/lib/lib/models/keyImportParameters.js b/lib/services/keyvault/lib/lib/models/keyImportParameters.js index 224f128ce8..c43b8b0799 100644 --- a/lib/services/keyvault/lib/lib/models/keyImportParameters.js +++ b/lib/services/keyvault/lib/lib/models/keyImportParameters.js @@ -23,8 +23,9 @@ class KeyImportParameters { * software key. * @member {object} key The Json web key * @member {string} [key.kid] Key identifier. - * @member {string} [key.kty] JsonWebKey key type (kty). Possible values - * include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' + * @member {string} [key.kty] JsonWebKey Key Type (kty), as defined in + * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. + * Possible values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct' * @member {array} [key.keyOps] * @member {buffer} [key.n] RSA modulus. * @member {buffer} [key.e] RSA public exponent. diff --git a/lib/services/keyvault/lib/lib/models/keyProperties.js b/lib/services/keyvault/lib/lib/models/keyProperties.js index 4a3d831573..9ddb113473 100644 --- a/lib/services/keyvault/lib/lib/models/keyProperties.js +++ b/lib/services/keyvault/lib/lib/models/keyProperties.js @@ -19,7 +19,9 @@ class KeyProperties { * Create a KeyProperties. * @member {boolean} [exportable] Indicates if the private key can be * exported. - * @member {string} [keyType] The key type. + * @member {string} [kty] The type of key pair to be used for the + * certificate. Possible values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', + * 'oct' * @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 @@ -49,7 +51,7 @@ class KeyProperties { name: 'Boolean' } }, - keyType: { + kty: { required: false, serializedName: 'kty', type: {