FabricTools v0.33.0 Public Preview

Get-FabricSQLEndpoint

Retrieves SQL Endpoints from a specified workspace in Fabric.

Syntax

Get-FabricSQLEndpoint [-WorkspaceId] <guid> [[-SQLEndpointId] <guid>] [[-SQLEndpointName] <string>]
 [<CommonParameters>]

Description

The Get-FabricSQLEndpoint function retrieves SQL Endpoints from a specified workspace in Fabric. It supports filtering by SQL Endpoint ID or SQL Endpoint Name. If both filters are provided, an error message is returned. The function handles token validation, API requests with continuation tokens, and processes the response to return the desired SQL Endpoint(s).

Examples

Example 1

Get-FabricSQLEndpoint -WorkspaceId "workspace123" -SQLEndpointId "endpoint456"

Example 2

Get-FabricSQLEndpoint -WorkspaceId "workspace123" -SQLEndpointName "MySQLEndpoint"

Parameters

NameTypeReq.Pos.PipelineDescription
-WorkspaceId guid ✓Required 0 –

The ID of the workspace from which to retrieve SQL Endpoints. This parameter is mandatory.

-SQLEndpointId guid 1 –

The ID of the SQL Endpoint to retrieve. This parameter is optional but cannot be used together with SQLEndpointName.

-SQLEndpointName string 2 –

The name of the SQL Endpoint to retrieve. This parameter is optional but cannot be used together with SQLEndpointId.

This cmdlet also supports the common parameters, such as -Verbose and -ErrorAction. See about_CommonParameters.

Notes

Author: Tiago Balabuch, Kamil Nowinski