Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PrivateEndpoint

PrivateEndpoint resource.

Properties

compartmentId

compartmentId: string

Identifier of the compartment in which private endpoint exists.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

PrivateEndpoint description.

displayName

displayName: string

PrivateEndpoint display name.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

id

id: string

The identifier of the Private Endpoint.

lifecycleState

lifecycleState: LifecycleState

Lifecycle states for private endpoint.

Optional lifecycleStateDetails

lifecycleStateDetails: undefined | string

Detailed message for the lifecycle state.

Optional nsgIds

nsgIds: Array<string>

The OCIDs of the network security groups that the private endpoint belongs to.

Optional privateIp

privateIp: undefined | string

IP address of the Private Endpoint.

Optional shardedDatabases

shardedDatabases: Array<string>

The OCIDs of sharded databases that consumes the given private endpoint.

subnetId

subnetId: string

Identifier of the subnet in which private endpoint exists.

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

timeCreated

timeCreated: Date

The time the PrivateEndpoint was first created. An RFC3339 formatted datetime string

timeUpdated

timeUpdated: Date

The time the Private Endpoint was last updated. An RFC3339 formatted datetime string

vcnId

vcnId: string

Identifier of the VCN in which subnet exists.

Functions

getDeserializedJsonObj

getJsonObj