@azure/arm-maps 3.1.0-beta.1 → 3.1.0

package/review/arm-maps.api.md

@@ -110,6 +110,7 @@ export class AzureMapsManagementClient extends coreClient.ServiceClient {
     // (undocumented)
     $host: string;
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureMapsManagementClientOptionalParams);
+    constructor(credentials: coreAuth.TokenCredential, options?: AzureMapsManagementClientOptionalParams);
     // (undocumented)
     accounts: Accounts;
     // (undocumented)
@@ -119,7 +120,7 @@ export class AzureMapsManagementClient extends coreClient.ServiceClient {
     // (undocumented)
     maps: Maps;
     // (undocumented)
-    subscriptionId: string;
+    subscriptionId?: string;
 }
 
 // @public
@@ -129,12 +130,6 @@ export interface AzureMapsManagementClientOptionalParams extends coreClient.Serv
     endpoint?: string;
 }
 
-// @public (undocumented)
-export interface Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties {
-    readonly clientId?: string;
-    readonly principalId?: string;
-}
-
 // @public
 export interface CorsRule {
     allowedOrigins: string[];
@@ -149,10 +144,10 @@ export interface CorsRules {
 export type CreatedByType = string;
 
 // @public
-export type Creator = TrackedResource & {
+export interface Creator extends TrackedResource {
     properties: CreatorProperties;
     readonly systemData?: SystemData;
-};
+}
 
 // @public
 export interface CreatorList {
@@ -223,6 +218,19 @@ export interface CreatorUpdateParameters {
     };
 }
 
+// @public
+export interface CustomerManagedKeyEncryption {
+    keyEncryptionKeyIdentity?: CustomerManagedKeyEncryptionKeyIdentity;
+    keyEncryptionKeyUrl?: string;
+}
+
+// @public
+export interface CustomerManagedKeyEncryptionKeyIdentity {
+    delegatedIdentityClientId?: string;
+    identityType?: IdentityType;
+    userAssignedIdentityResourceId?: string;
+}
+
 // @public
 export interface Dimension {
     displayName?: string;
@@ -233,6 +241,12 @@ export interface Dimension {
     toBeExportedToShoebox?: boolean;
 }
 
+// @public
+export interface Encryption {
+    customerManagedKeyEncryption?: CustomerManagedKeyEncryption;
+    infrastructureEncryption?: InfrastructureEncryption;
+}
+
 // @public
 export interface ErrorAdditionalInfo {
     readonly info?: Record<string, unknown>;
@@ -253,6 +267,15 @@ export interface ErrorResponse {
     error?: ErrorDetail;
 }
 
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
+// @public
+export type IdentityType = string;
+
+// @public
+export type InfrastructureEncryption = string;
+
 // @public
 type KeyType_2 = string;
 export { KeyType_2 as KeyType }
@@ -262,47 +285,56 @@ export type Kind = string;
 
 // @public
 export enum KnownCreatedByType {
-    // (undocumented)
     Application = "Application",
-    // (undocumented)
     Key = "Key",
-    // (undocumented)
     ManagedIdentity = "ManagedIdentity",
-    // (undocumented)
     User = "User"
 }
 
+// @public
+export enum KnownIdentityType {
+    DelegatedResourceIdentity = "delegatedResourceIdentity",
+    SystemAssignedIdentity = "systemAssignedIdentity",
+    UserAssignedIdentity = "userAssignedIdentity"
+}
+
+// @public
+export enum KnownInfrastructureEncryption {
+    Disabled = "disabled",
+    Enabled = "enabled"
+}
+
 // @public
 export enum KnownKeyType {
-    // (undocumented)
     Primary = "primary",
-    // (undocumented)
     Secondary = "secondary"
 }
 
 // @public
 export enum KnownKind {
-    // (undocumented)
     Gen1 = "Gen1",
-    // (undocumented)
     Gen2 = "Gen2"
 }
 
+// @public
+export enum KnownManagedServiceIdentityType {
+    None = "None",
+    SystemAssigned = "SystemAssigned",
+    SystemAssignedUserAssigned = "SystemAssigned, UserAssigned",
+    UserAssigned = "UserAssigned"
+}
+
 // @public
 export enum KnownName {
-    // (undocumented)
     G2 = "G2",
-    // (undocumented)
     S0 = "S0",
-    // (undocumented)
     S1 = "S1"
 }
 
 // @public
 export enum KnownSigningKey {
-    // (undocumented)
+    ManagedIdentity = "managedIdentity",
     PrimaryKey = "primaryKey",
-    // (undocumented)
     SecondaryKey = "secondaryKey"
 }
 
@@ -316,12 +348,15 @@ export interface LinkedResource {
 export interface ManagedServiceIdentity {
     readonly principalId?: string;
     readonly tenantId?: string;
-    type?: ResourceIdentityType;
+    type: ManagedServiceIdentityType;
     userAssignedIdentities?: {
-        [propertyName: string]: Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties;
+        [propertyName: string]: UserAssignedIdentity;
     };
 }
 
+// @public
+export type ManagedServiceIdentityType = string;
+
 // @public
 export interface Maps {
     listOperations(options?: MapsListOperationsOptionalParams): PagedAsyncIterableIterator<OperationDetail>;
@@ -329,13 +364,13 @@ export interface Maps {
 }
 
 // @public
-export type MapsAccount = TrackedResource & {
-    sku: Sku;
-    kind?: Kind;
-    readonly systemData?: SystemData;
+export interface MapsAccount extends TrackedResource {
     identity?: ManagedServiceIdentity;
+    kind?: Kind;
     properties?: MapsAccountProperties;
-};
+    sku: Sku;
+    readonly systemData?: SystemData;
+}
 
 // @public
 export interface MapsAccountKeys {
@@ -349,6 +384,7 @@ export interface MapsAccountKeys {
 export interface MapsAccountProperties {
     cors?: CorsRules;
     disableLocalAuth?: boolean;
+    encryption?: Encryption;
     linkedResources?: LinkedResource[];
     readonly provisioningState?: string;
     readonly uniqueId?: string;
@@ -369,6 +405,7 @@ export interface MapsAccountSasToken {
 export interface MapsAccountUpdateParameters {
     cors?: CorsRules;
     disableLocalAuth?: boolean;
+    encryption?: Encryption;
     identity?: ManagedServiceIdentity;
     kind?: Kind;
     linkedResources?: LinkedResource[];
@@ -428,9 +465,12 @@ export interface MetricSpecification {
     displayName?: string;
     fillGapWithZero?: boolean;
     internalMetricName?: string;
+    lockAggregationType?: string;
     name?: string;
     resourceIdDimensionNameOverride?: string;
     sourceMdmAccount?: string;
+    sourceMdmNamespace?: string;
+    supportedAggregationTypes?: string;
     unit?: string;
 }
 
@@ -461,9 +501,6 @@ export interface Resource {
     readonly type?: string;
 }
 
-// @public
-export type ResourceIdentityType = "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None";
-
 // @public
 export interface ServiceSpecification {
     metricSpecifications?: MetricSpecification[];
@@ -489,12 +526,18 @@ export interface SystemData {
 }
 
 // @public
-export type TrackedResource = Resource & {
+export interface TrackedResource extends Resource {
+    location: string;
     tags?: {
         [propertyName: string]: string;
     };
-    location: string;
-};
+}
+
+// @public
+export interface UserAssignedIdentity {
+    readonly clientId?: string;
+    readonly principalId?: string;
+}
 
 // (No @packageDocumentation comment for this package)
 

package/src/azureMapsManagementClient.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 { AccountsImpl, MapsImpl, CreatorsImpl } from "./operations";
 import { Accounts, Maps, Creators } from "./operationsInterfaces";
@@ -16,7 +21,7 @@ import { AzureMapsManagementClientOptionalParams } from "./models";
 export class AzureMapsManagementClient extends coreClient.ServiceClient {
   $host: string;
   apiVersion: string;
-  subscriptionId: string;
+  subscriptionId?: string;
 
   /**
    * Initializes a new instance of the AzureMapsManagementClient class.
@@ -28,12 +33,26 @@ export class AzureMapsManagementClient extends coreClient.ServiceClient {
     credentials: coreAuth.TokenCredential,
     subscriptionId: string,
     options?: AzureMapsManagementClientOptionalParams
+  );
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    options?: AzureMapsManagementClientOptionalParams
+  );
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    subscriptionIdOrOptions?: AzureMapsManagementClientOptionalParams | string,
+    options?: AzureMapsManagementClientOptionalParams
   ) {
     if (credentials === undefined) {
       throw new Error("'credentials' cannot be null");
     }
-    if (subscriptionId === undefined) {
-      throw new Error("'subscriptionId' cannot be null");
+
+    let subscriptionId: string | undefined;
+
+    if (typeof subscriptionIdOrOptions === "string") {
+      subscriptionId = subscriptionIdOrOptions;
+    } else if (typeof subscriptionIdOrOptions === "object") {
+      options = subscriptionIdOrOptions;
     }
 
     // Initializing default values for options
@@ -45,57 +64,92 @@ export class AzureMapsManagementClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-maps/3.1.0-beta.1`;
+    const packageDetails = `azsdk-js-arm-maps/3.1.0`;
     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;
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2021-12-01-preview";
+    this.apiVersion = options.apiVersion || "2023-06-01";
     this.accounts = new AccountsImpl(this);
     this.maps = new MapsImpl(this);
     this.creators = new CreatorsImpl(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);
   }
 
   accounts: Accounts;

package/src/index.ts

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