Skip to content

Commit

Permalink
format the help markdown files of Az.Synapse (#18750)
Browse files Browse the repository at this point in the history 
* format the help markdown files of Az.Synapse

* format the help markdown files of Az.Synapse

Co-authored-by: Ziyue Zheng <[email protected]>
  • Loading branch information
@v-yuzhichen @ziyuezh576
v-yuzhichen and ziyuezh576 authored Jul 1, 2022
1 parent 98e2cd0 commit cca26bc
Show file tree
Hide file tree
Showing 18 changed files with 176 additions and 175 deletions.
20 changes: 10 additions & 10 deletions src/Synapse/Synapse/help/Disable-AzSynapseActiveDirectoryOnlyAuthentication.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,36 +37,36 @@ The **Disable-AzSynapseActiveDirectoryOnlyAuthentication** cmdlet disables Azure

### Example 1
```powershell
PS C:\> Disable-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceName ContosoWorkspace
Disable-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceName ContosoWorkspace
```

```output
WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate
------------- --------------------------------- ----- ------------
ContosoWorkspace False Consistent 3/23/2022 8:27:47 AM

```
This command disables Azure AD only authentication for workspace ContosoWorkspace.

### Example 2
```powershell
PS C:\> $ws = Get-AzSynapseWorkspace -WorkspaceName ContosoWorkspace
PS C:\> $ws | Disable-AzSynapseActiveDirectoryOnlyAuthentication
$ws = Get-AzSynapseWorkspace -WorkspaceName ContosoWorkspace
$ws | Disable-AzSynapseActiveDirectoryOnlyAuthentication
```

```output
WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate
------------- --------------------------------- ----- ------------
ContosoWorkspace False Consistent 3/23/2022 8:27:47 AM

```
This command disables Azure AD only authentication for workspace ContosoWorkspace through pipeline.

### Example 3
```powershell
PS C:\> Disable-AzSynapseActiveDirectoryOnlyAuthentication -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace
Disable-AzSynapseActiveDirectoryOnlyAuthentication -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace
```

```outout
WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate
------------- --------------------------------- ----- ------------
ContosoWorkspace False Consistent 3/23/2022 8:27:47 AM

```
This command disables Azure AD only authentication for workspace ContosoWorkspace by ResourceId.

## PARAMETERS
Expand Down
20 changes: 10 additions & 10 deletions src/Synapse/Synapse/help/Enable-AzSynapseActiveDirectoryOnlyAuthentication.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,36 +37,36 @@ The **Enable-AzSynapseActiveDirectoryOnlyAuthentication** cmdlet enables Azure A

### Example 1
```powershell
PS C:\> Enable-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceName ContosoWorkspace
Enable-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceName ContosoWorkspace
```

```output
WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate
------------- --------------------------------- ----- ------------
ContosoWorkspace True Consistent 3/23/2022 8:27:47 AM

```
This command enables Azure AD only authentication for workspace ContosoWorkspace.

### Example 2
```powershell
PS C:\> $ws = Get-AzSynapseWorkspace -WorkspaceName ContosoWorkspace
PS C:\> $ws | Enable-AzSynapseActiveDirectoryOnlyAuthentication
$ws = Get-AzSynapseWorkspace -WorkspaceName ContosoWorkspace
$ws | Enable-AzSynapseActiveDirectoryOnlyAuthentication
```

```output
WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate
------------- --------------------------------- ----- ------------
ContosoWorkspace True Consistent 3/23/2022 8:27:47 AM

```
This command enables Azure AD only authentication for workspace ContosoWorkspace through pipeline.

### Example 3
```powershell
PS C:\> Enable-AzSynapseActiveDirectoryOnlyAuthentication -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace
Enable-AzSynapseActiveDirectoryOnlyAuthentication -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace
```

```output
WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate
------------- --------------------------------- ----- ------------
ContosoWorkspace True Consistent 3/23/2022 8:27:47 AM

```
This command enables Azure AD only authentication for workspace ContosoWorkspace by ResourceId.

## PARAMETERS
Expand Down
20 changes: 10 additions & 10 deletions src/Synapse/Synapse/help/Get-AzSynapseActiveDirectoryOnlyAuthentication.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,36 +37,36 @@ The **Get-AzSynapseActiveDirectoryOnlyAuthentication** cmdlet gets Azure Active

### Example 1
```powershell
PS C:\> Get-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceName ContosoWorkspace
Get-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceName ContosoWorkspace
```

```output
WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate
------------- --------------------------------- ----- ------------
ContosoWorkspace True Consistent 3/23/2022 8:27:47 AM

```
This command gets Azure AD only authentication status for Synapse workspace ContosoWorkspace.

### Example 2
```powershell
PS C:\> $ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
PS C:\> $ws | Get-AzSynapseActiveDirectoryOnlyAuthentication
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseActiveDirectoryOnlyAuthentication
```

```output
WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate
------------- --------------------------------- ----- ------------
ContosoWorkspace True Consistent 3/23/2022 8:27:47 AM

```
This command gets Azure AD only authentication status for Synapse workspace ContosoWorkspace through pipeline.

### Example 3
```powershell
PS C:\> Get-AzSynapseActiveDirectoryOnlyAuthentication -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace
Get-AzSynapseActiveDirectoryOnlyAuthentication -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace
```

```output
WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate
------------- --------------------------------- ----- ------------
ContosoWorkspace True Consistent 3/23/2022 8:27:47 AM

```
This command gets Azure AD only authentication for workspace ContosoWorkspace by ResourceId.

## PARAMETERS
Expand Down
8 changes: 4 additions & 4 deletions src/Synapse/Synapse/help/Get-AzSynapseLinkConnection.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,22 +31,22 @@ The **Get-AzSynapseLinkConnection** cmdlet gets information about link connectio

### Example 1
```powershell
PS C:\> Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace
Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace
```

Gets a list of all link connections in the workspace ContosoWorkspace.

### Example 2
```powershell
PS C:\> Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
```

Gets a single link connection named ContosoLinkConnection in the workspace ContosoWorkspace.

### Example 3
```powershell
PS C:\> $ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
PS C:\> $ws | Get-AzSynapseLinkConnection
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseLinkConnection
```

This command gets all link connections under a workspace through pipeline.
Expand Down
14 changes: 7 additions & 7 deletions src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionDetailedStatus.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,31 +31,31 @@ The **Get-AzSynapseLinkConnectionDetailedStatus** cmdlet gets detail status abou

### Example 1
```powershell
PS C:\> Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
```

Gets detail status about link connection ContosoLinkConnection in the workspace ContosoWorkspace.

### Example 2
```powershell
PS C:\> $ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
PS C:\> $ws | Get-AzSynapseLinkConnectionDetailedStatus -Name ContosoLinkConnection
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseLinkConnectionDetailedStatus -Name ContosoLinkConnection
```

This command gets detail status about link connection ContosoLinkConnection under a workspace through pipeline.

### Example 3
```powershell
PS C:\> Start-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
PS C:\> Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
Start-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
```

Starts a link connection named ContosoLinkConnection in workspace ContosoWorkspace, it will cost some time to start, then you can call **Get-AzSynapseLinkConnectionDetailedStatus** to monitor its status.

### Example 4
```powershell
PS C:\> Stop-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
PS C:\> Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
Stop-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
```

Stops a link connection named ContosoLinkConnection in workspace ContosoWorkspace, it will cost some time from running to stop, then you can call **Get-AzSynapseLinkConnectionDetailedStatus** to monitor its status.
Expand Down
2 changes: 1 addition & 1 deletion src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionLinkTable.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ This command gets information about link tables under link connection ContosoLin

### Example 3
```powershell
$lc = Get-AzSynpaseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
$lc = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
$lc | Get-AzSynapseLinkConnectionLinkTable
```

Expand Down
8 changes: 4 additions & 4 deletions src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionLinkTableStatus.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,23 +39,23 @@ The **Get-AzSynapseLinkConnectionLinkTablesStatus** cmdlet gets status of link t

### Example 1
```powershell
Get-AzSynapseLinkConnectionLinkTablesStatus -WorkspaceName ContosoWorkspace -LinkConnectionName ContosoLinkConnection -MaxSegmentCount 50
Get-AzSynapseLinkConnectionLinkTableStatus -WorkspaceName ContosoWorkspace -LinkConnectionName ContosoLinkConnection -MaxSegmentCount 50
```

This command gets status of link tables with max segment count 50 under link connection ContosoLinkConnection in workspace ContosoWorkspace.

### Example 2
```powershell
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseLinkConnectionLinkTablesStatus -LinkConnectionName ContosoLinkConnection -MaxSegmentCount 50
$ws | Get-AzSynapseLinkConnectionLinkTableStatus -LinkConnectionName ContosoLinkConnection -MaxSegmentCount 50
```

This command gets status of link tables with max segment count 50 under link connection ContosoLinkConnection in workspace ContosoWorkspace through pipeline.

### Example 3
```powershell
$lc = Get-AzSynpaseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
$lc | Get-AzSynapseLinkConnectionLinkTablesStatus -MaxSegmentCount 50
$lc = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
$lc | Get-AzSynapseLinkConnectionLinkTableStatus -MaxSegmentCount 50
```

This command gets status of link tables with max segment count 50 under a link connection through pipeline.
Expand Down
10 changes: 3 additions & 7 deletions src/Synapse/Synapse/help/Invoke-AzSynapseSparkStatement.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,18 +49,14 @@ The **Invoke-AzSynapseSparkStatement** cmdlet invokes a Synapse Analytics Spark
```powershell
$session = Start-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -Name ContosoSessionName -ExecutorCount 3 -ExecutorSize Small
$session.Language = 'Spark'
$session | Invoke-AzSynapseSparkStatement -Code '
print("Hello world\n")
'
$session | Invoke-AzSynapseSparkStatement -Code 'print("Hello world\n")'
```

These commands start a Spark session then invoke an inline Spark statement through pipeline.

### Example 2
```powershell
Invoke-AzSynapseSparkStatement -SessionId 324 -Language 'Spark' -Code '
print("Hello world\n")
'
Invoke-AzSynapseSparkStatement -SessionId 324 -Language 'Spark' -Code 'print("Hello world\n")'
```

These commands start a Spark session then invoke an inline Spark statement.
Expand All @@ -69,7 +65,7 @@ These commands start a Spark session then invoke an inline Spark statement.
```powershell
$session = Start-AzSynapseSparkSession -WorkspaceName ContosoWorkspace -SparkPoolName ContosoSparkPool -Name ContosoSessionName -ExecutorCount 3 -ExecutorSize Small
$session.Language = 'Spark'
$session | Invoke-AzSynapseSparkStatement -FilePath C:\path\to\code.sc
$session | Invoke-AzSynapseSparkStatement -FilePath 'C:\path\to\code.sc'
```

These commands start a Spark session then invoke Spark statements in a file.
Expand Down
12 changes: 6 additions & 6 deletions src/Synapse/Synapse/help/New-AzSynapseKustoPoolDataConnection.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,21 +73,21 @@ New-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName te
```

```output
Kind Location Name
---- -------- ----
Kind Location Name
---- -------- ----
EventHub East US 2 testws/testkustopool/testdatabase/eventhubdc
```

The above command creates a new EventHub data connection named "eventhubdc" for the database "testdatabase" in the kusto pool "testkustopool".

### Example 2: Create a new EventGrid data connection
```powershell
New-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventgriddc -Location eastus2 -Kind EventGrid -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/teststorage" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" -IgnoreFirstRecord -BlobStorageEventType "Microsoft.Storage.BlobRenamed"
New-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName testws -KustoPoolName testkustopool -DatabaseName testdatabase -Name eventgriddc -Location eastus2 -Kind EventGrid -EventHubResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/testeventhubns/eventhubs/testeventhub" -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/teststorage" -DataFormat "JSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping"
```

```output
Kind Location Name
---- -------- ----
---- -------- ----
EventGrid East US 2 testws/testkustopool/testdatabase/eventgriddc
```

Expand All @@ -99,8 +99,8 @@ New-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName te
```

```output
Kind Location Name
---- -------- ----
Kind Location Name
---- -------- ----
IotHub East US 2 testws/testkustopool/testdatabase/iothubdc
```

Expand Down
10 changes: 5 additions & 5 deletions src/Synapse/Synapse/help/Remove-AzSynapseLinkConnection.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,23 +37,23 @@ The **Remove-AzSynapseLinkConnection** cmdlet removes a link connection from wor

### Example 1
```powershell
PS C:\> Remove-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
Remove-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
```

This command removes the link connection named ContosoLinkConnection from the workspace named ContosoWorkspace.

### Example 2
```powershell
PS C:\> $ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
PS C:\> $ws | Remove-AzSynapseLinkConnection -Name ContosoLinkConnection
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Remove-AzSynapseLinkConnection -Name ContosoLinkConnection
```

This command removes the link connection named ContosoLinkConnection from the workspace named ContosoWorkspace through pipeline.

### Example 3
```powershell
PS C:\> $linkConnection = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
PS C:\> $linkConnection | Remove-AzSynapseLinkConnection
$linkConnection = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
$linkConnection | Remove-AzSynapseLinkConnection
```

This command removes the link connection named ContosoLinkConnection from the workspace named ContosoWorkspace through pipeline.
Expand Down
6 changes: 3 additions & 3 deletions src/Synapse/Synapse/help/Remove-AzSynapseSqlPoolRestorePoint.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,23 +45,23 @@ The **Remove-AzSynapseSqlPoolRestorePoint** cmdlet permanently deletes an Azure

### Example 1
```powershell
Remove-AzSynapseSqlPoolRestorePoint -WorkspaceName ContosoWorkspace -SqlPoolName ContosoSqlPool -Name ContosoSqlPoolRestorePointCreationDate
Remove-AzSynapseSqlPoolRestorePoint -WorkspaceName ContosoWorkspace -SqlPoolName ContosoSqlPool -RestorePointCreationDate ContosoSqlPoolRestorePointCreationDate
```

This command deletes an Azure Synapse Analytics SQL pool restore point.

### Example 2
```powershell
$pool = Get-AzSynapseSqlPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool
$pool | Remove-AzSynapseSqlPoolRestorePoint -Name ContosoSqlPoolRestorePointCreationDate
$pool | Remove-AzSynapseSqlPoolRestorePoint -RestorePointCreationDate ContosoSqlPoolRestorePointCreationDate
```

This command deletes an Azure Synapse Analytics SQL pool restore point through pipeline.

### Example 3
```powershell
$points = Get-AzSynapseSqlPoolRestorePoint -WorkspaceName ContosoWorkspace -Name ContosoSqlPool
$points[index] | Remove-AzSynapseSqlPoolRestorePoint
$points[$index] | Remove-AzSynapseSqlPoolRestorePoint
```

This command deletes an Azure Synapse Analytics SQL pool restore point through pipeline.
Expand Down
6 changes: 3 additions & 3 deletions src/Synapse/Synapse/help/Set-AzSynapseLinkConnection.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ The **Set-AzSynapseLinkConnection** cmdlet creates or updates a link connections

### Example 1
```powershell
PS C:\> Set-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\linkconnection.json"
Set-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -DefinitionFile "C:\\samples\\linkconnection.json"
```

This command creates or updates a link connection from definition file linkconnection.json in the workspace named ContosoWorkspace.

### Example 2
```powershell
PS C:\> $ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
PS C:\> $ws | Set-AzSynapseLinkConnection -DefinitionFile "C:\\samples\\linkconnection.json"
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Set-AzSynapseLinkConnection -DefinitionFile "C:\\samples\\linkconnection.json"
```

This command creates or updates a link connection from definition file linkconnection.json in the workspace named ContosoWorkspace through pipeline.
Expand Down
Loading

0 comments on commit cca26bc

Please sign in to comment.