From cca26bcc1b23916c4ca06ef7a207fc388c31db80 Mon Sep 17 00:00:00 2001 From: v-yuzhichen <96757176+v-yuzhichen@users.noreply.github.com> Date: Fri, 1 Jul 2022 14:33:02 +0800 Subject: [PATCH] format the help markdown files of Az.Synapse (#18750) * format the help markdown files of Az.Synapse * format the help markdown files of Az.Synapse Co-authored-by: Ziyue Zheng --- ...ynapseActiveDirectoryOnlyAuthentication.md | 20 +-- ...ynapseActiveDirectoryOnlyAuthentication.md | 20 +-- ...ynapseActiveDirectoryOnlyAuthentication.md | 20 +-- .../help/Get-AzSynapseLinkConnection.md | 8 +- ...t-AzSynapseLinkConnectionDetailedStatus.md | 14 +- .../Get-AzSynapseLinkConnectionLinkTable.md | 2 +- ...-AzSynapseLinkConnectionLinkTableStatus.md | 8 +- .../help/Invoke-AzSynapseSparkStatement.md | 10 +- .../New-AzSynapseKustoPoolDataConnection.md | 12 +- .../help/Remove-AzSynapseLinkConnection.md | 10 +- .../Remove-AzSynapseSqlPoolRestorePoint.md | 6 +- .../help/Set-AzSynapseLinkConnection.md | 6 +- .../Set-AzSynapseLinkConnectionLinkTable.md | 8 +- .../help/Start-AzSynapseLinkConnection.md | 38 +++--- ...napseSqlPoolVulnerabilityAssessmentScan.md | 124 +++++++++--------- .../help/Stop-AzSynapseLinkConnection.md | 37 +++--- ...apseLinkConnectionLandingZoneCredential.md | 2 +- ...seSqlPoolVulnerabilityAssessmentSetting.md | 6 +- 18 files changed, 176 insertions(+), 175 deletions(-) diff --git a/src/Synapse/Synapse/help/Disable-AzSynapseActiveDirectoryOnlyAuthentication.md b/src/Synapse/Synapse/help/Disable-AzSynapseActiveDirectoryOnlyAuthentication.md index f6f3a5db38bb..f2fadf8e6e2f 100644 --- a/src/Synapse/Synapse/help/Disable-AzSynapseActiveDirectoryOnlyAuthentication.md +++ b/src/Synapse/Synapse/help/Disable-AzSynapseActiveDirectoryOnlyAuthentication.md @@ -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 diff --git a/src/Synapse/Synapse/help/Enable-AzSynapseActiveDirectoryOnlyAuthentication.md b/src/Synapse/Synapse/help/Enable-AzSynapseActiveDirectoryOnlyAuthentication.md index 60628abe2d16..bb19967fea16 100644 --- a/src/Synapse/Synapse/help/Enable-AzSynapseActiveDirectoryOnlyAuthentication.md +++ b/src/Synapse/Synapse/help/Enable-AzSynapseActiveDirectoryOnlyAuthentication.md @@ -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 diff --git a/src/Synapse/Synapse/help/Get-AzSynapseActiveDirectoryOnlyAuthentication.md b/src/Synapse/Synapse/help/Get-AzSynapseActiveDirectoryOnlyAuthentication.md index 1137a9b29fb4..11539b83e443 100644 --- a/src/Synapse/Synapse/help/Get-AzSynapseActiveDirectoryOnlyAuthentication.md +++ b/src/Synapse/Synapse/help/Get-AzSynapseActiveDirectoryOnlyAuthentication.md @@ -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 diff --git a/src/Synapse/Synapse/help/Get-AzSynapseLinkConnection.md b/src/Synapse/Synapse/help/Get-AzSynapseLinkConnection.md index 07803d01caa4..348f9df20996 100644 --- a/src/Synapse/Synapse/help/Get-AzSynapseLinkConnection.md +++ b/src/Synapse/Synapse/help/Get-AzSynapseLinkConnection.md @@ -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. diff --git a/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionDetailedStatus.md b/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionDetailedStatus.md index 64247e7b9f7f..314c630e75cf 100644 --- a/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionDetailedStatus.md +++ b/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionDetailedStatus.md @@ -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. diff --git a/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionLinkTable.md b/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionLinkTable.md index 3ce1538fca28..1c3cd80d7418 100644 --- a/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionLinkTable.md +++ b/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionLinkTable.md @@ -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 ``` diff --git a/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionLinkTableStatus.md b/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionLinkTableStatus.md index 2a0ab31eaeba..c175868c1edb 100644 --- a/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionLinkTableStatus.md +++ b/src/Synapse/Synapse/help/Get-AzSynapseLinkConnectionLinkTableStatus.md @@ -39,7 +39,7 @@ 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. @@ -47,15 +47,15 @@ This command gets status of link tables with max segment count 50 under link con ### 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. diff --git a/src/Synapse/Synapse/help/Invoke-AzSynapseSparkStatement.md b/src/Synapse/Synapse/help/Invoke-AzSynapseSparkStatement.md index c7099cff4871..04692ea66747 100644 --- a/src/Synapse/Synapse/help/Invoke-AzSynapseSparkStatement.md +++ b/src/Synapse/Synapse/help/Invoke-AzSynapseSparkStatement.md @@ -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. @@ -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. diff --git a/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDataConnection.md b/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDataConnection.md index a398ea931c20..7131bd42833f 100644 --- a/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDataConnection.md +++ b/src/Synapse/Synapse/help/New-AzSynapseKustoPoolDataConnection.md @@ -73,8 +73,8 @@ New-AzSynapseKustoPoolDataConnection -ResourceGroupName testrg -WorkspaceName te ``` ```output -Kind Location Name ----- -------- ---- +Kind Location Name +---- -------- ---- EventHub East US 2 testws/testkustopool/testdatabase/eventhubdc ``` @@ -82,12 +82,12 @@ The above command creates a new EventHub data connection named "eventhubdc" for ### 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 ``` @@ -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 ``` diff --git a/src/Synapse/Synapse/help/Remove-AzSynapseLinkConnection.md b/src/Synapse/Synapse/help/Remove-AzSynapseLinkConnection.md index fd8d8ad84dd3..2e07b5b33c7d 100644 --- a/src/Synapse/Synapse/help/Remove-AzSynapseLinkConnection.md +++ b/src/Synapse/Synapse/help/Remove-AzSynapseLinkConnection.md @@ -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. diff --git a/src/Synapse/Synapse/help/Remove-AzSynapseSqlPoolRestorePoint.md b/src/Synapse/Synapse/help/Remove-AzSynapseSqlPoolRestorePoint.md index 271aaa6cc0cc..9e345c2aa734 100644 --- a/src/Synapse/Synapse/help/Remove-AzSynapseSqlPoolRestorePoint.md +++ b/src/Synapse/Synapse/help/Remove-AzSynapseSqlPoolRestorePoint.md @@ -45,7 +45,7 @@ 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. @@ -53,7 +53,7 @@ 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. @@ -61,7 +61,7 @@ This command deletes an Azure Synapse Analytics SQL pool restore point through p ### 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. diff --git a/src/Synapse/Synapse/help/Set-AzSynapseLinkConnection.md b/src/Synapse/Synapse/help/Set-AzSynapseLinkConnection.md index eb6a2fac7a99..4c1dde8c148a 100644 --- a/src/Synapse/Synapse/help/Set-AzSynapseLinkConnection.md +++ b/src/Synapse/Synapse/help/Set-AzSynapseLinkConnection.md @@ -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. diff --git a/src/Synapse/Synapse/help/Set-AzSynapseLinkConnectionLinkTable.md b/src/Synapse/Synapse/help/Set-AzSynapseLinkConnectionLinkTable.md index 1dae37d1288f..3f253360f64c 100644 --- a/src/Synapse/Synapse/help/Set-AzSynapseLinkConnectionLinkTable.md +++ b/src/Synapse/Synapse/help/Set-AzSynapseLinkConnectionLinkTable.md @@ -39,7 +39,7 @@ The **Set-AzSynapseLinkConnectionLinkTables** cmdlet edits link tables under a l ### Example 1 ```powershell -Set-AzSynapseLinkConnectionLinkTables -WorkspaceName ContosoWorkspace -LinkConnectionName ContosoLinkConnection -EditTablesRequestFile "C:\\samples\\edittables.json" +Set-AzSynapseLinkConnectionLinkTable -WorkspaceName ContosoWorkspace -LinkConnectionName ContosoLinkConnection -EditTablesRequestFile "C:\\samples\\edittables.json" ``` This command edits link tables under link connection ContosoLinkConnection in workspace ContosoWorkspace. @@ -49,7 +49,7 @@ This file includes information about edited link table. ### Example 2 ```powershell $ws = Get-AzSynapseWorkspace -Name ContosoWorkspace -$ws | Set-AzSynapseLinkConnectionLinkTables -LinkConnectionName ContosoLinkConnection -EditTablesRequestFile "C:\\samples\\edittables.json" +$ws | Set-AzSynapseLinkConnectionLinkTable -LinkConnectionName ContosoLinkConnection -EditTablesRequestFile "C:\\samples\\edittables.json" ``` This command edits link tables under link connection ContosoLinkConnection in workspace ContosoWorkspace through pipeline. @@ -58,8 +58,8 @@ This file includes information about edited link table. ### Example 3 ```powershell -$lc = Get-AzSynpaseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection -$lc | Set-AzSynapseLinkConnectionLinkTables -EditTablesRequestFile "C:\\samples\\edittables.json" +$lc = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +$lc | Set-AzSynapseLinkConnectionLinkTable -EditTablesRequestFile "C:\\samples\\edittables.json" ``` This command edits link tables under a link connection through pipeline. diff --git a/src/Synapse/Synapse/help/Start-AzSynapseLinkConnection.md b/src/Synapse/Synapse/help/Start-AzSynapseLinkConnection.md index f171f5a183a4..b5ec2e2708b8 100644 --- a/src/Synapse/Synapse/help/Start-AzSynapseLinkConnection.md +++ b/src/Synapse/Synapse/help/Start-AzSynapseLinkConnection.md @@ -37,46 +37,50 @@ The **Start-AzSynapseLinkConnection** cmdlet starts a link connection in workspa ### Example 1 ```powershell -PS C:\> Start-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +Start-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection ``` This command starts a link connection named ContosoLinkConnection in workspace. ### Example 2 ```powershell -PS C:\> $ws = Get-AzSynapseWorkspace -Workspacename ContosoWorkspace -PS C:\> $ws | Start-AzSynapseLinkConnection -Name ContosoLinkConnection +$ws = Get-AzSynapseWorkspace -Workspacename ContosoWorkspace +$ws | Start-AzSynapseLinkConnection -Name ContosoLinkConnection ``` This command starts a link connection named ContosoLinkConnection in workspace through pipeline. ### Example 3 ```powershell -PS C:\> $linkConnection = Get-AzSynapseLinkConnection -Workspacename ContosoWorkspace -Name ContosoLinkConnection -PS C:\> $linkConnection | Start-AzSynapseLinkConnection +$linkConnection = Get-AzSynapseLinkConnection -Workspacename ContosoWorkspace -Name ContosoLinkConnection +$linkConnection | Start-AzSynapseLinkConnection ``` This command starts a link connection named ContosoLinkConnection in workspace through pipeline. ### Example 4 ```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 +``` - WorkspaceName : ContosoWorkspace - Id : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - Name : ContosoLinkConnection - IsApplyingChanges : - IsPartiallyFailed : False - StartTime : 2022-03-10T07:57:37.8730044Z - StopTime : - Status : Starting - ContinuousRunId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - Error : +```output +WorkspaceName : ContosoWorkspace +Id : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Name : ContosoLinkConnection +IsApplyingChanges : +IsPartiallyFailed : False +StartTime : 2022-03-10T07:57:37.8730044Z +StopTime : +Status : Starting +ContinuousRunId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Error : ``` The **Start-AzSynapseLinkConnection** command starts a link connection named ContosoLinkConnection in workspace, then you can call **Get-AzSynapseLinkConnectionDetailedStatus** to get status of the link connection. +## PARAMETERS + ### -AsJob Run cmdlet in the background diff --git a/src/Synapse/Synapse/help/Start-AzSynapseSqlPoolVulnerabilityAssessmentScan.md b/src/Synapse/Synapse/help/Start-AzSynapseSqlPoolVulnerabilityAssessmentScan.md index ac8ce5e95458..72a3a84db8c3 100644 --- a/src/Synapse/Synapse/help/Start-AzSynapseSqlPoolVulnerabilityAssessmentScan.md +++ b/src/Synapse/Synapse/help/Start-AzSynapseSqlPoolVulnerabilityAssessmentScan.md @@ -43,16 +43,16 @@ Start-AzSynapseSqlPoolVulnerabilityAssessmentScan ` ``` ```output -ResourceGroupName : ResourceGroup01 -WorkspaceName : WorkspaceName01 -Name : Name01 -ScanId : myScan -TriggerType : OnDemand -State : Fail -StartTime : 6/11/2018 1:57:27 PM -EndTime : 6/11/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name01 +ScanId : myScan +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Error : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment scans/WorkspaceName01/Name01/scan_myScan.json NumberOfFailedSecurityChecks : 9 ``` @@ -62,20 +62,20 @@ NumberOfFailedSecurityChecks : 9 Start-AzSynapseSqlPoolVulnerabilityAssessmentScan ` -ResourceGroupName "ResourceGroup01" ` -WorkspaceName "WorkspaceName01" ` - -Name "Name01" ` + -Name "Name01" ``` -```output -ResourceGroupName : ResourceGroup01 -WorkspaceName : WorkspaceName01 -Name : Name01 -ScanId : 20180611_135726 -TriggerType : OnDemand -State : Fail -StartTime : 6/11/2018 1:57:27 PM -EndTime : 6/11/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment +```output +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name01 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment scans/WorkspaceName01/Name01/scan_myScan.json NumberOfFailedSecurityChecks : 9 ``` @@ -95,16 +95,16 @@ $scanJob | Receive-Job ``` ```output -ResourceGroupName : ResourceGroup01 -WorkspaceName : WorkspaceName01 -Name : Name01 -ScanId : myScan -TriggerType : OnDemand -State : Fail -StartTime : 6/11/2018 1:57:27 PM -EndTime : 6/11/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name01 +ScanId : myScan +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment scans/WorkspaceName01/Name01/scan_myScan.json NumberOfFailedSecurityChecks : 9 ``` @@ -119,16 +119,16 @@ Get-AzSynapseSqlPool ` ``` ```output -ResourceGroupName : ResourceGroup01 -WorkspaceName : WorkspaceName01 -Name : Name01 -ScanId : 20180611_135726 -TriggerType : OnDemand -State : Fail -StartTime : 6/11/2018 1:57:27 PM -EndTime : 6/11/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name01 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment scans/WorkspaceName01/Name01/scan_myScan.json NumberOfFailedSecurityChecks : 9 ``` @@ -143,30 +143,30 @@ Get-AzSynapseSqlPool ` ``` ```output -ResourceGroupName : ResourceGroup01 -WorkspaceName : WorkspaceName01 -Name : Name01 -ScanId : 20180611_135726 -TriggerType : OnDemand -State : Fail -StartTime : 6/11/2018 1:57:27 PM -EndTime : 6/11/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name01 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment scans/WorkspaceName01/Name01/scan_myScan.json NumberOfFailedSecurityChecks : 9 -ResourceGroupName : ResourceGroup01 -WorkspaceName : WorkspaceName01 -Name : Name02 -ScanId : 20180611_135726 -TriggerType : OnDemand -State : Fail -StartTime : 6/11/2018 1:57:27 PM -EndTime : 6/11/2018 1:57:31 PM -Errors : {} -ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment +ResourceGroupName : ResourceGroup01 +WorkspaceName : WorkspaceName01 +Name : Name02 +ScanId : 20180611_135726 +TriggerType : OnDemand +State : Fail +StartTime : 6/11/2018 1:57:27 PM +EndTime : 6/11/2018 1:57:31 PM +Errors : {} +ScanResultsLocationPath : https://myaccount.blob.core.windows.net/vulnerability-assessment scans/WorkspaceName01/Name02/scan_myScan.json NumberOfFailedSecurityChecks : 9 ``` diff --git a/src/Synapse/Synapse/help/Stop-AzSynapseLinkConnection.md b/src/Synapse/Synapse/help/Stop-AzSynapseLinkConnection.md index 42bc5c04e3a5..a170c8e727b4 100644 --- a/src/Synapse/Synapse/help/Stop-AzSynapseLinkConnection.md +++ b/src/Synapse/Synapse/help/Stop-AzSynapseLinkConnection.md @@ -37,42 +37,43 @@ The **Stop-AzSynapseLinkConnection** cmdlet stops a link connection in workspace ### Example 1 ```powershell -PS C:\> Stop-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +Stop-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection ``` This command stops a link connection named ContosoLinkConnection in workspace. ### Example 2 ```powershell -PS C:\> $ws = Get-AzSynapseWorkspace -Workspacename ContosoWorkspace -PS C:\> $ws | Stop-AzSynapseLinkConnection -Name ContosoLinkConnection +$ws = Get-AzSynapseWorkspace -Workspacename ContosoWorkspace +$ws | Stop-AzSynapseLinkConnection -Name ContosoLinkConnection ``` This command stops a link connection named ContosoLinkConnection in workspace through pipeline. ### Example 3 ```powershell -PS C:\> $linkConnection = Get-AzSynapseLinkConnection -Workspacename ContosoWorkspace -Name ContosoLinkConnection -PS C:\> $linkConnection | Stop-AzSynapseLinkConnection +$linkConnection = Get-AzSynapseLinkConnection -Workspacename ContosoWorkspace -Name ContosoLinkConnection +$linkConnection | Stop-AzSynapseLinkConnection ``` This command stops a link connection named ContosoLinkConnection in workspace through pipeline. ### Example 4 ```powershell -PS C:\> Stop-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection -PS C:\> Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection - - WorkspaceName : ContosoWorkspace - Id : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - Name : ContosoLinkConnection - IsApplyingChanges : - IsPartiallyFailed : False - StartTime : 2022-03-10T06:59:34.5820499Z - StopTime : 2022-03-10T07:21:42.4895248Z - Status : Stopping - ContinuousRunId : - Error : +Stop-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +Get-AzSynapseLinkConnectionDetailedStatus -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +``` +```output +WorkspaceName : ContosoWorkspace +Id : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx +Name : ContosoLinkConnection +IsApplyingChanges : +IsPartiallyFailed : False +StartTime : 2022-03-10T06:59:34.5820499Z +StopTime : 2022-03-10T07:21:42.4895248Z +Status : Stopping +ContinuousRunId : +Error : ``` This command stops a link connection named ContosoLinkConnection in workspace, then you can call **Get-AzSynapseLinkConnectionDetailedStatus** to get status of the link connection. diff --git a/src/Synapse/Synapse/help/Update-AzSynapseLinkConnectionLandingZoneCredential.md b/src/Synapse/Synapse/help/Update-AzSynapseLinkConnectionLandingZoneCredential.md index 18538d82adb1..0eff272183d3 100644 --- a/src/Synapse/Synapse/help/Update-AzSynapseLinkConnectionLandingZoneCredential.md +++ b/src/Synapse/Synapse/help/Update-AzSynapseLinkConnectionLandingZoneCredential.md @@ -53,7 +53,7 @@ This command updates the landing zone credential with sas token "exampleSasToken ### Example 3 ```powershell -$lc = Get-AzSynpaseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection +$lc = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection $lc | Update-AzSynapseLinkConnectionLandingZoneCredential -SasToken "SampleSasToken" ``` diff --git a/src/Synapse/Synapse/help/Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md b/src/Synapse/Synapse/help/Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md index 76ddece575b4..b355bb838ab9 100644 --- a/src/Synapse/Synapse/help/Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md +++ b/src/Synapse/Synapse/help/Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting.md @@ -84,7 +84,7 @@ Note that you need to run *Enable-AzSynapseSqlAdvancedDataSecurity* cmdlet as a ```powershell Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -StorageAccountName "mystorage" ` -ScanResultsContainerName "vulnerability-assessment" -RecurringScansInterval Weekly -EmailAdmin $true ` - -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") + -NotificationEmail @("mail1@mail.com","mail2@mail.com") ``` This command updates Vulnerability Assessment settings with storage account name. @@ -93,8 +93,8 @@ This command updates Vulnerability Assessment settings with storage account name ```powershell Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting -WorkspaceName ContosoWorkspace -Name ContosoSqlPool ` -BlobStorageSasUri "https://mystorage.blob.core.windows.net/vulnerability-assessment?st=XXXXXX" ` - -ScanResultsContainerName "vulnerability-assessment" -RecurringScansInterval Weekly -EmailAdmin $true ` - -NotificationEmail @("mail1@mail.com" , "mail2@mail.com") + -RecurringScansInterval Weekly -EmailAdmin $true ` + -NotificationEmail @("mail1@mail.com","mail2@mail.com") ``` This command updates Vulnerability Assessment settings with blob storage SAS URI.