maps

package
v4.42.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 15, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Account

type Account struct {
	pulumi.CustomResourceState

	// The name of the Azure Maps Account. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The primary key used to authenticate and authorize access to the Maps REST APIs.
	PrimaryAccessKey pulumi.StringOutput `pulumi:"primaryAccessKey"`
	// The name of the Resource Group in which the Azure Maps Account should exist. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// The secondary key used to authenticate and authorize access to the Maps REST APIs.
	SecondaryAccessKey pulumi.StringOutput `pulumi:"secondaryAccessKey"`
	// The sku of the Azure Maps Account. Possible values are `S0`, `S1` and `G2`.
	SkuName pulumi.StringOutput `pulumi:"skuName"`
	// A mapping of tags to assign to the Azure Maps Account.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A unique identifier for the Maps Account.
	XMsClientId pulumi.StringOutput `pulumi:"xMsClientId"`
}

Manages an Azure Maps Account.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/maps"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = maps.NewAccount(ctx, "exampleAccount", &maps.AccountArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			SkuName:           pulumi.String("S1"),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Test"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

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

```sh

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

```

func GetAccount

func GetAccount(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AccountState, opts ...pulumi.ResourceOption) (*Account, error)

GetAccount gets an existing Account resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAccount

func NewAccount(ctx *pulumi.Context,
	name string, args *AccountArgs, opts ...pulumi.ResourceOption) (*Account, error)

NewAccount registers a new resource with the given unique name, arguments, and options.

func (*Account) ElementType

func (*Account) ElementType() reflect.Type

func (*Account) ToAccountOutput

func (i *Account) ToAccountOutput() AccountOutput

func (*Account) ToAccountOutputWithContext

func (i *Account) ToAccountOutputWithContext(ctx context.Context) AccountOutput

type AccountArgs

