iotcentral

package
v5.21.0 Latest Latest
Warning

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

Go to latest
Published: Oct 13, 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 Application

type Application struct {
	pulumi.CustomResourceState

	// A `displayName` name. Custom display name for the IoT Central application. Default is resource name.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// An `identity` block as defined below.
	Identity ApplicationIdentityPtrOutput `pulumi:"identity"`
	// Specifies the supported Azure location where the resource has to be create. Changing this forces a new resource to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// Whether public network access is allowed for the IoT Central Application. Defaults to `true`.
	PublicNetworkAccessEnabled pulumi.BoolPtrOutput `pulumi:"publicNetworkAccessEnabled"`
	// The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// A `sku` name. Possible values is `ST1`, `ST2`, Default value is `ST1`
	Sku pulumi.StringPtrOutput `pulumi:"sku"`
	// A `subDomain` name. Subdomain for the IoT Central URL. Each application must have a unique subdomain.
	SubDomain pulumi.StringOutput `pulumi:"subDomain"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A `template` name. IoT Central application template name. Default is a custom application.
	Template pulumi.StringOutput `pulumi:"template"`
}

Manages an IoT Central Application

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/iotcentral"
"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 = iotcentral.NewApplication(ctx, "exampleApplication", &iotcentral.ApplicationArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			SubDomain:         pulumi.String("example-iotcentral-app-subdomain"),
			DisplayName:       pulumi.String("example-iotcentral-app-display-name"),
			Sku:               pulumi.String("ST1"),
			Template:          pulumi.String("iotc-default@1.0.0"),
			Tags: pulumi.StringMap{
				"Foo": pulumi.String("Bar"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

The IoT Central Application can be imported using the `resource id`, e.g.

```sh

$ pulumi import azure:iotcentral/application:Application example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.IoTCentral/ioTApps/app1

```

func GetApplication

func GetApplication(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationState, opts ...pulumi.ResourceOption) (*Application, error)

GetApplication gets an existing Application 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 NewApplication

func NewApplication(ctx *pulumi.Context,
	name string, args *ApplicationArgs, opts ...pulumi.ResourceOption) (*Application, error)

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

func (*Application) ElementType

func (*Application) ElementType() reflect.Type

func (*Application) ToApplicationOutput

func (i *Application) ToApplicationOutput() ApplicationOutput

func (*Application) ToApplicationOutputWithContext

func (i *Application) ToApplicationOutputWithContext(ctx context.Context) ApplicationOutput

type ApplicationArgs

type ApplicationArgs struct {
	// A `displayName` name. Custom display name for the IoT Central application. Default is resource name.
	DisplayName pulumi.StringPtrInput
	// An `identity` block as defined below.
	Identity ApplicationIdentityPtrInput
	// Specifies the supported Azure location where the resource has to be create. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// Whether public network access is allowed for the IoT Central Application. Defaults to `true`.
	PublicNetworkAccessEnabled pulumi.BoolPtrInput
	// The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringInput
	// A `sku` name. Possible values is `ST1`, `ST2`, Default value is `ST1`
	Sku pulumi.StringPtrInput
	// A `subDomain` name. Subdomain for the IoT Central URL. Each application must have a unique subdomain.
	SubDomain pulumi.StringInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
	// A `template` name. IoT Central application template name. Default is a custom application.
	Template pulumi.StringPtrInput
}

The set of arguments for constructing a Application resource.

func (ApplicationArgs) ElementType

func (ApplicationArgs) ElementType() reflect.Type

type ApplicationArray

type ApplicationArray []ApplicationInput

func (ApplicationArray) ElementType

func (ApplicationArray) ElementType() reflect.Type

func (ApplicationArray) ToApplicationArrayOutput

func (i ApplicationArray) ToApplicationArrayOutput() ApplicationArrayOutput

func (ApplicationArray) ToApplicationArrayOutputWithContext

func (i ApplicationArray) ToApplicationArrayOutputWithContext(ctx context.Context) ApplicationArrayOutput

type ApplicationArrayInput

type ApplicationArrayInput interface {
	pulumi.Input

	ToApplicationArrayOutput() ApplicationArrayOutput
	ToApplicationArrayOutputWithContext(context.Context) ApplicationArrayOutput
}

ApplicationArrayInput is an input type that accepts ApplicationArray and ApplicationArrayOutput values. You can construct a concrete instance of `ApplicationArrayInput` via:

ApplicationArray{ ApplicationArgs{...} }

type ApplicationArrayOutput

type ApplicationArrayOutput struct{ *pulumi.OutputState }

func (ApplicationArrayOutput) ElementType

func (ApplicationArrayOutput) ElementType() reflect.Type

func (ApplicationArrayOutput) Index

func (ApplicationArrayOutput) ToApplicationArrayOutput

func (o ApplicationArrayOutput) ToApplicationArrayOutput() ApplicationArrayOutput

func (ApplicationArrayOutput) ToApplicationArrayOutputWithContext

func (o ApplicationArrayOutput) ToApplicationArrayOutputWithContext(ctx context.Context) ApplicationArrayOutput

type ApplicationIdentity added in v5.21.0

type ApplicationIdentity struct {
	// The Principal ID associated with this Managed Service Identity.
	PrincipalId *string `pulumi:"principalId"`
	// The Tenant ID associated with this Managed Service Identity.
	TenantId *string `pulumi:"tenantId"`
	// Specifies the type of Managed Service Identity that should be configured on this IoT Central Application. The only possible value is `SystemAssigned`.
	Type string `pulumi:"type"`
}

type ApplicationIdentityArgs added in v5.21.0

type ApplicationIdentityArgs struct {
	// The Principal ID associated with this Managed Service Identity.
	PrincipalId pulumi.StringPtrInput `pulumi:"principalId"`
	// The Tenant ID associated with this Managed Service Identity.
	TenantId pulumi.StringPtrInput `pulumi:"tenantId"`
	// Specifies the type of Managed Service Identity that should be configured on this IoT Central Application. The only possible value is `SystemAssigned`.
	Type pulumi.StringInput `pulumi:"type"`
}

func (ApplicationIdentityArgs) ElementType added in v5.21.0

func (ApplicationIdentityArgs) ElementType() reflect.Type

func (ApplicationIdentityArgs) ToApplicationIdentityOutput added in v5.21.0

func (i ApplicationIdentityArgs) ToApplicationIdentityOutput() ApplicationIdentityOutput

func (ApplicationIdentityArgs) ToApplicationIdentityOutputWithContext added in v5.21.0

func (i ApplicationIdentityArgs) ToApplicationIdentityOutputWithContext(ctx context.Context) ApplicationIdentityOutput

func (ApplicationIdentityArgs) ToApplicationIdentityPtrOutput added in v5.21.0

func (i ApplicationIdentityArgs) ToApplicationIdentityPtrOutput() ApplicationIdentityPtrOutput

func (ApplicationIdentityArgs) ToApplicationIdentityPtrOutputWithContext added in v5.21.0

func (i ApplicationIdentityArgs) ToApplicationIdentityPtrOutputWithContext(ctx context.Context) ApplicationIdentityPtrOutput

type ApplicationIdentityInput added in v5.21.0

type ApplicationIdentityInput interface {
	pulumi.Input

	ToApplicationIdentityOutput() ApplicationIdentityOutput
	ToApplicationIdentityOutputWithContext(context.Context) ApplicationIdentityOutput
}

ApplicationIdentityInput is an input type that accepts ApplicationIdentityArgs and ApplicationIdentityOutput values. You can construct a concrete instance of `ApplicationIdentityInput` via:

ApplicationIdentityArgs{...}

type ApplicationIdentityOutput added in v5.21.0

type ApplicationIdentityOutput struct{ *pulumi.OutputState }

func (ApplicationIdentityOutput) ElementType added in v5.21.0

func (ApplicationIdentityOutput) ElementType() reflect.Type

func (ApplicationIdentityOutput) PrincipalId added in v5.21.0

The Principal ID associated with this Managed Service Identity.

func (ApplicationIdentityOutput) TenantId added in v5.21.0

The Tenant ID associated with this Managed Service Identity.

func (ApplicationIdentityOutput) ToApplicationIdentityOutput added in v5.21.0

func (o ApplicationIdentityOutput) ToApplicationIdentityOutput() ApplicationIdentityOutput

func (ApplicationIdentityOutput) ToApplicationIdentityOutputWithContext added in v5.21.0

func (o ApplicationIdentityOutput) ToApplicationIdentityOutputWithContext(ctx context.Context) ApplicationIdentityOutput

func (ApplicationIdentityOutput) ToApplicationIdentityPtrOutput added in v5.21.0

func (o ApplicationIdentityOutput) ToApplicationIdentityPtrOutput() ApplicationIdentityPtrOutput

func (ApplicationIdentityOutput) ToApplicationIdentityPtrOutputWithContext added in v5.21.0

func (o ApplicationIdentityOutput) ToApplicationIdentityPtrOutputWithContext(ctx context.Context) ApplicationIdentityPtrOutput

func (ApplicationIdentityOutput) Type added in v5.21.0

Specifies the type of Managed Service Identity that should be configured on this IoT Central Application. The only possible value is `SystemAssigned`.

type ApplicationIdentityPtrInput added in v5.21.0

type ApplicationIdentityPtrInput interface {
	pulumi.Input

	ToApplicationIdentityPtrOutput() ApplicationIdentityPtrOutput
	ToApplicationIdentityPtrOutputWithContext(context.Context) ApplicationIdentityPtrOutput
}

ApplicationIdentityPtrInput is an input type that accepts ApplicationIdentityArgs, ApplicationIdentityPtr and ApplicationIdentityPtrOutput values. You can construct a concrete instance of `ApplicationIdentityPtrInput` via:

        ApplicationIdentityArgs{...}

or:

        nil

func ApplicationIdentityPtr added in v5.21.0

func ApplicationIdentityPtr(v *ApplicationIdentityArgs) ApplicationIdentityPtrInput

type ApplicationIdentityPtrOutput added in v5.21.0

type ApplicationIdentityPtrOutput struct{ *pulumi.OutputState }

func (ApplicationIdentityPtrOutput) Elem added in v5.21.0

func (ApplicationIdentityPtrOutput) ElementType added in v5.21.0

func (ApplicationIdentityPtrOutput) PrincipalId added in v5.21.0

The Principal ID associated with this Managed Service Identity.

func (ApplicationIdentityPtrOutput) TenantId added in v5.21.0

The Tenant ID associated with this Managed Service Identity.

func (ApplicationIdentityPtrOutput) ToApplicationIdentityPtrOutput added in v5.21.0

func (o ApplicationIdentityPtrOutput) ToApplicationIdentityPtrOutput() ApplicationIdentityPtrOutput

func (ApplicationIdentityPtrOutput) ToApplicationIdentityPtrOutputWithContext added in v5.21.0

func (o ApplicationIdentityPtrOutput) ToApplicationIdentityPtrOutputWithContext(ctx context.Context) ApplicationIdentityPtrOutput

func (ApplicationIdentityPtrOutput) Type added in v5.21.0

Specifies the type of Managed Service Identity that should be configured on this IoT Central Application. The only possible value is `SystemAssigned`.

type ApplicationInput

type ApplicationInput interface {
	pulumi.Input

	ToApplicationOutput() ApplicationOutput
	ToApplicationOutputWithContext(ctx context.Context) ApplicationOutput
}

type ApplicationMap

type ApplicationMap map[string]ApplicationInput

func (ApplicationMap) ElementType

func (ApplicationMap) ElementType() reflect.Type

func (ApplicationMap) ToApplicationMapOutput

func (i ApplicationMap) ToApplicationMapOutput() ApplicationMapOutput

func (ApplicationMap) ToApplicationMapOutputWithContext

func (i ApplicationMap) ToApplicationMapOutputWithContext(ctx context.Context) ApplicationMapOutput

type ApplicationMapInput

type ApplicationMapInput interface {
	pulumi.Input

	ToApplicationMapOutput() ApplicationMapOutput
	ToApplicationMapOutputWithContext(context.Context) ApplicationMapOutput
}

ApplicationMapInput is an input type that accepts ApplicationMap and ApplicationMapOutput values. You can construct a concrete instance of `ApplicationMapInput` via:

ApplicationMap{ "key": ApplicationArgs{...} }

type ApplicationMapOutput

type ApplicationMapOutput struct{ *pulumi.OutputState }

func (ApplicationMapOutput) ElementType

func (ApplicationMapOutput) ElementType() reflect.Type

func (ApplicationMapOutput) MapIndex

func (ApplicationMapOutput) ToApplicationMapOutput

func (o ApplicationMapOutput) ToApplicationMapOutput() ApplicationMapOutput

func (ApplicationMapOutput) ToApplicationMapOutputWithContext

func (o ApplicationMapOutput) ToApplicationMapOutputWithContext(ctx context.Context) ApplicationMapOutput

type ApplicationOutput

type ApplicationOutput struct{ *pulumi.OutputState }

func (ApplicationOutput) DisplayName added in v5.5.0

func (o ApplicationOutput) DisplayName() pulumi.StringOutput

A `displayName` name. Custom display name for the IoT Central application. Default is resource name.

func (ApplicationOutput) ElementType

func (ApplicationOutput) ElementType() reflect.Type

func (ApplicationOutput) Identity added in v5.21.0

An `identity` block as defined below.

func (ApplicationOutput) Location added in v5.5.0

func (o ApplicationOutput) Location() pulumi.StringOutput

Specifies the supported Azure location where the resource has to be create. Changing this forces a new resource to be created.

func (ApplicationOutput) Name added in v5.5.0

Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

func (ApplicationOutput) PublicNetworkAccessEnabled added in v5.21.0

func (o ApplicationOutput) PublicNetworkAccessEnabled() pulumi.BoolPtrOutput

Whether public network access is allowed for the IoT Central Application. Defaults to `true`.

func (ApplicationOutput) ResourceGroupName added in v5.5.0

func (o ApplicationOutput) ResourceGroupName() pulumi.StringOutput

The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.

func (ApplicationOutput) Sku added in v5.5.0

A `sku` name. Possible values is `ST1`, `ST2`, Default value is `ST1`

func (ApplicationOutput) SubDomain added in v5.5.0

func (o ApplicationOutput) SubDomain() pulumi.StringOutput

A `subDomain` name. Subdomain for the IoT Central URL. Each application must have a unique subdomain.

func (ApplicationOutput) Tags added in v5.5.0

A mapping of tags to assign to the resource.

func (ApplicationOutput) Template added in v5.5.0

func (o ApplicationOutput) Template() pulumi.StringOutput

A `template` name. IoT Central application template name. Default is a custom application.

func (ApplicationOutput) ToApplicationOutput

func (o ApplicationOutput) ToApplicationOutput() ApplicationOutput

func (ApplicationOutput) ToApplicationOutputWithContext

func (o ApplicationOutput) ToApplicationOutputWithContext(ctx context.Context) ApplicationOutput

type ApplicationState

type ApplicationState struct {
	// A `displayName` name. Custom display name for the IoT Central application. Default is resource name.
	DisplayName pulumi.StringPtrInput
	// An `identity` block as defined below.
	Identity ApplicationIdentityPtrInput
	// Specifies the supported Azure location where the resource has to be create. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// Whether public network access is allowed for the IoT Central Application. Defaults to `true`.
	PublicNetworkAccessEnabled pulumi.BoolPtrInput
	// The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringPtrInput
	// A `sku` name. Possible values is `ST1`, `ST2`, Default value is `ST1`
	Sku pulumi.StringPtrInput
	// A `subDomain` name. Subdomain for the IoT Central URL. Each application must have a unique subdomain.
	SubDomain pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
	// A `template` name. IoT Central application template name. Default is a custom application.
	Template pulumi.StringPtrInput
}

func (ApplicationState) ElementType

func (ApplicationState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

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