Categories:: System functions (System Control)

SYSTEM$RESTORE_PRIVATELINK_ENDPOINT_TSS¶

Restores a private connectivity endpoint in the Snowflake VPC or VNet to enable Snowflake to connect to an external key management service (KMS) resource by using private connectivity. The endpoint can be a service endpoint or a resource endpoint, depending on the cloud platform that hosts your Snowflake account.

You can restore a private endpoint within 7 days of deprovisioning it. After 7 days, the endpoint cannot be restored and you need to recreate the endpoint with the SYSTEM$PROVISION_PRIVATELINK_ENDPOINT_TSS system function.

Syntax¶

AWS:

SYSTEM$RESTORE_PRIVATELINK_ENDPOINT_TSS(
  '<provider_service_name>'
  )

Copy

Azure:

SYSTEM$RESTORE_PRIVATELINK_ENDPOINT_TSS(
  '<provider_resource_id>'
  )

Copy

Arguments¶

AWS:

provider_service_name: Specifies the external KMS resource endpoint to restore.

Azure:

provider_resource_id: Specifies the fully-qualified identifier for the resource in your VPC or VNet.

Returns¶

Returns a status message stating that the endpoint, with its identifier, is restored successfully.

If unsuccessful, returns an error — for example, if the provided argument is not a valid existing endpoint. If you do not know the endpoint name, you can use the SYSTEM$GET_PRIVATELINK_ENDPOINTS_INFO system function to list all endpoints in your Snowflake account.

Access control requirements¶

Only account administrators (users with the ACCOUNTADMIN role) can call this function.

Usage notes¶

An error message occurs if a private connectivity endpoint is not associated with the specified arguments.

Examples¶

AWS:

Restore a private endpoint with external access to an AWS key store.

SELECT SYSTEM$RESTORE_PRIVATELINK_ENDPOINT_TSS(
  'com.amazonaws.us-west-2.s3'
  );

Copy

Azure:

Restore a private endpoint to allow Snowflake on Microsoft Azure to connect to the Azure key vault in your Azure VNet:

SELECT SYSTEM$RESTORE_PRIVATELINK_ENDPOINT_TSS(
  '/subscriptions/12345678-90ab-cdef-1234-567890abcdef/resourceGroups/myvault/providers/Microsoft.KeyVault/vaults/TriSecretVault'
  );

Copy

"Resource Endpoint with id "/subscriptions/12345678-90ab-cdef-1234-567890abcdef/resourceGroups/myvault/privatelink-test/providers/Microsoft.KeyVault/vaults/TriSecretVault/privateEndpoints/" restored successfully.