Class PublicIp
A public IP is a conceptual term that refers to a public IP address and related properties.
The publicIp
object is the API representation of a public IP.
There are two types of public IPs:
- Ephemeral
- Reserved
For more information and comparison of the two types, see Public IP Addresses.
Inherited Members
Namespace: Oci.VnmonitoringService.Models
Assembly: OCI.DotNetSDK.Vnmonitoring.dll
Syntax
public class PublicIp
Properties
AssignedEntityId
Declaration
[JsonProperty(PropertyName = "assignedEntityId")]
public string AssignedEntityId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the entity the public IP is assigned to, or in the process of being assigned to. |
AssignedEntityType
Declaration
[JsonProperty(PropertyName = "assignedEntityType")]
[JsonConverter(typeof(StringEnumConverter))]
public PublicIp.AssignedEntityTypeEnum? AssignedEntityType { get; set; }
Property Value
Type | Description |
---|---|
PublicIp.AssignedEntityTypeEnum? | The type of entity the public IP is assigned to, or in the process of being assigned to. |
AvailabilityDomain
Declaration
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }
Property Value
Type | Description |
---|---|
string | The public IP's availability domain. This property is set only for ephemeral public IPs
that are assigned to a private IP (that is, when the |
CompartmentId
Declaration
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment containing the public IP. For an ephemeral public IP, this is the compartment of its assigned entity (which can be a private IP or a regional entity such as a NAT gateway). For a reserved public IP that is currently assigned, its compartment can be different from the assigned private IP's. |
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. Example: {"foo-namespace": {"bar-key": "value"}} |
DisplayName
Declaration
[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. |
FreeformTags
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, string> | Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
Id
Declaration
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The public IP's Oracle ID (OCID). |
IpAddress
Declaration
[JsonProperty(PropertyName = "ipAddress")]
public string IpAddress { get; set; }
Property Value
Type | Description |
---|---|
string | The public IP address of the |
LifecycleState
Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public PublicIp.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
PublicIp.LifecycleStateEnum? | The public IP's current state. |
Lifetime
Declaration
[JsonProperty(PropertyName = "lifetime")]
[JsonConverter(typeof(StringEnumConverter))]
public PublicIp.LifetimeEnum? Lifetime { get; set; }
Property Value
Type | Description |
---|---|
PublicIp.LifetimeEnum? | Defines when the public IP is deleted and released back to Oracle's public IP pool.
|
PrivateIpId
Declaration
[JsonProperty(PropertyName = "privateIpId")]
public string PrivateIpId { get; set; }
Property Value
Type | Description |
---|---|
string | Deprecated. Use |
PublicIpPoolId
Declaration
[JsonProperty(PropertyName = "publicIpPoolId")]
public string PublicIpPoolId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the pool object created in the current tenancy. |
Scope
Declaration
[JsonProperty(PropertyName = "scope")]
[JsonConverter(typeof(StringEnumConverter))]
public PublicIp.ScopeEnum? Scope { get; set; }
Property Value
Type | Description |
---|---|
PublicIp.ScopeEnum? | Whether the public IP is regional or specific to a particular availability domain.
|
TimeCreated
Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the public IP was created, in the format defined by RFC3339.
|