@azure/arm-maps package

Classes

AzureMapsManagementClient

Interfaces

AccountSasParameters	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.
Accounts	Interface representing a Accounts.
AccountsCreateOrUpdateOptionalParams	Optional parameters.
AccountsDeleteOptionalParams	Optional parameters.
AccountsGetOptionalParams	Optional parameters.
AccountsListByResourceGroupNextOptionalParams	Optional parameters.
AccountsListByResourceGroupOptionalParams	Optional parameters.
AccountsListBySubscriptionNextOptionalParams	Optional parameters.
AccountsListBySubscriptionOptionalParams	Optional parameters.
AccountsListKeysOptionalParams	Optional parameters.
AccountsListSasOptionalParams	Optional parameters.
AccountsRegenerateKeysOptionalParams	Optional parameters.
AccountsUpdateOptionalParams	Optional parameters.
AzureMapsManagementClientOptionalParams	Optional parameters.
CorsRule	Specifies a CORS rule for the Map Account.
CorsRules	Sets the CORS rules. You can include up to five CorsRule elements in the request.
Creator	An Azure resource which represents Maps Creator product and provides ability to manage private location data.
CreatorList	A list of Creator resources.
CreatorProperties	Creator resource properties
CreatorUpdateParameters	Parameters used to update an existing Creator resource.
Creators	Interface representing a Creators.
CreatorsCreateOrUpdateOptionalParams	Optional parameters.
CreatorsDeleteOptionalParams	Optional parameters.
CreatorsGetOptionalParams	Optional parameters.
CreatorsListByAccountNextOptionalParams	Optional parameters.
CreatorsListByAccountOptionalParams	Optional parameters.
CreatorsUpdateOptionalParams	Optional parameters.
CustomerManagedKeyEncryption	All Customer-managed key encryption properties for the resource.
CustomerManagedKeyEncryptionKeyIdentity	All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
Dimension	Dimension of map account, for example API Category, Api Name, Result Type, and Response Code.
Encryption	(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.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
LinkedResource	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.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
Maps	Interface representing a Maps.
MapsAccount	An Azure resource which represents access to a suite of Maps REST APIs.
MapsAccountKeys	The set of keys which can be used to access the Maps REST APIs. Two keys are provided for key rotation without interruption.
MapsAccountProperties	Additional Map account properties
MapsAccountSasToken	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.
MapsAccountUpdateParameters	Parameters used to update an existing Maps Account.
MapsAccounts	A list of Maps Accounts.
MapsKeySpecification	Whether the operation refers to the primary or secondary key.
MapsListOperationsNextOptionalParams	Optional parameters.
MapsListOperationsOptionalParams	Optional parameters.
MapsListSubscriptionOperationsNextOptionalParams	Optional parameters.
MapsListSubscriptionOperationsOptionalParams	Optional parameters.
MapsOperations	The set of operations available for Maps.
MetricSpecification	Metric specification of operation.
OperationDetail	Operation detail payload
OperationDisplay	Operation display payload
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ServiceSpecification	One property of operation, include metric specifications.
Sku	The SKU of the Maps Account.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserAssignedIdentity	User assigned identity properties

Type Aliases

AccountsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
AccountsGetResponse	Contains response data for the get operation.
AccountsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
AccountsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
AccountsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
AccountsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
AccountsListKeysResponse	Contains response data for the listKeys operation.
AccountsListSasResponse	Contains response data for the listSas operation.
AccountsRegenerateKeysResponse	Contains response data for the regenerateKeys operation.
AccountsUpdateResponse	Contains response data for the update operation.
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
CreatorsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
CreatorsGetResponse	Contains response data for the get operation.
CreatorsListByAccountNextResponse	Contains response data for the listByAccountNext operation.
CreatorsListByAccountResponse	Contains response data for the listByAccount operation.
CreatorsUpdateResponse	Contains response data for the update operation.
IdentityType	Defines values for IdentityType. 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
InfrastructureEncryption	Defines values for InfrastructureEncryption. 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
KeyType	Defines values for KeyType. KnownKeyType can be used interchangeably with KeyType, this enum contains the known values that the service supports. Known values supported by the service primary secondary
Kind	Defines values for Kind. KnownKind can be used interchangeably with Kind, this enum contains the known values that the service supports. Known values supported by the service Gen1 Gen2
ManagedServiceIdentityType	Defines values for ManagedServiceIdentityType. 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
MapsListOperationsNextResponse	Contains response data for the listOperationsNext operation.
MapsListOperationsResponse	Contains response data for the listOperations operation.
MapsListSubscriptionOperationsNextResponse	Contains response data for the listSubscriptionOperationsNext operation.
MapsListSubscriptionOperationsResponse	Contains response data for the listSubscriptionOperations operation.
Name	Defines values for Name. KnownName can be used interchangeably with Name, this enum contains the known values that the service supports. Known values supported by the service S0 S1 G2
SigningKey	Defines values for SigningKey. 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 managedIdentity

Enums

KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownIdentityType	Known values of IdentityType that the service accepts.
KnownInfrastructureEncryption	Known values of InfrastructureEncryption that the service accepts.
KnownKeyType	Known values of KeyType that the service accepts.
KnownKind	Known values of Kind that the service accepts.
KnownManagedServiceIdentityType	Known values of ManagedServiceIdentityType that the service accepts.
KnownName	Known values of Name that the service accepts.
KnownSigningKey	Known values of SigningKey that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.