Skip to main content

private_endpoints

Creates, updates, deletes, gets or lists a private_endpoints resource.

Overview​

Nameprivate_endpoints
TypeResource
Idoci.resource_manager.private_endpoints

Fields​

The following fields are returned by SELECT queries:

Successfully retrieved the private endpoint.

NameDatatypeDescription
idstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint.
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this private endpoint.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
descriptionstringDescription of the private endpoint. Avoid entering confidential information.
displayNamestringA user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
dnsZonesarrayDNS zones to use for accessing private Git servers. For private Git server instructions, see [Private Git Server](/iaas/Content/ResourceManager/Tasks/private-endpoints.htm#private-git). 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: abc.oraclevcn.com
freeformTagsobjectFree-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](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
isUsedWithConfigurationSourceProviderbooleanWhen true, allows the private endpoint to be used with a configuration source provider.
lifecycleStatestringThe current lifecycle state of the private endpoint. (ACTIVE, CREATING, DELETING, DELETED, FAILED)
nsgIdListarrayThe [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of [network security groups (NSGs)](/iaas/Content/Network/Concepts/networksecuritygroups.htm) for the private endpoint. Order does not matter.
sourceIpsarrayThe source IP addresses that Resource Manager uses to connect to your network. Automatically assigned by Resource Manager.
subnetIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet within the VCN for the private endpoint.
systemTagsobjectThe system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https:​//docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {orcl-cloud: {free-tier-retain: true}}
timeCreatedstring (date-time)The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
vcnIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN for the private endpoint.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprivateEndpointId, regionopc-request-idGets the specified private endpoint.<br />For more information, see<br />[Getting a Private Endpoint's Details](/iaas/Content/ResourceManager/Tasks/get-private-endpoints.htm).<br />
listselectregionopc-request-id, compartmentId, privateEndpointId, displayName, vcnId, sortBy, sortOrder, limit, pageLists private endpoints according to the specified filter.<br />For more information, see<br />[Listing Private Endpoints](/iaas/Content/ResourceManager/Tasks/list-private-endpoints.htm).<br />- For compartmentId, lists all private endpoints in the matching compartment.<br />- For privateEndpointId, lists the matching private endpoint.<br />
createinsertregion, compartmentId, displayName, vcnId, subnetIdopc-request-id, opc-retry-tokenCreates a private endpoint in the specified compartment.<br />For more information, see<br />[Creating a Private Endpoint](/iaas/Content/ResourceManager/Tasks/create-private-endpoints.htm).<br />
updateupdateprivateEndpointId, regionopc-request-id, if-matchUpdates the specified private endpoint.<br />For more information, see<br />[Updating a Private Endpoint](/iaas/Content/ResourceManager/Tasks/update-private-endpoints.htm).<br />
deletedeleteprivateEndpointId, regionopc-request-id, if-matchDeletes the specified private endpoint.<br />For more information, see<br />[Deleting a Private Endpoint](/iaas/Content/ResourceManager/Tasks/delete-private-endpoints.htm).<br />
change_compartmentexecprivateEndpointId, region, compartmentIdif-match, opc-request-id, opc-retry-tokenMoves a private endpoint to a different compartment within the same tenancy.<br />For more information, see<br />[Moving a Private Endpoint](/iaas/Content/ResourceManager/Tasks/move-private-endpoints.htm).<br />

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
privateEndpointIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint.
regionstringOCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
compartmentIdstringA filter to return only resources that exist in the compartment, identified by [OCID](/iaas/Content/General/Concepts/identifiers.htm).
displayNamestringA filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
if-matchstringFor optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
limitintegerThe number of items returned in a paginated List call. For information about pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
opc-request-idstringUnique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of retrying the same action. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
pagestringThe value of the opc-next-page response header from the preceding List call. For information about pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
privateEndpointIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint.
sortBystringThe field to use when sorting returned resources. By default, TIMECREATED is ordered descending. By default, DISPLAYNAME is ordered ascending. Note that you can sort only on one field.
sortOrderstringThe sort order to use when sorting returned resources. Ascending (ASC) or descending (DESC).
vcnIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN.

SELECT examples​

Gets the specified private endpoint.<br />For more information, see<br />[Getting a Private Endpoint's Details](/iaas/Content/ResourceManager/Tasks/get-private-endpoints.htm).<br />

SELECT
id,
compartmentId,
definedTags,
description,
displayName,
dnsZones,
freeformTags,
isUsedWithConfigurationSourceProvider,
lifecycleState,
nsgIdList,
sourceIps,
subnetId,
systemTags,
timeCreated,
vcnId
FROM oci.resource_manager.private_endpoints
WHERE privateEndpointId = '{{ privateEndpointId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates a private endpoint in the specified compartment.<br />For more information, see<br />[Creating a Private Endpoint](/iaas/Content/ResourceManager/Tasks/create-private-endpoints.htm).<br />

INSERT INTO oci.resource_manager.private_endpoints (
compartmentId,
definedTags,
description,
displayName,
dnsZones,
freeformTags,
isUsedWithConfigurationSourceProvider,
nsgIdList,
subnetId,
vcnId,
region,
opc-request-id,
opc-retry-token
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ description }}',
'{{ displayName }}' /* required */,
'{{ dnsZones }}',
'{{ freeformTags }}',
{{ isUsedWithConfigurationSourceProvider }},
'{{ nsgIdList }}',
'{{ subnetId }}' /* required */,
'{{ vcnId }}' /* required */,
'{{ region }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
RETURNING
id,
compartmentId,
definedTags,
description,
displayName,
dnsZones,
freeformTags,
isUsedWithConfigurationSourceProvider,
lifecycleState,
nsgIdList,
sourceIps,
subnetId,
systemTags,
timeCreated,
vcnId
;

UPDATE examples​

Updates the specified private endpoint.<br />For more information, see<br />[Updating a Private Endpoint](/iaas/Content/ResourceManager/Tasks/update-private-endpoints.htm).<br />

UPDATE oci.resource_manager.private_endpoints
SET 
definedTags = '{{ definedTags }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
dnsZones = '{{ dnsZones }}',
freeformTags = '{{ freeformTags }}',
isUsedWithConfigurationSourceProvider = {{ isUsedWithConfigurationSourceProvider }},
nsgIdList = '{{ nsgIdList }}',
subnetId = '{{ subnetId }}',
vcnId = '{{ vcnId }}'
WHERE 
privateEndpointId = '{{ privateEndpointId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id}}'
AND if-match = '{{ if-match}}'
RETURNING
id,
compartmentId,
definedTags,
description,
displayName,
dnsZones,
freeformTags,
isUsedWithConfigurationSourceProvider,
lifecycleState,
nsgIdList,
sourceIps,
subnetId,
systemTags,
timeCreated,
vcnId;

DELETE examples​

Deletes the specified private endpoint.<br />For more information, see<br />[Deleting a Private Endpoint](/iaas/Content/ResourceManager/Tasks/delete-private-endpoints.htm).<br />

DELETE FROM oci.resource_manager.private_endpoints
WHERE privateEndpointId = '{{ privateEndpointId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id }}'
AND if-match = '{{ if-match }}'
;

Lifecycle Methods​

Moves a private endpoint to a different compartment within the same tenancy.<br />For more information, see<br />[Moving a Private Endpoint](/iaas/Content/ResourceManager/Tasks/move-private-endpoints.htm).<br />

EXEC oci.resource_manager.private_endpoints.change_compartment 
@privateEndpointId='{{ privateEndpointId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;