@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.
AccountsCreateOrUpdateOptionalParams	Optional parameters.
AccountsDeleteOptionalParams	Optional parameters.
AccountsGetOptionalParams	Optional parameters.
AccountsListByResourceGroupOptionalParams	Optional parameters.
AccountsListBySubscriptionOptionalParams	Optional parameters.
AccountsListKeysOptionalParams	Optional parameters.
AccountsListSasOptionalParams	Optional parameters.
AccountsOperations	Interface representing a Accounts operations.
AccountsRegenerateKeysOptionalParams	Optional parameters.
AccountsUpdateOptionalParams	Optional parameters.
AzureMapsManagementClientOptionalParams	Optional parameters for the client.
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.
CreatorProperties	Creator resource properties
CreatorUpdateParameters	Parameters used to update an existing Creator resource.
CreatorsCreateOrUpdateOptionalParams	Optional parameters.
CreatorsDeleteOptionalParams	Optional parameters.
CreatorsGetOptionalParams	Optional parameters.
CreatorsListByAccountOptionalParams	Optional parameters.
CreatorsOperations	Interface representing a Creators operations.
CreatorsUpdateOptionalParams	Optional parameters.
CustomerManagedKeyEncryption	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.
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.
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.
LocationsItem	Data processing location.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
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 Maps 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.
MapsKeySpecification	Whether the operation refers to the primary or secondary key.
MapsListOperationsOptionalParams	Optional parameters.
MapsOperations	Interface representing a Maps operations.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationResultGetOptionalParams	Optional parameters.
OperationResultOperations	Interface representing a OperationResult operations.
OperationStatusGetOptionalParams	Optional parameters.
OperationStatusOperations	Interface representing a OperationStatus operations.
OperationStatusResult	The current status of an async operation.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnection	The private endpoint connection resource.
PrivateEndpointConnectionProperties	Properties of the private endpoint connection.
PrivateEndpointConnectionsCreateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByAccountOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateLinkResource	A private link resource.
PrivateLinkResourceProperties	Properties of a private link resource.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListByAccountOptionalParams	Optional parameters.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SimplePollerLike	A simple poller that can be used to poll a long running operation.
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

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
IdentityType	The type of identity to use. KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports. Known values supported by the service systemAssignedIdentity: System assigned identity userAssignedIdentity: User assigned identity delegatedResourceIdentity: Delegated identity
InfrastructureEncryption	(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. KnownInfrastructureEncryption can be used interchangeably with InfrastructureEncryption, this enum contains the known values that the service supports. Known values supported by the service enabled: Encryption is enabled disabled: Encryption is disabled
KeyType	Whether the operation refers to the primary or secondary key. KnownKeyType can be used interchangeably with KeyType, this enum contains the known values that the service supports. Known values supported by the service primary: primary secondary: secondary
Kind	The Kind of the Maps Account. KnownKind can be used interchangeably with Kind, this enum contains the known values that the service supports. Known values supported by the service Gen2: Gen2
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
Name	The name of the SKU, in standard format (such as G2). KnownName can be used interchangeably with Name, this enum contains the known values that the service supports. Known values supported by the service G2: G2
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
PrivateEndpointConnectionProvisioningState	The current provisioning state. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Connection has been provisioned Creating: Connection is being created Deleting: Connection is being deleted Failed: Connection provisioning has failed
PrivateEndpointServiceConnectionStatus	The private endpoint connection status. KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending: Connection waiting for approval or rejection Approved: Connection approved Rejected: Connection Rejected
PublicNetworkAccess	Property to specify whether the Maps Account will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service enabled: enabled disabled: disabled
SigningKey	The Maps account key to use for signing. Picking primaryKey or secondaryKey will use the Maps account Shared Keys, and using managedIdentity will use the auto-renewed private key to sign the SAS. KnownSigningKey can be used interchangeably with SigningKey, this enum contains the known values that the service supports. Known values supported by the service primaryKey: primaryKey secondaryKey: secondaryKey managedIdentity: managedIdentity

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownCreatedByType	The kind of entity that created the resource.
KnownIdentityType	The type of identity to use.
KnownInfrastructureEncryption	(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.
KnownKeyType	Whether the operation refers to the primary or secondary key.
KnownKind	The Kind of the Maps Account.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownName	The name of the SKU, in standard format (such as G2).
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownPrivateEndpointConnectionProvisioningState	The current provisioning state.
KnownPrivateEndpointServiceConnectionStatus	The private endpoint connection status.
KnownPublicNetworkAccess	Property to specify whether the Maps Account will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked.
KnownSigningKey	The Maps account key to use for signing. Picking primaryKey or secondaryKey will use the Maps account Shared Keys, and using managedIdentity will use the auto-renewed private key to sign the SAS.
KnownVersions	The available API versions.

Functions

restorePoller<TResponse, TResult>(AzureMapsManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(AzureMapsManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: AzureMapsManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

AzureMapsManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>