"list"
******

* Description

* Usage

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Lists private endpoints according to the specified filter. - For
*compartmentId*, lists all private endpoints in the matching
compartment. - For *privateEndpointId*, lists the matching private
endpoint.


Usage
=====

   oci resource-manager private-endpoint list [OPTIONS]


Optional Parameters
===================

--all

Fetches all pages of results. If you provide this option, then you
cannot provide the "--limit" option.

--compartment-id, -c [text]

A filter to return only resources that exist in the compartment,
identified by OCID.

--display-name [text]

A 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.

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--limit [integer]

The number of items returned in a paginated *List* call. For
information about pagination, see List Pagination.

--page [text]

The value of the *opc-next-page* response header from the preceding
*List* call. For information about pagination, see List Pagination.

--page-size [integer]

When fetching results, the number of results to fetch per call. Only
valid when used with "--all" or "--limit", and ignored otherwise.

--private-endpoint-id [text]

The OCID of the private endpoint.

--sort-by [text]

The 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.

Accepted values are:

   DISPLAYNAME, TIMECREATED

--sort-order [text]

The sort order to use when sorting returned resources. Ascending
(*ASC*) or descending (*DESC*).

Accepted values are:

   ASC, DESC

--vcn-id [text]

The OCID of the VCN.


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
defaults-file", "--endpoint", "--generate-full-command-json-input", "
--generate-param-json-input", "--help", "--latest-version", "--max-
retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
"--output", "--profile", "--query", "--raw-output", "--read-timeout",
"--region", "--release-info", "--request-id", "--version", "-?", "-d",
"-h", "-i", "-v"


Example using required parameter
================================

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       oci resource-manager private-endpoint list
