1. Packages
  2. Azure Classic
  3. API Docs
  4. maps
  5. Account

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi

azure.maps.Account

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi

    Manages an Azure Maps Account.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleAccount = new azure.maps.Account("example", {
        name: "example-maps-account",
        resourceGroupName: example.name,
        skuName: "S1",
        localAuthenticationEnabled: true,
        tags: {
            environment: "Test",
        },
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_account = azure.maps.Account("example",
        name="example-maps-account",
        resource_group_name=example.name,
        sku_name="S1",
        local_authentication_enabled=True,
        tags={
            "environment": "Test",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/maps"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = maps.NewAccount(ctx, "example", &maps.AccountArgs{
    			Name:                       pulumi.String("example-maps-account"),
    			ResourceGroupName:          example.Name,
    			SkuName:                    pulumi.String("S1"),
    			LocalAuthenticationEnabled: pulumi.Bool(true),
    			Tags: pulumi.StringMap{
    				"environment": pulumi.String("Test"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleAccount = new Azure.Maps.Account("example", new()
        {
            Name = "example-maps-account",
            ResourceGroupName = example.Name,
            SkuName = "S1",
            LocalAuthenticationEnabled = true,
            Tags = 
            {
                { "environment", "Test" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.maps.Account;
    import com.pulumi.azure.maps.AccountArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()        
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
                .name("example-maps-account")
                .resourceGroupName(example.name())
                .skuName("S1")
                .localAuthenticationEnabled(true)
                .tags(Map.of("environment", "Test"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleAccount:
        type: azure:maps:Account
        name: example
        properties:
          name: example-maps-account
          resourceGroupName: ${example.name}
          skuName: S1
          localAuthenticationEnabled: true
          tags:
            environment: Test
    

    Create Account Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Account(name: string, args: AccountArgs, opts?: CustomResourceOptions);
    @overload
    def Account(resource_name: str,
                args: AccountArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Account(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                resource_group_name: Optional[str] = None,
                sku_name: Optional[str] = None,
                local_authentication_enabled: Optional[bool] = None,
                name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
    func NewAccount(ctx *Context, name string, args AccountArgs, opts ...ResourceOption) (*Account, error)
    public Account(string name, AccountArgs args, CustomResourceOptions? opts = null)
    public Account(String name, AccountArgs args)
    public Account(String name, AccountArgs args, CustomResourceOptions options)
    
    type: azure:maps:Account
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var exampleaccountResourceResourceFromMapsaccount = new Azure.Maps.Account("exampleaccountResourceResourceFromMapsaccount", new()
    {
        ResourceGroupName = "string",
        SkuName = "string",
        LocalAuthenticationEnabled = false,
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := maps.NewAccount(ctx, "exampleaccountResourceResourceFromMapsaccount", &maps.AccountArgs{
    	ResourceGroupName:          pulumi.String("string"),
    	SkuName:                    pulumi.String("string"),
    	LocalAuthenticationEnabled: pulumi.Bool(false),
    	Name:                       pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var exampleaccountResourceResourceFromMapsaccount = new Account("exampleaccountResourceResourceFromMapsaccount", AccountArgs.builder()        
        .resourceGroupName("string")
        .skuName("string")
        .localAuthenticationEnabled(false)
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    exampleaccount_resource_resource_from_mapsaccount = azure.maps.Account("exampleaccountResourceResourceFromMapsaccount",
        resource_group_name="string",
        sku_name="string",
        local_authentication_enabled=False,
        name="string",
        tags={
            "string": "string",
        })
    
    const exampleaccountResourceResourceFromMapsaccount = new azure.maps.Account("exampleaccountResourceResourceFromMapsaccount", {
        resourceGroupName: "string",
        skuName: "string",
        localAuthenticationEnabled: false,
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure:maps:Account
    properties:
        localAuthenticationEnabled: false
        name: string
        resourceGroupName: string
        skuName: string
        tags:
            string: string
    

    Account Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Account resource accepts the following input properties:

    ResourceGroupName string
    The name of the Resource Group in which the Azure Maps Account should exist. Changing this forces a new resource to be created.
    SkuName string

    The SKU of the Azure Maps Account. Possible values are S0, S1 and G2. Changing this forces a new resource to be created.

    Note: Gen1 SKUs (S0 and S1) are deprecated and can no longer be used for new deployments, which should instead use a Gen2 SKU (G2) - more information can be found in the Azure documentation.

    LocalAuthenticationEnabled bool
    Is local authentication enabled for this Azure Maps Account? When false, all authentication to the Azure Maps data-plane REST API is disabled, except Azure AD authentication. Defaults to true.
    Name string
    The name of the Azure Maps Account. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the Azure Maps Account.
    ResourceGroupName string
    The name of the Resource Group in which the Azure Maps Account should exist. Changing this forces a new resource to be created.
    SkuName string

    The SKU of the Azure Maps Account. Possible values are S0, S1 and G2. Changing this forces a new resource to be created.

    Note: Gen1 SKUs (S0 and S1) are deprecated and can no longer be used for new deployments, which should instead use a Gen2 SKU (G2) - more information can be found in the Azure documentation.

    LocalAuthenticationEnabled bool
    Is local authentication enabled for this Azure Maps Account? When false, all authentication to the Azure Maps data-plane REST API is disabled, except Azure AD authentication. Defaults to true.
    Name string
    The name of the Azure Maps Account. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the Azure Maps Account.
    resourceGroupName String
    The name of the Resource Group in which the Azure Maps Account should exist. Changing this forces a new resource to be created.
    skuName String

    The SKU of the Azure Maps Account. Possible values are S0, S1 and G2. Changing this forces a new resource to be created.

    Note: Gen1 SKUs (S0 and S1) are deprecated and can no longer be used for new deployments, which should instead use a Gen2 SKU (G2) - more information can be found in the Azure documentation.

    localAuthenticationEnabled Boolean
    Is local authentication enabled for this Azure Maps Account? When false, all authentication to the Azure Maps data-plane REST API is disabled, except Azure AD authentication. Defaults to true.
    name String
    The name of the Azure Maps Account. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the Azure Maps Account.
    resourceGroupName string
    The name of the Resource Group in which the Azure Maps Account should exist. Changing this forces a new resource to be created.
    skuName string

    The SKU of the Azure Maps Account. Possible values are S0, S1 and G2. Changing this forces a new resource to be created.

    Note: Gen1 SKUs (S0 and S1) are deprecated and can no longer be used for new deployments, which should instead use a Gen2 SKU (G2) - more information can be found in the Azure documentation.

    localAuthenticationEnabled boolean
    Is local authentication enabled for this Azure Maps Account? When false, all authentication to the Azure Maps data-plane REST API is disabled, except Azure AD authentication. Defaults to true.
    name string
    The name of the Azure Maps Account. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the Azure Maps Account.
    resource_group_name str
    The name of the Resource Group in which the Azure Maps Account should exist. Changing this forces a new resource to be created.
    sku_name str

    The SKU of the Azure Maps Account. Possible values are S0, S1 and G2. Changing this forces a new resource to be created.

    Note: Gen1 SKUs (S0 and S1) are deprecated and can no longer be used for new deployments, which should instead use a Gen2 SKU (G2) - more information can be found in the Azure documentation.

    local_authentication_enabled bool
    Is local authentication enabled for this Azure Maps Account? When false, all authentication to the Azure Maps data-plane REST API is disabled, except Azure AD authentication. Defaults to true.
    name str
    The name of the Azure Maps Account. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the Azure Maps Account.
    resourceGroupName String
    The name of the Resource Group in which the Azure Maps Account should exist. Changing this forces a new resource to be created.
    skuName String

    The SKU of the Azure Maps Account. Possible values are S0, S1 and G2. Changing this forces a new resource to be created.

    Note: Gen1 SKUs (S0 and S1) are deprecated and can no longer be used for new deployments, which should instead use a Gen2 SKU (G2) - more information can be found in the Azure documentation.

    localAuthenticationEnabled Boolean
    Is local authentication enabled for this Azure Maps Account? When false, all authentication to the Azure Maps data-plane REST API is disabled, except Azure AD authentication. Defaults to true.
    name String
    The name of the Azure Maps Account. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the Azure Maps Account.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Account resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryAccessKey string
    The primary key used to authenticate and authorize access to the Maps REST APIs.
    SecondaryAccessKey string
    The secondary key used to authenticate and authorize access to the Maps REST APIs.
    XMsClientId string
    A unique identifier for the Maps Account.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryAccessKey string
    The primary key used to authenticate and authorize access to the Maps REST APIs.
    SecondaryAccessKey string
    The secondary key used to authenticate and authorize access to the Maps REST APIs.
    XMsClientId string
    A unique identifier for the Maps Account.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryAccessKey String
    The primary key used to authenticate and authorize access to the Maps REST APIs.
    secondaryAccessKey String
    The secondary key used to authenticate and authorize access to the Maps REST APIs.
    xMsClientId String
    A unique identifier for the Maps Account.
    id string
    The provider-assigned unique ID for this managed resource.
    primaryAccessKey string
    The primary key used to authenticate and authorize access to the Maps REST APIs.
    secondaryAccessKey string
    The secondary key used to authenticate and authorize access to the Maps REST APIs.
    xMsClientId string
    A unique identifier for the Maps Account.
    id str
    The provider-assigned unique ID for this managed resource.
    primary_access_key str
    The primary key used to authenticate and authorize access to the Maps REST APIs.
    secondary_access_key str
    The secondary key used to authenticate and authorize access to the Maps REST APIs.
    x_ms_client_id str
    A unique identifier for the Maps Account.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryAccessKey String
    The primary key used to authenticate and authorize access to the Maps REST APIs.
    secondaryAccessKey String
    The secondary key used to authenticate and authorize access to the Maps REST APIs.
    xMsClientId String
    A unique identifier for the Maps Account.

    Look up Existing Account Resource

    Get an existing Account resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AccountState, opts?: CustomResourceOptions): Account
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            local_authentication_enabled: Optional[bool] = None,
            name: Optional[str] = None,
            primary_access_key: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            secondary_access_key: Optional[str] = None,
            sku_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            x_ms_client_id: Optional[str] = None) -> Account
    func GetAccount(ctx *Context, name string, id IDInput, state *AccountState, opts ...ResourceOption) (*Account, error)
    public static Account Get(string name, Input<string> id, AccountState? state, CustomResourceOptions? opts = null)
    public static Account get(String name, Output<String> id, AccountState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    LocalAuthenticationEnabled bool
    Is local authentication enabled for this Azure Maps Account? When false, all authentication to the Azure Maps data-plane REST API is disabled, except Azure AD authentication. Defaults to true.
    Name string
    The name of the Azure Maps Account. Changing this forces a new resource to be created.
    PrimaryAccessKey string
    The primary key used to authenticate and authorize access to the Maps REST APIs.
    ResourceGroupName string
    The name of the Resource Group in which the Azure Maps Account should exist. Changing this forces a new resource to be created.
    SecondaryAccessKey string
    The secondary key used to authenticate and authorize access to the Maps REST APIs.
    SkuName string

    The SKU of the Azure Maps Account. Possible values are S0, S1 and G2. Changing this forces a new resource to be created.

    Note: Gen1 SKUs (S0 and S1) are deprecated and can no longer be used for new deployments, which should instead use a Gen2 SKU (G2) - more information can be found in the Azure documentation.

    Tags Dictionary<string, string>
    A mapping of tags to assign to the Azure Maps Account.
    XMsClientId string
    A unique identifier for the Maps Account.
    LocalAuthenticationEnabled bool
    Is local authentication enabled for this Azure Maps Account? When false, all authentication to the Azure Maps data-plane REST API is disabled, except Azure AD authentication. Defaults to true.
    Name string
    The name of the Azure Maps Account. Changing this forces a new resource to be created.
    PrimaryAccessKey string
    The primary key used to authenticate and authorize access to the Maps REST APIs.
    ResourceGroupName string
    The name of the Resource Group in which the Azure Maps Account should exist. Changing this forces a new resource to be created.
    SecondaryAccessKey string
    The secondary key used to authenticate and authorize access to the Maps REST APIs.
    SkuName string

    The SKU of the Azure Maps Account. Possible values are S0, S1 and G2. Changing this forces a new resource to be created.

    Note: Gen1 SKUs (S0 and S1) are deprecated and can no longer be used for new deployments, which should instead use a Gen2 SKU (G2) - more information can be found in the Azure documentation.

    Tags map[string]string
    A mapping of tags to assign to the Azure Maps Account.
    XMsClientId string
    A unique identifier for the Maps Account.
    localAuthenticationEnabled Boolean
    Is local authentication enabled for this Azure Maps Account? When false, all authentication to the Azure Maps data-plane REST API is disabled, except Azure AD authentication. Defaults to true.
    name String
    The name of the Azure Maps Account. Changing this forces a new resource to be created.
    primaryAccessKey String
    The primary key used to authenticate and authorize access to the Maps REST APIs.
    resourceGroupName String
    The name of the Resource Group in which the Azure Maps Account should exist. Changing this forces a new resource to be created.
    secondaryAccessKey String
    The secondary key used to authenticate and authorize access to the Maps REST APIs.
    skuName String

    The SKU of the Azure Maps Account. Possible values are S0, S1 and G2. Changing this forces a new resource to be created.

    Note: Gen1 SKUs (S0 and S1) are deprecated and can no longer be used for new deployments, which should instead use a Gen2 SKU (G2) - more information can be found in the Azure documentation.

    tags Map<String,String>
    A mapping of tags to assign to the Azure Maps Account.
    xMsClientId String
    A unique identifier for the Maps Account.
    localAuthenticationEnabled boolean
    Is local authentication enabled for this Azure Maps Account? When false, all authentication to the Azure Maps data-plane REST API is disabled, except Azure AD authentication. Defaults to true.
    name string
    The name of the Azure Maps Account. Changing this forces a new resource to be created.
    primaryAccessKey string
    The primary key used to authenticate and authorize access to the Maps REST APIs.
    resourceGroupName string
    The name of the Resource Group in which the Azure Maps Account should exist. Changing this forces a new resource to be created.
    secondaryAccessKey string
    The secondary key used to authenticate and authorize access to the Maps REST APIs.
    skuName string

    The SKU of the Azure Maps Account. Possible values are S0, S1 and G2. Changing this forces a new resource to be created.

    Note: Gen1 SKUs (S0 and S1) are deprecated and can no longer be used for new deployments, which should instead use a Gen2 SKU (G2) - more information can be found in the Azure documentation.

    tags {[key: string]: string}
    A mapping of tags to assign to the Azure Maps Account.
    xMsClientId string
    A unique identifier for the Maps Account.
    local_authentication_enabled bool
    Is local authentication enabled for this Azure Maps Account? When false, all authentication to the Azure Maps data-plane REST API is disabled, except Azure AD authentication. Defaults to true.
    name str
    The name of the Azure Maps Account. Changing this forces a new resource to be created.
    primary_access_key str
    The primary key used to authenticate and authorize access to the Maps REST APIs.
    resource_group_name str
    The name of the Resource Group in which the Azure Maps Account should exist. Changing this forces a new resource to be created.
    secondary_access_key str
    The secondary key used to authenticate and authorize access to the Maps REST APIs.
    sku_name str

    The SKU of the Azure Maps Account. Possible values are S0, S1 and G2. Changing this forces a new resource to be created.

    Note: Gen1 SKUs (S0 and S1) are deprecated and can no longer be used for new deployments, which should instead use a Gen2 SKU (G2) - more information can be found in the Azure documentation.

    tags Mapping[str, str]
    A mapping of tags to assign to the Azure Maps Account.
    x_ms_client_id str
    A unique identifier for the Maps Account.
    localAuthenticationEnabled Boolean
    Is local authentication enabled for this Azure Maps Account? When false, all authentication to the Azure Maps data-plane REST API is disabled, except Azure AD authentication. Defaults to true.
    name String
    The name of the Azure Maps Account. Changing this forces a new resource to be created.
    primaryAccessKey String
    The primary key used to authenticate and authorize access to the Maps REST APIs.
    resourceGroupName String
    The name of the Resource Group in which the Azure Maps Account should exist. Changing this forces a new resource to be created.
    secondaryAccessKey String
    The secondary key used to authenticate and authorize access to the Maps REST APIs.
    skuName String

    The SKU of the Azure Maps Account. Possible values are S0, S1 and G2. Changing this forces a new resource to be created.

    Note: Gen1 SKUs (S0 and S1) are deprecated and can no longer be used for new deployments, which should instead use a Gen2 SKU (G2) - more information can be found in the Azure documentation.

    tags Map<String>
    A mapping of tags to assign to the Azure Maps Account.
    xMsClientId String
    A unique identifier for the Maps Account.

    Import

    A Maps Account can be imported using the resource id, e.g.

    $ pulumi import azure:maps/account:Account example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Maps/accounts/my-maps-account
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi