1. Packages
  2. Azure Native v2
  3. API Docs
  4. maps
  5. PrivateAtlase
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.PrivateAtlase

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

An Azure resource which represents which will provision the ability to create private location data. Azure REST API version: 2020-02-01-preview. Prior API version in Azure Native 1.x: 2020-02-01-preview.

Example Usage

CreatePrivateAtlas

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var privateAtlase = new AzureNative.Maps.PrivateAtlase("privateAtlase", new()
    {
        AccountName = "myMapsAccount",
        Location = "unitedstates",
        PrivateAtlasName = "myPrivateAtlas",
        ResourceGroupName = "myResourceGroup",
        Tags = 
        {
            { "test", "true" },
        },
    });

});
Copy
package main

import (
	maps "github.com/pulumi/pulumi-azure-native-sdk/maps/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := maps.NewPrivateAtlase(ctx, "privateAtlase", &maps.PrivateAtlaseArgs{
			AccountName:       pulumi.String("myMapsAccount"),
			Location:          pulumi.String("unitedstates"),
			PrivateAtlasName:  pulumi.String("myPrivateAtlas"),
			ResourceGroupName: pulumi.String("myResourceGroup"),
			Tags: pulumi.StringMap{
				"test": pulumi.String("true"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.maps.PrivateAtlase;
import com.pulumi.azurenative.maps.PrivateAtlaseArgs;
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 privateAtlase = new PrivateAtlase("privateAtlase", PrivateAtlaseArgs.builder()
            .accountName("myMapsAccount")
            .location("unitedstates")
            .privateAtlasName("myPrivateAtlas")
            .resourceGroupName("myResourceGroup")
            .tags(Map.of("test", "true"))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const privateAtlase = new azure_native.maps.PrivateAtlase("privateAtlase", {
    accountName: "myMapsAccount",
    location: "unitedstates",
    privateAtlasName: "myPrivateAtlas",
    resourceGroupName: "myResourceGroup",
    tags: {
        test: "true",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

private_atlase = azure_native.maps.PrivateAtlase("privateAtlase",
    account_name="myMapsAccount",
    location="unitedstates",
    private_atlas_name="myPrivateAtlas",
    resource_group_name="myResourceGroup",
    tags={
        "test": "true",
    })
Copy
resources:
  privateAtlase:
    type: azure-native:maps:PrivateAtlase
    properties:
      accountName: myMapsAccount
      location: unitedstates
      privateAtlasName: myPrivateAtlas
      resourceGroupName: myResourceGroup
      tags:
        test: 'true'
Copy

Create PrivateAtlase Resource

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

Constructor syntax

new PrivateAtlase(name: string, args: PrivateAtlaseArgs, opts?: CustomResourceOptions);
@overload
def PrivateAtlase(resource_name: str,
                  args: PrivateAtlaseArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def PrivateAtlase(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  account_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  location: Optional[str] = None,
                  private_atlas_name: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
func NewPrivateAtlase(ctx *Context, name string, args PrivateAtlaseArgs, opts ...ResourceOption) (*PrivateAtlase, error)
public PrivateAtlase(string name, PrivateAtlaseArgs args, CustomResourceOptions? opts = null)
public PrivateAtlase(String name, PrivateAtlaseArgs args)
public PrivateAtlase(String name, PrivateAtlaseArgs args, CustomResourceOptions options)
type: azure-native:maps:PrivateAtlase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

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

var privateAtlaseResource = new AzureNative.Maps.PrivateAtlase("privateAtlaseResource", new()
{
    AccountName = "string",
    ResourceGroupName = "string",
    Location = "string",
    PrivateAtlasName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := maps.NewPrivateAtlase(ctx, "privateAtlaseResource", &maps.PrivateAtlaseArgs{
	AccountName:       "string",
	ResourceGroupName: "string",
	Location:          "string",
	PrivateAtlasName:  "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
})
Copy
var privateAtlaseResource = new PrivateAtlase("privateAtlaseResource", PrivateAtlaseArgs.builder()
    .accountName("string")
    .resourceGroupName("string")
    .location("string")
    .privateAtlasName("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());
Copy
private_atlase_resource = azure_native.maps.PrivateAtlase("privateAtlaseResource",
    account_name=string,
    resource_group_name=string,
    location=string,
    private_atlas_name=string,
    tags={
        string: string,
    })
Copy
const privateAtlaseResource = new azure_native.maps.PrivateAtlase("privateAtlaseResource", {
    accountName: "string",
    resourceGroupName: "string",
    location: "string",
    privateAtlasName: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:maps:PrivateAtlase
properties:
    accountName: string
    location: string
    privateAtlasName: string
    resourceGroupName: string
    tags:
        string: string
Copy

PrivateAtlase Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PrivateAtlase resource accepts the following input properties:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Maps Account.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Location string
The location of the resource.
PrivateAtlasName Changes to this property will trigger replacement. string
The name of the Private Atlas instance.
Tags Dictionary<string, string>
Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Maps Account.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Location string
The location of the resource.
PrivateAtlasName Changes to this property will trigger replacement. string
The name of the Private Atlas instance.
Tags map[string]string
Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Maps Account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
location String
The location of the resource.
privateAtlasName Changes to this property will trigger replacement. String
The name of the Private Atlas instance.
tags Map<String,String>
Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.
accountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Maps Account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
location string
The location of the resource.
privateAtlasName Changes to this property will trigger replacement. string
The name of the Private Atlas instance.
tags {[key: string]: string}
Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.
account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Maps Account.
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.
location str
The location of the resource.
private_atlas_name Changes to this property will trigger replacement. str
The name of the Private Atlas instance.
tags Mapping[str, str]
Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Maps Account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
location String
The location of the resource.
privateAtlasName Changes to this property will trigger replacement. String
The name of the Private Atlas instance.
tags Map<String>
Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Properties Pulumi.AzureNative.Maps.Outputs.PrivateAtlasPropertiesResponse
The Private Atlas resource properties.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Properties PrivateAtlasPropertiesResponse
The Private Atlas resource properties.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
properties PrivateAtlasPropertiesResponse
The Private Atlas resource properties.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
properties PrivateAtlasPropertiesResponse
The Private Atlas resource properties.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
properties PrivateAtlasPropertiesResponse
The Private Atlas resource properties.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
properties Property Map
The Private Atlas resource properties.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

PrivateAtlasPropertiesResponse
, PrivateAtlasPropertiesResponseArgs

ProvisioningState string
The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled
ProvisioningState string
The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled
provisioningState String
The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled
provisioningState string
The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled
provisioning_state str
The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled
provisioningState String
The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:maps:PrivateAtlase myPrivateAtlas /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/privateAtlases/{privateAtlasName} 
Copy

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

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