@azure/arm-keyvault 2.0.1-alpha.20220420.2 → 2.1.0-alpha.20220426.2

package/src/models/index.ts

@@ -37,6 +37,10 @@ export interface KeyProperties {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly keyUriWithVersion?: string;
+  /** Key rotation policy in response. It will be used for both output and input. Omitted if empty */
+  rotationPolicy?: RotationPolicy;
+  /** Key release policy in response. It will be used for both output and input. Omitted if empty */
+  releasePolicy?: KeyReleasePolicy;
 }
 
 /** The object attributes managed by the Azure Key Vault service. */
@@ -66,6 +70,54 @@ export interface KeyAttributes {
   exportable?: boolean;
 }
 
+export interface RotationPolicy {
+  /** The attributes of key rotation policy. */
+  attributes?: KeyRotationPolicyAttributes;
+  /** The lifetimeActions for key rotation action. */
+  lifetimeActions?: LifetimeAction[];
+}
+
+export interface KeyRotationPolicyAttributes {
+  /**
+   * Creation time in seconds since 1970-01-01T00:00:00Z.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly created?: number;
+  /**
+   * Last updated time in seconds since 1970-01-01T00:00:00Z.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly updated?: number;
+  /** The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'. */
+  expiryTime?: string;
+}
+
+export interface LifetimeAction {
+  /** The trigger of key rotation policy lifetimeAction. */
+  trigger?: Trigger;
+  /** The action of key rotation policy lifetimeAction. */
+  action?: Action;
+}
+
+export interface Trigger {
+  /** The time duration after key creation to rotate the key. It only applies to rotate. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'. */
+  timeAfterCreate?: string;
+  /** The time duration before key expiring to rotate or notify. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'. */
+  timeBeforeExpiry?: string;
+}
+
+export interface Action {
+  /** The type of action. */
+  type?: KeyRotationPolicyActionType;
+}
+
+export interface KeyReleasePolicy {
+  /** Content type and version of key release policy */
+  contentType?: string;
+  /** Blob encoding the policy rules under which the key can be released. */
+  data?: Uint8Array;
+}
+
 /** Key Vault resource */
 export interface Resource {
   /**
@@ -152,7 +204,7 @@ export interface VaultProperties {
   enableSoftDelete?: boolean;
   /** softDelete data retention days. It accepts >=7 and <=90. */
   softDeleteRetentionInDays?: number;
-  /** Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be  ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC. */
+  /** Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be  ignored (warning: this is a preview feature). When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC. */
   enableRbacAuthorization?: boolean;
   /** The vault's create mode to indicate whether the vault need to be recovered or not. */
   createMode?: CreateMode;
@@ -332,7 +384,7 @@ export interface VaultPatchProperties {
   enabledForTemplateDeployment?: boolean;
   /** Property to specify whether the 'soft delete' functionality is enabled for this key vault. Once set to true, it cannot be reverted to false. */
   enableSoftDelete?: boolean;
-  /** Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be  ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change. */
+  /** Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be  ignored (warning: this is a preview feature). When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change. */
   enableRbacAuthorization?: boolean;
   /** softDelete data retention days. It accepts >=7 and <=90. */
   softDeleteRetentionInDays?: number;
@@ -929,6 +981,10 @@ export type Key = Resource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly keyUriWithVersion?: string;
+  /** Key rotation policy in response. It will be used for both output and input. Omitted if empty */
+  rotationPolicy?: RotationPolicy;
+  /** Key release policy in response. It will be used for both output and input. Omitted if empty */
+  releasePolicy?: KeyReleasePolicy;
 };
 
 /** Private endpoint connection resource. */
@@ -1082,7 +1138,8 @@ export enum KnownJsonWebKeyOperation {
   Verify = "verify",
   WrapKey = "wrapKey",
   UnwrapKey = "unwrapKey",
-  Import = "import"
+  Import = "import",
+  Release = "release"
 }
 
 /**
@@ -1096,7 +1153,8 @@ export enum KnownJsonWebKeyOperation {
  * **verify** \
  * **wrapKey** \
  * **unwrapKey** \
- * **import**
+ * **import** \
+ * **release**
  */
 export type JsonWebKeyOperation = string;
 
@@ -1152,7 +1210,11 @@ export enum KnownKeyPermissions {
   Backup = "backup",
   Restore = "restore",
   Recover = "recover",
-  Purge = "purge"
+  Purge = "purge",
+  Release = "release",
+  Rotate = "rotate",
+  Getrotationpolicy = "getrotationpolicy",
+  Setrotationpolicy = "setrotationpolicy"
 }
 
 /**
@@ -1176,7 +1238,11 @@ export enum KnownKeyPermissions {
  * **backup** \
  * **restore** \
  * **recover** \
- * **purge**
+ * **purge** \
+ * **release** \
+ * **rotate** \
+ * **getrotationpolicy** \
+ * **setrotationpolicy**
  */
 export type KeyPermissions = string;
 
@@ -1489,6 +1555,8 @@ export enum KnownManagedHsmSkuFamily {
  * **B**
  */
 export type ManagedHsmSkuFamily = string;
+/** Defines values for KeyRotationPolicyActionType. */
+export type KeyRotationPolicyActionType = "rotate" | "notify";
 /** Defines values for SkuName. */
 export type SkuName = "standard" | "premium";
 /** Defines values for CreateMode. */

package/src/models/mappers.ts

@@ -85,6 +85,20 @@ export const KeyProperties: coreClient.CompositeMapper = {
         type: {
           name: "String"
         }
+      },
+      rotationPolicy: {
+        serializedName: "rotationPolicy",
+        type: {
+          name: "Composite",
+          className: "RotationPolicy"
+        }
+      },
+      releasePolicy: {
+        serializedName: "release_policy",
+        type: {
+          name: "Composite",
+          className: "KeyReleasePolicy"
+        }
       }
     }
   }
@@ -144,6 +158,145 @@ export const KeyAttributes: coreClient.CompositeMapper = {
   }
 };
 
+export const RotationPolicy: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "RotationPolicy",
+    modelProperties: {
+      attributes: {
+        serializedName: "attributes",
+        type: {
+          name: "Composite",
+          className: "KeyRotationPolicyAttributes"
+        }
+      },
+      lifetimeActions: {
+        serializedName: "lifetimeActions",
+        type: {
+          name: "Sequence",
+          element: {
+            type: {
+              name: "Composite",
+              className: "LifetimeAction"
+            }
+          }
+        }
+      }
+    }
+  }
+};
+
+export const KeyRotationPolicyAttributes: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "KeyRotationPolicyAttributes",
+    modelProperties: {
+      created: {
+        serializedName: "created",
+        readOnly: true,
+        type: {
+          name: "Number"
+        }
+      },
+      updated: {
+        serializedName: "updated",
+        readOnly: true,
+        type: {
+          name: "Number"
+        }
+      },
+      expiryTime: {
+        serializedName: "expiryTime",
+        type: {
+          name: "String"
+        }
+      }
+    }
+  }
+};
+
+export const LifetimeAction: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "LifetimeAction",
+    modelProperties: {
+      trigger: {
+        serializedName: "trigger",
+        type: {
+          name: "Composite",
+          className: "Trigger"
+        }
+      },
+      action: {
+        serializedName: "action",
+        type: {
+          name: "Composite",
+          className: "Action"
+        }
+      }
+    }
+  }
+};
+
+export const Trigger: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "Trigger",
+    modelProperties: {
+      timeAfterCreate: {
+        serializedName: "timeAfterCreate",
+        type: {
+          name: "String"
+        }
+      },
+      timeBeforeExpiry: {
+        serializedName: "timeBeforeExpiry",
+        type: {
+          name: "String"
+        }
+      }
+    }
+  }
+};
+
+export const Action: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "Action",
+    modelProperties: {
+      type: {
+        serializedName: "type",
+        type: {
+          name: "Enum",
+          allowedValues: ["rotate", "notify"]
+        }
+      }
+    }
+  }
+};
+
+export const KeyReleasePolicy: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "KeyReleasePolicy",
+    modelProperties: {
+      contentType: {
+        defaultValue: "application/json; charset=utf-8",
+        serializedName: "contentType",
+        type: {
+          name: "String"
+        }
+      },
+      data: {
+        serializedName: "data",
+        type: {
+          name: "Base64Url"
+        }
+      }
+    }
+  }
+};
+
 export const Resource: coreClient.CompositeMapper = {
   type: {
     name: "Composite",
@@ -2349,6 +2502,20 @@ export const Key: coreClient.CompositeMapper = {
         type: {
           name: "String"
         }
+      },
+      rotationPolicy: {
+        serializedName: "properties.rotationPolicy",
+        type: {
+          name: "Composite",
+          className: "RotationPolicy"
+        }
+      },
+      releasePolicy: {
+        serializedName: "properties.release_policy",
+        type: {
+          name: "Composite",
+          className: "KeyReleasePolicy"
+        }
       }
     }
   }

package/src/models/parameters.ts

