Class PrivateEndpoint
PrivateEndpoint resource.
Inherited Members
Namespace: Oci.GloballydistributeddatabaseService.Models
Assembly: OCI.DotNetSDK.Globallydistributeddatabase.dll
Syntax
public class PrivateEndpoint
Properties
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | Identifier of the compartment in which private endpoint exists. |
Remarks
Required
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"}} |
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | PrivateEndpoint description. |
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | PrivateEndpoint display name. |
Remarks
Required
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
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The identifier of the Private Endpoint. |
Remarks
Required
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public PrivateEndpoint.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
PrivateEndpoint.LifecycleStateEnum? | Lifecycle states for private endpoint. |
Remarks
Required
LifecycleStateDetails
Declaration
[JsonProperty(PropertyName = "lifecycleStateDetails")]
public string LifecycleStateDetails { get; set; }
Property Value
Type | Description |
---|---|
string | Detailed message for the lifecycle state. |
NsgIds
Declaration
[JsonProperty(PropertyName = "nsgIds")]
public List<string> NsgIds { get; set; }
Property Value
Type | Description |
---|---|
List<string> | The OCIDs of the network security groups that the private endpoint belongs to. |
PrivateIp
Declaration
[JsonProperty(PropertyName = "privateIp")]
public string PrivateIp { get; set; }
Property Value
Type | Description |
---|---|
string | IP address of the Private Endpoint. |
ProxyComputeInstanceId
Declaration
[JsonProperty(PropertyName = "proxyComputeInstanceId")]
public string ProxyComputeInstanceId { get; set; }
Property Value
Type | Description |
---|---|
string | The identifier of the proxy compute instance. |
ShardedDatabases
Declaration
[JsonProperty(PropertyName = "shardedDatabases")]
public List<string> ShardedDatabases { get; set; }
Property Value
Type | Description |
---|---|
List<string> | The OCIDs of sharded databases that consumes the given private endpoint. |
SubnetId
Declaration
[Required(ErrorMessage = "SubnetId is required.")]
[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }
Property Value
Type | Description |
---|---|
string | Identifier of the subnet in which private endpoint exists. |
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>> | Usage of system tag keys. These predefined keys are scoped to namespaces. 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 time the PrivateEndpoint was first created. An RFC3339 formatted datetime string |
Remarks
Required
TimeUpdated
Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The time the Private Endpoint was last updated. An RFC3339 formatted datetime string |
Remarks
Required
VcnId
Declaration
[Required(ErrorMessage = "VcnId is required.")]
[JsonProperty(PropertyName = "vcnId")]
public string VcnId { get; set; }
Property Value
Type | Description |
---|---|
string | Identifier of the VCN in which subnet exists. |
Remarks
Required