maps

package
v3.56.0 Latest Latest
Warning

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

Go to latest
Published: Apr 12, 2021 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` and `S1`.
	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/v3/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/maps"
"github.com/pulumi/pulumi/sdk/v2/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 added in v3.31.1

func (*Account) ElementType() reflect.Type

func (*Account) ToAccountOutput added in v3.31.1

func (i *Account) ToAccountOutput() AccountOutput

func (*Account) ToAccountOutputWithContext added in v3.31.1

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

func (*Account) ToAccountPtrOutput added in v3.47.1

func (i *Account) ToAccountPtrOutput() AccountPtrOutput

func (*Account) ToAccountPtrOutputWithContext added in v3.47.1

func (i *Account) ToAccountPtrOutputWithContext(ctx context.Context) AccountPtrOutput

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` and `S1`.
	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 added in v3.47.1

type AccountArray []AccountInput

func (AccountArray) ElementType added in v3.47.1

func (AccountArray) ElementType() reflect.Type

func (AccountArray) ToAccountArrayOutput added in v3.47.1

func (i AccountArray) ToAccountArrayOutput() AccountArrayOutput

func (AccountArray) ToAccountArrayOutputWithContext added in v3.47.1

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

type AccountArrayInput added in v3.47.1

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 added in v3.47.1

type AccountArrayOutput struct{ *pulumi.OutputState }

func (AccountArrayOutput) ElementType added in v3.47.1

func (AccountArrayOutput) ElementType() reflect.Type

func (AccountArrayOutput) Index added in v3.47.1

func (AccountArrayOutput) ToAccountArrayOutput added in v3.47.1

func (o AccountArrayOutput) ToAccountArrayOutput() AccountArrayOutput

func (AccountArrayOutput) ToAccountArrayOutputWithContext added in v3.47.1

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

type AccountInput added in v3.31.1

type AccountInput interface {
	pulumi.Input

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

type AccountMap added in v3.47.1

type AccountMap map[string]AccountInput

func (AccountMap) ElementType added in v3.47.1

func (AccountMap) ElementType() reflect.Type

func (AccountMap) ToAccountMapOutput added in v3.47.1

func (i AccountMap) ToAccountMapOutput() AccountMapOutput

func (AccountMap) ToAccountMapOutputWithContext added in v3.47.1

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

type AccountMapInput added in v3.47.1

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 added in v3.47.1

type AccountMapOutput struct{ *pulumi.OutputState }

func (AccountMapOutput) ElementType added in v3.47.1

func (AccountMapOutput) ElementType() reflect.Type

func (AccountMapOutput) MapIndex added in v3.47.1

func (AccountMapOutput) ToAccountMapOutput added in v3.47.1

func (o AccountMapOutput) ToAccountMapOutput() AccountMapOutput

func (AccountMapOutput) ToAccountMapOutputWithContext added in v3.47.1

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

type AccountOutput added in v3.31.1

type AccountOutput struct {
	*pulumi.OutputState
}

func (AccountOutput) ElementType added in v3.31.1

func (AccountOutput) ElementType() reflect.Type

func (AccountOutput) ToAccountOutput added in v3.31.1

func (o AccountOutput) ToAccountOutput() AccountOutput

func (AccountOutput) ToAccountOutputWithContext added in v3.31.1

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

func (AccountOutput) ToAccountPtrOutput added in v3.47.1

func (o AccountOutput) ToAccountPtrOutput() AccountPtrOutput

func (AccountOutput) ToAccountPtrOutputWithContext added in v3.47.1

func (o AccountOutput) ToAccountPtrOutputWithContext(ctx context.Context) AccountPtrOutput

type AccountPtrInput added in v3.47.1

type AccountPtrInput interface {
	pulumi.Input

	ToAccountPtrOutput() AccountPtrOutput
	ToAccountPtrOutputWithContext(ctx context.Context) AccountPtrOutput
}

type AccountPtrOutput added in v3.47.1

type AccountPtrOutput struct {
	*pulumi.OutputState
}

func (AccountPtrOutput) ElementType added in v3.47.1

func (AccountPtrOutput) ElementType() reflect.Type

func (AccountPtrOutput) ToAccountPtrOutput added in v3.47.1

func (o AccountPtrOutput) ToAccountPtrOutput() AccountPtrOutput

func (AccountPtrOutput) ToAccountPtrOutputWithContext added in v3.47.1

func (o AccountPtrOutput) ToAccountPtrOutputWithContext(ctx context.Context) AccountPtrOutput

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` and `S1`.
	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 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 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/v3/go/azure/maps"
"github.com/pulumi/pulumi/sdk/v2/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
	})
}

```

Jump to

Keyboard shortcuts

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