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

package/package.json

@@ -3,29 +3,37 @@
   "sdk-type": "mgmt",
   "author": "Microsoft Corporation",
   "description": "A generated SDK for AzureMapsManagementClient.",
-  "version": "3.0.0",
-  "engines": { "node": ">=12.0.0" },
+  "version": "3.1.0-beta.1",
+  "engines": {
+    "node": ">=12.0.0"
+  },
   "dependencies": {
     "@azure/core-paging": "^1.2.0",
-    "@azure/core-client": "^1.0.0",
+    "@azure/core-client": "^1.5.0",
     "@azure/core-auth": "^1.3.0",
-    "@azure/core-rest-pipeline": "^1.1.0",
+    "@azure/core-rest-pipeline": "^1.8.0",
     "tslib": "^2.2.0"
   },
-  "keywords": ["node", "azure", "typescript", "browser", "isomorphic"],
+  "keywords": [
+    "node",
+    "azure",
+    "typescript",
+    "browser",
+    "isomorphic"
+  ],
   "license": "MIT",
   "main": "./dist/index.js",
   "module": "./dist-esm/src/index.js",
   "types": "./types/arm-maps.d.ts",
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.18.11",
-    "@rollup/plugin-commonjs": "11.0.2",
-    "@rollup/plugin-json": "^4.0.0",
-    "@rollup/plugin-multi-entry": "^3.0.0",
-    "@rollup/plugin-node-resolve": "^8.0.0",
+    "@microsoft/api-extractor": "7.18.11",
+    "@rollup/plugin-commonjs": "^21.0.1",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-multi-entry": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^13.1.3",
     "mkdirp": "^1.0.4",
-    "rollup": "^1.16.3",
-    "rollup-plugin-sourcemaps": "^0.4.2",
+    "rollup": "^2.66.1",
+    "rollup-plugin-sourcemaps": "^0.6.3",
     "typescript": "~4.2.0",
     "uglify-js": "^3.4.9",
     "rimraf": "^3.0.0",
@@ -39,7 +47,9 @@
     "type": "git",
     "url": "https://github.com/Azure/azure-sdk-for-js.git"
   },
-  "bugs": { "url": "https://github.com/Azure/azure-sdk-for-js/issues" },
+  "bugs": {
+    "url": "https://github.com/Azure/azure-sdk-for-js/issues"
+  },
   "files": [
     "dist/**/*.js",
     "dist/**/*.js.map",
@@ -88,8 +98,19 @@
   "sideEffects": false,
   "//metadata": {
     "constantPaths": [
-      { "path": "src/AzureMapsManagementClient.ts", "prefix": "packageDetails" }
+      {
+        "path": "src/azureMapsManagementClient.ts",
+        "prefix": "packageDetails"
+      }
     ]
   },
-  "autoPublish": true
+  "autoPublish": true,
+  "//sampleConfiguration": {
+    "productName": "",
+    "productSlugs": [
+      "azure"
+    ],
+    "disableDocsMs": true,
+    "apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-maps?view=azure-node-preview"
+  }
 }

package/review/arm-maps.api.md

@@ -16,10 +16,21 @@ export interface Accounts {
     listByResourceGroup(resourceGroupName: string, options?: AccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<MapsAccount>;
     listBySubscription(options?: AccountsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<MapsAccount>;
     listKeys(resourceGroupName: string, accountName: string, options?: AccountsListKeysOptionalParams): Promise<AccountsListKeysResponse>;
+    listSas(resourceGroupName: string, accountName: string, mapsAccountSasParameters: AccountSasParameters, options?: AccountsListSasOptionalParams): Promise<AccountsListSasResponse>;
     regenerateKeys(resourceGroupName: string, accountName: string, keySpecification: MapsKeySpecification, options?: AccountsRegenerateKeysOptionalParams): Promise<AccountsRegenerateKeysResponse>;
     update(resourceGroupName: string, accountName: string, mapsAccountUpdateParameters: MapsAccountUpdateParameters, options?: AccountsUpdateOptionalParams): Promise<AccountsUpdateResponse>;
 }
 
+// @public
+export interface AccountSasParameters {
+    expiry: string;
+    maxRatePerSecond: number;
+    principalId: string;
+    regions?: string[];
+    signingKey: SigningKey;
+    start: string;
+}
+
 // @public
 export interface AccountsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
 }
@@ -73,6 +84,13 @@ export interface AccountsListKeysOptionalParams extends coreClient.OperationOpti
 // @public
 export type AccountsListKeysResponse = MapsAccountKeys;
 
+// @public
+export interface AccountsListSasOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AccountsListSasResponse = MapsAccountSasToken;
+
 // @public
 export interface AccountsRegenerateKeysOptionalParams extends coreClient.OperationOptions {
 }
@@ -111,12 +129,29 @@ 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[];
+}
+
+// @public
+export interface CorsRules {
+    corsRules?: CorsRule[];
+}
+
 // @public
 export type CreatedByType = string;
 
 // @public
 export type Creator = TrackedResource & {
     properties: CreatorProperties;
+    readonly systemData?: SystemData;
 };
 
 // @public
@@ -263,6 +298,30 @@ export enum KnownName {
     S1 = "S1"
 }
 
+// @public
+export enum KnownSigningKey {
+    // (undocumented)
+    PrimaryKey = "primaryKey",
+    // (undocumented)
+    SecondaryKey = "secondaryKey"
+}
+
+// @public
+export interface LinkedResource {
+    id: string;
+    uniqueName: string;
+}
+
+// @public
+export interface ManagedServiceIdentity {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type?: ResourceIdentityType;
+    userAssignedIdentities?: {
+        [propertyName: string]: Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties;
+    };
+}
+
 // @public
 export interface Maps {
     listOperations(options?: MapsListOperationsOptionalParams): PagedAsyncIterableIterator<OperationDetail>;
@@ -274,6 +333,7 @@ export type MapsAccount = TrackedResource & {
     sku: Sku;
     kind?: Kind;
     readonly systemData?: SystemData;
+    identity?: ManagedServiceIdentity;
     properties?: MapsAccountProperties;
 };
 
@@ -287,7 +347,9 @@ export interface MapsAccountKeys {
 
 // @public
 export interface MapsAccountProperties {
+    cors?: CorsRules;
     disableLocalAuth?: boolean;
+    linkedResources?: LinkedResource[];
     readonly provisioningState?: string;
     readonly uniqueId?: string;
 }
@@ -298,10 +360,18 @@ export interface MapsAccounts {
     readonly value?: MapsAccount[];
 }
 
+// @public
+export interface MapsAccountSasToken {
+    readonly accountSasToken?: string;
+}
+
 // @public
 export interface MapsAccountUpdateParameters {
+    cors?: CorsRules;
     disableLocalAuth?: boolean;
+    identity?: ManagedServiceIdentity;
     kind?: Kind;
+    linkedResources?: LinkedResource[];
     readonly provisioningState?: string;
     sku?: Sku;
     tags?: {
@@ -357,8 +427,10 @@ export interface MetricSpecification {
     displayDescription?: string;
     displayName?: string;
     fillGapWithZero?: boolean;
+    internalMetricName?: string;
     name?: string;
     resourceIdDimensionNameOverride?: string;
+    sourceMdmAccount?: string;
     unit?: string;
 }
 
@@ -389,11 +461,17 @@ export interface Resource {
     readonly type?: string;
 }
 
+// @public
+export type ResourceIdentityType = "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None";
+
 // @public
 export interface ServiceSpecification {
     metricSpecifications?: MetricSpecification[];
 }
 
+// @public
+export type SigningKey = string;
+
 // @public
 export interface Sku {
     name: Name;

package/rollup.config.js

@@ -14,62 +14,14 @@ import json from "@rollup/plugin-json";
 
 import nodeBuiltins from "builtin-modules";
 
-/**
- * Gets the proper configuration needed for rollup's commonJS plugin for @opentelemetry/api.
- *
- * NOTE: this manual configuration is only needed because OpenTelemetry uses an
- * __exportStar downleveled helper function to declare its exports which confuses
- * rollup's automatic discovery mechanism.
- *
- * @returns an object reference that can be `...`'d into your cjs() configuration.
- */
-export function openTelemetryCommonJs() {
-  const namedExports = {};
-
-  for (const key of [
-    "@opentelemetry/api",
-    "@azure/core-tracing/node_modules/@opentelemetry/api"
-  ]) {
-    namedExports[key] = [
-      "SpanKind",
-      "TraceFlags",
-      "getSpan",
-      "setSpan",
-      "SpanStatusCode",
-      "getSpanContext",
-      "setSpanContext"
-    ];
-  }
-
-  const releasedOpenTelemetryVersions = ["0.10.2", "1.0.0-rc.0"];
-
-  for (const version of releasedOpenTelemetryVersions) {
-    namedExports[
-      // working around a limitation in the rollup common.js plugin - it's not able to resolve these modules so the named exports listed above will not get applied. We have to drill down to the actual path.
-      `../../../common/temp/node_modules/.pnpm/@opentelemetry/api@${version}/node_modules/@opentelemetry/api/build/src/index.js`
-    ] = [
-      "SpanKind",
-      "TraceFlags",
-      "getSpan",
-      "setSpan",
-      "StatusCode",
-      "CanonicalCode",
-      "getSpanContext",
-      "setSpanContext"
-    ];
-  }
-
-  return namedExports;
-}
-
 // #region Warning Handler
 
 /**
- * A function that can determine whether a rollupwarning should be ignored. If
+ * A function that can determine whether a rollup warning should be ignored. If
  * the function returns `true`, then the warning will not be displayed.
  */
 
-function ignoreNiseSinonEvalWarnings(warning) {
+function ignoreNiseSinonEval(warning) {
   return (
     warning.code === "EVAL" &&
     warning.id &&
@@ -78,17 +30,14 @@ function ignoreNiseSinonEvalWarnings(warning) {
   );
 }
 
-function ignoreChaiCircularDependencyWarnings(warning) {
+function ignoreChaiCircularDependency(warning) {
   return (
     warning.code === "CIRCULAR_DEPENDENCY" &&
     warning.importer && warning.importer.includes("node_modules/chai") === true
   );
 }
 
-const warningInhibitors = [
-  ignoreChaiCircularDependencyWarnings,
-  ignoreNiseSinonEvalWarnings
-];
+const warningInhibitors = [ignoreChaiCircularDependency, ignoreNiseSinonEval];
 
 /**
  * Construct a warning handler for the shared rollup configuration
@@ -122,22 +71,7 @@ function makeBrowserTestConfig() {
       nodeResolve({
         mainFields: ["module", "browser"]
       }),
-      cjs({
-        namedExports: {
-          // Chai's strange internal architecture makes it impossible to statically
-          // analyze its exports.
-          chai: [
-            "version",
-            "use",
-            "util",
-            "config",
-            "expect",
-            "should",
-            "assert"
-          ],
-          ...openTelemetryCommonJs()
-        }
-      }),
+      cjs(),
       json(),
       sourcemaps()
       //viz({ filename: "dist-test/browser-stats.html", sourcemap: true })
@@ -173,7 +107,7 @@ export function makeConfig(pkg, options) {
     ],
     output: { file: "dist/index.js", format: "cjs", sourcemap: true },
     preserveSymlinks: false,
-    plugins: [sourcemaps(), nodeResolve(), cjs()]
+    plugins: [sourcemaps(), nodeResolve()]
   };
 
   const config = [baseConfig];

package/src/azureMapsManagementClient.ts

@@ -7,6 +7,7 @@
  */
 
 import * as coreClient from "@azure/core-client";
+import * as coreRestPipeline from "@azure/core-rest-pipeline";
 import * as coreAuth from "@azure/core-auth";
 import { AccountsImpl, MapsImpl, CreatorsImpl } from "./operations";
 import { Accounts, Maps, Creators } from "./operationsInterfaces";
@@ -44,7 +45,7 @@ export class AzureMapsManagementClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-maps/3.0.0`;
+    const packageDetails = `azsdk-js-arm-maps/3.1.0-beta.1`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
@@ -59,15 +60,39 @@ export class AzureMapsManagementClient extends coreClient.ServiceClient {
       userAgentOptions: {
         userAgentPrefix
       },
-      baseUri: options.endpoint || "https://management.azure.com"
+      baseUri:
+        options.endpoint ?? options.baseUri ?? "https://management.azure.com"
     };
     super(optionsWithDefaults);
+
+    if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
+      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();
+      const 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
+            }
+          })
+        );
+      }
+    }
     // Parameter assignments
     this.subscriptionId = subscriptionId;
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2021-02-01";
+    this.apiVersion = options.apiVersion || "2021-12-01-preview";
     this.accounts = new AccountsImpl(this);
     this.maps = new MapsImpl(this);
     this.creators = new CreatorsImpl(this);

package/src/models/index.ts

@@ -35,6 +35,39 @@ export interface SystemData {
   lastModifiedAt?: Date;
 }
 
+/** Identity for the resource. */
+export interface ManagedServiceIdentity {
+  /**
+   * The principal ID of resource identity.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly principalId?: string;
+  /**
+   * The tenant ID of resource.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly tenantId?: string;
+  /** The identity type. */
+  type?: ResourceIdentityType;
+  /** The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */
+  userAssignedIdentities?: {
+    [propertyName: string]: Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties;
+  };
+}
+
+export interface Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties {
+  /**
+   * The principal id of user assigned identity.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly principalId?: string;
+  /**
+   * The client id of user assigned identity.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly clientId?: string;
+}
+
 /** Additional Map account properties */
 export interface MapsAccountProperties {
   /**
@@ -45,10 +78,34 @@ export interface MapsAccountProperties {
   /** Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys authentication from any usage. */
   disableLocalAuth?: boolean;
   /**
-   * the state of the provisioning.
+   * The provisioning state of the Map account resource.
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly provisioningState?: string;
+  /** Sets the resources to be used for Managed Identities based operations for the Map account resource. */
+  linkedResources?: LinkedResource[];
+  /** Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service. */
+  cors?: CorsRules;
+}
+
+/** Linked resource is reference to a resource deployed in an Azure subscription, add the linked resource `uniqueName` value as an optional parameter for operations on Azure Maps Geospatial REST APIs. */
+export interface LinkedResource {
+  /** A provided name which uniquely identifies the linked resource. */
+  uniqueName: string;
+  /** ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/accounts/{storageName}'. */
+  id: string;
+}
+
+/** Sets the CORS rules. You can include up to five CorsRule elements in the request. */
+export interface CorsRules {
+  /** The list of CORS rules. You can include up to five CorsRule elements in the request. */
+  corsRules?: CorsRule[];
+}
+
+/** Specifies a CORS rule for the Map Account. */
+export interface CorsRule {
+  /** Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains */
+  allowedOrigins: string[];
 }
 
 /** Common fields that are returned in the response for all Azure Resource Manager resources */
@@ -127,6 +184,8 @@ export interface MapsAccountUpdateParameters {
   kind?: Kind;
   /** The SKU of this account. */
   sku?: Sku;
+  /** Sets the identity property for maps account. */
+  identity?: ManagedServiceIdentity;
   /**
    * A unique identifier for the maps account
    * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -135,10 +194,14 @@ export interface MapsAccountUpdateParameters {
   /** Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys authentication from any usage. */
   disableLocalAuth?: boolean;
   /**
-   * the state of the provisioning.
+   * The provisioning state of the Map account resource.
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly provisioningState?: string;
+  /** Sets the resources to be used for Managed Identities based operations for the Map account resource. */
+  linkedResources?: LinkedResource[];
+  /** Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service. */
+  cors?: CorsRules;
 }
 
 /** A list of Maps Accounts. */
@@ -155,6 +218,31 @@ export interface MapsAccounts {
   nextLink?: string;
 }
 
+/** Parameters used to create an account Shared Access Signature (SAS) token. The REST API access control is provided by Azure Maps Role Based Access (RBAC) identity and access. */
+export interface AccountSasParameters {
+  /** The Map account key to use for signing. */
+  signingKey: SigningKey;
+  /** The principal Id also known as the object Id of a User Assigned Managed Identity currently assigned to the Map Account. To assign a Managed Identity of the account, use operation Create or Update an assign a User Assigned Identity resource Id. */
+  principalId: string;
+  /** Optional, allows control of which region locations are permitted access to Azure Maps REST APIs with the SAS token. Example: "eastus", "westus2". Omitting this parameter will allow all region locations to be accessible. */
+  regions?: string[];
+  /** Required parameter which represents the desired maximum request per second to allowed for the given SAS token. This does not guarantee perfect accuracy in measurements but provides application safe guards of abuse with eventual enforcement. */
+  maxRatePerSecond: number;
+  /** The date time offset of when the token validity begins. For example "2017-05-24T10:42:03.1567373Z". */
+  start: string;
+  /** The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z" */
+  expiry: string;
+}
+
+/** A new Sas token which can be used to access the Maps REST APIs and is controlled by the specified Managed identity permissions on Azure (IAM) Role Based Access Control. */
+export interface MapsAccountSasToken {
+  /**
+   * The shared access signature access token.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly accountSasToken?: string;
+}
+
 /** The set of keys which can be used to access the Maps REST APIs. Two keys are provided for key rotation without interruption. */
 export interface MapsAccountKeys {
   /**
@@ -251,6 +339,10 @@ export interface MetricSpecification {
   category?: string;
   /** Account Resource Id. */
   resourceIdDimensionNameOverride?: string;
+  /** Source metrics account. */
+  sourceMdmAccount?: string;
+  /** Internal metric name. */
+  internalMetricName?: string;
 }
 
 /** Dimension of map account, for example API Category, Api Name, Result Type, and Response Code. */
@@ -326,6 +418,8 @@ export type MapsAccount = TrackedResource & {
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly systemData?: SystemData;
+  /** Sets the identity property for maps account. */
+  identity?: ManagedServiceIdentity;
   /** The map account properties. */
   properties?: MapsAccountProperties;
 };
@@ -334,6 +428,11 @@ export type MapsAccount = TrackedResource & {
 export type Creator = TrackedResource & {
   /** The Creator resource properties. */
   properties: CreatorProperties;
+  /**
+   * The system meta data relating to this resource.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly systemData?: SystemData;
 };
 
 /** Known values of {@link Name} that the service accepts. */
@@ -390,6 +489,22 @@ export enum KnownCreatedByType {
  */
 export type CreatedByType = string;
 
+/** Known values of {@link SigningKey} that the service accepts. */
+export enum KnownSigningKey {
+  PrimaryKey = "primaryKey",
+  SecondaryKey = "secondaryKey"
+}
+
+/**
+ * Defines values for SigningKey. \
+ * {@link KnownSigningKey} can be used interchangeably with SigningKey,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **primaryKey** \
+ * **secondaryKey**
+ */
+export type SigningKey = string;
+
 /** Known values of {@link KeyType} that the service accepts. */
 export enum KnownKeyType {
   Primary = "primary",
@@ -405,6 +520,12 @@ export enum KnownKeyType {
  * **secondary**
  */
 export type KeyType = string;
+/** Defines values for ResourceIdentityType. */
+export type ResourceIdentityType =
+  | "SystemAssigned"
+  | "UserAssigned"
+  | "SystemAssigned, UserAssigned"
+  | "None";
 
 /** Optional parameters. */
 export interface AccountsCreateOrUpdateOptionalParams
@@ -445,6 +566,13 @@ export interface AccountsListBySubscriptionOptionalParams
 /** Contains response data for the listBySubscription operation. */
 export type AccountsListBySubscriptionResponse = MapsAccounts;
 
+/** Optional parameters. */
+export interface AccountsListSasOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listSas operation. */
+export type AccountsListSasResponse = MapsAccountSasToken;
+
 /** Optional parameters. */
 export interface AccountsListKeysOptionalParams
   extends coreClient.OperationOptions {}