Categories:: System functions (System Information)

SYSTEM$GET_PRIVATELINK_ENDPOINTS_INFO¶

Returns the status of all private connectivity endpoints that you provision. The endpoint can be a service endpoint or a resource endpoint depending on the cloud platform that hosts your Snowflake account.

See also:: Introduction to private connectivity , Manage private connectivity endpoints: Azure

Syntax¶

SYSTEM$GET_PRIVATELINK_ENDPOINTS_INFO()

Copy

Returns¶

Returns a JSON object as follows:

[
   {
      "host": "service_name",
      "status": "APPROVED | PENDING | DISCONNECTED | REJECTED",
      "resource_id": "private_endpoint_identifier"
   },
    ...
]

Usage notes¶

This function can take approximately 5 minutes to execute because it depends on the process to retrieve the private connectivity endpoints in the cloud platform (outside of Snowflake).

Examples¶

For your Snowflake account on Microsoft Azure, return the private connectivity endpoints that you provisioned and the service names that each endpoint is associated:

SELECT SYSTEM$GET_PRIVATELINK_ENDPOINTS_INFO();

Copy

[
   {
      "host": "aztest1-external-function-api.azure-api.net",
      "status": "APPROVED",
      "resource_id":  "/subscriptions/fa57a1f0-b4e6-4847-9c00-95f39520f35e/resourceGroups/privatelink-test/providers/Microsoft.Network/privateEndpoints/apim-pe"
   }
]

Copy