|
| 1 | +.. _mcli-atlas-private-endpoint-provider-delete-cmd: |
| 2 | + |
| 3 | +================================================ |
| 4 | +mongocli atlas privateendpoint <provider> delete |
| 5 | +================================================ |
| 6 | + |
| 7 | +.. default-domain:: mongodb |
| 8 | + |
| 9 | +.. contents:: On this page |
| 10 | + :local: |
| 11 | + :backlinks: none |
| 12 | + :depth: 1 |
| 13 | + :class: singlecol |
| 14 | + |
| 15 | +The ``privateendpoint <provider> delete`` command deletes one |
| 16 | +private endpoint connection for |aws| or Azure in an |service| project. |
| 17 | +You can also delete a private endpoint connections through the |
| 18 | +|service| :atlas:`UI |
| 19 | +</security-private-endpoint/#remove-a-private-endpoint-from-service>` |
| 20 | +or :atlas:`API </reference/api/private-endpoints-service-delete-one/>`. |
| 21 | + |
| 22 | +Syntax |
| 23 | +------ |
| 24 | + |
| 25 | +.. code-block:: text |
| 26 | + |
| 27 | + mongocli atlas privateendpoint(s)|privateEndpoint(s) aws|azure delete <private-endpoint-id> |
| 28 | + [ --force ] |
| 29 | + [ --profile|-P <profile-name> ] |
| 30 | + [ --projectId <project-ID> ] |
| 31 | + |
| 32 | +.. include:: /includes/fact-command-line-help.rst |
| 33 | + |
| 34 | +.. _atlas-private-endpoint-provider-delete-arguments: |
| 35 | + |
| 36 | +Arguments |
| 37 | +--------- |
| 38 | + |
| 39 | +.. list-table:: |
| 40 | + :header-rows: 1 |
| 41 | + :widths: 20 10 60 10 |
| 42 | + |
| 43 | + * - Argument |
| 44 | + - Type |
| 45 | + - Description |
| 46 | + - Required? |
| 47 | + |
| 48 | + * - ``<private-endpoint-id>`` |
| 49 | + - string |
| 50 | + - Unique identifier of the private endpoint connection that you |
| 51 | + want to delete. |
| 52 | + - yes |
| 53 | + |
| 54 | +.. _atlas-private-endpoint-provider-delete-options: |
| 55 | + |
| 56 | +Options |
| 57 | +------- |
| 58 | + |
| 59 | +.. list-table:: |
| 60 | + :widths: 20 10 60 10 |
| 61 | + :header-rows: 1 |
| 62 | + |
| 63 | + * - Option |
| 64 | + - Type |
| 65 | + - Description |
| 66 | + - Required? |
| 67 | + |
| 68 | + * - ``--force`` |
| 69 | + - |
| 70 | + - Flag that indicates that the agent API key can |
| 71 | + be deleted without requiring confirmation. |
| 72 | + - no |
| 73 | + |
| 74 | + * - ``--profile``, ``-P`` |
| 75 | + - string |
| 76 | + - Name of the profile where the public and private |
| 77 | + keys for the project are saved. If omitted, uses the |
| 78 | + {+default-profile+}. To learn more about creating a |
| 79 | + profile, see :ref:`mcli-configure`. |
| 80 | + - no |
| 81 | + |
| 82 | + * - ``--projectId`` |
| 83 | + - string |
| 84 | + - .. include:: /includes/extracts/fact-basic-options-project-id.rst |
| 85 | + - no |
| 86 | + |
| 87 | +.. _atlas-private-endpoint-provider-delete-output: |
| 88 | + |
| 89 | +Output |
| 90 | +------ |
| 91 | + |
| 92 | +If the command succeeds, it returns the following output in the default |
| 93 | +format. If the command returns errors, see |
| 94 | +:ref:`Troubleshooting <troubleshooting>` for recommended solutions. |
| 95 | + |
| 96 | +.. code-block:: sh |
| 97 | + :copyable: false |
| 98 | + |
| 99 | + ? Are you sure you want to delete: <private-endpoint-id> Yes |
| 100 | + Private endpoint '<private-endpoint-id>' deleted |
| 101 | + |
| 102 | +Example |
| 103 | +------- |
| 104 | + |
| 105 | +The following command deletes one private endpoint connection for |aws| |
| 106 | +or Azure in a project using the {+default-profile+}, which contains |
| 107 | +credentials and the project ID. The output is returned in the default |
| 108 | +format. |
| 109 | + |
| 110 | +.. code-block:: sh |
| 111 | + |
| 112 | + mongocli atlas privateendpoints aws delete 5f4fc14da2b47835a58c63a2 |
| 113 | + |
| 114 | +The previous command prints the following to the terminal. |
| 115 | + |
| 116 | +.. code-block:: sh |
| 117 | + :copyable: false |
| 118 | + |
| 119 | + ? Are you sure you want to delete: 5f4fc14da2b47835a58c63a2 Yes |
| 120 | + Private endpoint '5f4fc14da2b47835a58c63a2' deleted |
0 commit comments