type AccountArgs struct {
	// The name of the Azure Maps Account. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the Resource Group in which the Azure Maps Account should exist. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringInput
	// The sku of the Azure Maps Account. Possible values are `S0`, `S1` and `G2`.
	SkuName pulumi.StringInput
	// A mapping of tags to assign to the Azure Maps Account.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Account resource.

func (AccountArgs) ElementType

func (AccountArgs) ElementType() reflect.Type

type AccountArray

type AccountArray []AccountInput

func (AccountArray) ElementType

func (AccountArray) ElementType() reflect.Type

func (AccountArray) ToAccountArrayOutput

func (i AccountArray) ToAccountArrayOutput() AccountArrayOutput

func (AccountArray) ToAccountArrayOutputWithContext

func (i AccountArray) ToAccountArrayOutputWithContext(ctx context.Context) AccountArrayOutput

type AccountArrayInput

type AccountArrayInput interface {
	pulumi.Input

	ToAccountArrayOutput() AccountArrayOutput
	ToAccountArrayOutputWithContext(context.Context) AccountArrayOutput
}

AccountArrayInput is an input type that accepts AccountArray and AccountArrayOutput values. You can construct a concrete instance of `AccountArrayInput` via:

AccountArray{ AccountArgs{...} }

type AccountArrayOutput

type AccountArrayOutput struct{ *pulumi.OutputState }

func (AccountArrayOutput) ElementType

func (AccountArrayOutput) ElementType() reflect.Type

func (AccountArrayOutput) Index

func (AccountArrayOutput) ToAccountArrayOutput

func (o AccountArrayOutput) ToAccountArrayOutput() AccountArrayOutput

func (AccountArrayOutput) ToAccountArrayOutputWithContext

func (o AccountArrayOutput) ToAccountArrayOutputWithContext(ctx context.Context) AccountArrayOutput

type AccountInput

type AccountInput interface {
	pulumi.Input

	ToAccountOutput() AccountOutput
	ToAccountOutputWithContext(ctx context.Context) AccountOutput
}

type AccountMap

type AccountMap map[string]AccountInput

func (AccountMap) ElementType

func (AccountMap) ElementType() reflect.Type

func (AccountMap) ToAccountMapOutput

func (i AccountMap) ToAccountMapOutput() AccountMapOutput

func (AccountMap) ToAccountMapOutputWithContext

func (i AccountMap) ToAccountMapOutputWithContext(ctx context.Context) AccountMapOutput

type AccountMapInput

type AccountMapInput interface {
	pulumi.Input

	ToAccountMapOutput() AccountMapOutput
	ToAccountMapOutputWithContext(context.Context) AccountMapOutput
}

AccountMapInput is an input type that accepts AccountMap and AccountMapOutput values. You can construct a concrete instance of `AccountMapInput` via:

AccountMap{ "key": AccountArgs{...} }

type AccountMapOutput

type AccountMapOutput struct{ *pulumi.OutputState }

func (AccountMapOutput) ElementType

func (AccountMapOutput) ElementType() reflect.Type

func (AccountMapOutput) MapIndex

func (AccountMapOutput) ToAccountMapOutput

func (o AccountMapOutput) ToAccountMapOutput() AccountMapOutput

func (AccountMapOutput) ToAccountMapOutputWithContext

func (o AccountMapOutput) ToAccountMapOutputWithContext(ctx context.Context) AccountMapOutput

type AccountOutput

type AccountOutput struct{ *pulumi.OutputState }

func (AccountOutput) ElementType

func (AccountOutput) ElementType() reflect.Type

func (AccountOutput) ToAccountOutput

func (o AccountOutput) ToAccountOutput() AccountOutput

func (AccountOutput) ToAccountOutputWithContext

func (o AccountOutput) ToAccountOutputWithContext(ctx context.Context) AccountOutput

type AccountState

type AccountState struct {
	// The name of the Azure Maps Account. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The primary key used to authenticate and authorize access to the Maps REST APIs.
	PrimaryAccessKey pulumi.StringPtrInput
	// The name of the Resource Group in which the Azure Maps Account should exist. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringPtrInput
	// The secondary key used to authenticate and authorize access to the Maps REST APIs.
	SecondaryAccessKey pulumi.StringPtrInput
	// The sku of the Azure Maps Account. Possible values are `S0`, `S1` and `G2`.
	SkuName pulumi.StringPtrInput
	// A mapping of tags to assign to the Azure Maps Account.
	Tags pulumi.StringMapInput
	// A unique identifier for the Maps Account.
	XMsClientId pulumi.StringPtrInput
}

func (AccountState) ElementType

func (AccountState) ElementType() reflect.Type

type Creator added in v4.32.0

type Creator struct {
	pulumi.CustomResourceState

	// The Azure Region where the Azure Maps Creator should exist.
	Location pulumi.StringOutput `pulumi:"location"`
	// The ID of the Azure Maps Creator. Changing this forces a new resource to be created.
	MapsAccountId pulumi.StringOutput `pulumi:"mapsAccountId"`
	// The name of the Azure Maps Creator. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The storage units to be allocated. Integer values from 1 to 100, inclusive.
	StorageUnits pulumi.IntOutput `pulumi:"storageUnits"`
	// A mapping of tags which should be assigned to the Azure Maps Creator.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Manages an Azure Maps Creator.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/maps"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := maps.NewAccount(ctx, "exampleAccount", &maps.AccountArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			SkuName:           pulumi.String("G2"),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Test"),
			},
		})
		if err != nil {
			return err
		}
		_, err = maps.NewCreator(ctx, "exampleCreator", &maps.CreatorArgs{
			MapsAccountId: exampleAccount.ID(),
			Location:      exampleResourceGroup.Location,
			StorageUnits:  pulumi.Int(1),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Test"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

An Azure Maps Creators can be imported using the `resource id`, e.g.

```sh

$ pulumi import azure:maps/creator:Creator example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Maps/accounts/account1/creators/creator1

```

func GetCreator added in v4.32.0

func GetCreator(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CreatorState, opts ...pulumi.ResourceOption) (*Creator, error)

GetCreator gets an existing Creator resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCreator added in v4.32.0

func NewCreator(ctx *pulumi.Context,
	name string, args *CreatorArgs, opts ...pulumi.ResourceOption) (*Creator, error)

NewCreator registers a new resource with the given unique name, arguments, and options.

func (*Creator) ElementType added in v4.32.0

func (*Creator) ElementType() reflect.Type

func (*Creator) ToCreatorOutput added in v4.32.0

func (i *Creator) ToCreatorOutput() CreatorOutput

func (*Creator) ToCreatorOutputWithContext added in v4.32.0

func (i *Creator) ToCreatorOutputWithContext(ctx context.Context) CreatorOutput

type CreatorArgs added in v4.32.0

type CreatorArgs struct {
	// The Azure Region where the Azure Maps Creator should exist.
	Location pulumi.StringPtrInput
	// The ID of the Azure Maps Creator. Changing this forces a new resource to be created.
	MapsAccountId pulumi.StringInput
	// The name of the Azure Maps Creator. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The storage units to be allocated. Integer values from 1 to 100, inclusive.
	StorageUnits pulumi.IntInput
	// A mapping of tags which should be assigned to the Azure Maps Creator.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Creator resource.

func (CreatorArgs) ElementType added in v4.32.0

func (CreatorArgs) ElementType() reflect.Type

type CreatorArray added in v4.32.0

type CreatorArray []CreatorInput

func (CreatorArray) ElementType added in v4.32.0

func (CreatorArray) ElementType() reflect.Type

func (CreatorArray) ToCreatorArrayOutput added in v4.32.0

func (i CreatorArray) ToCreatorArrayOutput() CreatorArrayOutput

func (CreatorArray) ToCreatorArrayOutputWithContext added in v4.32.0

func (i CreatorArray) ToCreatorArrayOutputWithContext(ctx context.Context) CreatorArrayOutput

type CreatorArrayInput added in v4.32.0

type CreatorArrayInput interface {
	pulumi.Input

	ToCreatorArrayOutput() CreatorArrayOutput
	ToCreatorArrayOutputWithContext(context.Context) CreatorArrayOutput
}

CreatorArrayInput is an input type that accepts CreatorArray and CreatorArrayOutput values. You can construct a concrete instance of `CreatorArrayInput` via:

CreatorArray{ CreatorArgs{...} }

type CreatorArrayOutput added in v4.32.0

type CreatorArrayOutput struct{ *pulumi.OutputState }

func (CreatorArrayOutput) ElementType added in v4.32.0

func (CreatorArrayOutput) ElementType() reflect.Type

func (CreatorArrayOutput) Index added in v4.32.0

func (CreatorArrayOutput) ToCreatorArrayOutput added in v4.32.0

func (o CreatorArrayOutput) ToCreatorArrayOutput() CreatorArrayOutput

func (CreatorArrayOutput) ToCreatorArrayOutputWithContext added in v4.32.0

func (o CreatorArrayOutput) ToCreatorArrayOutputWithContext(ctx context.Context) CreatorArrayOutput

type CreatorInput added in v4.32.0

type CreatorInput interface {
	pulumi.Input

	ToCreatorOutput() CreatorOutput
	ToCreatorOutputWithContext(ctx context.Context) CreatorOutput
}

type CreatorMap added in v4.32.0

type CreatorMap map[string]CreatorInput

func (CreatorMap) ElementType added in v4.32.0

func (CreatorMap) ElementType() reflect.Type

func (CreatorMap) ToCreatorMapOutput added in v4.32.0

func (i CreatorMap) ToCreatorMapOutput() CreatorMapOutput

func (CreatorMap) ToCreatorMapOutputWithContext added in v4.32.0

func (i CreatorMap) ToCreatorMapOutputWithContext(ctx context.Context) CreatorMapOutput

type CreatorMapInput added in v4.32.0

type CreatorMapInput interface {
	pulumi.Input

	ToCreatorMapOutput() CreatorMapOutput
	ToCreatorMapOutputWithContext(context.Context) CreatorMapOutput
}

CreatorMapInput is an input type that accepts CreatorMap and CreatorMapOutput values. You can construct a concrete instance of `CreatorMapInput` via:

CreatorMap{ "key": CreatorArgs{...} }

type CreatorMapOutput added in v4.32.0

type CreatorMapOutput struct{ *pulumi.OutputState }

func (CreatorMapOutput) ElementType added in v4.32.0

func (CreatorMapOutput) ElementType() reflect.Type

func (CreatorMapOutput) MapIndex added in v4.32.0

func (CreatorMapOutput) ToCreatorMapOutput added in v4.32.0

func (o CreatorMapOutput) ToCreatorMapOutput() CreatorMapOutput

func (CreatorMapOutput) ToCreatorMapOutputWithContext added in v4.32.0

func (o CreatorMapOutput) ToCreatorMapOutputWithContext(ctx context.Context) CreatorMapOutput

type CreatorOutput added in v4.32.0

type CreatorOutput struct{ *pulumi.OutputState }

func (CreatorOutput) ElementType added in v4.32.0

func (CreatorOutput) ElementType() reflect.Type

func (CreatorOutput) ToCreatorOutput added in v4.32.0

func (o CreatorOutput) ToCreatorOutput() CreatorOutput

func (CreatorOutput) ToCreatorOutputWithContext added in v4.32.0

func (o CreatorOutput) ToCreatorOutputWithContext(ctx context.Context) CreatorOutput

type CreatorState added in v4.32.0

type CreatorState struct {
	// The Azure Region where the Azure Maps Creator should exist.
	Location pulumi.StringPtrInput
	// The ID of the Azure Maps Creator. Changing this forces a new resource to be created.
	MapsAccountId pulumi.StringPtrInput
	// The name of the Azure Maps Creator. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The storage units to be allocated. Integer values from 1 to 100, inclusive.
	StorageUnits pulumi.IntPtrInput
	// A mapping of tags which should be assigned to the Azure Maps Creator.
	Tags pulumi.StringMapInput
}

func (CreatorState) ElementType added in v4.32.0

func (CreatorState) ElementType() reflect.Type

type LookupAccountArgs

type LookupAccountArgs struct {
	// Specifies the name of the Maps Account.
	Name string `pulumi:"name"`
	// Specifies the name of the Resource Group in which the Maps Account is located.
	ResourceGroupName string            `pulumi:"resourceGroupName"`
	Tags              map[string]string `pulumi:"tags"`
}

A collection of arguments for invoking getAccount.

type LookupAccountOutputArgs added in v4.20.0

type LookupAccountOutputArgs struct {
	// Specifies the name of the Maps Account.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies the name of the Resource Group in which the Maps Account is located.
	ResourceGroupName pulumi.StringInput    `pulumi:"resourceGroupName"`
	Tags              pulumi.StringMapInput `pulumi:"tags"`
}

A collection of arguments for invoking getAccount.

func (LookupAccountOutputArgs) ElementType added in v4.20.0

func (LookupAccountOutputArgs) ElementType() reflect.Type

type LookupAccountResult

type LookupAccountResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id   string `pulumi:"id"`
	Name string `pulumi:"name"`
	// The primary key used to authenticate and authorize access to the Maps REST APIs.
	PrimaryAccessKey  string `pulumi:"primaryAccessKey"`
	ResourceGroupName string `pulumi:"resourceGroupName"`
	// The primary key used to authenticate and authorize access to the Maps REST APIs. The second key is given to provide seamless key regeneration.
	SecondaryAccessKey string `pulumi:"secondaryAccessKey"`
	// The sku of the Azure Maps Account.
	SkuName string            `pulumi:"skuName"`
	Tags    map[string]string `pulumi:"tags"`
	// A unique identifier for the Maps Account.
	XMsClientId string `pulumi:"xMsClientId"`
}

A collection of values returned by getAccount.

func LookupAccount

func LookupAccount(ctx *pulumi.Context, args *LookupAccountArgs, opts ...pulumi.InvokeOption) (*LookupAccountResult, error)

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

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/maps"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := maps.LookupAccount(ctx, &maps.LookupAccountArgs{
			Name:              "production",
			ResourceGroupName: "maps",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("mapsAccountId", example.Id)
		return nil
	})
}

