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.

maps

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.maps.Account(resource_name, opts=None, name=None, resource_group_name=None, sku_name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an Azure Maps Account.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.maps.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    sku_name="S1",
    tags={
        "environment": "Test",
    })
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the Azure Maps Account. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[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 (pulumi.Input[str]) – The sku of the Azure Maps Account. Possible values are S0 and S1.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the Azure Maps Account.

name: pulumi.Output[str] = None

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

primary_access_key: pulumi.Output[str] = None

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

resource_group_name: pulumi.Output[str] = None

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: pulumi.Output[str] = None

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

sku_name: pulumi.Output[str] = None

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

tags: pulumi.Output[dict] = None

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

x_ms_client_id: pulumi.Output[str] = None

A unique identifier for the Maps Account.

static get(resource_name, id, opts=None, name=None, primary_access_key=None, resource_group_name=None, secondary_access_key=None, sku_name=None, tags=None, x_ms_client_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the Azure Maps Account. Changing this forces a new resource to be created.

  • primary_access_key (pulumi.Input[str]) – The primary key used to authenticate and authorize access to the Maps REST APIs.

  • resource_group_name (pulumi.Input[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 (pulumi.Input[str]) – The secondary key used to authenticate and authorize access to the Maps REST APIs.

  • sku_name (pulumi.Input[str]) – The sku of the Azure Maps Account. Possible values are S0 and S1.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the Azure Maps Account.

  • x_ms_client_id (pulumi.Input[str]) – A unique identifier for the Maps Account.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.maps.AwaitableGetAccountResult(id=None, name=None, primary_access_key=None, resource_group_name=None, secondary_access_key=None, sku_name=None, tags=None, x_ms_client_id=None)
class pulumi_azure.maps.GetAccountResult(id=None, name=None, primary_access_key=None, resource_group_name=None, secondary_access_key=None, sku_name=None, tags=None, x_ms_client_id=None)

A collection of values returned by getAccount.

id = None

The provider-assigned unique ID for this managed resource.

primary_access_key = None

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

secondary_access_key = None

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

sku_name = None

The sku of the Azure Maps Account.

x_ms_client_id = None

A unique identifier for the Maps Account.

pulumi_azure.maps.get_account(name=None, resource_group_name=None, tags=None, opts=None)

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

import pulumi
import pulumi_azure as azure

example = azure.maps.get_account(name="production",
    resource_group_name="maps")
pulumi.export("mapsAccountId", example.id)
Parameters
  • name (str) – Specifies the name of the Maps Account.

  • resource_group_name (str) – Specifies the name of the Resource Group in which the Maps Account is located.