Skip to content

Spelling Fixes #27950

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Stop-AzSynapseDataFlowDebugSession
Add-AzSynapseDataFlowDebugSessionPackage -WorkspaceName ContosoWorkspace -PackageFile "D:\dataflowps\addpackage.json" -SessionId 3afb278e-ac5f-469f-a0b6-2f04c3ab59bc
```

Add data flow package into debug session "3afb278e-ac5f-469f-a0b6-2f04c3ab59bc" under Synapse workspace "ContosoWorkspace". Pakcage file contains data flow debug resource, list of dataset debug resource, list of linked service debug resource, debug setting and session ID. [-SessionId] parameter is optional, if it is specified, it will replace the existing sessionId property in the package file.
Add data flow package into debug session "3afb278e-ac5f-469f-a0b6-2f04c3ab59bc" under Synapse workspace "ContosoWorkspace". Package file contains data flow debug resource, list of dataset debug resource, list of linked service debug resource, debug setting and session ID. [-SessionId] parameter is optional, if it is specified, it will replace the existing sessionId property in the package file.

### Example 2
```powershell
Expand Down
8 changes: 4 additions & 4 deletions src/Synapse/Synapse/help/Add-AzSynapseTriggerSubscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Add-AzSynapseTriggerSubscription -InputObject <PSTriggerResource> [-AsJob]
```

## DESCRIPTION
The **Add-AzSynapseTriggerSubscription** cmdlet subscribes the event trigger to the specified external service events from the trigger defintion.
The **Add-AzSynapseTriggerSubscription** cmdlet subscribes the event trigger to the specified external service events from the trigger definition.

## EXAMPLES

Expand All @@ -40,23 +40,23 @@ The **Add-AzSynapseTriggerSubscription** cmdlet subscribes the event trigger to
Add-AzSynapseTriggerSubscription -WorkspaceName ContosoWorkspace -Name ContosoTrigger
```

This command will subscribe trigger called ContosoTrigger to the specified events from the trigger defintion.
This command will subscribe trigger called ContosoTrigger to the specified events from the trigger definition.

### Example 2
```powershell
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Add-AzSynapseTriggerSubscription -Name ContosoTrigger
```

This command will subscribe trigger called ContosoTrigger to the specified events from the trigger defintion through pipeline.
This command will subscribe trigger called ContosoTrigger to the specified events from the trigger definition through pipeline.

### Example 3
```powershell
$trigger = Get-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger
$trigger | Add-AzSynapseTriggerSubscription
```

This command will subscribe trigger called ContosoTrigger to the specified events from the trigger defintion through pipeline.
This command will subscribe trigger called ContosoTrigger to the specified events from the trigger definition through pipeline.

## PARAMETERS

Expand Down
4 changes: 2 additions & 2 deletions src/Synapse/Synapse/help/Az.Synapse.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ When creating an Azure Synapse Analytics workspace, you can choose to encrypt al
Exports KQL script.

### [Export-AzSynapseNotebook](Export-AzSynapseNotebook.md)
Exports notbooks.
Exports notebooks.

### [Export-AzSynapseSparkConfiguration](Export-AzSynapseSparkConfiguration.md)
Exports a Synapse spark configuration to an output folder.
Expand Down Expand Up @@ -141,7 +141,7 @@ Gets information about linked services in workspace.
Gets Managed Identity Sql Control Settings.

### [Get-AzSynapseManagedPrivateEndpoint](Get-AzSynapseManagedPrivateEndpoint.md)
Gets information about mananged private endpoints in a workspace
Gets information about managed private endpoints in a workspace

### [Get-AzSynapseNotebook](Get-AzSynapseNotebook.md)
Gets information about notebooks in a workspace.
Expand Down
4 changes: 2 additions & 2 deletions src/Synapse/Synapse/help/Export-AzSynapseKqlScript.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@ The name of the KQL script becomes the name of the exported file. If you specify

### Example 1
```powershell
Export-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -OutputFolder "C:\KqlScirpt"
Export-AzSynapseKqlScript -WorkspaceName ContosoWorkspace -OutputFolder "C:\KqlScript"
```

