Class IotDomain

An IoT domain is an Oracle Cloud Infrastructure resource that provides a managed environment for organizing and managing digital twin resources, such as models, adapters, instances and relationships, within a compartment and IoT domain group.
To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see Getting Started with Policies.

Inheritance
object
IotDomain
Inherited Members
Namespace: Oci.IotService.Models
Assembly: OCI.DotNetSDK.Iot.dll
Syntax
public class IotDomain

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment corresponding to the resource.
Remarks

Required

DataRetentionPeriodsInDays

Declaration
[JsonProperty(PropertyName = "dataRetentionPeriodsInDays")]
public DataRetentionPeriodsInDays DataRetentionPeriodsInDays { get; set; }
Property Value
Type Description
DataRetentionPeriodsInDays

DbAllowListedIdentityGroupNames

Declaration
[JsonProperty(PropertyName = "dbAllowListedIdentityGroupNames")]
public List<string> DbAllowListedIdentityGroupNames { get; set; }
Property Value
Type Description
List<string>

List of IAM groups of form described in here that are allowed to directly connect to the data host.

DbAllowedIdentityDomainHost

Declaration
[JsonProperty(PropertyName = "dbAllowedIdentityDomainHost")]
public string DbAllowedIdentityDomainHost { get; set; }
Property Value
Type Description
string

Host name of identity domain that is used for authenticating connect to data host via ORDS.

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

A short description of the resource.

DeviceHost

Declaration
[JsonProperty(PropertyName = "deviceHost")]
public string DeviceHost { get; set; }
Property Value
Type Description
string

Host name of an IoT domain, where IoT devices can connect to.

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Remarks

Required

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
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

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the resource.
Remarks

Required

IotDomainGroupId

Declaration
[Required(ErrorMessage = "IotDomainGroupId is required.")]
[JsonProperty(PropertyName = "iotDomainGroupId")]
public string IotDomainGroupId { get; set; }
Property Value
Type Description
string

The OCID of the IoT domain group.
Remarks

Required

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public IotDomain.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
IotDomain.LifecycleStateEnum?

The current state of the IoT domain.
Remarks

Required

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
Remarks

Required

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z