Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PrivateEndpointSummary

The summary metadata associated with the private endpoint.

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.

displayName

displayName: 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. DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.

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: undefined | string

The current lifecycle state of the private endpoint. Allowable values:

  • ACTIVE
  • CREATING
  • DELETING
  • DELETED
  • FAILED

Optional timeCreated

timeCreated: Date

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

vcnId

vcnId: string

The OCID of the VCN for the private endpoint.

Functions

getDeserializedJsonObj

getJsonObj