@azure/arm-keyvault 2.1.0-alpha.20221101.1 → 2.1.0-alpha.20221202.3

package/src/pagingHelper.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+export interface PageInfo {
+  continuationToken?: string;
+}
+
+const pageMap = new WeakMap<object, PageInfo>();
+
+/**
+ * Given a result page from a pageable operation, returns a
+ * continuation token that can be used to begin paging from
+ * that point later.
+ * @param page A result object from calling .byPage() on a paged operation.
+ * @returns The continuation token that can be passed into byPage().
+ */
+export function getContinuationToken(page: unknown): string | undefined {
+  if (typeof page !== "object" || page === null) {
+    return undefined;
+  }
+  return pageMap.get(page)?.continuationToken;
+}
+
+export function setContinuationToken(
+  page: unknown,
+  continuationToken: string | undefined
+): void {
+  if (typeof page !== "object" || page === null || !continuationToken) {
+    return;
+  }
+  const pageInfo = pageMap.get(page) ?? {};
+  pageInfo.continuationToken = continuationToken;
+  pageMap.set(page, pageInfo);
+}

package/types/arm-keyvault.d.ts

@@ -284,6 +284,15 @@ export declare interface ErrorModel {
     readonly innerError?: ErrorModel;
 }
 
+/**
+ * Given a result page from a pageable operation, returns a
+ * continuation token that can be used to begin paging from
+ * that point later.
+ * @param page A result object from calling .byPage() on a paged operation.
+ * @returns The continuation token that can be passed into byPage().
+ */
+export declare function getContinuationToken(page: unknown): string | undefined;
+
 /**
  * Defines values for IdentityType. \
  * {@link KnownIdentityType} can be used interchangeably with IdentityType,
@@ -343,7 +352,7 @@ export declare type JsonWebKeyOperation = string;
 export declare type JsonWebKeyType = string;
 
 /** The key resource. */
-export declare type Key = Resource & {
+export declare interface Key extends Resource {
     /** The attributes of the key. */
     attributes?: KeyAttributes;
     /** The type of the key. For valid values, see JsonWebKeyType. */
@@ -367,7 +376,7 @@ export declare type Key = Resource & {
     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. */
 export declare interface KeyAttributes {
@@ -603,6 +612,8 @@ export declare class KeyVaultManagementClient extends coreClient.ServiceClient {
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: KeyVaultManagementClientOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
     keys: Keys;
     vaults: Vaults;
     privateEndpointConnections: PrivateEndpointConnections;
@@ -626,131 +637,209 @@ export declare interface KeyVaultManagementClientOptionalParams extends coreClie
 
 /** Known values of {@link ActionsRequired} that the service accepts. */
 export declare enum KnownActionsRequired {
+    /** None */
     None = "None"
 }
 
 /** Known values of {@link CertificatePermissions} that the service accepts. */
 export declare enum KnownCertificatePermissions {
+    /** All */
     All = "all",
+    /** Get */
     Get = "get",
+    /** List */
     List = "list",
+    /** Delete */
     Delete = "delete",
+    /** Create */
     Create = "create",
+    /** Import */
     Import = "import",
+    /** Update */
     Update = "update",
+    /** Managecontacts */
     Managecontacts = "managecontacts",
+    /** Getissuers */
     Getissuers = "getissuers",
+    /** Listissuers */
     Listissuers = "listissuers",
+    /** Setissuers */
     Setissuers = "setissuers",
+    /** Deleteissuers */
     Deleteissuers = "deleteissuers",
+    /** Manageissuers */
     Manageissuers = "manageissuers",
+    /** Recover */
     Recover = "recover",
+    /** Purge */
     Purge = "purge",
+    /** Backup */
     Backup = "backup",
+    /** Restore */
     Restore = "restore"
 }
 
 /** Known values of {@link DeletionRecoveryLevel} that the service accepts. */
 export declare enum KnownDeletionRecoveryLevel {
+    /** Purgeable */
     Purgeable = "Purgeable",
+    /** RecoverablePurgeable */
     RecoverablePurgeable = "Recoverable+Purgeable",
+    /** Recoverable */
     Recoverable = "Recoverable",
+    /** RecoverableProtectedSubscription */
     RecoverableProtectedSubscription = "Recoverable+ProtectedSubscription"
 }
 
 /** Known values of {@link IdentityType} that the service accepts. */
 export declare enum KnownIdentityType {
+    /** User */
     User = "User",
+    /** Application */
     Application = "Application",
+    /** ManagedIdentity */
     ManagedIdentity = "ManagedIdentity",
+    /** Key */
     Key = "Key"
 }
 
 /** Known values of {@link JsonWebKeyCurveName} that the service accepts. */
 export declare enum KnownJsonWebKeyCurveName {
+    /** P256 */
     P256 = "P-256",
+    /** P384 */
     P384 = "P-384",
+    /** P521 */
     P521 = "P-521",
+    /** P256K */
     P256K = "P-256K"
 }
 
 /** Known values of {@link JsonWebKeyOperation} that the service accepts. */
 export declare enum KnownJsonWebKeyOperation {
+    /** Encrypt */
     Encrypt = "encrypt",
+    /** Decrypt */
     Decrypt = "decrypt",
+    /** Sign */
     Sign = "sign",
+    /** Verify */
     Verify = "verify",
+    /** WrapKey */
     WrapKey = "wrapKey",
+    /** UnwrapKey */
     UnwrapKey = "unwrapKey",
+    /** Import */
     Import = "import",
+    /** Release */
     Release = "release"
 }
 
 /** Known values of {@link JsonWebKeyType} that the service accepts. */
 export declare enum KnownJsonWebKeyType {
+    /** EC */
     EC = "EC",
+    /** ECHSM */
     ECHSM = "EC-HSM",
+    /** RSA */
     RSA = "RSA",
+    /** RSAHSM */
     RSAHSM = "RSA-HSM"
 }
 
 /** Known values of {@link KeyPermissions} that the service accepts. */
 export declare enum KnownKeyPermissions {
+    /** All */
     All = "all",
+    /** Encrypt */
     Encrypt = "encrypt",
+    /** Decrypt */
     Decrypt = "decrypt",
+    /** WrapKey */
     WrapKey = "wrapKey",
+    /** UnwrapKey */
     UnwrapKey = "unwrapKey",
+    /** Sign */
     Sign = "sign",
+    /** Verify */
     Verify = "verify",
+    /** Get */
     Get = "get",
+    /** List */
     List = "list",
+    /** Create */
     Create = "create",
+    /** Update */
     Update = "update",
+    /** Import */
     Import = "import",
+    /** Delete */
     Delete = "delete",
+    /** Backup */
     Backup = "backup",
+    /** Restore */
     Restore = "restore",
+    /** Recover */
     Recover = "recover",
+    /** Purge */
     Purge = "purge",
+    /** Release */
     Release = "release",
+    /** Rotate */
     Rotate = "rotate",
+    /** Getrotationpolicy */
     Getrotationpolicy = "getrotationpolicy",
+    /** Setrotationpolicy */
     Setrotationpolicy = "setrotationpolicy"
 }
 
 /** Known values of {@link ManagedHsmSkuFamily} that the service accepts. */
 export declare enum KnownManagedHsmSkuFamily {
+    /** B */
     B = "B"
 }
 
 /** Known values of {@link NetworkRuleAction} that the service accepts. */
 export declare enum KnownNetworkRuleAction {
+    /** Allow */
     Allow = "Allow",
+    /** Deny */
     Deny = "Deny"
 }
 
 /** Known values of {@link NetworkRuleBypassOptions} that the service accepts. */
 export declare enum KnownNetworkRuleBypassOptions {
+    /** AzureServices */
     AzureServices = "AzureServices",
+    /** None */
     None = "None"
 }
 
 /** Known values of {@link PrivateEndpointConnectionProvisioningState} that the service accepts. */
 export declare enum KnownPrivateEndpointConnectionProvisioningState {
+    /** Succeeded */
     Succeeded = "Succeeded",
+    /** Creating */
     Creating = "Creating",
+    /** Updating */
     Updating = "Updating",
+    /** Deleting */
     Deleting = "Deleting",
+    /** Failed */
     Failed = "Failed",
+    /** Disconnected */
     Disconnected = "Disconnected"
 }
 
 /** Known values of {@link PrivateEndpointServiceConnectionStatus} that the service accepts. */
 export declare enum KnownPrivateEndpointServiceConnectionStatus {
+    /** Pending */
     Pending = "Pending",
+    /** Approved */
     Approved = "Approved",
+    /** Rejected */
     Rejected = "Rejected",
+    /** Disconnected */
     Disconnected = "Disconnected"
 }
 
@@ -776,50 +865,79 @@ export declare enum KnownProvisioningState {
 
 /** Known values of {@link PublicNetworkAccess} that the service accepts. */
 export declare enum KnownPublicNetworkAccess {
+    /** Enabled */
     Enabled = "Enabled",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
 /** Known values of {@link SecretPermissions} that the service accepts. */
 export declare enum KnownSecretPermissions {
+    /** All */
     All = "all",
+    /** Get */
     Get = "get",
+    /** List */
     List = "list",
+    /** Set */
     Set = "set",
+    /** Delete */
     Delete = "delete",
+    /** Backup */
     Backup = "backup",
+    /** Restore */
     Restore = "restore",
+    /** Recover */
     Recover = "recover",
+    /** Purge */
     Purge = "purge"
 }
 
 /** Known values of {@link SkuFamily} that the service accepts. */
 export declare enum KnownSkuFamily {
+    /** A */
     A = "A"
 }
 
 /** Known values of {@link StoragePermissions} that the service accepts. */
 export declare enum KnownStoragePermissions {
+    /** All */
     All = "all",
+    /** Get */
     Get = "get",
+    /** List */
     List = "list",
+    /** Delete */
     Delete = "delete",
+    /** Set */
     Set = "set",
+    /** Update */
     Update = "update",
+    /** Regeneratekey */
     Regeneratekey = "regeneratekey",
+    /** Recover */
     Recover = "recover",
+    /** Purge */
     Purge = "purge",
+    /** Backup */
     Backup = "backup",
+    /** Restore */
     Restore = "restore",
+    /** Setsas */
     Setsas = "setsas",
+    /** Listsas */
     Listsas = "listsas",
+    /** Getsas */
     Getsas = "getsas",
+    /** Deletesas */
     Deletesas = "deletesas"
 }
 
 /** Known values of {@link VaultProvisioningState} that the service accepts. */
 export declare enum KnownVaultProvisioningState {
+    /** Succeeded */
     Succeeded = "Succeeded",
+    /** RegisteringDns */
     RegisteringDns = "RegisteringDns"
 }
 
@@ -841,10 +959,10 @@ export declare interface LogSpecification {
 }
 
 /** Resource information with extended details. */
-export declare type ManagedHsm = ManagedHsmResource & {
+export declare interface ManagedHsm extends ManagedHsmResource {
     /** Properties of the managed HSM */
     properties?: ManagedHsmProperties;
-};
+}
 
 /** The error exception. */
 export declare interface ManagedHsmError {
@@ -1146,6 +1264,12 @@ export declare interface ManagedHsmsPurgeDeletedOptionalParams extends coreClien
     resumeFrom?: string;
 }
 
+/** Defines headers for ManagedHsms_update operation. */
+export declare interface ManagedHsmsUpdateHeaders {
+    /** The URI to poll for completion status. */
+    location?: string;
+}
+
 /** Optional parameters. */
 export declare interface ManagedHsmsUpdateOptionalParams extends coreClient.OperationOptions {
     /** Delay to wait until next poll, in milliseconds. */
@@ -1211,7 +1335,7 @@ export declare interface MhsmPrivateEndpoint {
 }
 
 /** Private endpoint connection resource. */
-export declare type MhsmPrivateEndpointConnection = ManagedHsmResource & {
+export declare interface MhsmPrivateEndpointConnection extends ManagedHsmResource {
     /** Modified whenever there is a change in the state of private endpoint connection. */
     etag?: string;
     /** Properties of the private endpoint object. */
@@ -1220,10 +1344,14 @@ export declare type MhsmPrivateEndpointConnection = ManagedHsmResource & {
     privateLinkServiceConnectionState?: MhsmPrivateLinkServiceConnectionState;
     /** Provisioning state of the private endpoint connection. */
     provisioningState?: PrivateEndpointConnectionProvisioningState;
-};
+}
 
 /** Private endpoint connection item. */
 export declare interface MhsmPrivateEndpointConnectionItem {
+    /** Id of private endpoint connection. */
+    id?: string;
+    /** Modified whenever there is a change in the state of private endpoint connection. */
+    etag?: string;
     /** Properties of the private endpoint object. */
     privateEndpoint?: MhsmPrivateEndpoint;
     /** Approval state of the private link connection. */
@@ -1345,7 +1473,7 @@ export declare interface MhsmPrivateEndpointConnectionsPutOptionalParams extends
 export declare type MhsmPrivateEndpointConnectionsPutResponse = MhsmPrivateEndpointConnectionsPutHeaders & MhsmPrivateEndpointConnection;
 
 /** A private link resource */
-export declare type MhsmPrivateLinkResource = ManagedHsmResource & {
+export declare interface MhsmPrivateLinkResource extends ManagedHsmResource {
     /**
      * Group identifier of private link resource.
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -1358,7 +1486,7 @@ export declare type MhsmPrivateLinkResource = ManagedHsmResource & {
     readonly requiredMembers?: string[];
     /** Required DNS zone names of the the private link resource. */
     requiredZoneNames?: string[];
-};
+}
 
 /** A list of private link resources */
 export declare interface MhsmPrivateLinkResourceListResult {
@@ -1512,7 +1640,7 @@ export declare interface PrivateEndpoint {
 }
 
 /** Private endpoint connection resource. */
-export declare type PrivateEndpointConnection = Resource & {
+export declare interface PrivateEndpointConnection extends Resource {
     /** Modified whenever there is a change in the state of private endpoint connection. */
     etag?: string;
     /** Properties of the private endpoint object. */
@@ -1521,7 +1649,7 @@ export declare type PrivateEndpointConnection = Resource & {
     privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
     /** Provisioning state of the private endpoint connection. */
     provisioningState?: PrivateEndpointConnectionProvisioningState;
-};
+}
 
 /** Private endpoint connection item. */
 export declare interface PrivateEndpointConnectionItem {
@@ -1676,7 +1804,7 @@ export declare type PrivateEndpointConnectionsPutResponse = PrivateEndpointConne
 export declare type PrivateEndpointServiceConnectionStatus = string;
 
 /** A private link resource */
-export declare type PrivateLinkResource = Resource & {
+export declare interface PrivateLinkResource extends Resource {
     /**
      * Group identifier of private link resource.
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -1689,7 +1817,7 @@ export declare type PrivateLinkResource = Resource & {
     readonly requiredMembers?: string[];
     /** Required DNS zone names of the the private link resource. */
     requiredZoneNames?: string[];
-};
+}
 
 /** A list of private link resources */
 export declare interface PrivateLinkResourceListResult {
@@ -1801,13 +1929,14 @@ export declare interface RotationPolicy {
 }
 
 /** Resource information with extended details. */
-export declare type Secret = Resource & {
+export declare interface Secret extends Resource {
     /** Properties of the secret */
     properties: SecretProperties;
-};
+}
 
 /** The secret management attributes. */
-export declare type SecretAttributes = Attributes & {};
+export declare interface SecretAttributes extends Attributes {
+}
 
 /** Parameters for creating or updating a secret */
 export declare interface SecretCreateOrUpdateParameters {

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.33.5"
+      "packageVersion": "7.33.6"
     }
   ]
 }