Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PrivateEndpoint

A private endpoint allowing Resource Manager to access nonpublic cloud resources. For more information about private endpoints, see Private Endpoint Management.

Properties

compartmentId

compartmentId: string

The OCID of the compartment containing this private endpoint.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional description

description: undefined | string

Description of the private endpoint. Avoid entering confidential information.

Optional displayName

displayName: undefined | string

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

Optional dnsZones

dnsZones: Array<string>

DNS zones to use for accessing private Git servers. For private Git server instructions, see Private Git Server. Specify DNS fully qualified domain names (FQDNs); DNS Proxy forwards related DNS FQDN queries to the consumer DNS resolver. For DNS FQDNs not specified, queries go to service provider VCN resolver. Example: {@code abc.oraclevcn.com}

Optional freeformTags

freeformTags: undefined | object

Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {@code {"Department": "Finance"}}

id

id: string

The OCID of the private endpoint.

Optional isUsedWithConfigurationSourceProvider

isUsedWithConfigurationSourceProvider: undefined | false | true

When {@code true}, allows the private endpoint to be used with a configuration source provider.

Optional lifecycleState

lifecycleState: LifecycleState

The current lifecycle state of the private endpoint.

Optional nsgIdList

nsgIdList: Array<string>

The OCIDs of network security groups (NSGs) for the private endpoint. Order does not matter.

Optional sourceIps

sourceIps: Array<string>

The source IP addresses that Resource Manager uses to connect to your network. Automatically assigned by Resource Manager.

subnetId

subnetId: string

The OCID of the subnet within the VCN for the private endpoint.

Optional timeCreated

timeCreated: Date

The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: {@code 2020-11-25T21:10:29.600Z}

vcnId

vcnId: string

The OCID of the VCN for the private endpoint.

Functions

getDeserializedJsonObj

getJsonObj