Bearbeiten

Freigeben über

Remove-AzSynapseSqlScript

  • Reference
Module:
Az.Synapse

Removes a sql script from a Synapse workspace.

Syntax

Remove-AzSynapseSqlScript
      -WorkspaceName <String>
      -Name <String>
      [-PassThru]
      [-AsJob]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzSynapseSqlScript
      -WorkspaceObject <PSSynapseWorkspace>
      -Name <String>
      [-PassThru]
      [-AsJob]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzSynapseSqlScript
      -InputObject <PSSqlScriptResource>
      [-PassThru]
      [-AsJob]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzSynapseSqlScript cmdlet removes a sql script from a Synapse workspace.

Examples

Example 1

Remove-AzSynapseSqlScript -WorkspaceName ContosoWorkspace -Name ContosoSqlScript

Remove a sql script called ContosoSqlScript from the workspace ContosoWorkspace.

Example 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Remove-AzSynapseSqlScript -Name ContosoSqlScript

Remove a sql script called ContosoSqlScript from the workspace ContosoWorkspace through pipeline.

Example 3

$sqlscript = Get-AzSynapseSqlScript -WorkspaceName ContosoWorkspace -Name ContosoSqlScript
$sqlscript | Remove-AzSynapseSqlScript

Remove a sql script called ContosoSqlScript from the workspace ContosoWorkspace through pipeline.

Parameters

-AsJob

Run cmdlet in the background

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Do not ask for confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

The sql script object.

Type:PSSqlScriptResource
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The sql script name.

Type:String
Aliases:SqlScriptName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

This Cmdlet does not return an object by default. If this switch is specified, it returns true if successful.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceName

Name of Synapse workspace.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Type:PSSynapseWorkspace
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

PSSynapseWorkspace

PSSqlScriptResource

Outputs

Boolean