Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. digitaltwins
  5. Instance

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.digitaltwins.Instance

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Digital Twins instance.

    Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example_resources",
    location: "West Europe",
});
const exampleInstance = new azure.digitaltwins.Instance("example", {
    name: "example-DT",
    resourceGroupName: example.name,
    location: example.location,
    tags: {
        foo: "bar",
    },
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example_resources",
    location="West Europe")
example_instance = azure.digitaltwins.Instance("example",
    name="example-DT",
    resource_group_name=example.name,
    location=example.location,
    tags={
        "foo": "bar",
    })

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/digitaltwins"
	"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_resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = digitaltwins.NewInstance(ctx, "example", &digitaltwins.InstanceArgs{
			Name:              pulumi.String("example-DT"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			Tags: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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_resources",
        Location = "West Europe",
    });

    var exampleInstance = new Azure.DigitalTwins.Instance("example", new()
    {
        Name = "example-DT",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Tags = 
        {
            { "foo", "bar" },
        },
    });

});

    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.digitaltwins.Instance;
import com.pulumi.azure.digitaltwins.InstanceArgs;
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_resources")
            .location("West Europe")
            .build());

        var exampleInstance = new Instance("exampleInstance", InstanceArgs.builder()
            .name("example-DT")
            .resourceGroupName(example.name())
            .location(example.location())
            .tags(Map.of("foo", "bar"))
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example_resources
      location: West Europe
  exampleInstance:
    type: azure:digitaltwins:Instance
    name: example
    properties:
      name: example-DT
      resourceGroupName: ${example.name}
      location: ${example.location}
      tags:
        foo: bar

    Create Instance Resource

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

    Constructor syntax

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

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             resource_group_name: Optional[str] = None,
             identity: Optional[InstanceIdentityArgs] = None,
             location: Optional[str] = None,
             name: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    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 instanceResource = new Azure.DigitalTwins.Instance("instanceResource", new()
{
    ResourceGroupName = "string",
    Identity = new Azure.DigitalTwins.Inputs.InstanceIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := digitaltwins.NewInstance(ctx, "instanceResource", &digitaltwins.InstanceArgs{
	ResourceGroupName: pulumi.String("string"),
	Identity: &digitaltwins.InstanceIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var instanceResource = new Instance("instanceResource", InstanceArgs.builder()
    .resourceGroupName("string")
    .identity(InstanceIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    instance_resource = azure.digitaltwins.Instance("instanceResource",
    resource_group_name="string",
    identity={
        "type": "string",
        "identity_ids": ["string"],
        "principal_id": "string",
        "tenant_id": "string",
    },
    location="string",
    name="string",
    tags={
        "string": "string",
    })

    const instanceResource = new azure.digitaltwins.Instance("instanceResource", {
    resourceGroupName: "string",
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: azure:digitaltwins:Instance
properties:
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    location: string
    name: string
    resourceGroupName: string
    tags:
        string: string

    Instance 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 Instance resource accepts the following input properties:

    ResourceGroupName string
    The name of the Resource Group where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    Identity InstanceIdentity
    An identity block as defined below.
    Location string
    The Azure Region where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    Name string
    The name which should be used for this Digital Twins instance. Changing this forces a new Digital Twins instance to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Digital Twins instance.
    ResourceGroupName string
    The name of the Resource Group where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    Identity InstanceIdentityArgs
    An identity block as defined below.
    Location string
    The Azure Region where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    Name string
    The name which should be used for this Digital Twins instance. Changing this forces a new Digital Twins instance to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Digital Twins instance.
    resourceGroupName String
    The name of the Resource Group where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    identity InstanceIdentity
    An identity block as defined below.
    location String
    The Azure Region where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    name String
    The name which should be used for this Digital Twins instance. Changing this forces a new Digital Twins instance to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Digital Twins instance.
    resourceGroupName string
    The name of the Resource Group where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    identity InstanceIdentity
    An identity block as defined below.
    location string
    The Azure Region where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    name string
    The name which should be used for this Digital Twins instance. Changing this forces a new Digital Twins instance to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Digital Twins instance.
    resource_group_name str
    The name of the Resource Group where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    identity InstanceIdentityArgs
    An identity block as defined below.
    location str
    The Azure Region where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    name str
    The name which should be used for this Digital Twins instance. Changing this forces a new Digital Twins instance to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Digital Twins instance.
    resourceGroupName String
    The name of the Resource Group where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    identity Property Map
    An identity block as defined below.
    location String
    The Azure Region where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    name String
    The name which should be used for this Digital Twins instance. Changing this forces a new Digital Twins instance to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Digital Twins instance.

    Outputs

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

    HostName string
    The API endpoint to work with this Digital Twins instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    HostName string
    The API endpoint to work with this Digital Twins instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    hostName String
    The API endpoint to work with this Digital Twins instance.
    id String
    The provider-assigned unique ID for this managed resource.
    hostName string
    The API endpoint to work with this Digital Twins instance.
    id string
    The provider-assigned unique ID for this managed resource.
    host_name str
    The API endpoint to work with this Digital Twins instance.
    id str
    The provider-assigned unique ID for this managed resource.
    hostName String
    The API endpoint to work with this Digital Twins instance.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Instance Resource

    Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        host_name: Optional[str] = None,
        identity: Optional[InstanceIdentityArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    HostName string
    The API endpoint to work with this Digital Twins instance.
    Identity InstanceIdentity
    An identity block as defined below.
    Location string
    The Azure Region where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    Name string
    The name which should be used for this Digital Twins instance. Changing this forces a new Digital Twins instance to be created.
    ResourceGroupName string
    The name of the Resource Group where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Digital Twins instance.
    HostName string
    The API endpoint to work with this Digital Twins instance.
    Identity InstanceIdentityArgs
    An identity block as defined below.
    Location string
    The Azure Region where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    Name string
    The name which should be used for this Digital Twins instance. Changing this forces a new Digital Twins instance to be created.
    ResourceGroupName string
    The name of the Resource Group where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Digital Twins instance.
    hostName String
    The API endpoint to work with this Digital Twins instance.
    identity InstanceIdentity
    An identity block as defined below.
    location String
    The Azure Region where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    name String
    The name which should be used for this Digital Twins instance. Changing this forces a new Digital Twins instance to be created.
    resourceGroupName String
    The name of the Resource Group where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Digital Twins instance.
    hostName string
    The API endpoint to work with this Digital Twins instance.
    identity InstanceIdentity
    An identity block as defined below.
    location string
    The Azure Region where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    name string
    The name which should be used for this Digital Twins instance. Changing this forces a new Digital Twins instance to be created.
    resourceGroupName string
    The name of the Resource Group where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Digital Twins instance.
    host_name str
    The API endpoint to work with this Digital Twins instance.
    identity InstanceIdentityArgs
    An identity block as defined below.
    location str
    The Azure Region where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    name str
    The name which should be used for this Digital Twins instance. Changing this forces a new Digital Twins instance to be created.
    resource_group_name str
    The name of the Resource Group where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Digital Twins instance.
    hostName String
    The API endpoint to work with this Digital Twins instance.
    identity Property Map
    An identity block as defined below.
    location String
    The Azure Region where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    name String
    The name which should be used for this Digital Twins instance. Changing this forces a new Digital Twins instance to be created.
    resourceGroupName String
    The name of the Resource Group where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Digital Twins instance.

    Supporting Types

    InstanceIdentity, InstanceIdentityArgs

    Type string
    Specifies the type of Managed Service Identity that should be configured on this Digital Twins instance. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    IdentityIds List<string>

    A list of User Assigned Managed Identity IDs to be assigned to this Digital Twins instance.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    Type string
    Specifies the type of Managed Service Identity that should be configured on this Digital Twins instance. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    IdentityIds []string

    A list of User Assigned Managed Identity IDs to be assigned to this Digital Twins instance.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Digital Twins instance. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds List<String>

    A list of User Assigned Managed Identity IDs to be assigned to this Digital Twins instance.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.
    type string
    Specifies the type of Managed Service Identity that should be configured on this Digital Twins instance. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds string[]

    A list of User Assigned Managed Identity IDs to be assigned to this Digital Twins instance.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId string
    The Principal ID associated with this Managed Service Identity.
    tenantId string
    The Tenant ID associated with this Managed Service Identity.
    type str
    Specifies the type of Managed Service Identity that should be configured on this Digital Twins instance. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identity_ids Sequence[str]

    A list of User Assigned Managed Identity IDs to be assigned to this Digital Twins instance.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principal_id str
    The Principal ID associated with this Managed Service Identity.
    tenant_id str
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Digital Twins instance. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds List<String>

    A list of User Assigned Managed Identity IDs to be assigned to this Digital Twins instance.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.

    Import

    Digital Twins instances can be imported using the resource id, e.g.

    $ pulumi import azure:digitaltwins/instance:Instance example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DigitalTwins/digitalTwinsInstances/dt1

    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.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure