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

package/review/arm-keyvault.api.md

@@ -131,6 +131,9 @@ export interface ErrorModel {
     readonly message?: string;
 }
 
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
 // @public
 export type IdentityType = string;
 
@@ -149,17 +152,18 @@ export type JsonWebKeyOperation = string;
 export type JsonWebKeyType = string;
 
 // @public
-export type Key = Resource & {
+export interface Key extends Resource {
     attributes?: KeyAttributes;
-    kty?: JsonWebKeyType;
+    curveName?: JsonWebKeyCurveName;
+    // (undocumented)
     keyOps?: JsonWebKeyOperation[];
     keySize?: number;
-    curveName?: JsonWebKeyCurveName;
     readonly keyUri?: string;
     readonly keyUriWithVersion?: string;
-    rotationPolicy?: RotationPolicy;
+    kty?: JsonWebKeyType;
     releasePolicy?: KeyReleasePolicy;
-};
+    rotationPolicy?: RotationPolicy;
+}
 
 // @public
 export interface KeyAttributes {
@@ -315,159 +319,96 @@ export interface KeyVaultManagementClientOptionalParams extends coreClient.Servi
 
 // @public
 export enum KnownActionsRequired {
-    // (undocumented)
     None = "None"
 }
 
 // @public
 export enum KnownCertificatePermissions {
-    // (undocumented)
     All = "all",
-    // (undocumented)
     Backup = "backup",
-    // (undocumented)
     Create = "create",
-    // (undocumented)
     Delete = "delete",
-    // (undocumented)
     Deleteissuers = "deleteissuers",
-    // (undocumented)
     Get = "get",
-    // (undocumented)
     Getissuers = "getissuers",
-    // (undocumented)
     Import = "import",
-    // (undocumented)
     List = "list",
-    // (undocumented)
     Listissuers = "listissuers",
-    // (undocumented)
     Managecontacts = "managecontacts",
-    // (undocumented)
     Manageissuers = "manageissuers",
-    // (undocumented)
     Purge = "purge",
-    // (undocumented)
     Recover = "recover",
-    // (undocumented)
     Restore = "restore",
-    // (undocumented)
     Setissuers = "setissuers",
-    // (undocumented)
     Update = "update"
 }
 
 // @public
 export enum KnownDeletionRecoveryLevel {
-    // (undocumented)
     Purgeable = "Purgeable",
-    // (undocumented)
     Recoverable = "Recoverable",
-    // (undocumented)
     RecoverableProtectedSubscription = "Recoverable+ProtectedSubscription",
-    // (undocumented)
     RecoverablePurgeable = "Recoverable+Purgeable"
 }
 
 // @public
 export enum KnownIdentityType {
-    // (undocumented)
     Application = "Application",
-    // (undocumented)
     Key = "Key",
-    // (undocumented)
     ManagedIdentity = "ManagedIdentity",
-    // (undocumented)
     User = "User"
 }
 
 // @public
 export enum KnownJsonWebKeyCurveName {
-    // (undocumented)
     P256 = "P-256",
-    // (undocumented)
     P256K = "P-256K",
-    // (undocumented)
     P384 = "P-384",
-    // (undocumented)
     P521 = "P-521"
 }
 
 // @public
 export enum KnownJsonWebKeyOperation {
-    // (undocumented)
     Decrypt = "decrypt",
-    // (undocumented)
     Encrypt = "encrypt",
-    // (undocumented)
     Import = "import",
-    // (undocumented)
     Release = "release",
-    // (undocumented)
     Sign = "sign",
-    // (undocumented)
     UnwrapKey = "unwrapKey",
-    // (undocumented)
     Verify = "verify",
-    // (undocumented)
     WrapKey = "wrapKey"
 }
 
 // @public
 export enum KnownJsonWebKeyType {
-    // (undocumented)
     EC = "EC",
-    // (undocumented)
     ECHSM = "EC-HSM",
-    // (undocumented)
     RSA = "RSA",
-    // (undocumented)
     RSAHSM = "RSA-HSM"
 }
 
 // @public
 export enum KnownKeyPermissions {
-    // (undocumented)
     All = "all",
-    // (undocumented)
     Backup = "backup",
-    // (undocumented)
     Create = "create",
-    // (undocumented)
     Decrypt = "decrypt",
-    // (undocumented)
     Delete = "delete",
-    // (undocumented)
     Encrypt = "encrypt",
-    // (undocumented)
     Get = "get",
-    // (undocumented)
     Getrotationpolicy = "getrotationpolicy",
-    // (undocumented)
     Import = "import",
-    // (undocumented)
     List = "list",
-    // (undocumented)
     Purge = "purge",
-    // (undocumented)
     Recover = "recover",
-    // (undocumented)
     Release = "release",
-    // (undocumented)
     Restore = "restore",
-    // (undocumented)
     Rotate = "rotate",
-    // (undocumented)
     Setrotationpolicy = "setrotationpolicy",
-    // (undocumented)
     Sign = "sign",
-    // (undocumented)
     UnwrapKey = "unwrapKey",
-    // (undocumented)
     Update = "update",
-    // (undocumented)
     Verify = "verify",
-    // (undocumented)
     WrapKey = "wrapKey"
 }
 
@@ -479,45 +420,31 @@ export enum KnownManagedHsmSkuFamily {
 
 // @public
 export enum KnownNetworkRuleAction {
-    // (undocumented)
     Allow = "Allow",
-    // (undocumented)
     Deny = "Deny"
 }
 
 // @public
 export enum KnownNetworkRuleBypassOptions {
-    // (undocumented)
     AzureServices = "AzureServices",
-    // (undocumented)
     None = "None"
 }
 
 // @public
 export enum KnownPrivateEndpointConnectionProvisioningState {
-    // (undocumented)
     Creating = "Creating",
-    // (undocumented)
     Deleting = "Deleting",
-    // (undocumented)
     Disconnected = "Disconnected",
-    // (undocumented)
     Failed = "Failed",
-    // (undocumented)
     Succeeded = "Succeeded",
-    // (undocumented)
     Updating = "Updating"
 }
 
 // @public
 export enum KnownPrivateEndpointServiceConnectionStatus {
-    // (undocumented)
     Approved = "Approved",
-    // (undocumented)
     Disconnected = "Disconnected",
-    // (undocumented)
     Pending = "Pending",
-    // (undocumented)
     Rejected = "Rejected"
 }
 
@@ -535,31 +462,20 @@ export enum KnownProvisioningState {
 
 // @public
 export enum KnownPublicNetworkAccess {
-    // (undocumented)
     Disabled = "Disabled",
-    // (undocumented)
     Enabled = "Enabled"
 }
 
 // @public
 export enum KnownSecretPermissions {
-    // (undocumented)
     All = "all",
-    // (undocumented)
     Backup = "backup",
-    // (undocumented)
     Delete = "delete",
-    // (undocumented)
     Get = "get",
-    // (undocumented)
     List = "list",
-    // (undocumented)
     Purge = "purge",
-    // (undocumented)
     Recover = "recover",
-    // (undocumented)
     Restore = "restore",
-    // (undocumented)
     Set = "set"
 }
 
@@ -571,43 +487,26 @@ export enum KnownSkuFamily {
 
 // @public
 export enum KnownStoragePermissions {
-    // (undocumented)
     All = "all",
-    // (undocumented)
     Backup = "backup",
-    // (undocumented)
     Delete = "delete",
-    // (undocumented)
     Deletesas = "deletesas",
-    // (undocumented)
     Get = "get",
-    // (undocumented)
     Getsas = "getsas",
-    // (undocumented)
     List = "list",
-    // (undocumented)
     Listsas = "listsas",
-    // (undocumented)
     Purge = "purge",
-    // (undocumented)
     Recover = "recover",
-    // (undocumented)
     Regeneratekey = "regeneratekey",
-    // (undocumented)
     Restore = "restore",
-    // (undocumented)
     Set = "set",
-    // (undocumented)
     Setsas = "setsas",
-    // (undocumented)
     Update = "update"
 }
 
 // @public
 export enum KnownVaultProvisioningState {
-    // (undocumented)
     RegisteringDns = "RegisteringDns",
-    // (undocumented)
     Succeeded = "Succeeded"
 }
 
@@ -625,9 +524,9 @@ export interface LogSpecification {
 }
 
 // @public
-export type ManagedHsm = ManagedHsmResource & {
+export interface ManagedHsm extends ManagedHsmResource {
     properties?: ManagedHsmProperties;
-};
+}
 
 // @public
 export interface ManagedHsmError {
@@ -780,6 +679,11 @@ export interface ManagedHsmsPurgeDeletedOptionalParams extends coreClient.Operat
     updateIntervalInMs?: number;
 }
 
+// @public
+export interface ManagedHsmsUpdateHeaders {
+    location?: string;
+}
+
 // @public
 export interface ManagedHsmsUpdateOptionalParams extends coreClient.OperationOptions {
     resumeFrom?: string;
@@ -823,15 +727,17 @@ export interface MhsmPrivateEndpoint {
 }
 
 // @public
-export type MhsmPrivateEndpointConnection = ManagedHsmResource & {
+export interface MhsmPrivateEndpointConnection extends ManagedHsmResource {
     etag?: string;
     privateEndpoint?: MhsmPrivateEndpoint;
     privateLinkServiceConnectionState?: MhsmPrivateLinkServiceConnectionState;
     provisioningState?: PrivateEndpointConnectionProvisioningState;
-};
+}
 
 // @public
 export interface MhsmPrivateEndpointConnectionItem {
+    etag?: string;
+    id?: string;
     privateEndpoint?: MhsmPrivateEndpoint;
     privateLinkServiceConnectionState?: MhsmPrivateLinkServiceConnectionState;
     provisioningState?: PrivateEndpointConnectionProvisioningState;
@@ -902,11 +808,11 @@ export interface MhsmPrivateEndpointConnectionsPutOptionalParams extends coreCli
 export type MhsmPrivateEndpointConnectionsPutResponse = MhsmPrivateEndpointConnectionsPutHeaders & MhsmPrivateEndpointConnection;
 
 // @public
-export type MhsmPrivateLinkResource = ManagedHsmResource & {
+export interface MhsmPrivateLinkResource extends ManagedHsmResource {
     readonly groupId?: string;
     readonly requiredMembers?: string[];
     requiredZoneNames?: string[];
-};
+}
 
 // @public
 export interface MhsmPrivateLinkResourceListResult {
@@ -1008,12 +914,12 @@ export interface PrivateEndpoint {
 }
 
 // @public
-export type PrivateEndpointConnection = Resource & {
+export interface PrivateEndpointConnection extends Resource {
     etag?: string;
     privateEndpoint?: PrivateEndpoint;
     privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
     provisioningState?: PrivateEndpointConnectionProvisioningState;
-};
+}
 
 // @public
 export interface PrivateEndpointConnectionItem {
@@ -1095,11 +1001,11 @@ export type PrivateEndpointConnectionsPutResponse = PrivateEndpointConnectionsPu
 export type PrivateEndpointServiceConnectionStatus = string;
 
 // @public
-export type PrivateLinkResource = Resource & {
+export interface PrivateLinkResource extends Resource {
     readonly groupId?: string;
     readonly requiredMembers?: string[];
     requiredZoneNames?: string[];
-};
+}
 
 // @public
 export interface PrivateLinkResourceListResult {
@@ -1158,12 +1064,13 @@ export interface RotationPolicy {
 }
 
 // @public
-export type Secret = Resource & {
+export interface Secret extends Resource {
     properties: SecretProperties;
-};
+}
 
 // @public
-export type SecretAttributes = Attributes & {};
+export interface SecretAttributes extends Attributes {
+}
 
 // @public
 export interface SecretCreateOrUpdateParameters {

package/src/index.ts

@@ -7,6 +7,7 @@
  */
 
 /// <reference lib="esnext.asynciterable" />
+export { getContinuationToken } from "./pagingHelper";
 export * from "./models";
 export { KeyVaultManagementClient } from "./keyVaultManagementClient";
 export * from "./operationsInterfaces";

package/src/keyVaultManagementClient.ts

@@ -8,6 +8,11 @@
 
 import * as coreClient from "@azure/core-client";
 import * as coreRestPipeline from "@azure/core-rest-pipeline";
+import {
+  PipelineRequest,
+  PipelineResponse,
+  SendRequest
+} from "@azure/core-rest-pipeline";
 import * as coreAuth from "@azure/core-auth";
 import {
   KeysImpl,
@@ -66,47 +71,53 @@ export class KeyVaultManagementClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-keyvault/2.1.0-beta.1`;
+    const packageDetails = `azsdk-js-arm-keyvault/2.1.0-beta.2`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
         : `${packageDetails}`;
 
-    if (!options.credentialScopes) {
-      options.credentialScopes = ["https://management.azure.com/.default"];
-    }
     const optionsWithDefaults = {
       ...defaults,
       ...options,
       userAgentOptions: {
         userAgentPrefix
       },
-      baseUri:
+      endpoint:
         options.endpoint ?? options.baseUri ?? "https://management.azure.com"
     };
     super(optionsWithDefaults);
 
+    let bearerTokenAuthenticationPolicyFound: boolean = false;
     if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
       const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();
-      const bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
+      bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
         (pipelinePolicy) =>
           pipelinePolicy.name ===
           coreRestPipeline.bearerTokenAuthenticationPolicyName
       );
-      if (!bearerTokenAuthenticationPolicyFound) {
-        this.pipeline.removePolicy({
-          name: coreRestPipeline.bearerTokenAuthenticationPolicyName
-        });
-        this.pipeline.addPolicy(
-          coreRestPipeline.bearerTokenAuthenticationPolicy({
-            scopes: `${optionsWithDefaults.baseUri}/.default`,
-            challengeCallbacks: {
-              authorizeRequestOnChallenge:
-                coreClient.authorizeRequestOnClaimChallenge
-            }
-          })
-        );
-      }
+    }
+    if (
+      !options ||
+      !options.pipeline ||
+      options.pipeline.getOrderedPolicies().length == 0 ||
+      !bearerTokenAuthenticationPolicyFound
+    ) {
+      this.pipeline.removePolicy({
+        name: coreRestPipeline.bearerTokenAuthenticationPolicyName
+      });
+      this.pipeline.addPolicy(
+        coreRestPipeline.bearerTokenAuthenticationPolicy({
+          credential: credentials,
+          scopes:
+            optionsWithDefaults.credentialScopes ??
+            `${optionsWithDefaults.endpoint}/.default`,
+          challengeCallbacks: {
+            authorizeRequestOnChallenge:
+              coreClient.authorizeRequestOnClaimChallenge
+          }
+        })
+      );
     }
     // Parameter assignments
     this.subscriptionId = subscriptionId;
@@ -125,6 +136,35 @@ export class KeyVaultManagementClient extends coreClient.ServiceClient {
     this.mhsmPrivateLinkResources = new MhsmPrivateLinkResourcesImpl(this);
     this.operations = new OperationsImpl(this);
     this.secrets = new SecretsImpl(this);
+    this.addCustomApiVersionPolicy(options.apiVersion);
+  }
+
+  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+  private addCustomApiVersionPolicy(apiVersion?: string) {
+    if (!apiVersion) {
+      return;
+    }
+    const apiVersionPolicy = {
+      name: "CustomApiVersionPolicy",
+      async sendRequest(
+        request: PipelineRequest,
+        next: SendRequest
+      ): Promise<PipelineResponse> {
+        const param = request.url.split("?");
+        if (param.length > 1) {
+          const newParams = param[1].split("&").map((item) => {
+            if (item.indexOf("api-version") > -1) {
+              return "api-version=" + apiVersion;
+            } else {
+              return item;
+            }
+          });
+          request.url = param[0] + "?" + newParams.join("&");
+        }
+        return next(request);
+      }
+    };
+    this.pipeline.addPolicy(apiVersionPolicy);
   }
 
   keys: Keys;