Skip to content

Commit 24dd3ac

Browse files
author
Dongwei Wang
committed
Update help doc
1 parent 10ce069 commit 24dd3ac

File tree

4 files changed

+26
-60
lines changed

4 files changed

+26
-60
lines changed

src/Synapse/Synapse/help/Get-AzSynapseSparkJobDefinition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.Synapse.dll-Help.xml
33
Module Name: Az.Synapse
4-
online version: https://docs.microsoft.com/powershell/module/az.synapse/get-azsynapsesparkjobdefinition
4+
online version: https://docs.microsoft.com/powershell/module/az.synapse/get-azsynapsesparkjobdefinition
55
schema: 2.0.0
66
---
77

src/Synapse/Synapse/help/New-AzSynapseSqlDatabase.md

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,15 @@ This feature is in a limited preview, initially accessible only to certain subsc
1515
### CreateByNameParameterSet (Default)
1616
```
1717
New-AzSynapseSqlDatabase [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String>
18-
[-Tag <Hashtable>] [-Collation <String>] [-MaxSizeInBytes <Int64>]
19-
[-StorageRedundancy <PSSqlDatabaseStorageRedundancyType>] [-AsJob] [-DefaultProfile <IAzureContextContainer>]
20-
[-WhatIf] [-Confirm] [<CommonParameters>]
18+
[-Tag <Hashtable>] [-Collation <String>] [-StorageRedundancy <PSSqlDatabaseStorageRedundancyType>] [-AsJob]
19+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2120
```
2221

2322
### CreateByParentObjectParameterSet
2423
```
2524
New-AzSynapseSqlDatabase -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-Tag <Hashtable>]
26-
[-Collation <String>] [-MaxSizeInBytes <Int64>] [-StorageRedundancy <PSSqlDatabaseStorageRedundancyType>]
27-
[-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
25+
[-Collation <String>] [-StorageRedundancy <PSSqlDatabaseStorageRedundancyType>] [-AsJob]
26+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2827
```
2928

3029
## DESCRIPTION
@@ -87,21 +86,6 @@ Accept pipeline input: False
8786
Accept wildcard characters: False
8887
```
8988
90-
### -MaxSizeInBytes
91-
Specifies the maximum size of the database in bytes.
92-
93-
```yaml
94-
Type: System.Int64
95-
Parameter Sets: (All)
96-
Aliases:
97-
98-
Required: False
99-
Position: Named
100-
Default value: None
101-
Accept pipeline input: False
102-
Accept wildcard characters: False
103-
```
104-
10589
### -Name
10690
Name of Synapse SQL Database.
10791

src/Synapse/Synapse/help/New-AzSynapseSqlPool.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,16 @@ Creates a Synapse Analytics SQL pool.
1616
```
1717
New-AzSynapseSqlPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-Version <Int32>]
1818
[-Tag <Hashtable>] -PerformanceLevel <String> [-Collation <String>] [-MaxServiceObjectName <String>]
19-
[-AutoPauseTimer <Int32>] [-AutoResume] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
19+
[-AutoPauseTimer <Int32>] [-EnableAutoResume] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
2020
[-Confirm] [<CommonParameters>]
2121
```
2222

2323
### CreateByParentObjectParameterSet
2424
```
2525
New-AzSynapseSqlPool -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-Version <Int32>] [-Tag <Hashtable>]
2626
-PerformanceLevel <String> [-Collation <String>] [-MaxServiceObjectName <String>] [-AutoPauseTimer <Int32>]
27-
[-AutoResume] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
27+
[-EnableAutoResume] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
28+
[<CommonParameters>]
2829
```
2930

3031
## DESCRIPTION
@@ -71,11 +72,12 @@ Accept pipeline input: False
7172
Accept wildcard characters: False
7273
```
7374
74-
### -AutoResume
75-
Indicates whether the sql pool can automatically resume when connection attempts are made.
75+
### -Collation
76+
Collation defines the rules that sort and compare data, and cannot be changed after SQL pool creation.
77+
The default collation is SQL_Latin1_General_CP1_CI_AS.
7678
7779
```yaml
78-
Type: System.Management.Automation.SwitchParameter
80+
Type: System.String
7981
Parameter Sets: (All)
8082
Aliases:
8183

@@ -86,14 +88,13 @@ Accept pipeline input: False
8688
Accept wildcard characters: False
8789
```
8890
89-
### -Collation
90-
Collation defines the rules that sort and compare data, and cannot be changed after SQL pool creation.
91-
The default collation is SQL_Latin1_General_CP1_CI_AS.
91+
### -DefaultProfile
92+
The credentials, account, tenant, and subscription used for communication with Azure.
9293
9394
```yaml
94-
Type: System.String
95+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
9596
Parameter Sets: (All)
96-
Aliases:
97+
Aliases: AzContext, AzureRmContext, AzureCredential
9798

9899
Required: False
99100
Position: Named
@@ -102,13 +103,13 @@ Accept pipeline input: False
102103
Accept wildcard characters: False
103104
```
104105
105-
### -DefaultProfile
106-
The credentials, account, tenant, and subscription used for communication with Azure.
106+
### -EnableAutoResume
107+
Indicates whether the sql pool can automatically resume when connection attempts are made.
107108
108109
```yaml
109-
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
110+
Type: System.Management.Automation.SwitchParameter
110111
Parameter Sets: (All)
111-
Aliases: AzContext, AzureRmContext, AzureCredential
112+
Aliases:
112113

113114
Required: False
114115
Position: Named

src/Synapse/Synapse/help/Update-AzSynapseSqlDatabase.md

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -15,30 +15,27 @@ This feature is in a limited preview, initially accessible only to certain subsc
1515
### UpdateByNameParameterSet (Default)
1616
```
1717
Update-AzSynapseSqlDatabase [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String>
18-
[-MaxSizeInBytes <Int64>] [-StorageRedundancy <PSSqlDatabaseStorageRedundancyType>] [-Tag <Hashtable>]
19-
[-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
18+
[-MaxSizeInBytes <Int64>] [-Tag <Hashtable>] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>]
19+
[-WhatIf] [-Confirm] [<CommonParameters>]
2020
```
2121

2222
### UpdateByParentObjectParameterSet
2323
```
24-
Update-AzSynapseSqlDatabase -Name <String> [-MaxSizeInBytes <Int64>]
25-
[-StorageRedundancy <PSSqlDatabaseStorageRedundancyType>] -WorkspaceObject <PSSynapseWorkspace>
24+
Update-AzSynapseSqlDatabase -Name <String> [-MaxSizeInBytes <Int64>] -WorkspaceObject <PSSynapseWorkspace>
2625
[-Tag <Hashtable>] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
2726
[<CommonParameters>]
2827
```
2928

3029
### UpdateByInputObjectParameterSet
3130
```
32-
Update-AzSynapseSqlDatabase [-StorageRedundancy <PSSqlDatabaseStorageRedundancyType>]
33-
-InputObject <PSSynapseSqlDatabase> [-Tag <Hashtable>] [-PassThru] [-AsJob]
31+
Update-AzSynapseSqlDatabase -InputObject <PSSynapseSqlDatabase> [-Tag <Hashtable>] [-PassThru] [-AsJob]
3432
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
3533
```
3634

3735
### UpdateByResourceIdParameterSet
3836
```
39-
Update-AzSynapseSqlDatabase [-StorageRedundancy <PSSqlDatabaseStorageRedundancyType>] -ResourceId <String>
40-
[-Tag <Hashtable>] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
41-
[<CommonParameters>]
37+
Update-AzSynapseSqlDatabase -ResourceId <String> [-Tag <Hashtable>] [-PassThru] [-AsJob]
38+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
4239
```
4340

4441
## DESCRIPTION
@@ -176,22 +173,6 @@ Accept pipeline input: False
176173
Accept wildcard characters: False
177174
```
178175
179-
### -StorageRedundancy
180-
Storage redundancy of the database.
181-
182-
```yaml
183-
Type: Microsoft.Azure.Commands.Synapse.Models.PSSqlDatabaseStorageRedundancyType
184-
Parameter Sets: (All)
185-
Aliases:
186-
Accepted values: Geo, GeoZone, Local, Zone
187-
188-
Required: False
189-
Position: Named
190-
Default value: None
191-
Accept pipeline input: False
192-
Accept wildcard characters: False
193-
```
194-
195176
### -Tag
196177
A string,string dictionary of tags associated with the resource.
197178

0 commit comments

Comments
 (0)