Categories:

System Functions (System Information)

SYSTEM$GET_PRIVATELINK_CONFIG

Returns a JSON representation of the Snowflake account information necessary to facilitate the self-service configuration of private connectivity to the Snowflake service or internal stages.

Syntax

SYSTEM$GET_PRIVATELINK_CONFIG()

Arguments

None.

Usage Notes

Only account administrators (i.e. users with the ACCOUNTADMIN role) can execute this function.

Output

The function returns a JSON object containing the following name/value pairs:

AWS

{
  "privatelink-account-name": "<account_identifier>",
  "privatelink-internal-stage": "<privatelink_stage_endpoint>",
  "privatelink-account-url": "<privatelink_account_url>",
  "privatelink-ocsp-url": "<privatelink_ocsp_url>",
  "privatelink-vpce-id": "<aws_vpce_id>"
}

Azure

{
  "privatelink-account-name": "<account_identifier>",
  "privatelink-internal-stage": "<privatelink_stage_endpoint>",
  "privatelink-account-url":"<privatelink_account_url>",
  "privatelink-ocsp-url": "<privatelink_ocsp_url>",
  "privatelink-pls-id": "<azure_privatelink_service_id>"
}

Where:

privatelink-account-name

The identifier for your Snowflake account.

Use this value with clients for Connecting to Snowflake.

For more information, see Account Identifiers.

privatelink-internal-stage

The endpoint to connect to your Snowflake internal stage using AWS PrivateLink or Azure Private Link.

Use this value with Private Connectivity to Snowflake Internal Stages.

The visibility of this key and the corresponding value in the query result depends on the ENABLE_INTERNAL_STAGES_PRIVATELINK parameter setting. The default setting for this parameter is FALSE. You must set this parameter to TRUE prior to executing this system function to obtain the internal stage endpoint in the query result.

privatelink-account-url

The URL to connect to your Snowflake account using AWS PrivateLink or Azure Private Link.

Use this value to create a canonical name (i.e. CNAME) for DNS resolution. This URL should match the output from SYSTEM$WHITELIST_PRIVATELINK.

For more information on URL formats, see Account Identifiers.

privatelink-ocsp-url

The OCSP URL corresponding to your Snowflake account identifier that uses AWS PrivateLink or Azure Private Link.

Use this value to create a canonical name (i.e. CNAME) for DNS resolution. This URL should match the output from SYSTEM$WHITELIST_PRIVATELINK.

privatelink-vpce-id

The AWS VPCE ID for your account identifier.

Use this value to create an AWS VPC endpoint (i.e. VPCE).

privatelink-pls-id

The Azure Private Link Service ID for your account identifier.

Use this value to create an Azure Private Link private endpoint.

Examples

Retrieve the JSON information for your account on AWS PrivateLink and Azure Private Link:

-- AWS

SELECT SYSTEM$GET_PRIVATELINK_CONFIG();

+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| SYSTEM$GET_PRIVATELINK_CONFIG()                                                                                                                                                                                                                                  |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| {"privatelink-account-name": "<account_identifier>","privatelink-internal-stage": "<privatelink_stage_endpoint>","privatelink-account-url": "<privatelink_account_url>","privatelink-ocsp-url": "<privatelink_ocsp_url>","privatelink-vpce-id": "<aws_vpce_id>"} |
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

-- Azure

SELECT SYSTEM$GET_PRIVATELINK_CONFIG();

+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| SYSTEM$GET_PRIVATELINK_CONFIG()                                                                                                                                                                                                                                                   |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| {"privatelink-account-name": "<account_identifier>","privatelink-internal-stage": "<privatelink_stage_endpoint>","privatelink-account-url": "<privatelink_account_url>","privatelink-ocsp-url": "<privatelink_ocsp_url>","privatelink-pls-id": "<azure_private_link_service_id>"} |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

You can optionally run the following command to flatten the JSON output.

-- Azure

select key, value from table(flatten(input=>parse_json(SYSTEM$GET_PRIVATELINK_CONFIG())));

+------------------------------------------------------------------+
| KEY                        | VALUE                               |
+------------------------------------------------------------------+
| privatelink-account-name   | "<account_identifier>"              |
+------------------------------------------------------------------+
| privatelink-internal-stage | "<privatelink_stage_endpoint>"      |
+------------------------------------------------------------------+
| privatelink-account-url    | "<privatelink_account_url>"         |
+------------------------------------------------------------------+
| privatelink-pls-id         | "<azure_private_link_service_id>"   |
+------------------------------------------------------------------+
| privatelink-ocsp-url       | "<privatelink_ocsp_url>"            |
+------------------------------------------------------------------+