FabricTools v0.33.0 Public Preview

Refresh-FabricSQLEndpoint

Refreshes the metadata of a SQL analytics endpoint.

Syntax

Refresh-FabricSQLEndpoint [-WorkspaceId] <guid> [-SQLEndpointId] <guid> [[-Timeout] <int>] [-NoWait]
 [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Starts a refresh of the metadata for a SQL analytics endpoint in a specified workspace. By default, the function waits for the long-running operation to complete.

Examples

Example 1

Refresh-FabricSQLEndpoint -WorkspaceId $workspaceId -SQLEndpointId $sqlEndpointId

Parameters

NameTypeReq.Pos.PipelineDescription
-SQLEndpointId guid ✓Required 1 –

The ID of the SQL analytics endpoint to refresh.

-WorkspaceId guid ✓Required 0 –

The ID of the workspace containing the SQL analytics endpoint.

-Confirmalias: cf switch Named –

Prompts you for confirmation before running the cmdlet.

-NoWait switch Named –

If specified, returns immediately after the refresh request is accepted.

Default: False
-Timeout int 2 –

The maximum time, in minutes, to wait for the refresh operation. A value of 0 waits indefinitely.

Default: 15
-WhatIfalias: wi switch Named –

Runs the command in a mode that only reports what would happen without performing the actions.

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

Notes

Author: Kamil Nowinski