@azure/keyvault-keys 4.3.0-beta.1 → 4.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -6
- package/README.md +14 -16
- package/dist/index.js +32 -584
- package/dist/index.js.map +1 -1
- package/dist-esm/keyvault-keys/src/constants.js +1 -1
- package/dist-esm/keyvault-keys/src/constants.js.map +1 -1
- package/dist-esm/keyvault-keys/src/cryptographyClient.js +8 -9
- package/dist-esm/keyvault-keys/src/cryptographyClient.js.map +1 -1
- package/dist-esm/keyvault-keys/src/generated/keyVaultClient.js +14 -242
- package/dist-esm/keyvault-keys/src/generated/keyVaultClient.js.map +1 -1
- package/dist-esm/keyvault-keys/src/generated/keyVaultClientContext.js +7 -5
- package/dist-esm/keyvault-keys/src/generated/keyVaultClientContext.js.map +1 -1
- package/dist-esm/keyvault-keys/src/generated/models/index.js.map +1 -1
- package/dist-esm/keyvault-keys/src/generated/models/mappers.js +0 -278
- package/dist-esm/keyvault-keys/src/generated/models/mappers.js.map +1 -1
- package/dist-esm/keyvault-keys/src/generated/models/parameters.js +1 -45
- package/dist-esm/keyvault-keys/src/generated/models/parameters.js.map +1 -1
- package/dist-esm/keyvault-keys/src/index.js +2 -19
- package/dist-esm/keyvault-keys/src/index.js.map +1 -1
- package/dist-esm/keyvault-keys/src/keysModels.js +1 -19
- package/dist-esm/keyvault-keys/src/keysModels.js.map +1 -1
- package/package.json +7 -6
- package/types/keyvault-keys.d.ts +32 -51
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"keysModels.js","sourceRoot":"","sources":["../../../src/keysModels.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAalC;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,aAAa,CAAC;AAidhD,qEAAqE;AACrE,MAAM,CAAN,IAAY,kBAeX;AAfD,WAAY,kBAAkB;IAC5B,8BAA8B;IAC9B,yCAAmB,CAAA;IACnB,8BAA8B;IAC9B,yCAAmB,CAAA;IACnB,8BAA8B;IAC9B,mCAAa,CAAA;IACb,8BAA8B;IAC9B,uCAAiB,CAAA;IACjB,8BAA8B;IAC9B,yCAAmB,CAAA;IACnB,8BAA8B;IAC9B,6CAAuB,CAAA;IACvB,8BAA8B;IAC9B,uCAAiB,CAAA;AACnB,CAAC,EAfW,kBAAkB,KAAlB,kBAAkB,QAe7B","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport * as coreHttp from \"@azure/core-http\";\nimport {\n DeletionRecoveryLevel,\n JsonWebKeyType as KeyType,\n KnownJsonWebKeyType as KnownKeyTypes,\n JsonWebKeyOperation as KeyOperation\n} from \"./generated/models\";\nimport { KeyCurveName } from \"./cryptographyClientModels\";\n\nexport { KeyType, KnownKeyTypes, KeyOperation };\n\n/**\n * The latest supported Key Vault service API version\n */\nexport const LATEST_API_VERSION = \"7.3-preview\";\n\n/**\n * The optional parameters accepted by the KeyVault's KeyClient\n */\nexport interface KeyClientOptions extends coreHttp.PipelineOptions {\n /**\n * The version of the KeyVault's service API to make calls against.\n */\n serviceVersion?: string;\n}\n\n/**\n * The optional parameters accepted by the KeyVault's CryptographyClient\n */\nexport interface CryptographyClientOptions extends KeyClientOptions {}\n\n/**\n * As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18\n */\nexport interface JsonWebKey {\n /**\n * Key identifier.\n */\n kid?: string;\n /**\n * JsonWebKey Key Type (kty), as defined in\n * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible values include:\n * 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct', \"oct-HSM\"\n */\n kty?: KeyType;\n /**\n * Json web key operations. For more\n * information on possible key operations, see KeyOperation.\n */\n keyOps?: KeyOperation[];\n /**\n * RSA modulus.\n */\n n?: Uint8Array;\n /**\n * RSA public exponent.\n */\n e?: Uint8Array;\n /**\n * RSA private exponent, or the D component of an EC private key.\n */\n d?: Uint8Array;\n /**\n * RSA private key parameter.\n */\n dp?: Uint8Array;\n /**\n * RSA private key parameter.\n */\n dq?: Uint8Array;\n /**\n * RSA private key parameter.\n */\n qi?: Uint8Array;\n /**\n * RSA secret prime.\n */\n p?: Uint8Array;\n /**\n * RSA secret prime, with `p < q`.\n */\n q?: Uint8Array;\n /**\n * Symmetric key.\n */\n k?: Uint8Array;\n /**\n * HSM Token, used with 'Bring Your Own Key'.\n */\n t?: Uint8Array;\n /**\n * Elliptic curve name. For valid values, see KeyCurveName. Possible values include:\n * 'P-256', 'P-384', 'P-521', 'P-256K'\n */\n crv?: KeyCurveName;\n /**\n * X component of an EC public key.\n */\n x?: Uint8Array;\n /**\n * Y component of an EC public key.\n */\n y?: Uint8Array;\n}\n\n/**\n * An interface representing a Key Vault Key, with its name, value and {@link KeyProperties}.\n */\nexport interface KeyVaultKey {\n /**\n * The key value.\n */\n key?: JsonWebKey;\n /**\n * The name of the key.\n */\n name: string;\n /**\n * Key identifier.\n */\n id?: string;\n /**\n * JsonWebKey Key Type (kty), as defined in\n * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible values include:\n * 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct', \"oct-HSM\"\n */\n keyType?: KeyType;\n /**\n * Operations allowed on this key\n */\n keyOperations?: KeyOperation[];\n /**\n * The properties of the key.\n */\n properties: KeyProperties;\n}\n\n/**\n * An interface representing the Properties of {@link KeyVaultKey}\n */\nexport interface KeyProperties {\n /**\n * Key identifier.\n */\n id?: string;\n /**\n * The name of the key.\n */\n name: string;\n /**\n * The vault URI.\n */\n vaultUrl: string;\n /**\n * The version of the key. May be undefined.\n */\n version?: string;\n /**\n * Determines whether the object is enabled.\n */\n enabled?: boolean;\n /**\n * Not before date in UTC.\n */\n notBefore?: Date;\n /**\n * Expiry date in UTC.\n */\n expiresOn?: Date;\n /**\n * Application specific metadata in the form of key-value pairs.\n */\n tags?: { [propertyName: string]: string };\n /**\n * Creation time in UTC.\n * **NOTE: This property will not be serialized. It can only be populated by\n * the server.**\n */\n readonly createdOn?: Date;\n /**\n * Last updated time in UTC.\n * **NOTE: This property will not be serialized. It can only be populated by\n * the server.**\n */\n readonly updatedOn?: Date;\n /**\n * Reflects the deletion recovery level currently in effect for keys in the current vault.\n * If it contains 'Purgeable' the key can be permanently deleted by a privileged\n * user; otherwise, only the system can purge the key, at the end of the\n * retention interval. Possible values include: 'Purgeable',\n * 'Recoverable+Purgeable', 'Recoverable',\n * 'Recoverable+ProtectedSubscription'\n * **NOTE: This property will not be serialized. It can only be populated by\n * the server.**\n */\n readonly recoveryLevel?: DeletionRecoveryLevel;\n /**\n * The retention dates of the softDelete data.\n * The value should be `>=7` and `<=90` when softDelete enabled.\n * **NOTE: This property will not be serialized. It can only be populated by the server.**\n */\n recoverableDays?: number;\n\n /**\n * True if the secret's lifetime is managed by\n * key vault. If this is a secret backing a certificate, then managed will be\n * true.\n * **NOTE: This property will not be serialized. It can only be populated by\n * the server.**\n */\n readonly managed?: boolean;\n}\n\n/**\n * An interface representing a deleted Key Vault Key.\n */\nexport interface DeletedKey {\n /**\n * The key value.\n */\n key?: JsonWebKey;\n /**\n * The name of the key.\n */\n name: string;\n /**\n * Key identifier.\n */\n id?: string;\n /**\n * JsonWebKey Key Type (kty), as defined in\n * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible values include:\n * 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct', \"oct-HSM\"\n */\n keyType?: KeyType;\n /**\n * Operations allowed on this key\n */\n keyOperations?: KeyOperation[];\n /**\n * The properties of the key.\n */\n properties: KeyProperties & {\n /**\n * The url of the recovery object, used to\n * identify and recover the deleted key.\n */\n readonly recoveryId?: string;\n /**\n * The time when the key is scheduled to be purged, in UTC\n * **NOTE: This property will not be serialized. It can only be populated by\n * the server.**\n */\n readonly scheduledPurgeDate?: Date;\n /**\n * The time when the key was deleted, in UTC\n * **NOTE: This property will not be serialized. It can only be populated by\n * the server.**\n */\n deletedOn?: Date;\n };\n}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link createKey}\n */\nexport interface CreateKeyOptions extends coreHttp.OperationOptions {\n /**\n * Application specific metadata in the form of key-value pairs.\n */\n tags?: { [propertyName: string]: string };\n /**\n * Json web key operations. For more\n * information on possible key operations, see KeyOperation.\n */\n keyOps?: KeyOperation[];\n /**\n * Determines whether the object is enabled.\n */\n enabled?: boolean;\n /**\n * Not before date in UTC.\n */\n notBefore?: Date;\n /**\n * Expiry date in UTC.\n */\n readonly expiresOn?: Date;\n /**\n * The key size in bits. For example: 2048, 3072, or 4096 for RSA.\n */\n keySize?: number;\n /**\n * Elliptic curve name. For valid values, see KeyCurveName.\n * Possible values include: 'P-256', 'P-384', 'P-521', 'P-256K'\n */\n curve?: KeyCurveName;\n /**\n * Whether to import as a hardware key (HSM) or software key.\n */\n hsm?: boolean;\n}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link beginDeleteKey} and {@link beginRecoverDeletedKey}\n */\nexport interface KeyPollerOptions extends coreHttp.OperationOptions {\n /**\n * Time between each polling\n */\n intervalInMs?: number;\n /**\n * A serialized poller, used to resume an existing operation\n */\n resumeFrom?: string;\n}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link beginDeleteKey}\n */\nexport interface BeginDeleteKeyOptions extends KeyPollerOptions {}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link beginRecoverDeletedKey}\n */\nexport interface BeginRecoverDeletedKeyOptions extends KeyPollerOptions {}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link createEcKey}\n */\nexport interface CreateEcKeyOptions extends CreateKeyOptions {}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link createRsaKey}\n */\nexport interface CreateRsaKeyOptions extends CreateKeyOptions {\n /** The public exponent for a RSA key. */\n publicExponent?: number;\n}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link createOctKey}\n */\nexport interface CreateOctKeyOptions extends CreateKeyOptions {}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link importKey}\n */\nexport interface ImportKeyOptions extends coreHttp.OperationOptions {\n /**\n * Application specific metadata in the form of key-value pairs.\n */\n tags?: { [propertyName: string]: string };\n /**\n * Whether to import as a hardware key (HSM) or software key.\n */\n hardwareProtected?: boolean;\n /**\n * Determines whether the object is enabled.\n */\n enabled?: boolean;\n /**\n * Not before date in UTC.\n */\n notBefore?: Date;\n /**\n * Expiry date in UTC.\n */\n expiresOn?: Date;\n}\n\n/**\n * Options for {@link updateKeyProperties}.\n */\nexport interface UpdateKeyPropertiesOptions extends coreHttp.OperationOptions {\n /**\n * Json web key operations. For more\n * information on possible key operations, see KeyOperation.\n */\n keyOps?: KeyOperation[];\n /**\n * Determines whether the object is enabled.\n */\n enabled?: boolean;\n /**\n * Not before date in UTC.\n */\n notBefore?: Date;\n /**\n * Expiry date in UTC.\n */\n expiresOn?: Date;\n /**\n * Application specific metadata in the form of key-value pairs.\n */\n tags?: { [propertyName: string]: string };\n}\n\n/**\n * Options for {@link getKey}.\n */\nexport interface GetKeyOptions extends coreHttp.OperationOptions {\n /**\n * The version of the secret to retrieve. If not\n * specified the latest version of the secret will be retrieved.\n */\n version?: string;\n}\n\n/**\n * An interface representing optional parameters for KeyClient paged operations passed to {@link listKeys}.\n */\nexport interface ListKeysOptions extends coreHttp.OperationOptions {}\n\n/**\n * An interface representing optional parameters for KeyClient paged operations passed to {@link listPropertiesOfKeys}.\n */\nexport interface ListPropertiesOfKeysOptions extends coreHttp.OperationOptions {}\n\n/**\n * An interface representing optional parameters for KeyClient paged operations passed to {@link listPropertiesOfKeyVersions}.\n */\nexport interface ListPropertiesOfKeyVersionsOptions extends coreHttp.OperationOptions {}\n\n/**\n * An interface representing optional parameters for KeyClient paged operations passed to {@link listDeletedKeys}.\n */\nexport interface ListDeletedKeysOptions extends coreHttp.OperationOptions {}\n\n/**\n * Options for {@link getDeletedKey}.\n */\nexport interface GetDeletedKeyOptions extends coreHttp.OperationOptions {}\n\n/**\n * Options for {@link purgeDeletedKey}.\n */\nexport interface PurgeDeletedKeyOptions extends coreHttp.OperationOptions {}\n\n/**\n * @internal\n * Options for {@link recoverDeletedKey}.\n */\nexport interface RecoverDeletedKeyOptions extends coreHttp.OperationOptions {}\n\n/**\n * @internal\n * Options for {@link deleteKey}.\n */\nexport interface DeleteKeyOptions extends coreHttp.OperationOptions {}\n\n/**\n * Options for {@link backupKey}.\n */\nexport interface BackupKeyOptions extends coreHttp.OperationOptions {}\n\n/**\n * Options for {@link restoreKeyBackup}.\n */\nexport interface RestoreKeyBackupOptions extends coreHttp.OperationOptions {}\n\n/**\n * An interface representing the options of the cryptography API methods, go to the {@link CryptographyClient} for more information.\n */\nexport interface CryptographyOptions extends coreHttp.OperationOptions {}\n\n/**\n * Options for {@link KeyClient.getRandomBytes}\n */\nexport interface GetRandomBytesOptions extends coreHttp.OperationOptions {}\n\n/** Known values of {@link KeyOperation} that the service accepts. */\nexport enum KnownKeyOperations {\n /** Key operation - encrypt */\n Encrypt = \"encrypt\",\n /** Key operation - encrypt */\n Decrypt = \"decrypt\",\n /** Key operation - encrypt */\n Sign = \"sign\",\n /** Key operation - encrypt */\n Verify = \"verify\",\n /** Key operation - encrypt */\n WrapKey = \"wrapKey\",\n /** Key operation - encrypt */\n UnwrapKey = \"unwrapKey\",\n /** Key operation - encrypt */\n Import = \"import\"\n}\n"]}
|
|
1
|
+
{"version":3,"file":"keysModels.js","sourceRoot":"","sources":["../../../src/keysModels.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAclC;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport * as coreHttp from \"@azure/core-http\";\nimport {\n DeletionRecoveryLevel,\n JsonWebKeyType as KeyType,\n KnownJsonWebKeyType as KnownKeyTypes,\n JsonWebKeyOperation as KeyOperation,\n KnownJsonWebKeyOperation as KnownKeyOperations\n} from \"./generated/models\";\nimport { KeyCurveName } from \"./cryptographyClientModels\";\n\nexport { KeyType, KnownKeyTypes, KeyOperation, KnownKeyOperations };\n\n/**\n * The latest supported Key Vault service API version\n */\nexport const LATEST_API_VERSION = \"7.2\";\n\n/**\n * The optional parameters accepted by the KeyVault's KeyClient\n */\nexport interface KeyClientOptions extends coreHttp.PipelineOptions {\n /**\n * The version of the KeyVault's service API to make calls against.\n */\n serviceVersion?: string;\n}\n\n/**\n * The optional parameters accepted by the KeyVault's CryptographyClient\n */\nexport interface CryptographyClientOptions extends KeyClientOptions {}\n\n/**\n * As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18\n */\nexport interface JsonWebKey {\n /**\n * Key identifier.\n */\n kid?: string;\n /**\n * JsonWebKey Key Type (kty), as defined in\n * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible values include:\n * 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct', \"oct-HSM\"\n */\n kty?: KeyType;\n /**\n * Json web key operations. For more\n * information on possible key operations, see KeyOperation.\n */\n keyOps?: KeyOperation[];\n /**\n * RSA modulus.\n */\n n?: Uint8Array;\n /**\n * RSA public exponent.\n */\n e?: Uint8Array;\n /**\n * RSA private exponent, or the D component of an EC private key.\n */\n d?: Uint8Array;\n /**\n * RSA private key parameter.\n */\n dp?: Uint8Array;\n /**\n * RSA private key parameter.\n */\n dq?: Uint8Array;\n /**\n * RSA private key parameter.\n */\n qi?: Uint8Array;\n /**\n * RSA secret prime.\n */\n p?: Uint8Array;\n /**\n * RSA secret prime, with `p < q`.\n */\n q?: Uint8Array;\n /**\n * Symmetric key.\n */\n k?: Uint8Array;\n /**\n * HSM Token, used with 'Bring Your Own Key'.\n */\n t?: Uint8Array;\n /**\n * Elliptic curve name. For valid values, see KeyCurveName. Possible values include:\n * 'P-256', 'P-384', 'P-521', 'P-256K'\n */\n crv?: KeyCurveName;\n /**\n * X component of an EC public key.\n */\n x?: Uint8Array;\n /**\n * Y component of an EC public key.\n */\n y?: Uint8Array;\n}\n\n/**\n * An interface representing a Key Vault Key, with its name, value and {@link KeyProperties}.\n */\nexport interface KeyVaultKey {\n /**\n * The key value.\n */\n key?: JsonWebKey;\n /**\n * The name of the key.\n */\n name: string;\n /**\n * Key identifier.\n */\n id?: string;\n /**\n * JsonWebKey Key Type (kty), as defined in\n * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible values include:\n * 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct', \"oct-HSM\"\n */\n keyType?: KeyType;\n /**\n * Operations allowed on this key\n */\n keyOperations?: KeyOperation[];\n /**\n * The properties of the key.\n */\n properties: KeyProperties;\n}\n\n/**\n * An interface representing the Properties of {@link KeyVaultKey}\n */\nexport interface KeyProperties {\n /**\n * Key identifier.\n */\n id?: string;\n /**\n * The name of the key.\n */\n name: string;\n /**\n * The vault URI.\n */\n vaultUrl: string;\n /**\n * The version of the key. May be undefined.\n */\n version?: string;\n /**\n * Determines whether the object is enabled.\n */\n enabled?: boolean;\n /**\n * Not before date in UTC.\n */\n notBefore?: Date;\n /**\n * Expiry date in UTC.\n */\n expiresOn?: Date;\n /**\n * Application specific metadata in the form of key-value pairs.\n */\n tags?: { [propertyName: string]: string };\n /**\n * Creation time in UTC.\n * **NOTE: This property will not be serialized. It can only be populated by\n * the server.**\n */\n readonly createdOn?: Date;\n /**\n * Last updated time in UTC.\n * **NOTE: This property will not be serialized. It can only be populated by\n * the server.**\n */\n readonly updatedOn?: Date;\n /**\n * Reflects the deletion recovery level currently in effect for keys in the current vault.\n * If it contains 'Purgeable' the key can be permanently deleted by a privileged\n * user; otherwise, only the system can purge the key, at the end of the\n * retention interval. Possible values include: 'Purgeable',\n * 'Recoverable+Purgeable', 'Recoverable',\n * 'Recoverable+ProtectedSubscription'\n * **NOTE: This property will not be serialized. It can only be populated by\n * the server.**\n */\n readonly recoveryLevel?: DeletionRecoveryLevel;\n /**\n * The retention dates of the softDelete data.\n * The value should be `>=7` and `<=90` when softDelete enabled.\n * **NOTE: This property will not be serialized. It can only be populated by the server.**\n */\n recoverableDays?: number;\n\n /**\n * True if the secret's lifetime is managed by\n * key vault. If this is a secret backing a certificate, then managed will be\n * true.\n * **NOTE: This property will not be serialized. It can only be populated by\n * the server.**\n */\n readonly managed?: boolean;\n}\n\n/**\n * An interface representing a deleted Key Vault Key.\n */\nexport interface DeletedKey {\n /**\n * The key value.\n */\n key?: JsonWebKey;\n /**\n * The name of the key.\n */\n name: string;\n /**\n * Key identifier.\n */\n id?: string;\n /**\n * JsonWebKey Key Type (kty), as defined in\n * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible values include:\n * 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct', \"oct-HSM\"\n */\n keyType?: KeyType;\n /**\n * Operations allowed on this key\n */\n keyOperations?: KeyOperation[];\n /**\n * The properties of the key.\n */\n properties: KeyProperties & {\n /**\n * The url of the recovery object, used to\n * identify and recover the deleted key.\n */\n readonly recoveryId?: string;\n /**\n * The time when the key is scheduled to be purged, in UTC\n * **NOTE: This property will not be serialized. It can only be populated by\n * the server.**\n */\n readonly scheduledPurgeDate?: Date;\n /**\n * The time when the key was deleted, in UTC\n * **NOTE: This property will not be serialized. It can only be populated by\n * the server.**\n */\n deletedOn?: Date;\n };\n}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link createKey}\n */\nexport interface CreateKeyOptions extends coreHttp.OperationOptions {\n /**\n * Application specific metadata in the form of key-value pairs.\n */\n tags?: { [propertyName: string]: string };\n /**\n * Json web key operations. For more\n * information on possible key operations, see KeyOperation.\n */\n keyOps?: KeyOperation[];\n /**\n * Determines whether the object is enabled.\n */\n enabled?: boolean;\n /**\n * Not before date in UTC.\n */\n notBefore?: Date;\n /**\n * Expiry date in UTC.\n */\n readonly expiresOn?: Date;\n /**\n * The key size in bits. For example: 2048, 3072, or 4096 for RSA.\n */\n keySize?: number;\n /**\n * Elliptic curve name. For valid values, see KeyCurveName.\n * Possible values include: 'P-256', 'P-384', 'P-521', 'P-256K'\n */\n curve?: KeyCurveName;\n /**\n * Whether to import as a hardware key (HSM) or software key.\n */\n hsm?: boolean;\n}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link beginDeleteKey} and {@link beginRecoverDeletedKey}\n */\nexport interface KeyPollerOptions extends coreHttp.OperationOptions {\n /**\n * Time between each polling\n */\n intervalInMs?: number;\n /**\n * A serialized poller, used to resume an existing operation\n */\n resumeFrom?: string;\n}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link beginDeleteKey}\n */\nexport interface BeginDeleteKeyOptions extends KeyPollerOptions {}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link beginRecoverDeletedKey}\n */\nexport interface BeginRecoverDeletedKeyOptions extends KeyPollerOptions {}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link createEcKey}\n */\nexport interface CreateEcKeyOptions extends CreateKeyOptions {}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link createRsaKey}\n */\nexport interface CreateRsaKeyOptions extends CreateKeyOptions {\n /** The public exponent for a RSA key. */\n publicExponent?: number;\n}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link createOctKey}\n */\nexport interface CreateOctKeyOptions extends CreateKeyOptions {}\n\n/**\n * An interface representing the optional parameters that can be\n * passed to {@link importKey}\n */\nexport interface ImportKeyOptions extends coreHttp.OperationOptions {\n /**\n * Application specific metadata in the form of key-value pairs.\n */\n tags?: { [propertyName: string]: string };\n /**\n * Whether to import as a hardware key (HSM) or software key.\n */\n hardwareProtected?: boolean;\n /**\n * Determines whether the object is enabled.\n */\n enabled?: boolean;\n /**\n * Not before date in UTC.\n */\n notBefore?: Date;\n /**\n * Expiry date in UTC.\n */\n expiresOn?: Date;\n}\n\n/**\n * Options for {@link updateKeyProperties}.\n */\nexport interface UpdateKeyPropertiesOptions extends coreHttp.OperationOptions {\n /**\n * Json web key operations. For more\n * information on possible key operations, see KeyOperation.\n */\n keyOps?: KeyOperation[];\n /**\n * Determines whether the object is enabled.\n */\n enabled?: boolean;\n /**\n * Not before date in UTC.\n */\n notBefore?: Date;\n /**\n * Expiry date in UTC.\n */\n expiresOn?: Date;\n /**\n * Application specific metadata in the form of key-value pairs.\n */\n tags?: { [propertyName: string]: string };\n}\n\n/**\n * Options for {@link getKey}.\n */\nexport interface GetKeyOptions extends coreHttp.OperationOptions {\n /**\n * The version of the secret to retrieve. If not\n * specified the latest version of the secret will be retrieved.\n */\n version?: string;\n}\n\n/**\n * An interface representing optional parameters for KeyClient paged operations passed to {@link listKeys}.\n */\nexport interface ListKeysOptions extends coreHttp.OperationOptions {}\n\n/**\n * An interface representing optional parameters for KeyClient paged operations passed to {@link listPropertiesOfKeys}.\n */\nexport interface ListPropertiesOfKeysOptions extends coreHttp.OperationOptions {}\n\n/**\n * An interface representing optional parameters for KeyClient paged operations passed to {@link listPropertiesOfKeyVersions}.\n */\nexport interface ListPropertiesOfKeyVersionsOptions extends coreHttp.OperationOptions {}\n\n/**\n * An interface representing optional parameters for KeyClient paged operations passed to {@link listDeletedKeys}.\n */\nexport interface ListDeletedKeysOptions extends coreHttp.OperationOptions {}\n\n/**\n * Options for {@link getDeletedKey}.\n */\nexport interface GetDeletedKeyOptions extends coreHttp.OperationOptions {}\n\n/**\n * Options for {@link purgeDeletedKey}.\n */\nexport interface PurgeDeletedKeyOptions extends coreHttp.OperationOptions {}\n\n/**\n * @internal\n * Options for {@link recoverDeletedKey}.\n */\nexport interface RecoverDeletedKeyOptions extends coreHttp.OperationOptions {}\n\n/**\n * @internal\n * Options for {@link deleteKey}.\n */\nexport interface DeleteKeyOptions extends coreHttp.OperationOptions {}\n\n/**\n * Options for {@link backupKey}.\n */\nexport interface BackupKeyOptions extends coreHttp.OperationOptions {}\n\n/**\n * Options for {@link restoreKeyBackup}.\n */\nexport interface RestoreKeyBackupOptions extends coreHttp.OperationOptions {}\n\n/**\n * An interface representing the options of the cryptography API methods, go to the {@link CryptographyClient} for more information.\n */\nexport interface CryptographyOptions extends coreHttp.OperationOptions {}\n"]}
|
package/package.json
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
"name": "@azure/keyvault-keys",
|
|
3
3
|
"sdk-type": "client",
|
|
4
4
|
"author": "Microsoft Corporation",
|
|
5
|
-
"version": "4.3.0
|
|
5
|
+
"version": "4.3.0",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"description": "Isomorphic client library for Azure KeyVault's keys.",
|
|
8
|
-
"homepage": "https://github.com/Azure/azure-sdk-for-js/blob/
|
|
8
|
+
"homepage": "https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/README.md",
|
|
9
9
|
"repository": "github:Azure/azure-sdk-for-js",
|
|
10
10
|
"keywords": [
|
|
11
11
|
"node",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"module": "dist-esm/keyvault-keys/src/index.js",
|
|
24
24
|
"types": "./types/keyvault-keys.d.ts",
|
|
25
25
|
"engines": {
|
|
26
|
-
"node": ">=
|
|
26
|
+
"node": ">=8.0.0"
|
|
27
27
|
},
|
|
28
28
|
"files": [
|
|
29
29
|
"types/keyvault-keys.d.ts",
|
|
@@ -107,17 +107,18 @@
|
|
|
107
107
|
"@azure/core-http": "^2.0.0",
|
|
108
108
|
"@azure/core-lro": "^2.0.0",
|
|
109
109
|
"@azure/core-paging": "^1.1.1",
|
|
110
|
-
"@azure/core-tracing": "1.0.0-preview.
|
|
110
|
+
"@azure/core-tracing": "1.0.0-preview.13",
|
|
111
111
|
"@azure/logger": "^1.0.0",
|
|
112
112
|
"tslib": "^2.2.0"
|
|
113
113
|
},
|
|
114
114
|
"devDependencies": {
|
|
115
115
|
"@azure/dev-tool": "^1.0.0",
|
|
116
116
|
"@azure/eslint-plugin-azure-sdk": "^3.0.0",
|
|
117
|
-
"@azure/identity": "2.0.0-beta.
|
|
117
|
+
"@azure/identity": "2.0.0-beta.3",
|
|
118
118
|
"@azure/test-utils": "^1.0.0",
|
|
119
119
|
"@azure/test-utils-recorder": "^1.0.0",
|
|
120
120
|
"@microsoft/api-extractor": "7.7.11",
|
|
121
|
+
"@opentelemetry/api": "^1.0.1",
|
|
121
122
|
"@rollup/plugin-commonjs": "11.0.2",
|
|
122
123
|
"@rollup/plugin-json": "^4.0.0",
|
|
123
124
|
"@rollup/plugin-multi-entry": "^3.0.0",
|
|
@@ -126,7 +127,7 @@
|
|
|
126
127
|
"@types/chai": "^4.1.6",
|
|
127
128
|
"@types/chai-as-promised": "^7.1.0",
|
|
128
129
|
"@types/mocha": "^7.0.2",
|
|
129
|
-
"@types/node": "^
|
|
130
|
+
"@types/node": "^8.0.0",
|
|
130
131
|
"@types/query-string": "6.2.0",
|
|
131
132
|
"@types/sinon": "^9.0.4",
|
|
132
133
|
"assert": "^1.4.1",
|
package/types/keyvault-keys.d.ts
CHANGED
|
@@ -508,7 +508,7 @@ export declare interface DeletedKey {
|
|
|
508
508
|
* Defines values for DeletionRecoveryLevel. \
|
|
509
509
|
* {@link KnownDeletionRecoveryLevel} can be used interchangeably with DeletionRecoveryLevel,
|
|
510
510
|
* this enum contains the known values that the service supports.
|
|
511
|
-
* ###
|
|
511
|
+
* ### Know values supported by the service
|
|
512
512
|
* **Purgeable**: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.) \
|
|
513
513
|
* **Recoverable+Purgeable**: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered \
|
|
514
514
|
* **Recoverable**: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered \
|
|
@@ -523,7 +523,7 @@ export declare type DeletionRecoveryLevel = string;
|
|
|
523
523
|
* Defines values for JsonWebKeyEncryptionAlgorithm. \
|
|
524
524
|
* {@link KnownJsonWebKeyEncryptionAlgorithm} can be used interchangeably with JsonWebKeyEncryptionAlgorithm,
|
|
525
525
|
* this enum contains the known values that the service supports.
|
|
526
|
-
* ###
|
|
526
|
+
* ### Know values supported by the service
|
|
527
527
|
* **RSA-OAEP** \
|
|
528
528
|
* **RSA-OAEP-256** \
|
|
529
529
|
* **RSA1_5** \
|
|
@@ -600,12 +600,6 @@ export declare interface GetKeyOptions extends coreHttp.OperationOptions {
|
|
|
600
600
|
version?: string;
|
|
601
601
|
}
|
|
602
602
|
|
|
603
|
-
/**
|
|
604
|
-
* Options for {@link KeyClient.getRandomBytes}
|
|
605
|
-
*/
|
|
606
|
-
export declare interface GetRandomBytesOptions extends coreHttp.OperationOptions {
|
|
607
|
-
}
|
|
608
|
-
|
|
609
603
|
/**
|
|
610
604
|
* An interface representing the optional parameters that can be
|
|
611
605
|
* passed to {@link importKey}
|
|
@@ -971,18 +965,6 @@ export declare class KeyClient {
|
|
|
971
965
|
* @param options - The optional parameters.
|
|
972
966
|
*/
|
|
973
967
|
restoreKeyBackup(backup: Uint8Array, options?: RestoreKeyBackupOptions): Promise<KeyVaultKey>;
|
|
974
|
-
/**
|
|
975
|
-
* Gets the requested number of bytes containing random values from a managed HSM.
|
|
976
|
-
*
|
|
977
|
-
* Example usage:
|
|
978
|
-
* ```ts
|
|
979
|
-
* let client = new KeyClient(vaultUrl, credentials);
|
|
980
|
-
* let bytes = await client.getRandomBytes(10);
|
|
981
|
-
* ```
|
|
982
|
-
* @param count - The number of bytes to generate between 1 and 128 inclusive.
|
|
983
|
-
* @param options - The optional parameters.
|
|
984
|
-
*/
|
|
985
|
-
getRandomBytes(count: number, options?: GetRandomBytesOptions): Promise<Uint8Array>;
|
|
986
968
|
/* Excluded from this release type: listPropertiesOfKeyVersionsPage */
|
|
987
969
|
/* Excluded from this release type: listPropertiesOfKeyVersionsAll */
|
|
988
970
|
/**
|
|
@@ -1052,7 +1034,7 @@ export declare interface KeyClientOptions extends coreHttp.PipelineOptions {
|
|
|
1052
1034
|
* Defines values for JsonWebKeyCurveName. \
|
|
1053
1035
|
* {@link KnownJsonWebKeyCurveName} can be used interchangeably with JsonWebKeyCurveName,
|
|
1054
1036
|
* this enum contains the known values that the service supports.
|
|
1055
|
-
* ###
|
|
1037
|
+
* ### Know values supported by the service
|
|
1056
1038
|
* **P-256**: The NIST P-256 elliptic curve, AKA SECG curve SECP256R1. \
|
|
1057
1039
|
* **P-384**: The NIST P-384 elliptic curve, AKA SECG curve SECP384R1. \
|
|
1058
1040
|
* **P-521**: The NIST P-521 elliptic curve, AKA SECG curve SECP521R1. \
|
|
@@ -1064,15 +1046,14 @@ export declare type KeyCurveName = string;
|
|
|
1064
1046
|
* Defines values for JsonWebKeyOperation. \
|
|
1065
1047
|
* {@link KnownJsonWebKeyOperation} can be used interchangeably with JsonWebKeyOperation,
|
|
1066
1048
|
* this enum contains the known values that the service supports.
|
|
1067
|
-
* ###
|
|
1049
|
+
* ### Know values supported by the service
|
|
1068
1050
|
* **encrypt** \
|
|
1069
1051
|
* **decrypt** \
|
|
1070
1052
|
* **sign** \
|
|
1071
1053
|
* **verify** \
|
|
1072
1054
|
* **wrapKey** \
|
|
1073
1055
|
* **unwrapKey** \
|
|
1074
|
-
* **import**
|
|
1075
|
-
* **export**
|
|
1056
|
+
* **import**
|
|
1076
1057
|
*/
|
|
1077
1058
|
export declare type KeyOperation = string;
|
|
1078
1059
|
|
|
@@ -1172,13 +1153,13 @@ export declare interface KeyProperties {
|
|
|
1172
1153
|
* Defines values for JsonWebKeyType. \
|
|
1173
1154
|
* {@link KnownJsonWebKeyType} can be used interchangeably with JsonWebKeyType,
|
|
1174
1155
|
* this enum contains the known values that the service supports.
|
|
1175
|
-
* ###
|
|
1156
|
+
* ### Know values supported by the service
|
|
1176
1157
|
* **EC**: Elliptic Curve. \
|
|
1177
|
-
* **EC-HSM**: Elliptic Curve with a private key which is
|
|
1178
|
-
* **RSA**: RSA (https
|
|
1179
|
-
* **RSA-HSM**: RSA with a private key which is
|
|
1158
|
+
* **EC-HSM**: Elliptic Curve with a private key which is not exportable from the HSM. \
|
|
1159
|
+
* **RSA**: RSA (https://tools.ietf.org/html/rfc3447) \
|
|
1160
|
+
* **RSA-HSM**: RSA with a private key which is not exportable from the HSM. \
|
|
1180
1161
|
* **oct**: Octet sequence (used to represent symmetric keys) \
|
|
1181
|
-
* **oct-HSM**: Octet sequence (used to represent symmetric keys) which is
|
|
1162
|
+
* **oct-HSM**: Octet sequence (used to represent symmetric keys) which is not exportable from the HSM.
|
|
1182
1163
|
*/
|
|
1183
1164
|
export declare type KeyType = string;
|
|
1184
1165
|
|
|
@@ -1308,21 +1289,21 @@ export declare const enum KnownKeyCurveNames {
|
|
|
1308
1289
|
P256K = "P-256K"
|
|
1309
1290
|
}
|
|
1310
1291
|
|
|
1311
|
-
/** Known values of {@link
|
|
1312
|
-
export declare enum KnownKeyOperations {
|
|
1292
|
+
/** Known values of {@link JsonWebKeyOperation} that the service accepts. */
|
|
1293
|
+
export declare const enum KnownKeyOperations {
|
|
1313
1294
|
/** Key operation - encrypt */
|
|
1314
1295
|
Encrypt = "encrypt",
|
|
1315
|
-
/** Key operation -
|
|
1296
|
+
/** Key operation - decrypt */
|
|
1316
1297
|
Decrypt = "decrypt",
|
|
1317
|
-
/** Key operation -
|
|
1298
|
+
/** Key operation - sign */
|
|
1318
1299
|
Sign = "sign",
|
|
1319
|
-
/** Key operation -
|
|
1300
|
+
/** Key operation - verify */
|
|
1320
1301
|
Verify = "verify",
|
|
1321
|
-
/** Key operation -
|
|
1302
|
+
/** Key operation - wrapKey */
|
|
1322
1303
|
WrapKey = "wrapKey",
|
|
1323
|
-
/** Key operation -
|
|
1304
|
+
/** Key operation - unwrapKey */
|
|
1324
1305
|
UnwrapKey = "unwrapKey",
|
|
1325
|
-
/** Key operation -
|
|
1306
|
+
/** Key operation - import */
|
|
1326
1307
|
Import = "import"
|
|
1327
1308
|
}
|
|
1328
1309
|
|
|
@@ -1330,15 +1311,15 @@ export declare enum KnownKeyOperations {
|
|
|
1330
1311
|
export declare const enum KnownKeyTypes {
|
|
1331
1312
|
/** Elliptic Curve. */
|
|
1332
1313
|
EC = "EC",
|
|
1333
|
-
/** Elliptic Curve with a private key which is
|
|
1314
|
+
/** Elliptic Curve with a private key which is not exportable from the HSM. */
|
|
1334
1315
|
ECHSM = "EC-HSM",
|
|
1335
1316
|
/** RSA (https://tools.ietf.org/html/rfc3447) */
|
|
1336
1317
|
RSA = "RSA",
|
|
1337
|
-
/** RSA with a private key which is
|
|
1318
|
+
/** RSA with a private key which is not exportable from the HSM. */
|
|
1338
1319
|
RSAHSM = "RSA-HSM",
|
|
1339
1320
|
/** Octet sequence (used to represent symmetric keys) */
|
|
1340
1321
|
Oct = "oct",
|
|
1341
|
-
/** Octet sequence (used to represent symmetric keys) which is
|
|
1322
|
+
/** Octet sequence (used to represent symmetric keys) which is not exportable from the HSM. */
|
|
1342
1323
|
OctHSM = "oct-HSM"
|
|
1343
1324
|
}
|
|
1344
1325
|
|
|
@@ -1463,18 +1444,18 @@ export declare interface RsaEncryptParameters {
|
|
|
1463
1444
|
* Defines values for JsonWebKeySignatureAlgorithm. \
|
|
1464
1445
|
* {@link KnownJsonWebKeySignatureAlgorithm} can be used interchangeably with JsonWebKeySignatureAlgorithm,
|
|
1465
1446
|
* this enum contains the known values that the service supports.
|
|
1466
|
-
* ###
|
|
1467
|
-
* **PS256**: RSASSA-PSS using SHA-256 and MGF1 with SHA-256, as described in https
|
|
1468
|
-
* **PS384**: RSASSA-PSS using SHA-384 and MGF1 with SHA-384, as described in https
|
|
1469
|
-
* **PS512**: RSASSA-PSS using SHA-512 and MGF1 with SHA-512, as described in https
|
|
1470
|
-
* **RS256**: RSASSA-PKCS1-v1_5 using SHA-256, as described in https
|
|
1471
|
-
* **RS384**: RSASSA-PKCS1-v1_5 using SHA-384, as described in https
|
|
1472
|
-
* **RS512**: RSASSA-PKCS1-v1_5 using SHA-512, as described in https
|
|
1447
|
+
* ### Know values supported by the service
|
|
1448
|
+
* **PS256**: RSASSA-PSS using SHA-256 and MGF1 with SHA-256, as described in https://tools.ietf.org/html/rfc7518 \
|
|
1449
|
+
* **PS384**: RSASSA-PSS using SHA-384 and MGF1 with SHA-384, as described in https://tools.ietf.org/html/rfc7518 \
|
|
1450
|
+
* **PS512**: RSASSA-PSS using SHA-512 and MGF1 with SHA-512, as described in https://tools.ietf.org/html/rfc7518 \
|
|
1451
|
+
* **RS256**: RSASSA-PKCS1-v1_5 using SHA-256, as described in https://tools.ietf.org/html/rfc7518 \
|
|
1452
|
+
* **RS384**: RSASSA-PKCS1-v1_5 using SHA-384, as described in https://tools.ietf.org/html/rfc7518 \
|
|
1453
|
+
* **RS512**: RSASSA-PKCS1-v1_5 using SHA-512, as described in https://tools.ietf.org/html/rfc7518 \
|
|
1473
1454
|
* **RSNULL**: Reserved \
|
|
1474
|
-
* **ES256**: ECDSA using P-256 and SHA-256, as described in https
|
|
1475
|
-
* **ES384**: ECDSA using P-384 and SHA-384, as described in https
|
|
1476
|
-
* **ES512**: ECDSA using P-521 and SHA-512, as described in https
|
|
1477
|
-
* **ES256K**: ECDSA using P-256K and SHA-256, as described in https
|
|
1455
|
+
* **ES256**: ECDSA using P-256 and SHA-256, as described in https://tools.ietf.org/html/rfc7518. \
|
|
1456
|
+
* **ES384**: ECDSA using P-384 and SHA-384, as described in https://tools.ietf.org/html/rfc7518 \
|
|
1457
|
+
* **ES512**: ECDSA using P-521 and SHA-512, as described in https://tools.ietf.org/html/rfc7518 \
|
|
1458
|
+
* **ES256K**: ECDSA using P-256K and SHA-256, as described in https://tools.ietf.org/html/rfc7518
|
|
1478
1459
|
*/
|
|
1479
1460
|
export declare type SignatureAlgorithm = string;
|
|
1480
1461
|
|