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 AWS PrivateLink or Azure Private Link.

For more information, see:

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-account-url": "<privatelink_account_url>",
  "privatelink-ocsp-url": "<privatelink_ocsp_url>",
  "privatelink-vpce-id": "<aws_vpce_id>"
}

Azure

{
  "privatelink-account-name": "<account_identifier>",
  "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-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-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-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.

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

+-----------------------------------------------------------------+
| KEY                       | VALUE                               |
+-----------------------------------------------------------------+
| privatelink-account-name  | "<account_identifier>"              |
+-----------------------------------------------------------------+
| privatelink-account-url     | "<privatelink_account_url>"         |
+-----------------------------------------------------------------+
| privatelink-vpce-id       | "<aws_vpce_id>"                     |
+-----------------------------------------------------------------+
| privatelink-ocsp-url      | "<privatelink_ocsp_url>"            |
+-----------------------------------------------------------------+