Exports all KQL scripts in the workspace ContosoWorkspace to the folder "C:\KqlScirpt".
Exports all KQL scripts in the workspace ContosoWorkspace to the folder "C:\KqlScript".

### Example 2
```powershell
Expand Down
2 changes: 1 addition & 1 deletion src/Synapse/Synapse/help/Export-AzSynapseNotebook.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Export-AzSynapseNotebook

## SYNOPSIS
Exports notbooks.
Exports notebooks.

## SYNTAX

Expand Down
2 changes: 1 addition & 1 deletion src/Synapse/Synapse/help/Get-AzSynapseDroppedSqlPool.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Accept wildcard characters: False
```

### -DeletionDate
The deletion date of the Azure Synaspe SQL Database to retrieve backups for, with millisecond precision (e.g. 2016-02-23T00:21:22.847Z)
The deletion date of the Azure Synapse SQL Database to retrieve backups for, with millisecond precision (e.g. 2016-02-23T00:21:22.847Z)

```yaml
Type: System.Nullable`1[System.DateTime]
Expand Down
2 changes: 1 addition & 1 deletion src/Synapse/Synapse/help/Get-AzSynapseFirewallRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Accept wildcard characters: False
```

### -Name
The firerwall rule name for the workspace.
The firewall rule name for the workspace.

```yaml
Type: System.String
Expand Down
10 changes: 5 additions & 5 deletions src/Synapse/Synapse/help/Get-AzSynapseManagedPrivateEndpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Get-AzSynapseManagedPrivateEndpoint

## SYNOPSIS
Gets information about mananged private endpoints in a workspace
Gets information about managed private endpoints in a workspace

## SYNTAX

