1. Packages
  2. Azure Native
  3. API Docs
  4. maps
  5. listAccountSas
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi

azure-native.maps.listAccountSas

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 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.

    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>
    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]
    func ListAccountSas(ctx *Context, args *ListAccountSasArgs, opts ...InvokeOption) (*ListAccountSasResult, error)
    func ListAccountSasOutput(ctx *Context, args *ListAccountSasOutputArgs, opts ...InvokeOption) ListAccountSasResultOutput

    > 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)
    }
    public static CompletableFuture<ListAccountSasResult> listAccountSas(ListAccountSasArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:maps:listAccountSas
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountName string
    The name of the Maps Account.
    Expiry string
    The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z"
    MaxRatePerSecond 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 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 string
    The name of the resource group. The name is case insensitive.
    SigningKey string | Pulumi.AzureNative.Maps.SigningKey
    The Map account key to use for signing.
    Start 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 string
    The name of the Maps Account.
    Expiry string
    The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z"
    MaxRatePerSecond 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 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 string
    The name of the resource group. The name is case insensitive.
    SigningKey string | SigningKey
    The Map account key to use for signing.
    Start 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 String
    The name of the Maps Account.
    expiry String
    The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z"
    maxRatePerSecond 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 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 String
    The name of the resource group. The name is case insensitive.
    signingKey String | SigningKey
    The Map account key to use for signing.
    start 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 string
    The name of the Maps Account.
    expiry string
    The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z"
    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 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 string
    The name of the resource group. The name is case insensitive.
    signingKey string | SigningKey
    The Map account key to use for signing.
    start 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 str
    The name of the Maps Account.
    expiry str
    The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z"
    max_rate_per_second 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 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 str
    The name of the resource group. The name is case insensitive.
    signing_key str | SigningKey
    The Map account key to use for signing.
    start 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 String
    The name of the Maps Account.
    expiry String
    The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z"
    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 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 String
    The name of the resource group. The name is case insensitive.
    signingKey String | "primaryKey" | "secondaryKey"
    The Map account key to use for signing.
    start 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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi