@azure/keyvault-keys 4.4.0-beta.2 → 4.4.0

package/types/keyvault-keys.d.ts

@@ -404,7 +404,16 @@ export declare class CryptographyClient {
      * @param options - Additional options.
      */
     verifyData(algorithm: SignatureAlgorithm, data: Uint8Array, signature: Uint8Array, options?: VerifyOptions): Promise<VerifyResult>;
-    /* Excluded from this release type: getKeyMaterial */
+    /**
+     * Retrieves the {@link JsonWebKey} from the Key Vault.
+     *
+     * Example usage:
+     * ```ts
+     * let client = new CryptographyClient(keyVaultKey, credentials);
+     * let result = await client.getKeyMaterial();
+     * ```
+     */
+    private getKeyMaterial;
     /**
      * Returns the underlying key used for cryptographic operations.
      * If needed, fetches the key from KeyVault and exchanges the ID for the actual key.
@@ -688,15 +697,8 @@ declare interface JsonWebKey_2 {
     /**
      * Json web key operations. For more
      * information on possible key operations, see KeyOperation.
-     *
-     * @deprecated Use {@link key_ops} instead. keyOps will be removed in version 5.x of `@azure/keyvault-keys`.
      */
     keyOps?: KeyOperation[];
-    /**
-     * Json web key operations. For more
-     * information on possible key operations, see KeyOperation.
-     */
-    key_ops?: KeyOperation[];
     /**
      * RSA modulus.
      */
@@ -765,8 +767,15 @@ export declare class KeyClient {
      * The base URL to the vault
      */
     readonly vaultUrl: string;
-    /* Excluded from this release type: client */
-    /* Excluded from this release type: credential */
+    /**
+     * A reference to the auto-generated Key Vault HTTP client.
+     */
+    private readonly client;
+    /**
+     * A reference to the credential that was used to construct this client.
+     * Later used to instantiate a {@link CryptographyClient} with the same credential.
+     */
+    private readonly credential;
     /**
      * Creates an instance of KeyClient.
      *
@@ -943,7 +952,13 @@ export declare class KeyClient {
      * @param options - The optional parameters.
      */
     updateKeyProperties(name: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>;
-    /* Excluded from this release type: disambiguateUpdateKeyPropertiesArgs */
+    /**
+     * Standardizes an overloaded arguments collection for the updateKeyProperties method.
+     *
+     * @param args - The arguments collection.
+     * @returns - The standardized arguments collection.
+     */
+    private disambiguateUpdateKeyPropertiesArgs;
     /**
      * The getKey method gets a specified key and is applicable to any key stored in Azure Key Vault.
      * This operation requires the keys/get permission.
@@ -1051,6 +1066,7 @@ export declare class KeyClient {
     restoreKeyBackup(backup: Uint8Array, options?: RestoreKeyBackupOptions): Promise<KeyVaultKey>;
     /**
      * Gets the requested number of bytes containing random values from a managed HSM.
+     * This operation requires the managedHsm/rng permission.
      *
      * Example usage:
      * ```ts
@@ -1060,7 +1076,7 @@ export declare class KeyClient {
      * @param count - The number of bytes to generate between 1 and 128 inclusive.
      * @param options - The optional parameters.
      */
-    getRandomBytes(count: number, options?: GetRandomBytesOptions): Promise<RandomBytes>;
+    getRandomBytes(count: number, options?: GetRandomBytesOptions): Promise<Uint8Array>;
     /**
      * Rotates the key based on the key policy by generating a new version of the key. This operation requires the keys/rotate permission.
      *
@@ -1086,26 +1102,28 @@ export declare class KeyClient {
      * ```
      *
      * @param name - The name of the key.
-     * @param target - The attestation assertion for the target of the key release.
+     * @param targetAttestationToken - The attestation assertion for the target of the key release.
      * @param options - The optional parameters.
      */
-    releaseKey(name: string, target: string, options?: ReleaseKeyOptions): Promise<ReleaseKeyResult>;
+    releaseKey(name: string, targetAttestationToken: string, options?: ReleaseKeyOptions): Promise<ReleaseKeyResult>;
     /**
      * Gets the rotation policy of a Key Vault Key.
+     * By default, all keys have a policy that will notify 30 days before expiry.
      *
+     * This operation requires the keys/get permission.
      * Example usage:
      * ```ts
      * let client = new KeyClient(vaultUrl, credentials);
-     * await client.updateKeyRotationPolicy("MyKey", myPolicy);
      * let result = await client.getKeyRotationPolicy("myKey");
      * ```
      *
-     * @param name - The name of the key.
+     * @param keyName - The name of the key.
      * @param options - The optional parameters.
      */
-    getKeyRotationPolicy(name: string, options?: GetKeyRotationPolicyOptions): Promise<KeyRotationPolicy>;
+    getKeyRotationPolicy(keyName: string, options?: GetKeyRotationPolicyOptions): Promise<KeyRotationPolicy>;
     /**
      * Updates the rotation policy of a Key Vault Key.
+     * This operation requires the keys/update permission.
      *
      * Example usage:
      * ```ts
@@ -1113,13 +1131,24 @@ export declare class KeyClient {
      * const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);
      * ```
      *
-     * @param name - The name of the key.
+     * @param keyName - The name of the key.
      * @param policyProperties - The {@link KeyRotationPolicyProperties} for the policy.
      * @param options - The optional parameters.
      */
-    updateKeyRotationPolicy(name: string, policy: KeyRotationPolicyProperties, options?: UpdateKeyRotationPolicyOptions): Promise<KeyRotationPolicy>;
-    /* Excluded from this release type: listPropertiesOfKeyVersionsPage */
-    /* Excluded from this release type: listPropertiesOfKeyVersionsAll */
+    updateKeyRotationPolicy(keyName: string, policy: KeyRotationPolicyProperties, options?: UpdateKeyRotationPolicyOptions): Promise<KeyRotationPolicy>;
+    /**
+     * Deals with the pagination of {@link listPropertiesOfKeyVersions}.
+     * @param name - The name of the Key Vault Key.
+     * @param continuationState - An object that indicates the position of the paginated request.
+     * @param options - Common options for the iterative endpoints.
+     */
+    private listPropertiesOfKeyVersionsPage;
+    /**
+     * Deals with the iteration of all the available results of {@link listPropertiesOfKeyVersions}.
+     * @param name - The name of the Key Vault Key.
+     * @param options - Common options for the iterative endpoints.
+     */
+    private listPropertiesOfKeyVersionsAll;
     /**
      * Iterates all versions of the given key in the vault. The full key identifier, properties, and tags are provided
      * in the response. This operation requires the keys/list permission.
@@ -1136,8 +1165,17 @@ export declare class KeyClient {
      * @param options - The optional parameters.
      */
     listPropertiesOfKeyVersions(name: string, options?: ListPropertiesOfKeyVersionsOptions): PagedAsyncIterableIterator<KeyProperties>;
-    /* Excluded from this release type: listPropertiesOfKeysPage */
-    /* Excluded from this release type: listPropertiesOfKeysAll */
+    /**
+     * Deals with the pagination of {@link listPropertiesOfKeys}.
+     * @param continuationState - An object that indicates the position of the paginated request.
+     * @param options - Common options for the iterative endpoints.
+     */
+    private listPropertiesOfKeysPage;
+    /**
+     * Deals with the iteration of all the available results of {@link listPropertiesOfKeys}.
+     * @param options - Common options for the iterative endpoints.
+     */
+    private listPropertiesOfKeysAll;
     /**
      * Iterates the latest version of all keys in the vault.  The full key identifier and properties are provided
      * in the response. No values are returned for the keys. This operations requires the keys/list permission.
@@ -1154,8 +1192,17 @@ export declare class KeyClient {
      * @param options - The optional parameters.
      */
     listPropertiesOfKeys(options?: ListPropertiesOfKeysOptions): PagedAsyncIterableIterator<KeyProperties>;
-    /* Excluded from this release type: listDeletedKeysPage */
-    /* Excluded from this release type: listDeletedKeysAll */
+    /**
+     * Deals with the pagination of {@link listDeletedKeys}.
+     * @param continuationState - An object that indicates the position of the paginated request.
+     * @param options - Common options for the iterative endpoints.
+     */
+    private listDeletedKeysPage;
+    /**
+     * Deals with the iteration of all the available results of {@link listDeletedKeys}.
+     * @param options - Common options for the iterative endpoints.
+     */
+    private listDeletedKeysAll;
     /**
      * Iterates the deleted keys in the vault.  The full key identifier and properties are provided
      * in the response. No values are returned for the keys. This operations requires the keys/list permission.
@@ -1332,8 +1379,16 @@ export declare interface KeyReleasePolicy {
      * Defaults to "application/json; charset=utf-8" if omitted.
      */
     contentType?: string;
-    /** Blob encoding the policy rules under which the key can be released. */
-    data?: Uint8Array;
+    /**
+     * The policy rules under which the key can be released. Encoded based on the {@link KeyReleasePolicy.contentType}.
+     *
+     * For more information regarding the release policy grammar for Azure Key Vault, please refer to:
+     * - https://aka.ms/policygrammarkeys for Azure Key Vault release policy grammar.
+     * - https://aka.ms/policygrammarmhsm for Azure Managed HSM release policy grammar.
+     */
+    encodedPolicy?: Uint8Array;
+    /** Marks a release policy as immutable. An immutable release policy cannot be changed or updated after being marked immutable. */
+    immutable?: boolean;
 }
 
 /**
@@ -1493,7 +1548,7 @@ export declare enum KnownDeletionRecoveryLevel {
     CustomizedRecoverableProtectedSubscription = "CustomizedRecoverable+ProtectedSubscription"
 }
 
-/** Known values of {@link JsonWebKeyEncryptionAlgorithm} that the service accepts. */
+/** Known values of {@link EncryptionAlgorithm} that the service accepts. */
 export declare enum KnownEncryptionAlgorithms {
     /** Encryption Algorithm - RSA-OAEP */
     RSAOaep = "RSA-OAEP",
@@ -1539,6 +1594,16 @@ export declare enum KnownKeyCurveNames {
     P256K = "P-256K"
 }
 
+/** Known values of {@link KeyExportEncryptionAlgorithm} that the service accepts. */
+export declare enum KnownKeyExportEncryptionAlgorithm {
+    /** CKM_RSA_AES_KEY_WRAP Key Export Encryption Algorithm */
+    CkmRsaAesKeyWrap = "CKM_RSA_AES_KEY_WRAP",
+    /** RSA_AES_KEY_WRAP_256 Key Export Encryption Algorithm */
+    RsaAesKeyWrap256 = "RSA_AES_KEY_WRAP_256",
+    /** RSA_AES_KEY_WRAP_384 Key Export Encryption Algorithm */
+    RsaAesKeyWrap384 = "RSA_AES_KEY_WRAP_384"
+}
+
 /** Known values of {@link KeyOperation} that the service accepts. */
 export declare enum KnownKeyOperations {
     /** Key operation - encrypt */
@@ -1656,14 +1721,6 @@ export { PollOperationState }
 export declare interface PurgeDeletedKeyOptions extends coreHttp.OperationOptions {
 }
 
-/**
- * Result of the {@link KeyClient.getRandomBytes} operation.
- */
-export declare interface RandomBytes {
-    /** The random bytes returned by the service. */
-    bytes: Uint8Array;
-}
-
 /**
  * Options for {@link KeyClient.releaseKey}
  */