Expand All @@ -25,7 +25,7 @@ Get-AzSynapseManagedPrivateEndpoint -WorkspaceObject <PSSynapseWorkspace> [-Name
```

## DESCRIPTION
The **Get-AzSynapseManagedPrivateEndpoint** cmdlet gets information about mananged private endpoints in a workspace. If you specify the name of a mananged private endpoint, the cmdlet gets information about that mananged private endpoint. If you do not specify a name, the cmdlet gets information about all mananged private endpoints in the workspace.
The **Get-AzSynapseManagedPrivateEndpoint** cmdlet gets information about managed private endpoints in a workspace. If you specify the name of a managed private endpoint, the cmdlet gets information about that managed private endpoint. If you do not specify a name, the cmdlet gets information about all managed private endpoints in the workspace.

## EXAMPLES

Expand All @@ -34,22 +34,22 @@ The **Get-AzSynapseManagedPrivateEndpoint** cmdlet gets information about manang
Get-AzSynapseManagedPrivateEndpoint -WorkspaceName ContosoWorkspace -Name ContosoManagedPrivateEndpoint
```

Gets a single mananged private endpoint called ContosoManagedPrivateEndpoint in the workspace ContosoWorkspace.
Gets a single managed private endpoint called ContosoManagedPrivateEndpoint in the workspace ContosoWorkspace.

### Example 2
```powershell
Get-AzSynapseManagedPrivateEndpoint -WorkspaceName ContosoWorkspace
```

Gets a list of all mananged private endpoints in the workspace ContosoWorkspace.
Gets a list of all managed private endpoints in the workspace ContosoWorkspace.

### Example 3
```powershell
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseManagedPrivateEndpoint -Name ContosoManagedPrivateEndpoint
```

Gets a single mananged private endpoint called ContosoManagedPrivateEndpoint in the workspace ContosoWorkspace through pipeline.
Gets a single managed private endpoint called ContosoManagedPrivateEndpoint in the workspace ContosoWorkspace through pipeline.

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,23 +40,23 @@ The **Get-AzSynapseTriggerSubscriptionStatus** cmdlet gets the status of the sub
Get-AzSynapseTriggerSubscriptionStatus -WorkspaceName ContosoWorkspace -Name ContosoTrigger
```

This command will get the status of the subscribtion for trigger called ContosoTrigger to the external service events.
This command will get the status of the subscription for trigger called ContosoTrigger to the external service events.

### Example 2
```powershell
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseTriggerSubscriptionStatus -Name ContosoTrigger
```

This command will get the status of the subscribtion for trigger called ContosoTrigger to the external service events through pipeline.
This command will get the status of the subscription for trigger called ContosoTrigger to the external service events through pipeline.

### Example 3
```powershell
$trigger = Get-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger
$trigger | Get-AzSynapseTriggerSubscriptionStatus
```

This command will get the status of the subscribtion for trigger called ContosoTrigger to the external service events through pipeline.
This command will get the status of the subscription for trigger called ContosoTrigger to the external service events through pipeline.

## PARAMETERS

Expand Down
4 changes: 2 additions & 2 deletions src/Synapse/Synapse/help/Invoke-AzSynapseTriggerRun.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Invoke-AzSynapseTriggerRun -WorkspaceName <String> -Name <String> -TriggerRunId
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### InvokByInputObject
### InvokeByInputObject
```
Invoke-AzSynapseTriggerRun -InputObject <PSTriggerRun> [-PassThru] [-DefaultProfile <IAzureContextContainer>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Expand Down Expand Up @@ -80,7 +80,7 @@ The information about the trigger run.

```yaml
Type: Microsoft.Azure.Commands.Synapse.Models.PSTriggerRun
Parameter Sets: InvokByInputObject
Parameter Sets: InvokeByInputObject
Aliases:

Required: True
Expand Down
2 changes: 1 addition & 1 deletion src/Synapse/Synapse/help/New-AzSynapseFirewallRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Accept wildcard characters: False
```

### -Name
The firerwall rule name for the workspace.
The firewall rule name for the workspace.

```yaml
Type: System.String
Expand Down
4 changes: 2 additions & 2 deletions src/Synapse/Synapse/help/New-AzSynapseWorkspacePackage.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The **New-AzSynapseWorkspacePackage** uploads a local workspace package file to
New-AzSynapseWorkspacePackage -WorkspaceName ContosoWorkspace -Package ".\ContosoPackage.whl"
```

This command uploads the workspace package whose location is ".\ContosoPackage.whl" to an Azure Synapse workspace named ContosoWorkspace. The workspace pacakge can be either wheel or jar files.
This command uploads the workspace package whose location is ".\ContosoPackage.whl" to an Azure Synapse workspace named ContosoWorkspace. The workspace package can be either wheel or jar files.

### Example 2: Upload all workspace packages under the current folder
```powershell
Expand All @@ -50,7 +50,7 @@ $package = New-AzSynapseWorkspacePackage -WorkspaceName ContosoWorkspace -Packag
Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -PackageAction Add -Package $package
```

This first command uploads the workspace package whose location is ".\ContosoPackage.whl" to an Azure Synapse workspace named ContosoWorkspace. The workspace pacakge can be either wheel or jar files. Then the second command addes the package to a given Apache Spark pool named ContotoSparkPool.
This first command uploads the workspace package whose location is ".\ContosoPackage.whl" to an Azure Synapse workspace named ContosoWorkspace. The workspace package can be either wheel or jar files. Then the second command addes the package to a given Apache Spark pool named ContosoSparkPool.

## PARAMETERS

Expand Down
2 changes: 1 addition & 1 deletion src/Synapse/Synapse/help/Remove-AzSynapseFirewallRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Accept wildcard characters: False
```

### -Name
The firerwall rule name for the workspace.
The firewall rule name for the workspace.

```yaml
Type: System.String
Expand Down
2 changes: 1 addition & 1 deletion src/Synapse/Synapse/help/Remove-AzSynapseLinkConnection.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Remove-AzSynapseLinkConnection -InputObject <PSLinkConnectionResource> [-PassThr
```

## DESCRIPTION
The **Remove-AzSynapseLinkConnection** cmdlet removes a link connection from workspace. Only link connections in initial or stpped status can be removed.
The **Remove-AzSynapseLinkConnection** cmdlet removes a link connection from workspace. Only link connections in initial or stopped status can be removed.

## EXAMPLES

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ Remove a managed private endpoint called ContosoManagedPrivateEndpoint from the

### Example 3
```powershell
$privateendpint = Get-AzSynapseManagedPrivateEndpoint -WorkspaceName ContosoWorkspace -Name ContosoManagedPrivateEndpoint
$privateendpint | Remove-AzSynapseManagedPrivateEndpoint
$privateendpoint = Get-AzSynapseManagedPrivateEndpoint -WorkspaceName ContosoWorkspace -Name ContosoManagedPrivateEndpoint
$privateendpoint | Remove-AzSynapseManagedPrivateEndpoint
```

Remove a managed private endpoint called ContosoManagedPrivateEndpoint from the workspace ContosoWorkspace through pipeline.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Remove-AzSynapseTriggerSubscription -InputObject <PSTriggerResource> [-PassThru]
```

## DESCRIPTION
The **Remove-AzSynapseTriggerSubscription** cmdlet unsubscribes the event trigger to the specified external service events from the trigger defintion.
The **Remove-AzSynapseTriggerSubscription** cmdlet unsubscribes the event trigger to the specified external service events from the trigger definition.

## EXAMPLES

Expand All @@ -40,23 +40,23 @@ The **Remove-AzSynapseTriggerSubscription** cmdlet unsubscribes the event trigge
Remove-AzSynapseTriggerSubscription -WorkspaceName ContosoWorkspace -Name ContosoTrigger
```

This command will unsubscribe trigger called ContosoTrigger to the specified events from the trigger defintion.
This command will unsubscribe trigger called ContosoTrigger to the specified events from the trigger definition.

### Example 2
```powershell
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Remove-AzSynapseTriggerSubscription -Name ContosoTrigger
```

This command will unsubscribe trigger called ContosoTrigger to the specified events from the trigger defintion through pipeline.
This command will unsubscribe trigger called ContosoTrigger to the specified events from the trigger definition through pipeline.

### Example 3
```powershell
$trigger = Get-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger
$trigger | Remove-AzSynapseTriggerSubscription
```

This command will unsubscribe trigger called ContosoTrigger to the specified events from the trigger defintion through pipeline.
This command will unsubscribe trigger called ContosoTrigger to the specified events from the trigger definition through pipeline.

## PARAMETERS

Expand Down
2 changes: 1 addition & 1 deletion src/Synapse/Synapse/help/Restore-AzSynapseSqlPool.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ Accept wildcard characters: False
```

### -DeletionDate
The deletion date of the Azure Synaspe SQL Database to retrieve backups for, with millisecond precision (e.g. 2016-02-23T00:21:22.847Z)
The deletion date of the Azure Synapse SQL Database to retrieve backups for, with millisecond precision (e.g. 2016-02-23T00:21:22.847Z)

```yaml
Type: System.DateTime
Expand Down
4 changes: 2 additions & 2 deletions src/Synapse/Synapse/help/Update-AzSynapseFirewallRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Update-AzSynapseFirewallRule -WorkspaceObject <PSSynapseWorkspace> -Name <String
```

## DESCRIPTION
The **Update-AzSynapseFirewallRule** cmdlet modifys an Azure Synapse Analytics Firewall Rule.
The **Update-AzSynapseFirewallRule** cmdlet modifies an Azure Synapse Analytics Firewall Rule.

## EXAMPLES

Expand Down Expand Up @@ -96,7 +96,7 @@ Accept wildcard characters: False
```

### -Name
The firerwall rule name for the workspace.
The firewall rule name for the workspace.

```yaml
Type: System.String
Expand Down
2 changes: 1 addition & 1 deletion src/Synapse/Synapse/help/Update-AzSynapseSparkPool.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ $new_pool_packages = @($workspace_packages | Where-Object {$_.name -in $library_
Update-AzSynapseSparkPool -ResourceGroupName ContosoResourceGroup -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -PackageAction Set -Package $new_pool_packages
```

The first command retrieves the packages available in the workspace. The second command group retrieves the spark pool to get the packages currently linked to this pool and removes all versions of the package starting with `new_package-` from the retrieved list. The new version of the package is then added to this list. In the third group of commands the package list, containing only package names, is tranformed into a list of workspace packages by filtering the list of available workspace_packages accordingly and is then linked to the spark pool.
The first command retrieves the packages available in the workspace. The second command group retrieves the spark pool to get the packages currently linked to this pool and removes all versions of the package starting with `new_package-` from the retrieved list. The new version of the package is then added to this list. In the third group of commands the package list, containing only package names, is transformed into a list of workspace packages by filtering the list of available workspace_packages accordingly and is then linked to the spark pool.

### Example 15
```powershell
Expand Down
18 changes: 9 additions & 9 deletions src/Synapse/Synapse/help/Update-AzSynapseWorkspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,37 +58,37 @@ The **Update-AzSynapseWorkspace** cmdlet updates an Azure Synapse Analytics work
Update-AzSynapseWorkspace -Name ContosoWorkspace -Tag @{'key'='value'}
```

This commands updates tags for the specififed Azure Synapse Analytics workspace.
This command updates tags for the specified Azure Synapse Analytics workspace.

### Example 2
```powershell
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Update-AzSynapseWorkspace -Tag @{'key'='value1'}
```

This commands updates tags for the specififed Azure Synapse Analytics workspace through pipeline.
This commands updates tags for the specified Azure Synapse Analytics workspace through pipeline.

### Example 3
```powershell
Update-AzSynapseWorkspace -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace -Tag @{'key'='value2'}
```

This commands updates tags for the specififed Azure Synapse Analytics workspace through pipeline with resource ID.
This commands updates tags for the specified Azure Synapse Analytics workspace through pipeline with resource ID.

### Example 4
```powershell
$config = New-AzSynapseGitRepositoryConfig -RepositoryType GitHub -AccountName ContosoAccount -RepositoryName ContosoRepo -CollaborationBranch main
Update-AzSynapseWorkspace -Name ContosoWorkspace -GitRepository $config
```

This commands updates Git repository which workspace is conneceted to for the specififed Azure Synapse Analytics workspace.
This commands updates Git repository which workspace is connected to for the specified Azure Synapse Analytics workspace.

### Example 5
```powershell
Update-AzSynapseWorkspace -Name ContosoWorkspace -EnablePublicNetworkAccess $True
```

This commands updates the specififed Azure Synapse Analytics workspace to enable public network access.
This commands updates the specified Azure Synapse Analytics workspace to enable public network access.

### Example 6
```powershell
Expand All @@ -101,7 +101,7 @@ foreach($uami in $uamis){
Update-AzSynapseWorkspace -Name ContosoWorkspace -UserAssignedIdentityAction Add -UserAssignedIdentityId $uamilist
```

This commands updates workspace to add user assigned managed identites in $uamilist.
This commands updates workspace to add user assigned managed identities in $uamilist.

### Example 7
```powershell
Expand All @@ -114,7 +114,7 @@ foreach($uami in $uamis){
Update-AzSynapseWorkspace -Name ContosoWorkspace -UserAssignedIdentityAction Remove -UserAssignedIdentityId $uamilist[0]
```

This commands removes user assigned managed identites $uamilist[0] from workspace.
This commands removes user assigned managed identities $uamilist[0] from workspace.

### Example 8
```powershell
Expand All @@ -127,7 +127,7 @@ foreach($uami in $uamis){
Update-AzSynapseWorkspace -Name ContosoWorkspace -UserAssignedIdentityAction Set -UserAssignedIdentityId $uamilist
```

This commands updates workspace with user assigned managed identites $uamilist that will cover current identities.
This commands updates workspace with user assigned managed identities $uamilist that will cover current identities.

### Example 9
```powershell
Expand All @@ -137,7 +137,7 @@ New-AzSynapseWorkspaceKey -ResourceGroupName ContosoResourceGroup -WorkspaceName
##Update the workspace and set the temp key as the TDE protector
Update-AzSynapseWorkspace -WorkspaceName ContosoWorkspace -EncryptionKeyName TempKey -UseSystemAssignedIdentityInEncryption $true

##Note, we need to create a new key version for the original encrytion key of the Azure key vault before moving to next steps.
##Note, we need to create a new key version for the original encryption key of the Azure key vault before moving to next steps.

##Update the workspace and set the encryption key back after we created a new key version.
Update-AzSynapseWorkspace -WorkspaceName ContosoWorkspace -EncryptionKeyName default -UseSystemAssignedIdentityInEncryption $true
Expand Down
Loading