@@ -118,7 +118,7 @@ export const keyName: OperationURLParameter = {
 export const apiVersion: OperationQueryParameter = {
   parameterPath: "apiVersion",
   mapper: {
-    defaultValue: "2021-10-01",
+    defaultValue: "2021-11-01-preview",
     isConstant: true,
     serializedName: "api-version",
     type: {

package/src/operations/managedHsms.ts

@@ -254,10 +254,12 @@ export class ManagedHsmsImpl implements ManagedHsms {
       { resourceGroupName, name, parameters, options },
       createOrUpdateOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
+    await poller.poll();
+    return poller;
   }
 
   /**
@@ -344,10 +346,12 @@ export class ManagedHsmsImpl implements ManagedHsms {
       { resourceGroupName, name, parameters, options },
       updateOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
+    await poller.poll();
+    return poller;
   }
 
   /**
@@ -427,10 +431,12 @@ export class ManagedHsmsImpl implements ManagedHsms {
       { resourceGroupName, name, options },
       deleteOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
+    await poller.poll();
+    return poller;
   }
 
   /**
@@ -579,10 +585,12 @@ export class ManagedHsmsImpl implements ManagedHsms {
       { name, location, options },
       purgeDeletedOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
+    await poller.poll();
+    return poller;
   }
 
   /**

package/src/operations/mhsmPrivateEndpointConnections.ts

@@ -231,10 +231,12 @@ export class MhsmPrivateEndpointConnectionsImpl
       { resourceGroupName, name, privateEndpointConnectionName, options },
       deleteOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
+    await poller.poll();
+    return poller;
   }
 
   /**

package/src/operations/privateEndpointConnections.ts

@@ -225,10 +225,12 @@ export class PrivateEndpointConnectionsImpl
       { resourceGroupName, vaultName, privateEndpointConnectionName, options },
       deleteOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
+    await poller.poll();
+    return poller;
   }
 
   /**

package/src/operations/vaults.ts

@@ -310,10 +310,12 @@ export class VaultsImpl implements Vaults {
       { resourceGroupName, vaultName, parameters, options },
       createOrUpdateOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
+    await poller.poll();
+    return poller;
   }
 
   /**
@@ -526,10 +528,12 @@ export class VaultsImpl implements Vaults {
       { vaultName, location, options },
       purgeDeletedOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
+    await poller.poll();
+    return poller;
   }
 
   /**

package/tsconfig.json

@@ -9,11 +9,25 @@
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
     "forceConsistentCasingInFileNames": true,
-    "lib": ["es6", "dom"],
+    "lib": [
+      "es6",
+      "dom"
+    ],
     "declaration": true,
     "outDir": "./dist-esm",
-    "importHelpers": true
+    "importHelpers": true,
+    "paths": {
+      "@azure/arm-keyvault": [
+        "./src/index"
+      ]
+    }
   },
-  "include": ["./src/**/*.ts", "./test/**/*.ts"],
-  "exclude": ["node_modules"]
-}
+  "include": [
+    "./src/**/*.ts",
+    "./test/**/*.ts",
+    "samples-dev/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

package/types/arm-keyvault.d.ts

@@ -19,6 +19,11 @@ export declare interface AccessPolicyEntry {
 /** Defines values for AccessPolicyUpdateKind. */
 export declare type AccessPolicyUpdateKind = "add" | "replace" | "remove";
 
+export declare interface Action {
+    /** The type of action. */
+    type?: KeyRotationPolicyActionType;
+}
+
 /**
  * Defines values for ActionsRequired. \
  * {@link KnownActionsRequired} can be used interchangeably with ActionsRequired,
@@ -320,7 +325,8 @@ export declare type JsonWebKeyCurveName = string;
  * **verify** \
  * **wrapKey** \
  * **unwrapKey** \
- * **import**
+ * **import** \
+ * **release**
  */
 export declare type JsonWebKeyOperation = string;
 
@@ -357,6 +363,10 @@ export declare type Key = Resource & {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly keyUriWithVersion?: string;
+    /** Key rotation policy in response. It will be used for both output and input. Omitted if empty */
+    rotationPolicy?: RotationPolicy;
+    /** Key release policy in response. It will be used for both output and input. Omitted if empty */
+    releasePolicy?: KeyReleasePolicy;
 };
 
 /** The object attributes managed by the Azure Key Vault service. */
@@ -425,7 +435,11 @@ export declare interface KeyListResult {
  * **backup** \
  * **restore** \
  * **recover** \
- * **purge**
+ * **purge** \
+ * **release** \
+ * **rotate** \
+ * **getrotationpolicy** \
+ * **setrotationpolicy**
  */
 export declare type KeyPermissions = string;
 
@@ -450,6 +464,35 @@ export declare interface KeyProperties {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly keyUriWithVersion?: string;
+    /** Key rotation policy in response. It will be used for both output and input. Omitted if empty */
+    rotationPolicy?: RotationPolicy;
+    /** Key release policy in response. It will be used for both output and input. Omitted if empty */
+    releasePolicy?: KeyReleasePolicy;
+}
+
+export declare interface KeyReleasePolicy {
+    /** Content type and version of key release policy */
+    contentType?: string;
+    /** Blob encoding the policy rules under which the key can be released. */
+    data?: Uint8Array;
+}
+
+/** Defines values for KeyRotationPolicyActionType. */
+export declare type KeyRotationPolicyActionType = "rotate" | "notify";
+
+export declare interface KeyRotationPolicyAttributes {
+    /**
+     * Creation time in seconds since 1970-01-01T00:00:00Z.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly created?: number;
+    /**
+     * Last updated time in seconds since 1970-01-01T00:00:00Z.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly updated?: number;
+    /** The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'. */
+    expiryTime?: string;
 }
 
 /** Interface representing a Keys. */
@@ -639,7 +682,8 @@ export declare enum KnownJsonWebKeyOperation {
     Verify = "verify",
     WrapKey = "wrapKey",
     UnwrapKey = "unwrapKey",
-    Import = "import"
+    Import = "import",
+    Release = "release"
 }
 
 /** Known values of {@link JsonWebKeyType} that the service accepts. */
@@ -668,7 +712,11 @@ export declare enum KnownKeyPermissions {
     Backup = "backup",
     Restore = "restore",
     Recover = "recover",
-    Purge = "purge"
+    Purge = "purge",
+    Release = "release",
+    Rotate = "rotate",
+    Getrotationpolicy = "getrotationpolicy",
+    Setrotationpolicy = "setrotationpolicy"
 }
 
 /** Known values of {@link ManagedHsmSkuFamily} that the service accepts. */
@@ -775,6 +823,13 @@ export declare enum KnownVaultProvisioningState {
     RegisteringDns = "RegisteringDns"
 }
 
+export declare interface LifetimeAction {
+    /** The trigger of key rotation policy lifetimeAction. */
+    trigger?: Trigger;
+    /** The action of key rotation policy lifetimeAction. */
+    action?: Action;
+}
+
 /** Log specification of operation. */
 export declare interface LogSpecification {
     /** Name of log specification. */
@@ -1738,6 +1793,13 @@ export declare interface ResourceListResult {
     nextLink?: string;
 }
 
+export declare interface RotationPolicy {
+    /** The attributes of key rotation policy. */
+    attributes?: KeyRotationPolicyAttributes;
+    /** The lifetimeActions for key rotation action. */
+    lifetimeActions?: LifetimeAction[];
+}
+
 /** Resource information with extended details. */
 export declare type Secret = Resource & {
     /** Properties of the secret */
@@ -1971,6 +2033,13 @@ export declare interface SystemData {
     lastModifiedAt?: Date;
 }
 
+export declare interface Trigger {
+    /** The time duration after key creation to rotate the key. It only applies to rotate. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'. */
+    timeAfterCreate?: string;
+    /** The time duration before key expiring to rotate or notify. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'. */
+    timeBeforeExpiry?: string;
+}
+
 /** Resource information with extended details. */
 export declare interface Vault {
     /**
@@ -2089,7 +2158,7 @@ export declare interface VaultPatchProperties {
     enabledForTemplateDeployment?: boolean;
     /** Property to specify whether the 'soft delete' functionality is enabled for this key vault. Once set to true, it cannot be reverted to false. */
     enableSoftDelete?: boolean;
-    /** Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be  ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change. */
+    /** Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be  ignored (warning: this is a preview feature). When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change. */
     enableRbacAuthorization?: boolean;
     /** softDelete data retention days. It accepts >=7 and <=90. */
     softDeleteRetentionInDays?: number;
@@ -2128,7 +2197,7 @@ export declare interface VaultProperties {
     enableSoftDelete?: boolean;
     /** softDelete data retention days. It accepts >=7 and <=90. */
     softDeleteRetentionInDays?: number;
-    /** Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be  ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC. */
+    /** Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be  ignored (warning: this is a preview feature). When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC. */
     enableRbacAuthorization?: boolean;
     /** The vault's create mode to indicate whether the vault need to be recovered or not. */
     createMode?: CreateMode;