Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi
oci.oci.getIotDigitalTwinRelationships
This data source provides the list of Digital Twin Relationships in Oracle Cloud Infrastructure Iot service.
Retrieves a list of digital twin relationships within the specified IoT domain.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDigitalTwinRelationships = oci.oci.getIotDigitalTwinRelationships({
iotDomainId: testIotDomain.id,
contentPath: digitalTwinRelationshipContentPath,
displayName: digitalTwinRelationshipDisplayName,
id: digitalTwinRelationshipId,
sourceDigitalTwinInstanceId: testDigitalTwinInstance.id,
state: digitalTwinRelationshipState,
targetDigitalTwinInstanceId: testDigitalTwinInstance.id,
});
import pulumi
import pulumi_oci as oci
test_digital_twin_relationships = oci.oci.get_iot_digital_twin_relationships(iot_domain_id=test_iot_domain["id"],
content_path=digital_twin_relationship_content_path,
display_name=digital_twin_relationship_display_name,
id=digital_twin_relationship_id,
source_digital_twin_instance_id=test_digital_twin_instance["id"],
state=digital_twin_relationship_state,
target_digital_twin_instance_id=test_digital_twin_instance["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.GetIotDigitalTwinRelationships(ctx, &oci.GetIotDigitalTwinRelationshipsArgs{
IotDomainId: testIotDomain.Id,
ContentPath: pulumi.StringRef(digitalTwinRelationshipContentPath),
DisplayName: pulumi.StringRef(digitalTwinRelationshipDisplayName),
Id: pulumi.StringRef(digitalTwinRelationshipId),
SourceDigitalTwinInstanceId: pulumi.StringRef(testDigitalTwinInstance.Id),
State: pulumi.StringRef(digitalTwinRelationshipState),
TargetDigitalTwinInstanceId: pulumi.StringRef(testDigitalTwinInstance.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 testDigitalTwinRelationships = Oci.Oci.GetIotDigitalTwinRelationships.Invoke(new()
{
IotDomainId = testIotDomain.Id,
ContentPath = digitalTwinRelationshipContentPath,
DisplayName = digitalTwinRelationshipDisplayName,
Id = digitalTwinRelationshipId,
SourceDigitalTwinInstanceId = testDigitalTwinInstance.Id,
State = digitalTwinRelationshipState,
TargetDigitalTwinInstanceId = testDigitalTwinInstance.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.GetIotDigitalTwinRelationshipsArgs;
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 testDigitalTwinRelationships = OciFunctions.getIotDigitalTwinRelationships(GetIotDigitalTwinRelationshipsArgs.builder()
.iotDomainId(testIotDomain.id())
.contentPath(digitalTwinRelationshipContentPath)
.displayName(digitalTwinRelationshipDisplayName)
.id(digitalTwinRelationshipId)
.sourceDigitalTwinInstanceId(testDigitalTwinInstance.id())
.state(digitalTwinRelationshipState)
.targetDigitalTwinInstanceId(testDigitalTwinInstance.id())
.build());
}
}
variables:
testDigitalTwinRelationships:
fn::invoke:
function: oci:oci:getIotDigitalTwinRelationships
arguments:
iotDomainId: ${testIotDomain.id}
contentPath: ${digitalTwinRelationshipContentPath}
displayName: ${digitalTwinRelationshipDisplayName}
id: ${digitalTwinRelationshipId}
sourceDigitalTwinInstanceId: ${testDigitalTwinInstance.id}
state: ${digitalTwinRelationshipState}
targetDigitalTwinInstanceId: ${testDigitalTwinInstance.id}
Using getIotDigitalTwinRelationships
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 getIotDigitalTwinRelationships(args: GetIotDigitalTwinRelationshipsArgs, opts?: InvokeOptions): Promise<GetIotDigitalTwinRelationshipsResult>
function getIotDigitalTwinRelationshipsOutput(args: GetIotDigitalTwinRelationshipsOutputArgs, opts?: InvokeOptions): Output<GetIotDigitalTwinRelationshipsResult>def get_iot_digital_twin_relationships(content_path: Optional[str] = None,
display_name: Optional[str] = None,
filters: Optional[Sequence[GetIotDigitalTwinRelationshipsFilter]] = None,
id: Optional[str] = None,
iot_domain_id: Optional[str] = None,
source_digital_twin_instance_id: Optional[str] = None,
state: Optional[str] = None,
target_digital_twin_instance_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetIotDigitalTwinRelationshipsResult
def get_iot_digital_twin_relationships_output(content_path: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetIotDigitalTwinRelationshipsFilterArgs]]]] = None,
id: Optional[pulumi.Input[str]] = None,
iot_domain_id: Optional[pulumi.Input[str]] = None,
source_digital_twin_instance_id: Optional[pulumi.Input[str]] = None,
state: Optional[pulumi.Input[str]] = None,
target_digital_twin_instance_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetIotDigitalTwinRelationshipsResult]func GetIotDigitalTwinRelationships(ctx *Context, args *GetIotDigitalTwinRelationshipsArgs, opts ...InvokeOption) (*GetIotDigitalTwinRelationshipsResult, error)
func GetIotDigitalTwinRelationshipsOutput(ctx *Context, args *GetIotDigitalTwinRelationshipsOutputArgs, opts ...InvokeOption) GetIotDigitalTwinRelationshipsResultOutput> Note: This function is named GetIotDigitalTwinRelationships in the Go SDK.
public static class GetIotDigitalTwinRelationships
{
public static Task<GetIotDigitalTwinRelationshipsResult> InvokeAsync(GetIotDigitalTwinRelationshipsArgs args, InvokeOptions? opts = null)
public static Output<GetIotDigitalTwinRelationshipsResult> Invoke(GetIotDigitalTwinRelationshipsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetIotDigitalTwinRelationshipsResult> getIotDigitalTwinRelationships(GetIotDigitalTwinRelationshipsArgs args, InvokeOptions options)
public static Output<GetIotDigitalTwinRelationshipsResult> getIotDigitalTwinRelationships(GetIotDigitalTwinRelationshipsArgs args, InvokeOptions options)
fn::invoke:
function: oci:oci/getIotDigitalTwinRelationships:getIotDigitalTwinRelationships
arguments:
# arguments dictionaryThe following arguments are supported:
- Iot
Domain stringId - The OCID of the IoT domain in which to list digital twin resources.
- Content
Path string - Filters resources that match the content path of the digital twin relationship.
- Display
Name string - Filter resources whose display name matches the specified value.
- Filters
List<Get
Iot Digital Twin Relationships Filter> - Id string
- Filter resources by OCID. Must be a valid OCID of the resource type.
- Source
Digital stringTwin Instance Id - Filter resources that match the specified OCID of source digital twin instance.
- State string
- Filter resources whose lifecycleState matches the specified value.
- Target
Digital stringTwin Instance Id - Filter resources that match the specified OCID of target digital twin instance.
- Iot
Domain stringId - The OCID of the IoT domain in which to list digital twin resources.
- Content
Path string - Filters resources that match the content path of the digital twin relationship.
- Display
Name string - Filter resources whose display name matches the specified value.
- Filters
[]Get
Iot Digital Twin Relationships Filter - Id string
- Filter resources by OCID. Must be a valid OCID of the resource type.
- Source
Digital stringTwin Instance Id - Filter resources that match the specified OCID of source digital twin instance.
- State string
- Filter resources whose lifecycleState matches the specified value.
- Target
Digital stringTwin Instance Id - Filter resources that match the specified OCID of target digital twin instance.
- iot
Domain StringId - The OCID of the IoT domain in which to list digital twin resources.
- content
Path String - Filters resources that match the content path of the digital twin relationship.
- display
Name String - Filter resources whose display name matches the specified value.
- filters
List<Get
Iot Digital Twin Relationships Filter> - id String
- Filter resources by OCID. Must be a valid OCID of the resource type.
- source
Digital StringTwin Instance Id - Filter resources that match the specified OCID of source digital twin instance.
- state String
- Filter resources whose lifecycleState matches the specified value.
- target
Digital StringTwin Instance Id - Filter resources that match the specified OCID of target digital twin instance.
- iot
Domain stringId - The OCID of the IoT domain in which to list digital twin resources.
- content
Path string - Filters resources that match the content path of the digital twin relationship.
- display
Name string - Filter resources whose display name matches the specified value.
- filters
Get
Iot Digital Twin Relationships Filter[] - id string
- Filter resources by OCID. Must be a valid OCID of the resource type.
- source
Digital stringTwin Instance Id - Filter resources that match the specified OCID of source digital twin instance.
- state string
- Filter resources whose lifecycleState matches the specified value.
- target
Digital stringTwin Instance Id - Filter resources that match the specified OCID of target digital twin instance.
- iot_
domain_ strid - The OCID of the IoT domain in which to list digital twin resources.
- content_
path str - Filters resources that match the content path of the digital twin relationship.
- display_
name str - Filter resources whose display name matches the specified value.
- filters
Sequence[Get
Iot Digital Twin Relationships Filter] - id str
- Filter resources by OCID. Must be a valid OCID of the resource type.
- source_
digital_ strtwin_ instance_ id - Filter resources that match the specified OCID of source digital twin instance.
- state str
- Filter resources whose lifecycleState matches the specified value.
- target_
digital_ strtwin_ instance_ id - Filter resources that match the specified OCID of target digital twin instance.
- iot
Domain StringId - The OCID of the IoT domain in which to list digital twin resources.
- content
Path String - Filters resources that match the content path of the digital twin relationship.
- display
Name String - Filter resources whose display name matches the specified value.
- filters List<Property Map>
- id String
- Filter resources by OCID. Must be a valid OCID of the resource type.
- source
Digital StringTwin Instance Id - Filter resources that match the specified OCID of source digital twin instance.
- state String
- Filter resources whose lifecycleState matches the specified value.
- target
Digital StringTwin Instance Id - Filter resources that match the specified OCID of target digital twin instance.
getIotDigitalTwinRelationships Result
The following output properties are available:
- Digital
Twin List<GetRelationship Collections Iot Digital Twin Relationships Digital Twin Relationship Collection> - The list of digital_twin_relationship_collection.
- Iot
Domain stringId - The OCID of the IoT domain.
- Content
Path 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.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
List<Get
Iot Digital Twin Relationships Filter> - Id string
- The OCID of the resource.
- Source
Digital stringTwin Instance Id - The OCID of source digital twin instance.
- State string
- The current state of the digital twin relationship.
- Target
Digital stringTwin Instance Id - The OCID of target digital twin instance.
- Digital
Twin []GetRelationship Collections Iot Digital Twin Relationships Digital Twin Relationship Collection - The list of digital_twin_relationship_collection.
- Iot
Domain stringId - The OCID of the IoT domain.
- Content
Path 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.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
[]Get
Iot Digital Twin Relationships Filter - Id string
- The OCID of the resource.
- Source
Digital stringTwin Instance Id - The OCID of source digital twin instance.
- State string
- The current state of the digital twin relationship.
- Target
Digital stringTwin Instance Id - The OCID of target digital twin instance.
- digital
Twin List<GetRelationship Collections Iot Digital Twin Relationships Digital Twin Relationship Collection> - The list of digital_twin_relationship_collection.
- iot
Domain StringId - The OCID of the IoT domain.
- content
Path 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.
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
List<Get
Iot Digital Twin Relationships Filter> - id String
- The OCID of the resource.
- source
Digital StringTwin Instance Id - The OCID of source digital twin instance.
- state String
- The current state of the digital twin relationship.
- target
Digital StringTwin Instance Id - The OCID of target digital twin instance.
- digital
Twin GetRelationship Collections Iot Digital Twin Relationships Digital Twin Relationship Collection[] - The list of digital_twin_relationship_collection.
- iot
Domain stringId - The OCID of the IoT domain.
- content
Path 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.
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
Get
Iot Digital Twin Relationships Filter[] - id string
- The OCID of the resource.
- source
Digital stringTwin Instance Id - The OCID of source digital twin instance.
- state string
- The current state of the digital twin relationship.
- target
Digital stringTwin Instance Id - The OCID of target digital twin instance.
- digital_
twin_ Sequence[Getrelationship_ collections Iot Digital Twin Relationships Digital Twin Relationship Collection] - The list of digital_twin_relationship_collection.
- iot_
domain_ strid - The OCID of the IoT domain.
- 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.
- display_
name str - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
Sequence[Get
Iot Digital Twin Relationships Filter] - id str
- The OCID of the resource.
- source_
digital_ strtwin_ instance_ id - The OCID of source digital twin instance.
- state str
- The current state of the digital twin relationship.
- target_
digital_ strtwin_ instance_ id - The OCID of target digital twin instance.
- digital
Twin List<Property Map>Relationship Collections - The list of digital_twin_relationship_collection.
- iot
Domain StringId - The OCID of the IoT domain.
- content
Path 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.
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters List<Property Map>
- id String
- The OCID of the resource.
- source
Digital StringTwin Instance Id - The OCID of source digital twin instance.
- state String
- The current state of the digital twin relationship.
- target
Digital StringTwin Instance Id - The OCID of target digital twin instance.
Supporting Types
GetIotDigitalTwinRelationshipsDigitalTwinRelationshipCollection
GetIotDigitalTwinRelationshipsDigitalTwinRelationshipCollectionItem
- Content string
- The value(s) of the relationship properties defined in the source digital twin model.
- Content
Path string - Filters resources that match the content path of the digital twin relationship.
- 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.
- Display
Name string - Filter resources whose display name matches the specified value.
- 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
- Filter resources by OCID. Must be a valid OCID of the resource type.
- Iot
Domain stringId - The OCID of the IoT domain in which to list digital twin resources.
- Source
Digital stringTwin Instance Id - Filter resources that match the specified OCID of source digital twin instance.
- State string
- Filter resources whose lifecycleState matches the specified value.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - Target
Digital stringTwin Instance Id - Filter resources that match the specified OCID of target digital twin instance.
- Time
Created string - 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 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.
- Content
Path string - Filters resources that match the content path of the digital twin relationship.
- 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.
- Display
Name string - Filter resources whose display name matches the specified value.
- 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
- Filter resources by OCID. Must be a valid OCID of the resource type.
- Iot
Domain stringId - The OCID of the IoT domain in which to list digital twin resources.
- Source
Digital stringTwin Instance Id - Filter resources that match the specified OCID of source digital twin instance.
- State string
- Filter resources whose lifecycleState matches the specified value.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - Target
Digital stringTwin Instance Id - Filter resources that match the specified OCID of target digital twin instance.
- Time
Created string - 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 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.
- content
Path String - Filters resources that match the content path of the digital twin relationship.
- 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.
- display
Name String - Filter resources whose display name matches the specified value.
- 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
- Filter resources by OCID. Must be a valid OCID of the resource type.
- iot
Domain StringId - The OCID of the IoT domain in which to list digital twin resources.
- source
Digital StringTwin Instance Id - Filter resources that match the specified OCID of source digital twin instance.
- state String
- Filter resources whose lifecycleState matches the specified value.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - target
Digital StringTwin Instance Id - Filter resources that match the specified OCID of target digital twin instance.
- time
Created String - 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 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.
- content
Path string - Filters resources that match the content path of the digital twin relationship.
- {[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.
- display
Name string - Filter resources whose display name matches the specified value.
- {[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
- Filter resources by OCID. Must be a valid OCID of the resource type.
- iot
Domain stringId - The OCID of the IoT domain in which to list digital twin resources.
- source
Digital stringTwin Instance Id - Filter resources that match the specified OCID of source digital twin instance.
- state string
- Filter resources whose lifecycleState matches the specified value.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - target
Digital stringTwin Instance Id - Filter resources that match the specified OCID of target digital twin instance.
- time
Created string - 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 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 - Filters resources that match the content path of the digital twin relationship.
- 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.
- display_
name str - Filter resources whose display name matches the specified value.
- 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
- Filter resources by OCID. Must be a valid OCID of the resource type.
- iot_
domain_ strid - The OCID of the IoT domain in which to list digital twin resources.
- source_
digital_ strtwin_ instance_ id - Filter resources that match the specified OCID of source digital twin instance.
- state str
- Filter resources whose lifecycleState matches the specified value.
- 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_ strtwin_ instance_ id - Filter resources that match the specified 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.
- content
Path String - Filters resources that match the content path of the digital twin relationship.
- 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.
- display
Name String - Filter resources whose display name matches the specified value.
- 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
- Filter resources by OCID. Must be a valid OCID of the resource type.
- iot
Domain StringId - The OCID of the IoT domain in which to list digital twin resources.
- source
Digital StringTwin Instance Id - Filter resources that match the specified OCID of source digital twin instance.
- state String
- Filter resources whose lifecycleState matches the specified value.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"} - target
Digital StringTwin Instance Id - Filter resources that match the specified OCID of target digital twin instance.
- time
Created String - 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 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
GetIotDigitalTwinRelationshipsFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.
