Skip to content

Commit 6225512

Browse files
adding markdowe help files
1 parent 7b3d2db commit 6225512

File tree

4 files changed

+584
-1
lines changed

4 files changed

+584
-1
lines changed

src/Sql/Sql/help/Az.Sql.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,10 @@ Converts a vulnerability assessment scan results to Excel format.
6666
Converts a vulnerability assessment scan results to Excel format.
6767

6868
### [Copy-AzSqlDatabaseLongTermRetentionBackup](Copy-AzSqlDatabaseLongTermRetentionBackup.md)
69-
Copies a long term retention backup to a target database.
69+
Copies a long term retention backup to a target database.
70+
71+
### [Disable-AzSqlDatabaseLedgerDigestUpload](Disable-AzSqlDatabaseLedgerDigestUpload.md)
72+
Disables uploading ledger digests to Azure Blob storage or to Azure Confidential Ledger.
7073

7174
### [Disable-AzSqlDatabaseSensitivityRecommendation](Disable-AzSqlDatabaseSensitivityRecommendation.md)
7275
Disables (dismisses) sensitivity recommendations on columns in the database.
@@ -86,6 +89,9 @@ Disables Azure AD only authentication for a specific SQL Server.
8689
### [Disable-AzSqlServerAdvancedDataSecurity](Disable-AzSqlServerAdvancedDataSecurity.md)
8790
Disables Advanced Data Security on a server.
8891

92+
### [Enable-AzSqlDatabaseLedgerDigestUpload](Enable-AzSqlDatabaseLedgerDigestUpload.md)
93+
Enables uploading ledger digests to an Azure Storage account or to Azure Confidential Ledger.
94+
8995
### [Enable-AzSqlDatabaseSensitivityRecommendation](Enable-AzSqlDatabaseSensitivityRecommendation.md)
9096
Enables sensitivity recommendations on columns (recommendations are enabled by default on all columns) in the database.
9197

@@ -104,6 +110,9 @@ Enables Azure AD only authentication for a specific SQL Server.
104110
### [Enable-AzSqlServerAdvancedDataSecurity](Enable-AzSqlServerAdvancedDataSecurity.md)
105111
Enables Advanced Data Security on a server.
106112

113+
### [Enable-AzSqlServerAdvancedThreatProtection](Enable-AzSqlServerAdvancedThreatProtection.md)
114+
Enables Advanced Threat Protection on a server.
115+
107116
### [Get-AzSqlCapability](Get-AzSqlCapability.md)
108117
Gets SQL Database capabilities for the current subscription.
109118

@@ -155,6 +164,9 @@ Gets the recommended index operations for a server or database.
155164
### [Get-AzSqlDatabaseInstanceFailoverGroup](Get-AzSqlDatabaseInstanceFailoverGroup.md)
156165
Gets or lists Instance Failover Groups.
157166

167+
### [Get-AzSqlDatabaseLedgerDigestUpload](Get-AzSqlDatabaseLedgerDigestUpload.md)
168+
Gets the ledger digest upload settings of an Azure SQL database.
169+
158170
### [Get-AzSqlDatabaseLongTermRetentionBackup](Get-AzSqlDatabaseLongTermRetentionBackup.md)
159171
Gets one or more long term retention backups.
160172

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
---
2+
external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml
3+
Module Name: Az.Sql
4+
online version: https://docs.microsoft.com/en-us/powershell/module/az.sql/Disable-AzSqlDatabaseLedgerDigestUpload
5+
schema: 2.0.0
6+
---
7+
8+
# Disable-AzSqlDatabaseLedgerDigestUpload
9+
10+
## SYNOPSIS
11+
Disables uploading ledger digests to Azure Blob storage or to Azure Confidential Ledger.
12+
13+
## SYNTAX
14+
15+
### DatabaseParameterSet
16+
```
17+
Disable-AzSqlDatabaseLedgerDigestUpload [-ResourceGroupName] <String> [-ServerName] <String>
18+
[-DatabaseName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
19+
```
20+
21+
### InputObjectParameterSet
22+
```
23+
Disable-AzSqlDatabaseLedgerDigestUpload -InputObject <AzureSqlDatabaseModel>
24+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
25+
```
26+
27+
### ResourceIdParameterSet
28+
```
29+
Disable-AzSqlDatabaseLedgerDigestUpload [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>]
30+
[-WhatIf] [-Confirm] [<CommonParameters>]
31+
```
32+
33+
## DESCRIPTION
34+
The Disable-AzSqlDatabaseLedgerDigestUpload cmdlet disables uploading ledger digests to Azure Blob storage or Azure Confidental Ledger. To use the cmdlet, identify the database.
35+
36+
## EXAMPLES
37+
38+
### Example 1
39+
```powershell
40+
PS C:\> Disable-AzSqlDatabaseLedgerDigestUpload -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01"
41+
```
42+
43+
ResourceGroupName ServerName DatabaseName State Endpoint
44+
----------------- ---------- ------------ ----- --------
45+
ResourceGroup01 Server01 Database01 Disabled
46+
47+
## PARAMETERS
48+
49+
### -DatabaseName
50+
SQL Database name.
51+
52+
```yaml
53+
Type: System.String
54+
Parameter Sets: DatabaseParameterSet
55+
Aliases:
56+
57+
Required: True
58+
Position: 2
59+
Default value: None
60+
Accept pipeline input: False
61+
Accept wildcard characters: False
62+
```
63+
64+
### -DefaultProfile
65+
The credentials, account, tenant, and subscription used for communication with Azure.
66+
67+
```yaml
68+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
69+
Parameter Sets: (All)
70+
Aliases: AzContext, AzureRmContext, AzureCredential
71+
72+
Required: False
73+
Position: Named
74+
Default value: None
75+
Accept pipeline input: False
76+
Accept wildcard characters: False
77+
```
78+
79+
### -InputObject
80+
The database object to disable digest uploads for.
81+
82+
```yaml
83+
Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel
84+
Parameter Sets: InputObjectParameterSet
85+
Aliases:
86+
87+
Required: True
88+
Position: Named
89+
Default value: None
90+
Accept pipeline input: True (ByValue)
91+
Accept wildcard characters: False
92+
```
93+
94+
### -ResourceGroupName
95+
The name of the resource group.
96+
97+
```yaml
98+
Type: System.String
99+
Parameter Sets: DatabaseParameterSet
100+
Aliases:
101+
102+
Required: True
103+
Position: 0
104+
Default value: None
105+
Accept pipeline input: False
106+
Accept wildcard characters: False
107+
```
108+
109+
### -ResourceId
110+
The resource id of the database to disable digest uploads for.
111+
112+
```yaml
113+
Type: System.String
114+
Parameter Sets: ResourceIdParameterSet
115+
Aliases:
116+
117+
Required: True
118+
Position: 0
119+
Default value: None
120+
Accept pipeline input: True (ByPropertyName)
121+
Accept wildcard characters: False
122+
```
123+
124+
### -ServerName
125+
SQL server name.
126+
127+
```yaml
128+
Type: System.String
129+
Parameter Sets: DatabaseParameterSet
130+
Aliases:
131+
132+
Required: True
133+
Position: 1
134+
Default value: None
135+
Accept pipeline input: False
136+
Accept wildcard characters: False
137+
```
138+
139+
### -Confirm
140+
Prompts you for confirmation before running the cmdlet.
141+
142+
```yaml
143+
Type: System.Management.Automation.SwitchParameter
144+
Parameter Sets: (All)
145+
Aliases: cf
146+
147+
Required: False
148+
Position: Named
149+
Default value: None
150+
Accept pipeline input: False
151+
Accept wildcard characters: False
152+
```
153+
154+
### -WhatIf
155+
Shows what would happen if the cmdlet runs.
156+
The cmdlet is not run.
157+
158+
```yaml
159+
Type: System.Management.Automation.SwitchParameter
160+
Parameter Sets: (All)
161+
Aliases: wi
162+
163+
Required: False
164+
Position: Named
165+
Default value: None
166+
Accept pipeline input: False
167+
Accept wildcard characters: False
168+
```
169+
170+
### CommonParameters
171+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
172+
173+
## INPUTS
174+
175+
### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel
176+
177+
### System.String
178+
179+
## OUTPUTS
180+
181+
### Microsoft.Azure.Commands.Sql.LedgerDigestUploads.Model.AzureSqlDatabaseLedgerDigestLocationModel
182+
183+
## NOTES
184+
185+
## RELATED LINKS

0 commit comments

Comments
 (0)