SYSTEM$GET_PRIVATELINK¶

Syntax¶

AWS:

SYSTEM$GET_PRIVATELINK( '<aws_id>' , '<federated_token>' )

Copy

Azure:

SYSTEM$GET_PRIVATELINK( '<private-endpoint-resource-id>' , '<federated_token>' )

Copy

Arguments¶

'aws_id'

The 12-digit identifier that uniquely identifies your Amazon Web Services (AWS) account, as a string.

'private-endpoint-resource-id'

The identifier that uniquely identifies the private endpoint in Microsoft Azure (Azure) as a string.

'federated_token'

The federated token value that contains access credentials for a federated user as a string.

To obtain this value, execute the appropriate command for the cloud platform that hosts your Snowflake account. Use the command-line tool provided by the platform:

• For Snowflake on AWS:

  aws sts get-federation-token --name sam
  

  Copy

• For Snowflake on Azure:

  az account get-access-token --subscription <SubscriptionID>
  

  Copy

  Where:

  • SubscriptionID

    The unique identifier for your subscription. For example:

    13c...

    To obtain this value, execute the following Azure CLI command in your command line environment:

    az account list --output table
    

    Copy

    Note the output value in the SubscriptionID column, which is truncated in this example:

    Name     CloudName   SubscriptionId                        State    IsDefault
    -------  ----------  ------------------------------------  -------  ----------
    MyCloud  AzureCloud  13c...                                Enabled  True
    

    Copy

Usage notes¶

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

• This function can be used with Snowflake accounts on AWS or Azure; Google Cloud Platform (GCP) is not currently supported.

• Call the SYSTEM$AUTHORIZE_PRIVATELINK function to enable your Snowflake account to use private connectivity to the Snowflake service.

• Call the SYSTEM$REVOKE_PRIVATELINK function to disable your Snowflake account to use private connectivity to the Snowflake service.

Examples¶

Verify whether AWS PrivateLink is authorized for your Snowflake account on AWS. Note that the values are truncated in this example.

use role accountadmin;

select SYSTEM$GET_PRIVATELINK(
    '185...',
    '{
      "Credentials": {
          "AccessKeyId": "ASI...",
          "SecretAccessKey": "enw...",
          "SessionToken": "Fwo...",
          "Expiration": "2021-01-07T19:06:23+00:00"
      },
      "FederatedUser": {
          "FederatedUserId": "185...:sam",
          "Arn": "arn:aws:sts::185...:federated-user/sam"
      },
      "PackedPolicySize": 0
  }'
  );

Copy

Verify whether Azure Private Link is authorized for your Snowflake account on Azure. Note that the values are truncated in this example.

use role accountadmin;

select SYSTEM$GET_PRIVATELINK(
  '/subscriptions/26d.../resourcegroups/sf-1/providers/microsoft.network/privateendpoints/test-self-service',
  'eyJ...');

Copy