1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. oci
  5. getIotDigitalTwinRelationship
Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

oci.oci.getIotDigitalTwinRelationship

Get Started
oci logo
Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

    This data source provides details about a specific Digital Twin Relationship resource in Oracle Cloud Infrastructure Iot service.

    Retrieves the digital twin relationship identified by the specified OCID.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDigitalTwinRelationship = oci.oci.getIotDigitalTwinRelationship({
        digitalTwinRelationshipId: testDigitalTwinRelationshipOciIotDigitalTwinRelationship.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_digital_twin_relationship = oci.oci.get_iot_digital_twin_relationship(digital_twin_relationship_id=test_digital_twin_relationship_oci_iot_digital_twin_relationship["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/oci"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := oci.LookupIotDigitalTwinRelationship(ctx, &oci.LookupIotDigitalTwinRelationshipArgs{
    			DigitalTwinRelationshipId: testDigitalTwinRelationshipOciIotDigitalTwinRelationship.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testDigitalTwinRelationship = Oci.Oci.GetIotDigitalTwinRelationship.Invoke(new()
        {
            DigitalTwinRelationshipId = testDigitalTwinRelationshipOciIotDigitalTwinRelationship.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.oci.OciFunctions;
    import com.pulumi.oci.oci.inputs.GetIotDigitalTwinRelationshipArgs;
    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) {
            final var testDigitalTwinRelationship = OciFunctions.getIotDigitalTwinRelationship(GetIotDigitalTwinRelationshipArgs.builder()
                .digitalTwinRelationshipId(testDigitalTwinRelationshipOciIotDigitalTwinRelationship.id())
                .build());
    
        }
    }
    
    variables:
      testDigitalTwinRelationship:
        fn::invoke:
          function: oci:oci:getIotDigitalTwinRelationship
          arguments:
            digitalTwinRelationshipId: ${testDigitalTwinRelationshipOciIotDigitalTwinRelationship.id}
    

    Using getIotDigitalTwinRelationship

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIotDigitalTwinRelationship(args: GetIotDigitalTwinRelationshipArgs, opts?: InvokeOptions): Promise<GetIotDigitalTwinRelationshipResult>
    function getIotDigitalTwinRelationshipOutput(args: GetIotDigitalTwinRelationshipOutputArgs, opts?: InvokeOptions): Output<GetIotDigitalTwinRelationshipResult>
    def get_iot_digital_twin_relationship(digital_twin_relationship_id: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetIotDigitalTwinRelationshipResult
    def get_iot_digital_twin_relationship_output(digital_twin_relationship_id: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetIotDigitalTwinRelationshipResult]
    func LookupIotDigitalTwinRelationship(ctx *Context, args *LookupIotDigitalTwinRelationshipArgs, opts ...InvokeOption) (*LookupIotDigitalTwinRelationshipResult, error)
    func LookupIotDigitalTwinRelationshipOutput(ctx *Context, args *LookupIotDigitalTwinRelationshipOutputArgs, opts ...InvokeOption) LookupIotDigitalTwinRelationshipResultOutput

    > Note: This function is named LookupIotDigitalTwinRelationship in the Go SDK.

    public static class GetIotDigitalTwinRelationship 
    {
        public static Task<GetIotDigitalTwinRelationshipResult> InvokeAsync(GetIotDigitalTwinRelationshipArgs args, InvokeOptions? opts = null)
        public static Output<GetIotDigitalTwinRelationshipResult> Invoke(GetIotDigitalTwinRelationshipInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIotDigitalTwinRelationshipResult> getIotDigitalTwinRelationship(GetIotDigitalTwinRelationshipArgs args, InvokeOptions options)
    public static Output<GetIotDigitalTwinRelationshipResult> getIotDigitalTwinRelationship(GetIotDigitalTwinRelationshipArgs args, InvokeOptions options)
    
    fn::invoke:
      function: oci:oci/getIotDigitalTwinRelationship:getIotDigitalTwinRelationship
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DigitalTwinRelationshipId string
    The OCID of digital twin relationship.
    DigitalTwinRelationshipId string
    The OCID of digital twin relationship.
    digitalTwinRelationshipId String
    The OCID of digital twin relationship.
    digitalTwinRelationshipId string
    The OCID of digital twin relationship.
    digital_twin_relationship_id str
    The OCID of digital twin relationship.
    digitalTwinRelationshipId String
    The OCID of digital twin relationship.

    getIotDigitalTwinRelationship Result

    The following output properties are available:

    Content string
    The value(s) of the relationship properties defined in the source digital twin model.
    ContentPath string
    Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    A short description of the resource.
    DigitalTwinRelationshipId string
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the resource.
    IotDomainId string
    The OCID of the IoT domain.
    SourceDigitalTwinInstanceId string
    The OCID of source digital twin instance.
    State string
    The current state of the digital twin relationship.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TargetDigitalTwinInstanceId string
    The OCID of target digital twin instance.
    TimeCreated string
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    Content string
    The value(s) of the relationship properties defined in the source digital twin model.
    ContentPath string
    Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    A short description of the resource.
    DigitalTwinRelationshipId string
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the resource.
    IotDomainId string
    The OCID of the IoT domain.
    SourceDigitalTwinInstanceId string
    The OCID of source digital twin instance.
    State string
    The current state of the digital twin relationship.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TargetDigitalTwinInstanceId string
    The OCID of target digital twin instance.
    TimeCreated string
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    content String
    The value(s) of the relationship properties defined in the source digital twin model.
    contentPath String
    Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    A short description of the resource.
    digitalTwinRelationshipId String
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the resource.
    iotDomainId String
    The OCID of the IoT domain.
    sourceDigitalTwinInstanceId String
    The OCID of source digital twin instance.
    state String
    The current state of the digital twin relationship.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    targetDigitalTwinInstanceId String
    The OCID of target digital twin instance.
    timeCreated String
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    content string
    The value(s) of the relationship properties defined in the source digital twin model.
    contentPath string
    Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    A short description of the resource.
    digitalTwinRelationshipId string
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of the resource.
    iotDomainId string
    The OCID of the IoT domain.
    sourceDigitalTwinInstanceId string
    The OCID of source digital twin instance.
    state string
    The current state of the digital twin relationship.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    targetDigitalTwinInstanceId string
    The OCID of target digital twin instance.
    timeCreated string
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    content str
    The value(s) of the relationship properties defined in the source digital twin model.
    content_path str
    Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    A short description of the resource.
    digital_twin_relationship_id str
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of the resource.
    iot_domain_id str
    The OCID of the IoT domain.
    source_digital_twin_instance_id str
    The OCID of source digital twin instance.
    state str
    The current state of the digital twin relationship.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    target_digital_twin_instance_id str
    The OCID of target digital twin instance.
    time_created str
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    content String
    The value(s) of the relationship properties defined in the source digital twin model.
    contentPath String
    Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    A short description of the resource.
    digitalTwinRelationshipId String
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the resource.
    iotDomainId String
    The OCID of the IoT domain.
    sourceDigitalTwinInstanceId String
    The OCID of source digital twin instance.
    state String
    The current state of the digital twin relationship.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    targetDigitalTwinInstanceId String
    The OCID of target digital twin instance.
    timeCreated String
    The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate