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

package/types/arm-maps.d.ts

@@ -47,6 +47,21 @@ export declare interface Accounts {
      * @param options The options parameters.
      */
     get(resourceGroupName: string, accountName: string, options?: AccountsGetOptionalParams): Promise<AccountsGetResponse>;
+    /**
+     * Create and list an account shared access signature token. Use this SAS token for authentication to
+     * Azure Maps REST APIs through various Azure Maps SDKs. As prerequisite to create a SAS Token.
+     *
+     * Prerequisites:
+     * 1. Create or have an existing User Assigned Managed Identity in the same Azure region as the
+     * account.
+     * 2. Create or update an Azure Map account with the same Azure region as the User Assigned Managed
+     * Identity is placed.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param accountName The name of the Maps Account.
+     * @param mapsAccountSasParameters The updated parameters for the Maps Account.
+     * @param options The options parameters.
+     */
+    listSas(resourceGroupName: string, accountName: string, mapsAccountSasParameters: AccountSasParameters, options?: AccountsListSasOptionalParams): Promise<AccountsListSasResponse>;
     /**
      * Get the keys to use with the Maps APIs. A key is used to authenticate and authorize access to the
      * Maps REST APIs. Only one key is needed at a time; two are given to provide seamless key
@@ -67,6 +82,22 @@ export declare interface Accounts {
     regenerateKeys(resourceGroupName: string, accountName: string, keySpecification: MapsKeySpecification, options?: AccountsRegenerateKeysOptionalParams): Promise<AccountsRegenerateKeysResponse>;
 }
 
+/** 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 declare 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;
+}
+
 /** Optional parameters. */
 export declare interface AccountsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
 }
@@ -120,6 +151,13 @@ export declare interface AccountsListKeysOptionalParams extends coreClient.Opera
 /** Contains response data for the listKeys operation. */
 export declare type AccountsListKeysResponse = MapsAccountKeys;
 
+/** Optional parameters. */
+export declare interface AccountsListSasOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listSas operation. */
+export declare type AccountsListSasResponse = MapsAccountSasToken;
+
 /** Optional parameters. */
 export declare interface AccountsRegenerateKeysOptionalParams extends coreClient.OperationOptions {
 }
@@ -160,6 +198,31 @@ export declare interface AzureMapsManagementClientOptionalParams extends coreCli
     endpoint?: string;
 }
 
+export declare 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;
+}
+
+/** Specifies a CORS rule for the Map Account. */
+export declare 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[];
+}
+
+/** Sets the CORS rules. You can include up to five CorsRule elements in the request. */
+export declare interface CorsRules {
+    /** The list of CORS rules. You can include up to five CorsRule elements in the request. */
+    corsRules?: CorsRule[];
+}
+
 /**
  * Defines values for CreatedByType. \
  * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
@@ -176,6 +239,11 @@ export declare type CreatedByType = string;
 export declare 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;
 };
 
 /** A list of Creator resources. */
@@ -417,6 +485,40 @@ export declare enum KnownName {
     G2 = "G2"
 }
 
+/** Known values of {@link SigningKey} that the service accepts. */
+export declare enum KnownSigningKey {
+    PrimaryKey = "primaryKey",
+    SecondaryKey = "secondaryKey"
+}
+
+/** 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 declare 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;
+}
+
+/** Identity for the resource. */
+export declare 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;
+    };
+}
+
 /** Interface representing a Maps. */
 export declare interface Maps {
     /**
@@ -442,6 +544,8 @@ export declare 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;
 };
@@ -480,10 +584,14 @@ export declare 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;
 }
 
 /** A list of Maps Accounts. */
@@ -500,6 +608,15 @@ export declare interface MapsAccounts {
     nextLink?: 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 declare 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;
+}
+
 /** Parameters used to update an existing Maps Account. */
 export declare interface MapsAccountUpdateParameters {
     /** Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. */
@@ -510,6 +627,8 @@ export declare 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.
@@ -518,10 +637,14 @@ export declare 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;
 }
 
 /** Whether the operation refers to the primary or secondary key. */
@@ -592,6 +715,10 @@ export declare interface MetricSpecification {
     category?: string;
     /** Account Resource Id. */
     resourceIdDimensionNameOverride?: string;
+    /** Source metrics account. */
+    sourceMdmAccount?: string;
+    /** Internal metric name. */
+    internalMetricName?: string;
 }
 
 /**
@@ -650,12 +777,25 @@ export declare interface Resource {
     readonly type?: string;
 }
 
+/** Defines values for ResourceIdentityType. */
+export declare type ResourceIdentityType = "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None";
+
 /** One property of operation, include metric specifications. */
 export declare interface ServiceSpecification {
     /** Metric specifications of operation. */
     metricSpecifications?: MetricSpecification[];
 }
 
+/**
+ * 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 declare type SigningKey = string;
+
 /** The SKU of the Maps Account. */
 export declare interface Sku {
     /** The name of the SKU, in standard format (such as S0). */

package/types/tsdoc-metadata.json

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

package/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2021 Microsoft
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.