```

type LookupAccountResultOutput added in v4.20.0

type LookupAccountResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAccount.

func LookupAccountOutput added in v4.20.0

func LookupAccountOutput(ctx *pulumi.Context, args LookupAccountOutputArgs, opts ...pulumi.InvokeOption) LookupAccountResultOutput

func (LookupAccountResultOutput) ElementType added in v4.20.0

func (LookupAccountResultOutput) ElementType() reflect.Type

func (LookupAccountResultOutput) Id added in v4.20.0

The provider-assigned unique ID for this managed resource.

func (LookupAccountResultOutput) Name added in v4.20.0

func (LookupAccountResultOutput) PrimaryAccessKey added in v4.20.0

func (o LookupAccountResultOutput) PrimaryAccessKey() pulumi.StringOutput

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

func (LookupAccountResultOutput) ResourceGroupName added in v4.20.0

func (o LookupAccountResultOutput) ResourceGroupName() pulumi.StringOutput

func (LookupAccountResultOutput) SecondaryAccessKey added in v4.20.0

func (o LookupAccountResultOutput) SecondaryAccessKey() pulumi.StringOutput

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

func (LookupAccountResultOutput) SkuName added in v4.20.0

The sku of the Azure Maps Account.

func (LookupAccountResultOutput) Tags added in v4.20.0

func (LookupAccountResultOutput) ToLookupAccountResultOutput added in v4.20.0

func (o LookupAccountResultOutput) ToLookupAccountResultOutput() LookupAccountResultOutput

func (LookupAccountResultOutput) ToLookupAccountResultOutputWithContext added in v4.20.0

func (o LookupAccountResultOutput) ToLookupAccountResultOutputWithContext(ctx context.Context) LookupAccountResultOutput

func (LookupAccountResultOutput) XMsClientId added in v4.20.0

A unique identifier for the Maps Account.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL