1. Packages
  2. Azure Native v2
  3. API Docs
  4. maps
  5. listAccountSas
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.maps.listAccountSas

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

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 Map account with the same Azure region as the User Assigned Managed Identity is placed. Azure REST API version: 2021-12-01-preview.

Other available API versions: 2023-06-01, 2023-08-01-preview, 2023-12-01-preview, 2024-01-01-preview, 2024-07-01-preview.

Using listAccountSas

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function listAccountSas(args: ListAccountSasArgs, opts?: InvokeOptions): Promise<ListAccountSasResult>
function listAccountSasOutput(args: ListAccountSasOutputArgs, opts?: InvokeOptions): Output<ListAccountSasResult>
Copy
def list_account_sas(account_name: Optional[str] = None,
                     expiry: Optional[str] = None,
                     max_rate_per_second: Optional[int] = None,
                     principal_id: Optional[str] = None,
                     regions: Optional[Sequence[str]] = None,
                     resource_group_name: Optional[str] = None,
                     signing_key: Optional[Union[str, SigningKey]] = None,
                     start: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> ListAccountSasResult
def list_account_sas_output(account_name: Optional[pulumi.Input[str]] = None,
                     expiry: Optional[pulumi.Input[str]] = None,
                     max_rate_per_second: Optional[pulumi.Input[int]] = None,
                     principal_id: Optional[pulumi.Input[str]] = None,
                     regions: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     signing_key: Optional[pulumi.Input[Union[str, SigningKey]]] = None,
                     start: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[ListAccountSasResult]
Copy
func ListAccountSas(ctx *Context, args *ListAccountSasArgs, opts ...InvokeOption) (*ListAccountSasResult, error)
func ListAccountSasOutput(ctx *Context, args *ListAccountSasOutputArgs, opts ...InvokeOption) ListAccountSasResultOutput
Copy

> Note: This function is named ListAccountSas in the Go SDK.

public static class ListAccountSas 
{
    public static Task<ListAccountSasResult> InvokeAsync(ListAccountSasArgs args, InvokeOptions? opts = null)
    public static Output<ListAccountSasResult> Invoke(ListAccountSasInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListAccountSasResult> listAccountSas(ListAccountSasArgs args, InvokeOptions options)
public static Output<ListAccountSasResult> listAccountSas(ListAccountSasArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:maps:listAccountSas
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Maps Account.
Expiry This property is required. string
The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z"
MaxRatePerSecond This property is required. int
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 This property is required. 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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SigningKey This property is required. string | Pulumi.AzureNative.Maps.SigningKey
The Map account key to use for signing.
Start This property is required. string
The date time offset of when the token validity begins. For example "2017-05-24T10:42:03.1567373Z".
Regions List<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.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Maps Account.
Expiry This property is required. string
The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z"
MaxRatePerSecond This property is required. int
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 This property is required. 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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SigningKey This property is required. string | SigningKey
The Map account key to use for signing.
Start This property is required. string
The date time offset of when the token validity begins. For example "2017-05-24T10:42:03.1567373Z".
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.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Maps Account.
expiry This property is required. String
The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z"
maxRatePerSecond This property is required. Integer
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 This property is required. 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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
signingKey This property is required. String | SigningKey
The Map account key to use for signing.
start This property is required. String
The date time offset of when the token validity begins. For example "2017-05-24T10:42:03.1567373Z".
regions List<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.
accountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Maps Account.
expiry This property is required. string
The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z"
maxRatePerSecond This property is required. 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 This property is required. 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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
signingKey This property is required. string | SigningKey
The Map account key to use for signing.
start This property is required. string
The date time offset of when the token validity begins. For example "2017-05-24T10:42:03.1567373Z".
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.
account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Maps Account.
expiry This property is required. str
The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z"
max_rate_per_second This property is required. int
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.
principal_id This property is required. str
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.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
signing_key This property is required. str | SigningKey
The Map account key to use for signing.
start This property is required. str
The date time offset of when the token validity begins. For example "2017-05-24T10:42:03.1567373Z".
regions Sequence[str]
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.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Maps Account.
expiry This property is required. String
The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z"
maxRatePerSecond This property is required. 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 This property is required. 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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
signingKey This property is required. String | "primaryKey" | "secondaryKey"
The Map account key to use for signing.
start This property is required. String
The date time offset of when the token validity begins. For example "2017-05-24T10:42:03.1567373Z".
regions List<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.

listAccountSas Result

The following output properties are available:

AccountSasToken string
The shared access signature access token.
AccountSasToken string
The shared access signature access token.
accountSasToken String
The shared access signature access token.
accountSasToken string
The shared access signature access token.
account_sas_token str
The shared access signature access token.
accountSasToken String
The shared access signature access token.

Supporting Types

SigningKey

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi