iotcentral

package
v6.8.0 Latest Latest
Warning

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

Go to latest
Published: Nov 4, 2024 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.
	//
	// > **NOTE:** Due to a bug in the provider, the default value of `displayName` of a newly created IoT Central App will be the Resource Group Name, it will be fixed and use resource name in 4.0. For an existing IoT Central App, this could be fixed by specifying the `displayName` explicitly.
	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 `ST0`, `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. Defaults to `iotc-pnp-preview@1.0.0`. Changing this forces a new resource to be created.
	Template pulumi.StringPtrOutput `pulumi:"template"`
}

Manages an IoT Central Application

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/iotcentral"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resource"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = iotcentral.NewApplication(ctx, "example", &iotcentral.ApplicationArgs{
			Name:              pulumi.String("example-iotcentral-app"),
			ResourceGroupName: example.Name,
			Location:          example.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.
	//
	// > **NOTE:** Due to a bug in the provider, the default value of `displayName` of a newly created IoT Central App will be the Resource Group Name, it will be fixed and use resource name in 4.0. For an existing IoT Central App, this could be fixed by specifying the `displayName` explicitly.
	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 `ST0`, `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. Defaults to `iotc-pnp-preview@1.0.0`. Changing this forces a new resource to be created.
	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

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

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

func (ApplicationIdentityArgs) ElementType() reflect.Type

func (ApplicationIdentityArgs) ToApplicationIdentityOutput

func (i ApplicationIdentityArgs) ToApplicationIdentityOutput() ApplicationIdentityOutput

func (ApplicationIdentityArgs) ToApplicationIdentityOutputWithContext

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

func (ApplicationIdentityArgs) ToApplicationIdentityPtrOutput

func (i ApplicationIdentityArgs) ToApplicationIdentityPtrOutput() ApplicationIdentityPtrOutput

func (ApplicationIdentityArgs) ToApplicationIdentityPtrOutputWithContext

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

type ApplicationIdentityInput

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

type ApplicationIdentityOutput struct{ *pulumi.OutputState }

func (ApplicationIdentityOutput) ElementType

func (ApplicationIdentityOutput) ElementType() reflect.Type

func (ApplicationIdentityOutput) PrincipalId

The Principal ID associated with this Managed Service Identity.

func (ApplicationIdentityOutput) TenantId

The Tenant ID associated with this Managed Service Identity.

func (ApplicationIdentityOutput) ToApplicationIdentityOutput

func (o ApplicationIdentityOutput) ToApplicationIdentityOutput() ApplicationIdentityOutput

func (ApplicationIdentityOutput) ToApplicationIdentityOutputWithContext

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

func (ApplicationIdentityOutput) ToApplicationIdentityPtrOutput

func (o ApplicationIdentityOutput) ToApplicationIdentityPtrOutput() ApplicationIdentityPtrOutput

func (ApplicationIdentityOutput) ToApplicationIdentityPtrOutputWithContext

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

func (ApplicationIdentityOutput) Type

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

type ApplicationIdentityPtrInput

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

type ApplicationIdentityPtrOutput

type ApplicationIdentityPtrOutput struct{ *pulumi.OutputState }

func (ApplicationIdentityPtrOutput) Elem

func (ApplicationIdentityPtrOutput) ElementType

func (ApplicationIdentityPtrOutput) PrincipalId

The Principal ID associated with this Managed Service Identity.

func (ApplicationIdentityPtrOutput) TenantId

The Tenant ID associated with this Managed Service Identity.

func (ApplicationIdentityPtrOutput) ToApplicationIdentityPtrOutput

func (o ApplicationIdentityPtrOutput) ToApplicationIdentityPtrOutput() ApplicationIdentityPtrOutput

func (ApplicationIdentityPtrOutput) ToApplicationIdentityPtrOutputWithContext

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

func (ApplicationIdentityPtrOutput) Type

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 ApplicationNetworkRuleSet

