Categories:: System functions (System Control)

SYSTEM$RESTORE_PRIVATELINK_ENDPOINT¶

Restores a private connectivity endpoint in the Snowflake VPC or VNet to enable Snowflake to connect to an external service 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 system function.

Syntax¶

AWS:

SYSTEM$RESTORE_PRIVATELINK_ENDPOINT( '<provider_service_name>' )

Copy

Azure:

SYSTEM$RESTORE_PRIVATELINK_ENDPOINT(
  '<provider_resource_id>'
  [, '<subresource>' ]
  )

Copy

Arguments¶

provider_service_name: Specifies the external service or resource endpoint to restore. For example, com.amazonaws.us-west-2.execute-api for the Amazon API Gateway or com.amazonaws.us-west-2.s3 for Amazon S3.

'provider_resource_id'

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

'subresource'

Specifies the name of the subresource of the Azure resource.

This argument is not required for Azure Private Link Service (https://learn.microsoft.com/en-us/azure/private-link/private-link-service-overview) and Azure API Management Service.

For all supported values, see the Sub-resource table (https://learn.microsoft.com/en-us/azure/private-link/private-endpoint-overview#private-link-resource).

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.

Usage notes¶

Only account administrators (users with the ACCOUNTADMIN role) can call this function.
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 Amazon S3:

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

Copy

Azure:

Restore a private endpoint to allow Snowflake on Microsoft Azure to connect to the Azure API Management service in your Azure VNet:

SELECT SYSTEM$RESTORE_PRIVATELINK_ENDPOINT(
  '/subscriptions/11111111-2222-3333-4444-5555555555/resourceGroups/my_rg/providers/Microsoft.Sql/servers/my_db_server',
  'sqlServer'
);

Copy

Private endpoint with id ''/subscriptions/66666666-7777-8888-9999-0000000000/resourcegroups/rg/providers/microsoft.network/privateendpoints/00000000-1111-2222-3333-4444444444'' restored successfully.