1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. maps

Module maps

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Functions

Others

Resources

Resource Account

class Account extends CustomResource

Manages an Azure Maps Account.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.maps.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    skuName: "S1",
    tags: {
        environment: "Test",
    },
});

constructor

new Account(name: string, args: AccountArgs, opts?: pulumi.CustomResourceOptions)

Create a Account resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AccountState, opts?: pulumi.CustomResourceOptions): Account

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Account

Returns true if the given object is an instance of Account. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the Azure Maps Account. Changing this forces a new resource to be created.

property primaryAccessKey

public primaryAccessKey: pulumi.Output<string>;

The primary key used to authenticate and authorize access to the Maps REST APIs.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property secondaryAccessKey

public secondaryAccessKey: pulumi.Output<string>;

The secondary key used to authenticate and authorize access to the Maps REST APIs.

property skuName

public skuName: pulumi.Output<string>;

The sku of the Azure Maps Account. Possible values are S0 and S1.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the Azure Maps Account.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property xMsClientId

public xMsClientId: pulumi.Output<string>;

A unique identifier for the Maps Account.

Functions

Function getAccount

getAccount(args: GetAccountArgs, opts?: pulumi.InvokeOptions): Promise<GetAccountResult>

Use this data source to access information about an existing Azure Maps Account.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.maps.getAccount({
    name: "production",
    resourceGroupName: "maps",
});
export const mapsAccountId = example.then(example => example.id);

Others

interface AccountArgs

interface AccountArgs

The set of arguments for constructing a Account resource.

property name

name?: pulumi.Input<string>;

The name of the Azure Maps Account. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property skuName

skuName: pulumi.Input<string>;

The sku of the Azure Maps Account. Possible values are S0 and S1.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the Azure Maps Account.

interface AccountState

interface AccountState

Input properties used for looking up and filtering Account resources.

property name

name?: pulumi.Input<string>;

The name of the Azure Maps Account. Changing this forces a new resource to be created.

property primaryAccessKey

primaryAccessKey?: pulumi.Input<string>;

The primary key used to authenticate and authorize access to the Maps REST APIs.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property secondaryAccessKey

secondaryAccessKey?: pulumi.Input<string>;

The secondary key used to authenticate and authorize access to the Maps REST APIs.

property skuName

skuName?: pulumi.Input<string>;

The sku of the Azure Maps Account. Possible values are S0 and S1.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the Azure Maps Account.

property xMsClientId

xMsClientId?: pulumi.Input<string>;

A unique identifier for the Maps Account.

interface GetAccountArgs

interface GetAccountArgs

A collection of arguments for invoking getAccount.

property name

name: string;

Specifies the name of the Maps Account.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the Resource Group in which the Maps Account is located.

property tags

tags?: undefined | {[key: string]: string};

interface GetAccountResult

interface GetAccountResult

A collection of values returned by getAccount.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property primaryAccessKey

primaryAccessKey: string;

The primary key used to authenticate and authorize access to the Maps REST APIs.

property resourceGroupName

resourceGroupName: string;

property secondaryAccessKey

secondaryAccessKey: string;

The primary key used to authenticate and authorize access to the Maps REST APIs. The second key is given to provide seamless key regeneration.

property skuName

skuName: string;

The sku of the Azure Maps Account.

property tags

tags?: undefined | {[key: string]: string};

property xMsClientId

xMsClientId: string;

A unique identifier for the Maps Account.