Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountSasParameters

Package version

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.

Hierarchy

  • AccountSasParameters

Index

Properties

expiry

expiry: string

The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z"

maxRatePerSecond

maxRatePerSecond: number

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.

principalId

principalId: string

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.

Optional regions

regions: 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.

signingKey

signingKey: SigningKey

The Map account key to use for signing.

start

start: string

The date time offset of when the token validity begins. For example "2017-05-24T10:42:03.1567373Z".

Generated using TypeDoc