type ApplicationNetworkRuleSet struct {
	pulumi.CustomResourceState

	// Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are `true`, `false`. Defaults to `true`
	ApplyToDevice pulumi.BoolPtrOutput `pulumi:"applyToDevice"`
	// Specifies the default action for the IoT Central Application Network Rule Set. Possible values are `Allow` and `Deny`. Defaults to `Deny`.
	DefaultAction pulumi.StringPtrOutput `pulumi:"defaultAction"`
	// The ID of the IoT Central Application. Changing this forces a new resource to be created.
	IotcentralApplicationId pulumi.StringOutput `pulumi:"iotcentralApplicationId"`
	// One or more `ipRule` blocks as defined below.
	IpRules ApplicationNetworkRuleSetIpRuleArrayOutput `pulumi:"ipRules"`
}

Manages an IoT Central Application Network Rule Set.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/iotcentral"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resource"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleApplication, err := iotcentral.NewApplication(ctx, "example", &iotcentral.ApplicationArgs{
			Name:              pulumi.String("example-iotcentral-app"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			SubDomain:         pulumi.String("example-iotcentral-app-subdomain"),
			DisplayName:       pulumi.String("example-iotcentral-app-display-name"),
			Sku:               pulumi.String("ST1"),
			Tags: pulumi.StringMap{
				"Foo": pulumi.String("Bar"),
			},
		})
		if err != nil {
			return err
		}
		_, err = iotcentral.NewApplicationNetworkRuleSet(ctx, "example", &iotcentral.ApplicationNetworkRuleSetArgs{
			IotcentralApplicationId: exampleApplication.ID(),
			IpRules: iotcentral.ApplicationNetworkRuleSetIpRuleArray{
				&iotcentral.ApplicationNetworkRuleSetIpRuleArgs{
					Name:   pulumi.String("rule1"),
					IpMask: pulumi.String("10.0.1.0/24"),
				},
				&iotcentral.ApplicationNetworkRuleSetIpRuleArgs{
					Name:   pulumi.String("rule2"),
					IpMask: pulumi.String("10.1.1.0/24"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

IoT Central Application Network Rule Sets can be imported using the `resource id`, e.g.

```sh $ pulumi import azure:iotcentral/applicationNetworkRuleSet:ApplicationNetworkRuleSet example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.IoTCentral/iotApps/app1 ```

func GetApplicationNetworkRuleSet

func GetApplicationNetworkRuleSet(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApplicationNetworkRuleSetState, opts ...pulumi.ResourceOption) (*ApplicationNetworkRuleSet, error)

GetApplicationNetworkRuleSet gets an existing ApplicationNetworkRuleSet 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 NewApplicationNetworkRuleSet

func NewApplicationNetworkRuleSet(ctx *pulumi.Context,
	name string, args *ApplicationNetworkRuleSetArgs, opts ...pulumi.ResourceOption) (*ApplicationNetworkRuleSet, error)

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

func (*ApplicationNetworkRuleSet) ElementType

func (*ApplicationNetworkRuleSet) ElementType() reflect.Type

func (*ApplicationNetworkRuleSet) ToApplicationNetworkRuleSetOutput

func (i *ApplicationNetworkRuleSet) ToApplicationNetworkRuleSetOutput() ApplicationNetworkRuleSetOutput

func (*ApplicationNetworkRuleSet) ToApplicationNetworkRuleSetOutputWithContext

func (i *ApplicationNetworkRuleSet) ToApplicationNetworkRuleSetOutputWithContext(ctx context.Context) ApplicationNetworkRuleSetOutput

type ApplicationNetworkRuleSetArgs

type ApplicationNetworkRuleSetArgs struct {
	// Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are `true`, `false`. Defaults to `true`
	ApplyToDevice pulumi.BoolPtrInput
	// Specifies the default action for the IoT Central Application Network Rule Set. Possible values are `Allow` and `Deny`. Defaults to `Deny`.
	DefaultAction pulumi.StringPtrInput
	// The ID of the IoT Central Application. Changing this forces a new resource to be created.
	IotcentralApplicationId pulumi.StringInput
	// One or more `ipRule` blocks as defined below.
	IpRules ApplicationNetworkRuleSetIpRuleArrayInput
}

The set of arguments for constructing a ApplicationNetworkRuleSet resource.

func (ApplicationNetworkRuleSetArgs) ElementType

type ApplicationNetworkRuleSetArray

type ApplicationNetworkRuleSetArray []ApplicationNetworkRuleSetInput

func (ApplicationNetworkRuleSetArray) ElementType

func (ApplicationNetworkRuleSetArray) ToApplicationNetworkRuleSetArrayOutput

func (i ApplicationNetworkRuleSetArray) ToApplicationNetworkRuleSetArrayOutput() ApplicationNetworkRuleSetArrayOutput

func (ApplicationNetworkRuleSetArray) ToApplicationNetworkRuleSetArrayOutputWithContext

func (i ApplicationNetworkRuleSetArray) ToApplicationNetworkRuleSetArrayOutputWithContext(ctx context.Context) ApplicationNetworkRuleSetArrayOutput

type ApplicationNetworkRuleSetArrayInput

type ApplicationNetworkRuleSetArrayInput interface {
	pulumi.Input

	ToApplicationNetworkRuleSetArrayOutput() ApplicationNetworkRuleSetArrayOutput
	ToApplicationNetworkRuleSetArrayOutputWithContext(context.Context) ApplicationNetworkRuleSetArrayOutput
}

ApplicationNetworkRuleSetArrayInput is an input type that accepts ApplicationNetworkRuleSetArray and ApplicationNetworkRuleSetArrayOutput values. You can construct a concrete instance of `ApplicationNetworkRuleSetArrayInput` via:

ApplicationNetworkRuleSetArray{ ApplicationNetworkRuleSetArgs{...} }

type ApplicationNetworkRuleSetArrayOutput

type ApplicationNetworkRuleSetArrayOutput struct{ *pulumi.OutputState }

func (ApplicationNetworkRuleSetArrayOutput) ElementType

func (ApplicationNetworkRuleSetArrayOutput) Index

func (ApplicationNetworkRuleSetArrayOutput) ToApplicationNetworkRuleSetArrayOutput

func (o ApplicationNetworkRuleSetArrayOutput) ToApplicationNetworkRuleSetArrayOutput() ApplicationNetworkRuleSetArrayOutput

func (ApplicationNetworkRuleSetArrayOutput) ToApplicationNetworkRuleSetArrayOutputWithContext

func (o ApplicationNetworkRuleSetArrayOutput) ToApplicationNetworkRuleSetArrayOutputWithContext(ctx context.Context) ApplicationNetworkRuleSetArrayOutput

type ApplicationNetworkRuleSetInput

type ApplicationNetworkRuleSetInput interface {
	pulumi.Input

	ToApplicationNetworkRuleSetOutput() ApplicationNetworkRuleSetOutput
	ToApplicationNetworkRuleSetOutputWithContext(ctx context.Context) ApplicationNetworkRuleSetOutput
}

type ApplicationNetworkRuleSetIpRule

type ApplicationNetworkRuleSetIpRule struct {
	// The IP address range in CIDR notation for the IP Rule.
	IpMask string `pulumi:"ipMask"`
	// The name of the IP Rule
	Name string `pulumi:"name"`
}

type ApplicationNetworkRuleSetIpRuleArgs

type ApplicationNetworkRuleSetIpRuleArgs struct {
	// The IP address range in CIDR notation for the IP Rule.
	IpMask pulumi.StringInput `pulumi:"ipMask"`
	// The name of the IP Rule
	Name pulumi.StringInput `pulumi:"name"`
}

func (ApplicationNetworkRuleSetIpRuleArgs) ElementType

func (ApplicationNetworkRuleSetIpRuleArgs) ToApplicationNetworkRuleSetIpRuleOutput

func (i ApplicationNetworkRuleSetIpRuleArgs) ToApplicationNetworkRuleSetIpRuleOutput() ApplicationNetworkRuleSetIpRuleOutput

func (ApplicationNetworkRuleSetIpRuleArgs) ToApplicationNetworkRuleSetIpRuleOutputWithContext

func (i ApplicationNetworkRuleSetIpRuleArgs) ToApplicationNetworkRuleSetIpRuleOutputWithContext(ctx context.Context) ApplicationNetworkRuleSetIpRuleOutput

type ApplicationNetworkRuleSetIpRuleArray

type ApplicationNetworkRuleSetIpRuleArray []ApplicationNetworkRuleSetIpRuleInput

func (ApplicationNetworkRuleSetIpRuleArray) ElementType

func (ApplicationNetworkRuleSetIpRuleArray) ToApplicationNetworkRuleSetIpRuleArrayOutput

func (i ApplicationNetworkRuleSetIpRuleArray) ToApplicationNetworkRuleSetIpRuleArrayOutput() ApplicationNetworkRuleSetIpRuleArrayOutput

func (ApplicationNetworkRuleSetIpRuleArray) ToApplicationNetworkRuleSetIpRuleArrayOutputWithContext

func (i ApplicationNetworkRuleSetIpRuleArray) ToApplicationNetworkRuleSetIpRuleArrayOutputWithContext(ctx context.Context) ApplicationNetworkRuleSetIpRuleArrayOutput

type ApplicationNetworkRuleSetIpRuleArrayInput

type ApplicationNetworkRuleSetIpRuleArrayInput interface {
	pulumi.Input

	ToApplicationNetworkRuleSetIpRuleArrayOutput() ApplicationNetworkRuleSetIpRuleArrayOutput
	ToApplicationNetworkRuleSetIpRuleArrayOutputWithContext(context.Context) ApplicationNetworkRuleSetIpRuleArrayOutput
}

ApplicationNetworkRuleSetIpRuleArrayInput is an input type that accepts ApplicationNetworkRuleSetIpRuleArray and ApplicationNetworkRuleSetIpRuleArrayOutput values. You can construct a concrete instance of `ApplicationNetworkRuleSetIpRuleArrayInput` via:

ApplicationNetworkRuleSetIpRuleArray{ ApplicationNetworkRuleSetIpRuleArgs{...} }

type ApplicationNetworkRuleSetIpRuleArrayOutput

type ApplicationNetworkRuleSetIpRuleArrayOutput struct{ *pulumi.OutputState }

func (ApplicationNetworkRuleSetIpRuleArrayOutput) ElementType

func (ApplicationNetworkRuleSetIpRuleArrayOutput) Index

func (ApplicationNetworkRuleSetIpRuleArrayOutput) ToApplicationNetworkRuleSetIpRuleArrayOutput

func (o ApplicationNetworkRuleSetIpRuleArrayOutput) ToApplicationNetworkRuleSetIpRuleArrayOutput() ApplicationNetworkRuleSetIpRuleArrayOutput

func (ApplicationNetworkRuleSetIpRuleArrayOutput) ToApplicationNetworkRuleSetIpRuleArrayOutputWithContext

func (o ApplicationNetworkRuleSetIpRuleArrayOutput) ToApplicationNetworkRuleSetIpRuleArrayOutputWithContext(ctx context.Context) ApplicationNetworkRuleSetIpRuleArrayOutput

type ApplicationNetworkRuleSetIpRuleInput

type ApplicationNetworkRuleSetIpRuleInput interface {
	pulumi.Input

	ToApplicationNetworkRuleSetIpRuleOutput() ApplicationNetworkRuleSetIpRuleOutput
	ToApplicationNetworkRuleSetIpRuleOutputWithContext(context.Context) ApplicationNetworkRuleSetIpRuleOutput
}

ApplicationNetworkRuleSetIpRuleInput is an input type that accepts ApplicationNetworkRuleSetIpRuleArgs and ApplicationNetworkRuleSetIpRuleOutput values. You can construct a concrete instance of `ApplicationNetworkRuleSetIpRuleInput` via:

ApplicationNetworkRuleSetIpRuleArgs{...}

type ApplicationNetworkRuleSetIpRuleOutput

type ApplicationNetworkRuleSetIpRuleOutput struct{ *pulumi.OutputState }

func (ApplicationNetworkRuleSetIpRuleOutput) ElementType

func (ApplicationNetworkRuleSetIpRuleOutput) IpMask

The IP address range in CIDR notation for the IP Rule.

func (ApplicationNetworkRuleSetIpRuleOutput) Name

The name of the IP Rule

func (ApplicationNetworkRuleSetIpRuleOutput) ToApplicationNetworkRuleSetIpRuleOutput

func (o ApplicationNetworkRuleSetIpRuleOutput) ToApplicationNetworkRuleSetIpRuleOutput() ApplicationNetworkRuleSetIpRuleOutput

func (ApplicationNetworkRuleSetIpRuleOutput) ToApplicationNetworkRuleSetIpRuleOutputWithContext

func (o ApplicationNetworkRuleSetIpRuleOutput) ToApplicationNetworkRuleSetIpRuleOutputWithContext(ctx context.Context) ApplicationNetworkRuleSetIpRuleOutput

type ApplicationNetworkRuleSetMap

type ApplicationNetworkRuleSetMap map[string]ApplicationNetworkRuleSetInput

func (ApplicationNetworkRuleSetMap) ElementType

func (ApplicationNetworkRuleSetMap) ToApplicationNetworkRuleSetMapOutput

func (i ApplicationNetworkRuleSetMap) ToApplicationNetworkRuleSetMapOutput() ApplicationNetworkRuleSetMapOutput

func (ApplicationNetworkRuleSetMap) ToApplicationNetworkRuleSetMapOutputWithContext

func (i ApplicationNetworkRuleSetMap) ToApplicationNetworkRuleSetMapOutputWithContext(ctx context.Context) ApplicationNetworkRuleSetMapOutput

type ApplicationNetworkRuleSetMapInput

type ApplicationNetworkRuleSetMapInput interface {
	pulumi.Input

	ToApplicationNetworkRuleSetMapOutput() ApplicationNetworkRuleSetMapOutput
	ToApplicationNetworkRuleSetMapOutputWithContext(context.Context) ApplicationNetworkRuleSetMapOutput
}

ApplicationNetworkRuleSetMapInput is an input type that accepts ApplicationNetworkRuleSetMap and ApplicationNetworkRuleSetMapOutput values. You can construct a concrete instance of `ApplicationNetworkRuleSetMapInput` via:

ApplicationNetworkRuleSetMap{ "key": ApplicationNetworkRuleSetArgs{...} }

type ApplicationNetworkRuleSetMapOutput

type ApplicationNetworkRuleSetMapOutput struct{ *pulumi.OutputState }

func (ApplicationNetworkRuleSetMapOutput) ElementType

func (ApplicationNetworkRuleSetMapOutput) MapIndex

func (ApplicationNetworkRuleSetMapOutput) ToApplicationNetworkRuleSetMapOutput

func (o ApplicationNetworkRuleSetMapOutput) ToApplicationNetworkRuleSetMapOutput() ApplicationNetworkRuleSetMapOutput

func (ApplicationNetworkRuleSetMapOutput) ToApplicationNetworkRuleSetMapOutputWithContext

func (o ApplicationNetworkRuleSetMapOutput) ToApplicationNetworkRuleSetMapOutputWithContext(ctx context.Context) ApplicationNetworkRuleSetMapOutput

type ApplicationNetworkRuleSetOutput

type ApplicationNetworkRuleSetOutput struct{ *pulumi.OutputState }

func (ApplicationNetworkRuleSetOutput) ApplyToDevice

Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are `true`, `false`. Defaults to `true`

func (ApplicationNetworkRuleSetOutput) DefaultAction

Specifies the default action for the IoT Central Application Network Rule Set. Possible values are `Allow` and `Deny`. Defaults to `Deny`.

func (ApplicationNetworkRuleSetOutput) ElementType

func (ApplicationNetworkRuleSetOutput) IotcentralApplicationId

func (o ApplicationNetworkRuleSetOutput) IotcentralApplicationId() pulumi.StringOutput

The ID of the IoT Central Application. Changing this forces a new resource to be created.

func (ApplicationNetworkRuleSetOutput) IpRules

One or more `ipRule` blocks as defined below.

func (ApplicationNetworkRuleSetOutput) ToApplicationNetworkRuleSetOutput

func (o ApplicationNetworkRuleSetOutput) ToApplicationNetworkRuleSetOutput() ApplicationNetworkRuleSetOutput

func (ApplicationNetworkRuleSetOutput) ToApplicationNetworkRuleSetOutputWithContext

func (o ApplicationNetworkRuleSetOutput) ToApplicationNetworkRuleSetOutputWithContext(ctx context.Context) ApplicationNetworkRuleSetOutput

type ApplicationNetworkRuleSetState

type ApplicationNetworkRuleSetState struct {
	// Whether these IP Rules apply for device connectivity to IoT Hub and Device Provisioning Service associated with this IoT Central Application. Possible values are `true`, `false`. Defaults to `true`
	ApplyToDevice pulumi.BoolPtrInput
	// Specifies the default action for the IoT Central Application Network Rule Set. Possible values are `Allow` and `Deny`. Defaults to `Deny`.
	DefaultAction pulumi.StringPtrInput
	// The ID of the IoT Central Application. Changing this forces a new resource to be created.
	IotcentralApplicationId pulumi.StringPtrInput
	// One or more `ipRule` blocks as defined below.
	IpRules ApplicationNetworkRuleSetIpRuleArrayInput
}

func (ApplicationNetworkRuleSetState) ElementType

type ApplicationOutput

type ApplicationOutput struct{ *pulumi.OutputState }

func (ApplicationOutput) DisplayName

func (o ApplicationOutput) DisplayName() pulumi.StringOutput

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

> **NOTE:** Due to a bug in the provider, the default value of `displayName` of a newly created IoT Central App will be the Resource Group Name, it will be fixed and use resource name in 4.0. For an existing IoT Central App, this could be fixed by specifying the `displayName` explicitly.

func (ApplicationOutput) ElementType

func (ApplicationOutput) ElementType() reflect.Type

func (ApplicationOutput) Identity

An `identity` block as defined below.

func (ApplicationOutput) Location

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

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

func (ApplicationOutput) PublicNetworkAccessEnabled

func (o ApplicationOutput) PublicNetworkAccessEnabled() pulumi.BoolPtrOutput

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

func (ApplicationOutput) ResourceGroupName

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

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

func (ApplicationOutput) SubDomain

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

A mapping of tags to assign to the resource.

func (ApplicationOutput) Template

A `template` name. IoT Central application template name. Defaults to `iotc-pnp-preview@1.0.0`. Changing this forces a new resource to be created.

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.
	//
	// > **NOTE:** Due to a bug in the provider, the default value of `displayName` of a newly created IoT Central App will be the Resource Group Name, it will be fixed and use resource name in 4.0. For an existing IoT Central App, this could be fixed by specifying the `displayName` explicitly.
	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 `ST0`, `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. Defaults to `iotc-pnp-preview@1.0.0`. Changing this forces a new resource to be created.
	Template pulumi.StringPtrInput
}

func (ApplicationState) ElementType

func (ApplicationState) ElementType() reflect.Type

type Organization

type Organization struct {
	pulumi.CustomResourceState

	// Custom `displayName` for the organization.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// The application `id`. Changing this forces a new resource to be created.
	IotcentralApplicationId pulumi.StringOutput `pulumi:"iotcentralApplicationId"`
	// The ID of the organization. Changing this forces a new resource to be created.
	OrganizationId pulumi.StringOutput `pulumi:"organizationId"`
	// The `organizationId` of the parent organization. Changing this forces a new resource to be created.
	ParentOrganizationId pulumi.StringPtrOutput `pulumi:"parentOrganizationId"`
}

Manages an IoT Central Organization

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/iotcentral"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resource"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleApplication, err := iotcentral.NewApplication(ctx, "example", &iotcentral.ApplicationArgs{
			Name:              pulumi.String("example-iotcentral-app"),
			ResourceGroupName: example.Name,
			Location:          example.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
		}
		exampleParent, err := iotcentral.NewOrganization(ctx, "example_parent", &iotcentral.OrganizationArgs{
			IotcentralApplicationId: exampleApplication.ID(),
			OrganizationId:          pulumi.String("example-parent-organization-id"),
			DisplayName:             pulumi.String("Org example parent"),
		})
		if err != nil {
			return err
		}
		_, err = iotcentral.NewOrganization(ctx, "example", &iotcentral.OrganizationArgs{
			IotcentralApplicationId: exampleApplication.ID(),
			OrganizationId:          pulumi.String("example-child-organization-id"),
			DisplayName:             pulumi.String("Org example"),
			ParentOrganizationId:    exampleParent.OrganizationId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

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

```sh $ pulumi import azure:iotcentral/organization:Organization example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.IoTCentral/iotApps/example/organizations/example ```

func GetOrganization

func GetOrganization(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *OrganizationState, opts ...pulumi.ResourceOption) (*Organization, error)

GetOrganization gets an existing Organization 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 NewOrganization

func NewOrganization(ctx *pulumi.Context,
	name string, args *OrganizationArgs, opts ...pulumi.ResourceOption) (*Organization, error)

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

func (*Organization) ElementType

func (*Organization) ElementType() reflect.Type

func (*Organization) ToOrganizationOutput

func (i *Organization) ToOrganizationOutput() OrganizationOutput

func (*Organization) ToOrganizationOutputWithContext

func (i *Organization) ToOrganizationOutputWithContext(ctx context.Context) OrganizationOutput

type OrganizationArgs

type OrganizationArgs struct {
	// Custom `displayName` for the organization.
	DisplayName pulumi.StringInput
	// The application `id`. Changing this forces a new resource to be created.
	IotcentralApplicationId pulumi.StringInput
	// The ID of the organization. Changing this forces a new resource to be created.
	OrganizationId pulumi.StringInput
	// The `organizationId` of the parent organization. Changing this forces a new resource to be created.
	ParentOrganizationId pulumi.StringPtrInput
}

The set of arguments for constructing a Organization resource.

func (OrganizationArgs) ElementType

func (OrganizationArgs) ElementType() reflect.Type

type OrganizationArray

type OrganizationArray []OrganizationInput

func (OrganizationArray) ElementType

func (OrganizationArray) ElementType() reflect.Type

func (OrganizationArray) ToOrganizationArrayOutput

func (i OrganizationArray) ToOrganizationArrayOutput() OrganizationArrayOutput

func (OrganizationArray) ToOrganizationArrayOutputWithContext

func (i OrganizationArray) ToOrganizationArrayOutputWithContext(ctx context.Context) OrganizationArrayOutput

type OrganizationArrayInput

type OrganizationArrayInput interface {
	pulumi.Input

	ToOrganizationArrayOutput() OrganizationArrayOutput
	ToOrganizationArrayOutputWithContext(context.Context) OrganizationArrayOutput
}

OrganizationArrayInput is an input type that accepts OrganizationArray and OrganizationArrayOutput values. You can construct a concrete instance of `OrganizationArrayInput` via:

OrganizationArray{ OrganizationArgs{...} }

type OrganizationArrayOutput

type OrganizationArrayOutput struct{ *pulumi.OutputState }

func (OrganizationArrayOutput) ElementType

func (OrganizationArrayOutput) ElementType() reflect.Type

func (OrganizationArrayOutput) Index

func (OrganizationArrayOutput) ToOrganizationArrayOutput

func (o OrganizationArrayOutput) ToOrganizationArrayOutput() OrganizationArrayOutput

func (OrganizationArrayOutput) ToOrganizationArrayOutputWithContext

func (o OrganizationArrayOutput) ToOrganizationArrayOutputWithContext(ctx context.Context) OrganizationArrayOutput

type OrganizationInput

type OrganizationInput interface {
	pulumi.Input

	ToOrganizationOutput() OrganizationOutput
	ToOrganizationOutputWithContext(ctx context.Context) OrganizationOutput
}

type OrganizationMap

type OrganizationMap map[string]OrganizationInput

func (OrganizationMap) ElementType

func (OrganizationMap) ElementType() reflect.Type

func (OrganizationMap) ToOrganizationMapOutput

func (i OrganizationMap) ToOrganizationMapOutput() OrganizationMapOutput

func (OrganizationMap) ToOrganizationMapOutputWithContext

func (i OrganizationMap) ToOrganizationMapOutputWithContext(ctx context.Context) OrganizationMapOutput

type OrganizationMapInput

type OrganizationMapInput interface {
	pulumi.Input

	ToOrganizationMapOutput() OrganizationMapOutput
	ToOrganizationMapOutputWithContext(context.Context) OrganizationMapOutput
}

OrganizationMapInput is an input type that accepts OrganizationMap and OrganizationMapOutput values. You can construct a concrete instance of `OrganizationMapInput` via:

OrganizationMap{ "key": OrganizationArgs{...} }

type OrganizationMapOutput

type OrganizationMapOutput struct{ *pulumi.OutputState }

func (OrganizationMapOutput) ElementType

func (OrganizationMapOutput) ElementType() reflect.Type

func (OrganizationMapOutput) MapIndex

func (OrganizationMapOutput) ToOrganizationMapOutput

func (o OrganizationMapOutput) ToOrganizationMapOutput() OrganizationMapOutput

func (OrganizationMapOutput) ToOrganizationMapOutputWithContext

func (o OrganizationMapOutput) ToOrganizationMapOutputWithContext(ctx context.Context) OrganizationMapOutput

type OrganizationOutput

type OrganizationOutput struct{ *pulumi.OutputState }

func (OrganizationOutput) DisplayName

func (o OrganizationOutput) DisplayName() pulumi.StringOutput

Custom `displayName` for the organization.

func (OrganizationOutput) ElementType

func (OrganizationOutput) ElementType() reflect.Type

func (OrganizationOutput) IotcentralApplicationId

func (o OrganizationOutput) IotcentralApplicationId() pulumi.StringOutput

The application `id`. Changing this forces a new resource to be created.

func (OrganizationOutput) OrganizationId

func (o OrganizationOutput) OrganizationId() pulumi.StringOutput

The ID of the organization. Changing this forces a new resource to be created.

func (OrganizationOutput) ParentOrganizationId

func (o OrganizationOutput) ParentOrganizationId() pulumi.StringPtrOutput

The `organizationId` of the parent organization. Changing this forces a new resource to be created.

func (OrganizationOutput) ToOrganizationOutput

func (o OrganizationOutput) ToOrganizationOutput() OrganizationOutput

func (OrganizationOutput) ToOrganizationOutputWithContext

func (o OrganizationOutput) ToOrganizationOutputWithContext(ctx context.Context) OrganizationOutput

type OrganizationState

type OrganizationState struct {
	// Custom `displayName` for the organization.
	DisplayName pulumi.StringPtrInput
	// The application `id`. Changing this forces a new resource to be created.
	IotcentralApplicationId pulumi.StringPtrInput
	// The ID of the organization. Changing this forces a new resource to be created.
	OrganizationId pulumi.StringPtrInput
	// The `organizationId` of the parent organization. Changing this forces a new resource to be created.
	ParentOrganizationId pulumi.StringPtrInput
}

func (OrganizationState) ElementType

func (OrganizationState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

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