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

package/types/arm-maps.d.ts

@@ -84,7 +84,7 @@ export declare interface Accounts {
 
 /** 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. */
+    /** The Map account key to use for signing. Picking `primaryKey` or `secondaryKey` will use the Map account Shared Keys, and using `managedIdentity` will use the auto-renewed private key to sign the SAS. */
     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;
@@ -92,9 +92,9 @@ export declare interface AccountSasParameters {
     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". */
+    /** The date time offset of when the token validity begins. For example "2017-05-24T10:42:03.1567373Z". Maximum duration allowed is 24 hours between `start` and `expiry`. */
     start: string;
-    /** The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z" */
+    /** The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z". Maximum duration allowed is 24 hours between `start` and `expiry`. */
     expiry: string;
 }
 
@@ -175,7 +175,7 @@ export declare type AccountsUpdateResponse = MapsAccount;
 export declare class AzureMapsManagementClient extends coreClient.ServiceClient {
     $host: string;
     apiVersion: string;
-    subscriptionId: string;
+    subscriptionId?: string;
     /**
      * Initializes a new instance of the AzureMapsManagementClient class.
      * @param credentials Subscription credentials which uniquely identify client subscription.
@@ -183,6 +183,9 @@ export declare class AzureMapsManagementClient extends coreClient.ServiceClient
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureMapsManagementClientOptionalParams);
+    constructor(credentials: coreAuth.TokenCredential, options?: AzureMapsManagementClientOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
     accounts: Accounts;
     maps: Maps;
     creators: Creators;
@@ -198,19 +201,6 @@ 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 */
@@ -236,7 +226,7 @@ export declare interface CorsRules {
 export declare type CreatedByType = string;
 
 /** An Azure resource which represents Maps Creator product and provides ability to manage private location data. */
-export declare type Creator = TrackedResource & {
+export declare interface Creator extends TrackedResource {
     /** The Creator resource properties. */
     properties: CreatorProperties;
     /**
@@ -244,7 +234,7 @@ export declare type Creator = TrackedResource & {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly systemData?: SystemData;
-};
+}
 
 /** A list of Creator resources. */
 export declare interface CreatorList {
@@ -372,6 +362,24 @@ export declare interface CreatorUpdateParameters {
     storageUnits?: number;
 }
 
+/** All Customer-managed key encryption properties for the resource. */
+export declare interface CustomerManagedKeyEncryption {
+    /** All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */
+    keyEncryptionKeyIdentity?: CustomerManagedKeyEncryptionKeyIdentity;
+    /** key encryption key Url, versioned or non-versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. */
+    keyEncryptionKeyUrl?: string;
+}
+
+/** All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */
+export declare interface CustomerManagedKeyEncryptionKeyIdentity {
+    /** Values can be systemAssignedIdentity or userAssignedIdentity */
+    identityType?: IdentityType;
+    /** user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity and delegatedResourceIdentity. */
+    userAssignedIdentityResourceId?: string;
+    /** delegated identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity and userAssignedIdentity - internal use only. */
+    delegatedIdentityClientId?: string;
+}
+
 /** Dimension of map account, for example API Category, Api Name, Result Type, and Response Code. */
 export declare interface Dimension {
     /** Display name of dimension. */
@@ -388,6 +396,14 @@ export declare interface Dimension {
     toBeExportedToShoebox?: boolean;
 }
 
+/** (Optional) Discouraged to include in resource definition. Only needed where it is possible to disable platform (AKA infrastructure) encryption. Azure SQL TDE is an example of this. Values are enabled and disabled. */
+export declare interface Encryption {
+    /** Values are enabled and disabled. */
+    infrastructureEncryption?: InfrastructureEncryption;
+    /** All Customer-managed key encryption properties for the resource. */
+    customerManagedKeyEncryption?: CustomerManagedKeyEncryption;
+}
+
 /** The resource management error additional info. */
 export declare interface ErrorAdditionalInfo {
     /**
@@ -437,6 +453,36 @@ export declare interface ErrorResponse {
     error?: ErrorDetail;
 }
 
+/**
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
+ * that point later.
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
+ */
+export declare function getContinuationToken(page: unknown): string | undefined;
+
+/**
+ * Defines values for IdentityType. \
+ * {@link KnownIdentityType} can be used interchangeably with IdentityType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **systemAssignedIdentity** \
+ * **userAssignedIdentity** \
+ * **delegatedResourceIdentity**
+ */
+export declare type IdentityType = string;
+
+/**
+ * Defines values for InfrastructureEncryption. \
+ * {@link KnownInfrastructureEncryption} can be used interchangeably with InfrastructureEncryption,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **enabled** \
+ * **disabled**
+ */
+export declare type InfrastructureEncryption = string;
+
 /**
  * Defines values for KeyType. \
  * {@link KnownKeyType} can be used interchangeably with KeyType,
@@ -460,35 +506,80 @@ export declare type Kind = string;
 
 /** Known values of {@link CreatedByType} that the service accepts. */
 export declare enum KnownCreatedByType {
+    /** User */
     User = "User",
+    /** Application */
     Application = "Application",
+    /** ManagedIdentity */
     ManagedIdentity = "ManagedIdentity",
+    /** Key */
     Key = "Key"
 }
 
+/** Known values of {@link IdentityType} that the service accepts. */
+export declare enum KnownIdentityType {
+    /** SystemAssignedIdentity */
+    SystemAssignedIdentity = "systemAssignedIdentity",
+    /** UserAssignedIdentity */
+    UserAssignedIdentity = "userAssignedIdentity",
+    /** DelegatedResourceIdentity */
+    DelegatedResourceIdentity = "delegatedResourceIdentity"
+}
+
+/** Known values of {@link InfrastructureEncryption} that the service accepts. */
+export declare enum KnownInfrastructureEncryption {
+    /** Enabled */
+    Enabled = "enabled",
+    /** Disabled */
+    Disabled = "disabled"
+}
+
 /** Known values of {@link KeyType} that the service accepts. */
 export declare enum KnownKeyType {
+    /** Primary */
     Primary = "primary",
+    /** Secondary */
     Secondary = "secondary"
 }
 
 /** Known values of {@link Kind} that the service accepts. */
 export declare enum KnownKind {
+    /** Gen1 */
     Gen1 = "Gen1",
+    /** Gen2 */
     Gen2 = "Gen2"
 }
 
+/** Known values of {@link ManagedServiceIdentityType} that the service accepts. */
+export declare enum KnownManagedServiceIdentityType {
+    /** None */
+    None = "None",
+    /** SystemAssigned */
+    SystemAssigned = "SystemAssigned",
+    /** UserAssigned */
+    UserAssigned = "UserAssigned",
+    /** SystemAssignedUserAssigned */
+    SystemAssignedUserAssigned = "SystemAssigned, UserAssigned"
+}
+
 /** Known values of {@link Name} that the service accepts. */
 export declare enum KnownName {
+    /** S0 */
     S0 = "S0",
+    /** S1 */
     S1 = "S1",
+    /** G2 */
     G2 = "G2"
 }
 
 /** Known values of {@link SigningKey} that the service accepts. */
 export declare enum KnownSigningKey {
+    /** PrimaryKey */
     PrimaryKey = "primaryKey",
-    SecondaryKey = "secondaryKey"
+    /** SecondaryKey */
+    SecondaryKey = "secondaryKey",
+    /** ManagedIdentity */
+    ManagedIdentity = "managedIdentity"
 }
 
 /** 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. */
@@ -499,26 +590,38 @@ export declare interface LinkedResource {
     id: string;
 }
 
-/** Identity for the resource. */
+/** Managed service identity (system assigned and/or user assigned identities) */
 export declare interface ManagedServiceIdentity {
     /**
-     * The principal ID of resource identity.
+     * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly principalId?: string;
     /**
-     * The tenant ID of resource.
+     * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
      * 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}'. */
+    /** Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */
+    type: ManagedServiceIdentityType;
+    /** The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */
     userAssignedIdentities?: {
-        [propertyName: string]: Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties;
+        [propertyName: string]: UserAssignedIdentity;
     };
 }
 
+/**
+ * Defines values for ManagedServiceIdentityType. \
+ * {@link KnownManagedServiceIdentityType} can be used interchangeably with ManagedServiceIdentityType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **None** \
+ * **SystemAssigned** \
+ * **UserAssigned** \
+ * **SystemAssigned, UserAssigned**
+ */
+export declare type ManagedServiceIdentityType = string;
+
 /** Interface representing a Maps. */
 export declare interface Maps {
     /**
@@ -534,21 +637,21 @@ export declare interface Maps {
 }
 
 /** An Azure resource which represents access to a suite of Maps REST APIs. */
-export declare type MapsAccount = TrackedResource & {
+export declare interface MapsAccount extends TrackedResource {
     /** The SKU of this account. */
     sku: Sku;
     /** Get or Set Kind property. */
     kind?: Kind;
     /**
-     * The system meta data relating to this resource.
+     * Metadata pertaining to creation and last modification of the resource.
      * 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. */
+    /** Managed service identity (system assigned and/or user assigned identities) */
     identity?: ManagedServiceIdentity;
     /** The map account properties. */
     properties?: MapsAccountProperties;
-};
+}
 
 /** The set of keys which can be used to access the Maps REST APIs. Two keys are provided for key rotation without interruption. */
 export declare interface MapsAccountKeys {
@@ -581,17 +684,19 @@ export declare interface MapsAccountProperties {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly uniqueId?: string;
-    /** Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys authentication from any usage. */
+    /** Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys and Shared Access Signature Token authentication from any usage. */
     disableLocalAuth?: boolean;
     /**
-     * The provisioning state of the Map account resource.
+     * The provisioning state of the Map account resource, Account updates can only be performed on terminal states. Terminal states: `Succeeded` and `Failed`
      * 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. */
+    /** The array of associated resources to the Map account. Linked resource in the array cannot individually update, you must update all linked resources in the array together. These resources may be used on operations on the Azure Maps REST API. Access is controlled by the Map Account Managed Identity(s) permissions to those resource(s). */
     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;
+    /** (Optional) Discouraged to include in resource definition. Only needed where it is possible to disable platform (AKA infrastructure) encryption. Azure SQL TDE is an example of this. Values are enabled and disabled. */
+    encryption?: Encryption;
 }
 
 /** A list of Maps Accounts. */
@@ -627,24 +732,26 @@ export declare interface MapsAccountUpdateParameters {
     kind?: Kind;
     /** The SKU of this account. */
     sku?: Sku;
-    /** Sets the identity property for maps account. */
+    /** Managed service identity (system assigned and/or user assigned identities) */
     identity?: ManagedServiceIdentity;
     /**
      * A unique identifier for the maps account
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly uniqueId?: string;
-    /** Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys authentication from any usage. */
+    /** Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys and Shared Access Signature Token authentication from any usage. */
     disableLocalAuth?: boolean;
     /**
-     * The provisioning state of the Map account resource.
+     * The provisioning state of the Map account resource, Account updates can only be performed on terminal states. Terminal states: `Succeeded` and `Failed`
      * 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. */
+    /** The array of associated resources to the Map account. Linked resource in the array cannot individually update, you must update all linked resources in the array together. These resources may be used on operations on the Azure Maps REST API. Access is controlled by the Map Account Managed Identity(s) permissions to those resource(s). */
     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;
+    /** (Optional) Discouraged to include in resource definition. Only needed where it is possible to disable platform (AKA infrastructure) encryption. Azure SQL TDE is an example of this. Values are enabled and disabled. */
+    encryption?: Encryption;
 }
 
 /** Whether the operation refers to the primary or secondary key. */
@@ -719,6 +826,12 @@ export declare interface MetricSpecification {
     sourceMdmAccount?: string;
     /** Internal metric name. */
     internalMetricName?: string;
+    /** Lock aggregation type for metrics. */
+    lockAggregationType?: string;
+    /** Metrics namespace. */
+    sourceMdmNamespace?: string;
+    /** Allowed aggregation types for metrics. */
+    supportedAggregationTypes?: string;
 }
 
 /**
@@ -777,9 +890,6 @@ 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. */
@@ -792,7 +902,8 @@ export declare interface ServiceSpecification {
  *  this enum contains the known values that the service supports.
  * ### Known values supported by the service
  * **primaryKey** \
- * **secondaryKey**
+ * **secondaryKey** \
+ * **managedIdentity**
  */
 export declare type SigningKey = string;
 
@@ -824,13 +935,27 @@ export declare interface SystemData {
 }
 
 /** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
-export declare type TrackedResource = Resource & {
+export declare interface TrackedResource extends Resource {
     /** Resource tags. */
     tags?: {
         [propertyName: string]: string;
     };
     /** The geo-location where the resource lives */
     location: string;
-};
+}
+
+/** User assigned identity properties */
+export declare interface UserAssignedIdentity {
+    /**
+     * The principal ID of the assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly principalId?: string;
+    /**
+     * The client ID of the assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly clientId?: string;
+}
 
 export { }

package/types/tsdoc-metadata.json

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

package/dist-esm/test/sampleTest.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=sampleTest.d.ts.map

package/dist-esm/test/sampleTest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sampleTest.d.ts","sourceRoot":"","sources":["../../test/sampleTest.ts"],"names":[],"mappings":""}

package/dist-esm/test/sampleTest.js

@@ -1,40 +0,0 @@
-/*
- * 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.
- */
-import { __awaiter } from "tslib";
-import { record } from "@azure-tools/test-recorder";
-const recorderEnvSetup = {
-    replaceableVariables: {
-        AZURE_CLIENT_ID: "azure_client_id",
-        AZURE_CLIENT_SECRET: "azure_client_secret",
-        AZURE_TENANT_ID: "88888888-8888-8888-8888-888888888888",
-        SUBSCRIPTION_ID: "azure_subscription_id"
-    },
-    customizationsOnRecordings: [
-        (recording) => recording.replace(/"access_token":"[^"]*"/g, `"access_token":"access_token"`)
-    ],
-    queryParametersToSkip: []
-};
-describe("My test", () => {
-    let recorder;
-    beforeEach(function () {
-        return __awaiter(this, void 0, void 0, function* () {
-            recorder = record(this, recorderEnvSetup);
-        });
-    });
-    afterEach(function () {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield recorder.stop();
-        });
-    });
-    it("sample test", function () {
-        return __awaiter(this, void 0, void 0, function* () {
-            console.log("Hi, I'm a test!");
-        });
-    });
-});
-//# sourceMappingURL=sampleTest.js.map

package/dist-esm/test/sampleTest.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sampleTest.js","sourceRoot":"","sources":["../../test/sampleTest.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;;AAEH,OAAO,EAEL,MAAM,EAGP,MAAM,4BAA4B,CAAC;AAGpC,MAAM,gBAAgB,GAA6B;IACjD,oBAAoB,EAAE;QACpB,eAAe,EAAE,iBAAiB;QAClC,mBAAmB,EAAE,qBAAqB;QAC1C,eAAe,EAAE,sCAAsC;QACvD,eAAe,EAAE,uBAAuB;KACzC;IACD,0BAA0B,EAAE;QAC1B,CAAC,SAAc,EAAO,EAAE,CACtB,SAAS,CAAC,OAAO,CACf,yBAAyB,EACzB,+BAA+B,CAChC;KACJ;IACD,qBAAqB,EAAE,EAAE;CAC1B,CAAC;AAEF,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,IAAI,QAAkB,CAAC;IAEvB,UAAU,CAAC;;YACT,QAAQ,GAAG,MAAM,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QAC5C,CAAC;KAAA,CAAC,CAAC;IAEH,SAAS,CAAC;;YACR,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACxB,CAAC;KAAA,CAAC,CAAC;IAEH,EAAE,CAAC,aAAa,EAAE;;YAChB,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACjC,CAAC;KAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}