Show / Hide Table of Contents

Class CreatePrivateEndpointDetails

Details to create a private endpoint

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

Properties

AccessTargets

Declaration
[Required(ErrorMessage = "AccessTargets is required.")]
[JsonProperty(PropertyName = "accessTargets")]
public List<AccessTargetDetails> AccessTargets { get; set; }
Property Value
Type Description
List<AccessTargetDetails>

A list of targets that can be accessed by the private endpoint.

Remarks

Required

AdditionalPrefixes

Declaration
[JsonProperty(PropertyName = "additionalPrefixes")]
public List<string> AdditionalPrefixes { get; set; }
Property Value
Type Description
List<string>

A list of additional prefix that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.

CompartmentId

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

The ID of the compartment in which to create the 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"}}

FreeformTags

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

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

Name

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

This name associated with the endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. Example: my-new-private-endpoint1

Remarks

Required

NsgIds

Declaration
[JsonProperty(PropertyName = "nsgIds")]
public List<string> NsgIds { get; set; }
Property Value
Type Description
List<string>

A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see {@link NetworkSecurityGroup}.

Prefix

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

PrivateEndpointIp

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

The private IP address to assign to this private endpoint. If you provide a value, it must be an available IP address in the customer's subnet. If it's not available, an error is returned.
If you do not provide a value, an available IP address in the subnet is automatically chosen.

SubnetId

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

The OCID of the customer's subnet where the private endpoint VNIC will reside.

Remarks

Required

In this article
Back to top