pulumi-azure-native-kotlin/com.pulumi.azurenative.maps.kotlin/MapsFunctions/listAccountSas

listAccountSas

suspend fun listAccountSas(argument: ListAccountSasPlainArgs): ListAccountSasResult

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 Maps account with the same Azure region as the User Assigned Managed Identity is placed. Uses Azure REST API version 2024-07-01-preview. Other available API versions: 2021-12-01-preview, 2023-06-01, 2023-08-01-preview, 2023-12-01-preview, 2024-01-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native maps [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Return

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.

Parameters

argument

null

suspend fun listAccountSas(accountName: String, expiry: String, maxRatePerSecond: Int, principalId: String, regions: List<String>? = null, resourceGroupName: String, signingKey: Either<String, SigningKey>, start: String): ListAccountSasResult

Return

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.

Parameters

accountName

The name of the Maps Account.

expiry

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.

maxRatePerSecond

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

The principal Id also known as the object Id of a User Assigned Managed Identity currently assigned to the Maps Account. To assign a Managed Identity of the account, use operation Create or Update an assign a User Assigned Identity resource Id.

regions

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.

resourceGroupName

The name of the resource group. The name is case insensitive.

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.

start

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.

See also

.

suspend fun listAccountSas(argument: suspend ListAccountSasPlainArgsBuilder.() -> Unit): ListAccountSasResult

Return

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.

Parameters

argument

Builder for com.pulumi.azurenative.maps.kotlin.inputs.ListAccountSasPlainArgs.

See also

.