Show / Hide Table of Contents

Class PrivateEndpointSummary

The summary metadata associated with the private endpoint.

Inheritance
object
PrivateEndpointSummary
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.ResourcemanagerService.Models
Assembly: OCI.DotNetSDK.Resourcemanager.dll
Syntax
public class PrivateEndpointSummary

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment containing this private endpoint.

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. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

Description of the private endpoint. Avoid entering confidential information.

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[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.

Remarks

Required

DnsZones

Declaration
[JsonProperty(PropertyName = "dnsZones")]
public List<string> DnsZones { get; set; }
Property Value
Type Description
List<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.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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: {"Department": "Finance"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the private endpoint.

Remarks

Required

IsUsedWithConfigurationSourceProvider

Declaration
[JsonProperty(PropertyName = "isUsedWithConfigurationSourceProvider")]
public bool? IsUsedWithConfigurationSourceProvider { get; set; }
Property Value
Type Description
bool?

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

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public PrivateEndpoint.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
PrivateEndpoint.LifecycleStateEnum?

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

  • ACTIVE
  • CREATING
  • DELETING
  • DELETED
  • FAILED

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

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

VcnId

Declaration
[Required(ErrorMessage = "VcnId is required.")]
[JsonProperty(PropertyName = "vcnId")]
public string VcnId { get; set; }
Property Value
Type Description
string

The OCID of the VCN for the private endpoint.

Remarks

Required

In this article
Back to top