Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. iotcentral
  5. Organization

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.iotcentral.Organization

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an IoT Central Organization

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resource",
    location: "West Europe",
});
const exampleApplication = new azure.iotcentral.Application("example", {
    name: "example-iotcentral-app",
    resourceGroupName: example.name,
    location: example.location,
    subDomain: "example-iotcentral-app-subdomain",
    displayName: "example-iotcentral-app-display-name",
    sku: "ST1",
    template: "iotc-default@1.0.0",
    tags: {
        Foo: "Bar",
    },
});
const exampleParent = new azure.iotcentral.Organization("example_parent", {
    iotcentralApplicationId: exampleApplication.id,
    organizationId: "example-parent-organization-id",
    displayName: "Org example parent",
});
const exampleOrganization = new azure.iotcentral.Organization("example", {
    iotcentralApplicationId: exampleApplication.id,
    organizationId: "example-child-organization-id",
    displayName: "Org example",
    parentOrganizationId: exampleParent.organizationId,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resource",
    location="West Europe")
example_application = azure.iotcentral.Application("example",
    name="example-iotcentral-app",
    resource_group_name=example.name,
    location=example.location,
    sub_domain="example-iotcentral-app-subdomain",
    display_name="example-iotcentral-app-display-name",
    sku="ST1",
    template="iotc-default@1.0.0",
    tags={
        "Foo": "Bar",
    })
example_parent = azure.iotcentral.Organization("example_parent",
    iotcentral_application_id=example_application.id,
    organization_id="example-parent-organization-id",
    display_name="Org example parent")
example_organization = azure.iotcentral.Organization("example",
    iotcentral_application_id=example_application.id,
    organization_id="example-child-organization-id",
    display_name="Org example",
    parent_organization_id=example_parent.organization_id)
Copy
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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resource",
        Location = "West Europe",
    });

    var exampleApplication = new Azure.IotCentral.Application("example", new()
    {
        Name = "example-iotcentral-app",
        ResourceGroupName = example.Name,
        Location = example.Location,
        SubDomain = "example-iotcentral-app-subdomain",
        DisplayName = "example-iotcentral-app-display-name",
        Sku = "ST1",
        Template = "iotc-default@1.0.0",
        Tags = 
        {
            { "Foo", "Bar" },
        },
    });

    var exampleParent = new Azure.IotCentral.Organization("example_parent", new()
    {
        IotcentralApplicationId = exampleApplication.Id,
        OrganizationId = "example-parent-organization-id",
        DisplayName = "Org example parent",
    });

    var exampleOrganization = new Azure.IotCentral.Organization("example", new()
    {
        IotcentralApplicationId = exampleApplication.Id,
        OrganizationId = "example-child-organization-id",
        DisplayName = "Org example",
        ParentOrganizationId = exampleParent.OrganizationId,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.iotcentral.Application;
import com.pulumi.azure.iotcentral.ApplicationArgs;
import com.pulumi.azure.iotcentral.Organization;
import com.pulumi.azure.iotcentral.OrganizationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resource")
            .location("West Europe")
            .build());

        var exampleApplication = new Application("exampleApplication", ApplicationArgs.builder()
            .name("example-iotcentral-app")
            .resourceGroupName(example.name())
            .location(example.location())
            .subDomain("example-iotcentral-app-subdomain")
            .displayName("example-iotcentral-app-display-name")
            .sku("ST1")
            .template("iotc-default@1.0.0")
            .tags(Map.of("Foo", "Bar"))
            .build());

        var exampleParent = new Organization("exampleParent", OrganizationArgs.builder()
            .iotcentralApplicationId(exampleApplication.id())
            .organizationId("example-parent-organization-id")
            .displayName("Org example parent")
            .build());

        var exampleOrganization = new Organization("exampleOrganization", OrganizationArgs.builder()
            .iotcentralApplicationId(exampleApplication.id())
            .organizationId("example-child-organization-id")
            .displayName("Org example")
            .parentOrganizationId(exampleParent.organizationId())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resource
      location: West Europe
  exampleApplication:
    type: azure:iotcentral:Application
    name: example
    properties:
      name: example-iotcentral-app
      resourceGroupName: ${example.name}
      location: ${example.location}
      subDomain: example-iotcentral-app-subdomain
      displayName: example-iotcentral-app-display-name
      sku: ST1
      template: iotc-default@1.0.0
      tags:
        Foo: Bar
  exampleParent:
    type: azure:iotcentral:Organization
    name: example_parent
    properties:
      iotcentralApplicationId: ${exampleApplication.id}
      organizationId: example-parent-organization-id
      displayName: Org example parent
  exampleOrganization:
    type: azure:iotcentral:Organization
    name: example
    properties:
      iotcentralApplicationId: ${exampleApplication.id}
      organizationId: example-child-organization-id
      displayName: Org example
      parentOrganizationId: ${exampleParent.organizationId}
Copy

Create Organization Resource

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

Constructor syntax

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

@overload
def Organization(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 display_name: Optional[str] = None,
                 iotcentral_application_id: Optional[str] = None,
                 organization_id: Optional[str] = None,
                 parent_organization_id: Optional[str] = None)
func NewOrganization(ctx *Context, name string, args OrganizationArgs, opts ...ResourceOption) (*Organization, error)
public Organization(string name, OrganizationArgs args, CustomResourceOptions? opts = null)
public Organization(String name, OrganizationArgs args)
public Organization(String name, OrganizationArgs args, CustomResourceOptions options)

type: azure:iotcentral:Organization
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

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

var organizationResource = new Azure.IotCentral.Organization("organizationResource", new()
{
    DisplayName = "string",
    IotcentralApplicationId = "string",
    OrganizationId = "string",
    ParentOrganizationId = "string",
});
Copy
example, err := iotcentral.NewOrganization(ctx, "organizationResource", &iotcentral.OrganizationArgs{
	DisplayName:             pulumi.String("string"),
	IotcentralApplicationId: pulumi.String("string"),
	OrganizationId:          pulumi.String("string"),
	ParentOrganizationId:    pulumi.String("string"),
})
Copy
var organizationResource = new Organization("organizationResource", OrganizationArgs.builder()
    .displayName("string")
    .iotcentralApplicationId("string")
    .organizationId("string")
    .parentOrganizationId("string")
    .build());
Copy
organization_resource = azure.iotcentral.Organization("organizationResource",
    display_name="string",
    iotcentral_application_id="string",
    organization_id="string",
    parent_organization_id="string")
Copy
const organizationResource = new azure.iotcentral.Organization("organizationResource", {
    displayName: "string",
    iotcentralApplicationId: "string",
    organizationId: "string",
    parentOrganizationId: "string",
});
Copy
type: azure:iotcentral:Organization
properties:
    displayName: string
    iotcentralApplicationId: string
    organizationId: string
    parentOrganizationId: string
Copy

Organization Resource Properties

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

Inputs

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

The Organization resource accepts the following input properties:

DisplayName This property is required. string
Custom display_name for the organization.
IotcentralApplicationId
This property is required.
Changes to this property will trigger replacement.
string
The application id. Changing this forces a new resource to be created.
OrganizationId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the organization. Changing this forces a new resource to be created.
ParentOrganizationId Changes to this property will trigger replacement. string
The organization_id of the parent organization. Changing this forces a new resource to be created.
DisplayName This property is required. string
Custom display_name for the organization.
IotcentralApplicationId
This property is required.
Changes to this property will trigger replacement.
string
The application id. Changing this forces a new resource to be created.
OrganizationId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the organization. Changing this forces a new resource to be created.
ParentOrganizationId Changes to this property will trigger replacement. string
The organization_id of the parent organization. Changing this forces a new resource to be created.
displayName This property is required. String
Custom display_name for the organization.
iotcentralApplicationId
This property is required.
Changes to this property will trigger replacement.
String
The application id. Changing this forces a new resource to be created.
organizationId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the organization. Changing this forces a new resource to be created.
parentOrganizationId Changes to this property will trigger replacement. String
The organization_id of the parent organization. Changing this forces a new resource to be created.
displayName This property is required. string
Custom display_name for the organization.
iotcentralApplicationId
This property is required.
Changes to this property will trigger replacement.
string
The application id. Changing this forces a new resource to be created.
organizationId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the organization. Changing this forces a new resource to be created.
parentOrganizationId Changes to this property will trigger replacement. string
The organization_id of the parent organization. Changing this forces a new resource to be created.
display_name This property is required. str
Custom display_name for the organization.
iotcentral_application_id
This property is required.
Changes to this property will trigger replacement.
str
The application id. Changing this forces a new resource to be created.
organization_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the organization. Changing this forces a new resource to be created.
parent_organization_id Changes to this property will trigger replacement. str
The organization_id of the parent organization. Changing this forces a new resource to be created.
displayName This property is required. String
Custom display_name for the organization.
iotcentralApplicationId
This property is required.
Changes to this property will trigger replacement.
String
The application id. Changing this forces a new resource to be created.
organizationId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the organization. Changing this forces a new resource to be created.
parentOrganizationId Changes to this property will trigger replacement. String
The organization_id of the parent organization. Changing this forces a new resource to be created.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Organization Resource

Get an existing Organization resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OrganizationState, opts?: CustomResourceOptions): Organization
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        display_name: Optional[str] = None,
        iotcentral_application_id: Optional[str] = None,
        organization_id: Optional[str] = None,
        parent_organization_id: Optional[str] = None) -> Organization
func GetOrganization(ctx *Context, name string, id IDInput, state *OrganizationState, opts ...ResourceOption) (*Organization, error)
public static Organization Get(string name, Input<string> id, OrganizationState? state, CustomResourceOptions? opts = null)
public static Organization get(String name, Output<String> id, OrganizationState state, CustomResourceOptions options)
resources:  _:    type: azure:iotcentral:Organization    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
DisplayName string
Custom display_name for the organization.
IotcentralApplicationId Changes to this property will trigger replacement. string
The application id. Changing this forces a new resource to be created.
OrganizationId Changes to this property will trigger replacement. string
The ID of the organization. Changing this forces a new resource to be created.
ParentOrganizationId Changes to this property will trigger replacement. string
The organization_id of the parent organization. Changing this forces a new resource to be created.
DisplayName string
Custom display_name for the organization.
IotcentralApplicationId Changes to this property will trigger replacement. string
The application id. Changing this forces a new resource to be created.
OrganizationId Changes to this property will trigger replacement. string
The ID of the organization. Changing this forces a new resource to be created.
ParentOrganizationId Changes to this property will trigger replacement. string
The organization_id of the parent organization. Changing this forces a new resource to be created.
displayName String
Custom display_name for the organization.
iotcentralApplicationId Changes to this property will trigger replacement. String
The application id. Changing this forces a new resource to be created.
organizationId Changes to this property will trigger replacement. String
The ID of the organization. Changing this forces a new resource to be created.
parentOrganizationId Changes to this property will trigger replacement. String
The organization_id of the parent organization. Changing this forces a new resource to be created.
displayName string
Custom display_name for the organization.
iotcentralApplicationId Changes to this property will trigger replacement. string
The application id. Changing this forces a new resource to be created.
organizationId Changes to this property will trigger replacement. string
The ID of the organization. Changing this forces a new resource to be created.
parentOrganizationId Changes to this property will trigger replacement. string
The organization_id of the parent organization. Changing this forces a new resource to be created.
display_name str
Custom display_name for the organization.
iotcentral_application_id Changes to this property will trigger replacement. str
The application id. Changing this forces a new resource to be created.
organization_id Changes to this property will trigger replacement. str
The ID of the organization. Changing this forces a new resource to be created.
parent_organization_id Changes to this property will trigger replacement. str
The organization_id of the parent organization. Changing this forces a new resource to be created.
displayName String
Custom display_name for the organization.
iotcentralApplicationId Changes to this property will trigger replacement. String
The application id. Changing this forces a new resource to be created.
organizationId Changes to this property will trigger replacement. String
The ID of the organization. Changing this forces a new resource to be created.
parentOrganizationId Changes to this property will trigger replacement. String
The organization_id of the parent organization. Changing this forces a new resource to be created.

Import

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

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

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

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure