Skip to content

Commit 128ebfa

Browse files
potatoqualiteegithub-actions[bot]
authored andcommitted
refreshing docs pages
1 parent 3b822a5 commit 128ebfa

13 files changed

+927
-809
lines changed

Backup-DbaDatabase.html

Lines changed: 69 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -508,8 +508,9 @@ <h2 id="syntax">Syntax</h2>
508508
[-MaxTransferSize &lt;Int32&gt;]
509509
[-BlockSize &lt;Int32&gt;]
510510
[-BufferCount &lt;Int32&gt;]
511-
[-AzureBaseUrl &lt;String[]&gt;]
512-
[-AzureCredential &lt;String&gt;]
511+
[-StorageBaseUrl &lt;String[]&gt;]
512+
[-StorageCredential &lt;String&gt;]
513+
[-StorageRegion &lt;String&gt;]
513514
[-NoRecovery]
514515
[-BuildPath]
515516
[-WithFormat]
@@ -545,8 +546,9 @@ <h2 id="syntax">Syntax</h2>
545546
[-MaxTransferSize &lt;Int32&gt;]
546547
[-BlockSize &lt;Int32&gt;]
547548
[-BufferCount &lt;Int32&gt;]
548-
[-AzureBaseUrl &lt;String[]&gt;]
549-
[-AzureCredential &lt;String&gt;]
549+
[-StorageBaseUrl &lt;String[]&gt;]
550+
[-StorageCredential &lt;String&gt;]
551+
[-StorageRegion &lt;String&gt;]
550552
[-NoRecovery]
551553
[-BuildPath]
552554
[-WithFormat]
@@ -583,8 +585,9 @@ <h2 id="syntax">Syntax</h2>
583585
[-MaxTransferSize &lt;Int32&gt;]
584586
[-BlockSize &lt;Int32&gt;]
585587
[-BufferCount &lt;Int32&gt;]
586-
[-AzureBaseUrl &lt;String[]&gt;]
587-
[-AzureCredential &lt;String&gt;]
588+
[-StorageBaseUrl &lt;String[]&gt;]
589+
[-StorageCredential &lt;String&gt;]
590+
[-StorageRegion &lt;String&gt;]
588591
[-NoRecovery]
589592
[-BuildPath]
590593
[-WithFormat]
@@ -614,7 +617,7 @@ <h5 id="example-2">Example: 2</h5>
614617
</code></pre>
615618
<p>Backs up AdventureWorks2014 to sql2016 C:\temp folder.<br></p>
616619
<h5 id="example-3">Example: 3</h5>
617-
<pre><code>PS C:\&gt; Backup-DbaDatabase -SqlInstance sql2016 -AzureBaseUrl https://dbatoolsaz.blob.core.windows.net/azbackups/ -AzureCredential dbatoolscred -Type Full -CreateFolder
620+
<pre><code>PS C:\&gt; Backup-DbaDatabase -SqlInstance sql2016 -StorageBaseUrl https://dbatoolsaz.blob.core.windows.net/azbackups/ -StorageCredential dbatoolscred -Type Full -CreateFolder
618621
</code></pre>
619622
<p>Performs a full backup of all databases on the sql2016 instance to their own containers under the <a href="https://dbatoolsaz.blob.core.windows.net/azbackups/">https://dbatoolsaz.blob.core.windows.net/azbackups/</a> container on Azure blob storage using the sql <br>
620623
credential &quot;dbatoolscred&quot; registered on the sql2016 instance.<br></p>
@@ -644,6 +647,19 @@ <h5 id="example-9">Example: 9</h5>
644647
<pre><code>PS C:\&gt; Backup-DbaDatabase -SqlInstance Sql2017 -Database master -EncryptionAlgorithm AES256 -EncryptionCertificate BackupCert
645648
</code></pre>
646649
<p>Backs up the master database using the BackupCert certificate and the AES256 algorithm.<br></p>
650+
<h5 id="example-10">Example: 10</h5>
651+
<pre><code>PS C:\&gt; Backup-DbaDatabase -SqlInstance sql2022 -Database AdventureWorks -StorageBaseUrl &quot;s3://mybucket.s3.us-west-2.amazonaws.com/backups&quot; -Type Full -CompressBackup
652+
</code></pre>
653+
<p>Performs a full compressed backup of the AdventureWorks database to an S3-compatible storage bucket. Requires SQL Server 2022 or later and a credential matching the S3 URL created with <br>
654+
New-DbaCredential using Identity 'S3 Access Key'.<br></p>
655+
<h5 id="example-11">Example: 11</h5>
656+
<pre><code>PS C:\&gt; Backup-DbaDatabase -SqlInstance sql2022 -Database AdventureWorks -S3BaseUrl &quot;s3://minio.local:9000/sqlbackups&quot; -Type Full
657+
</code></pre>
658+
<p>Performs a full backup to a MinIO S3-compatible storage server using the S3BaseUrl alias. The credential must be created to match the S3 URL path.<br></p>
659+
<h5 id="example-12">Example: 12</h5>
660+
<pre><code>PS C:\&gt; Backup-DbaDatabase -SqlInstance sql2022 -Database AdventureWorks -StorageBaseUrl &quot;s3://mybucket.s3.amazonaws.com/backups&quot; -StorageRegion &quot;us-west-2&quot; -MaxTransferSize 10485760 -Type Full
661+
</code></pre>
662+
<p>Performs a full backup to S3 with explicit region specification and a 10MB transfer size. The StorageRegion parameter adds BACKUP_OPTIONS to the backup command for cross-region scenarios.<br></p>
647663
<h3 id="required-parameters">Required Parameters</h3>
648664
<h5 id="sqlinstance">-SqlInstance</h5>
649665
<p>The SQL Server instance hosting the databases to be backed up. <br></p>
@@ -1160,7 +1176,9 @@ <h5 id="verify">-Verify</h5>
11601176
</tbody>
11611177
</table>
11621178
<h5 id="maxtransfersize">-MaxTransferSize</h5>
1163-
<p>Controls the size of each data transfer unit during backup operations. Must be a multiple of 64KB with 4MB maximum.<br />
1179+
<p>Controls the size of each data transfer unit during backup operations. Must be a multiple of 64KB.<br />
1180+
For disk and Azure backups: Maximum value is 4MB.<br />
1181+
For S3 backups: Value must be between 5MB and 20MB (required for S3-compatible storage).<br />
11641182
Larger values can improve performance for fast storage but may cause memory pressure.<br />
11651183
Automatically set to 128KB for TDE-encrypted databases with compression to avoid conflicts.<br></p>
11661184
<table>
@@ -1192,7 +1210,7 @@ <h5 id="maxtransfersize">-MaxTransferSize</h5>
11921210
<h5 id="blocksize">-BlockSize</h5>
11931211
<p>Sets the physical block size for backup devices. Must be 0.5KB, 1KB, 2KB, 4KB, 8KB, 16KB, 32KB, or 64KB.<br />
11941212
Affects backup file structure and restore performance. Larger blocks may improve performance for fast storage.<br />
1195-
Cannot be used with Azure page blob backups (when AzureCredential is specified).<br></p>
1213+
Cannot be used with Azure page blob backups (when StorageCredential is specified).<br></p>
11961214
<table>
11971215
<thead>
11981216
<tr>
@@ -1249,11 +1267,11 @@ <h5 id="buffercount">-BufferCount</h5>
12491267
</tr>
12501268
</tbody>
12511269
</table>
1252-
<h5 id="azurebaseurl">-AzureBaseUrl</h5>
1253-
<p>Specifies Azure blob storage container URLs for cloud backup destinations.<br />
1254-
Single URL required for page blobs (with AzureCredential), multiple URLs supported for block blobs with SAS.<br />
1255-
Requires corresponding SQL Server credentials for authentication. Limits other parameter usage to core backup options.<br />
1256-
Essential for backing up to Azure storage for cloud-native or hybrid SQL Server deployments.<br></p>
1270+
<h5 id="storagebaseurl">-StorageBaseUrl</h5>
1271+
<p>Specifies cloud storage URLs for backup destinations, supporting Azure Blob Storage and S3-compatible object storage.<br />
1272+
For Azure: Use https:// URLs like 'https://account.blob.core.windows.net/container'. Single URL required for page blobs (with StorageCredential), multiple URLs supported for block blobs with SAS.<br />
1273+
For S3: Use s3:// URLs like 's3://bucket.s3.region.amazonaws.com/folder'. Requires SQL Server 2022 or later. Supports AWS S3, MinIO, and other S3-compatible providers.<br />
1274+
Requires corresponding SQL Server credentials for authentication. Essential for backing up to cloud storage for cloud-native or hybrid SQL Server deployments.<br></p>
12571275
<table>
12581276
<thead>
12591277
<tr>
@@ -1264,7 +1282,7 @@ <h5 id="azurebaseurl">-AzureBaseUrl</h5>
12641282
<tbody>
12651283
<tr>
12661284
<td>Alias</td>
1267-
<td></td>
1285+
<td>AzureBaseUrl,S3BaseUrl</td>
12681286
</tr>
12691287
<tr>
12701288
<td>Required</td>
@@ -1280,10 +1298,11 @@ <h5 id="azurebaseurl">-AzureBaseUrl</h5>
12801298
</tr>
12811299
</tbody>
12821300
</table>
1283-
<h5 id="azurecredential">-AzureCredential</h5>
1284-
<p>Specifies the SQL Server credential name for Azure storage access key authentication.<br />
1285-
Creates page blob backups with automatic single-file restriction and ignores BlockSize/MaxTransferSize.<br />
1286-
For SAS authentication, use credentials named to match the AzureBaseUrl. Required for Azure storage access key scenarios.<br></p>
1301+
<h5 id="storagecredential">-StorageCredential</h5>
1302+
<p>Specifies the SQL Server credential name for cloud storage authentication.<br />
1303+
For Azure: The credential for storage access key authentication. Creates page blob backups with automatic single-file restriction and ignores BlockSize/MaxTransferSize.<br />
1304+
For S3: The credential containing the S3 Access Key ID and Secret Key ID. The credential name should match the S3 URL path.<br />
1305+
For SAS authentication, use credentials named to match the StorageBaseUrl.<br></p>
12871306
<table>
12881307
<thead>
12891308
<tr>
@@ -1294,8 +1313,39 @@ <h5 id="azurecredential">-AzureCredential</h5>
12941313
<tbody>
12951314
<tr>
12961315
<td>Alias</td>
1316+
<td>AzureCredential,S3Credential</td>
1317+
</tr>
1318+
<tr>
1319+
<td>Required</td>
1320+
<td>False</td>
1321+
</tr>
1322+
<tr>
1323+
<td>Pipeline</td>
1324+
<td>false</td>
1325+
</tr>
1326+
<tr>
1327+
<td>Default Value</td>
12971328
<td></td>
12981329
</tr>
1330+
</tbody>
1331+
</table>
1332+
<h5 id="storageregion">-StorageRegion</h5>
1333+
<p>Specifies the AWS region for S3 backups using the BACKUP_OPTIONS JSON parameter. Only applies to S3-compatible storage.<br />
1334+
Use this when your S3 bucket is in a specific region that differs from the default, or when required by your S3-compatible provider.<br />
1335+
Example regions: us-east-1, us-west-2, eu-west-1, ap-southeast-1.<br />
1336+
When specified, adds BACKUP_OPTIONS = '{&quot;s3&quot;: {&quot;region&quot;:&quot;<region>&quot;}}' to the backup command.<br></p>
1337+
<table>
1338+
<thead>
1339+
<tr>
1340+
<th></th>
1341+
<th></th>
1342+
</tr>
1343+
</thead>
1344+
<tbody>
1345+
<tr>
1346+
<td>Alias</td>
1347+
<td>S3Region</td>
1348+
</tr>
12991349
<tr>
13001350
<td>Required</td>
13011351
<td>False</td>

Copy-DbaCredential.html

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -503,6 +503,7 @@ <h2 id="syntax">Syntax</h2>
503503
[[-ExcludeName] &lt;String[]&gt;]
504504
[[-Identity] &lt;String[]&gt;]
505505
[[-ExcludeIdentity] &lt;String[]&gt;]
506+
[-ExcludePassword]
506507
[-Force]
507508
[-EnableException]
508509
[-WhatIf]
@@ -786,6 +787,35 @@ <h5 id="excludeidentity">-ExcludeIdentity</h5>
786787
</tr>
787788
</tbody>
788789
</table>
790+
<h5 id="excludepassword">-ExcludePassword</h5>
791+
<p>Copies credential definitions without the actual password values.<br />
792+
Use this in security-conscious environments where password decryption is restricted or when passwords should be manually reset after migration.<br></p>
793+
<table>
794+
<thead>
795+
<tr>
796+
<th></th>
797+
<th></th>
798+
</tr>
799+
</thead>
800+
<tbody>
801+
<tr>
802+
<td>Alias</td>
803+
<td></td>
804+
</tr>
805+
<tr>
806+
<td>Required</td>
807+
<td>False</td>
808+
</tr>
809+
<tr>
810+
<td>Pipeline</td>
811+
<td>false</td>
812+
</tr>
813+
<tr>
814+
<td>Default Value</td>
815+
<td>False</td>
816+
</tr>
817+
</tbody>
818+
</table>
789819
<h5 id="force">-Force</h5>
790820
<p>Overwrites existing credentials on the destination server by dropping and recreating them with the source values.<br />
791821
Use this when you need to update credential passwords or identities that have changed on the source server since the last migration.<br></p>

Copy-DbaDbMail.html

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -494,6 +494,7 @@ <h2 id="syntax">Syntax</h2>
494494
<pre><code>Copy-DbaDbMail -Source &lt;DbaInstanceParameter&gt; -Destination &lt;DbaInstanceParameter[]&gt;
495495
[-SourceSqlCredential &lt;PSCredential&gt;]
496496
[-DestinationSqlCredential &lt;PSCredential&gt;]
497+
[-ExcludePassword]
497498
[-Force]
498499
[-EnableException]
499500
[-WhatIf]
@@ -504,6 +505,7 @@ <h2 id="syntax">Syntax</h2>
504505
[-Type &lt;String[]&gt;]
505506
[-SourceSqlCredential &lt;PSCredential&gt;]
506507
[-DestinationSqlCredential &lt;PSCredential&gt;]
508+
[-ExcludePassword]
507509
[-Force]
508510
[-EnableException]
509511
[-WhatIf]
@@ -684,6 +686,35 @@ <h5 id="destinationsqlcredential">-DestinationSqlCredential</h5>
684686
</tr>
685687
</tbody>
686688
</table>
689+
<h5 id="excludepassword">-ExcludePassword</h5>
690+
<p>Copies credential definitions without the actual password values.<br />
691+
Use this in security-conscious environments where password decryption is restricted or when passwords should be manually reset after migration.<br></p>
692+
<table>
693+
<thead>
694+
<tr>
695+
<th></th>
696+
<th></th>
697+
</tr>
698+
</thead>
699+
<tbody>
700+
<tr>
701+
<td>Alias</td>
702+
<td></td>
703+
</tr>
704+
<tr>
705+
<td>Required</td>
706+
<td>False</td>
707+
</tr>
708+
<tr>
709+
<td>Pipeline</td>
710+
<td>false</td>
711+
</tr>
712+
<tr>
713+
<td>Default Value</td>
714+
<td>False</td>
715+
</tr>
716+
</tbody>
717+
</table>
687718
<h5 id="force">-Force</h5>
688719
<p>Overwrites existing Database Mail objects on the destination that have matching names from the source. Without this switch, existing profiles, accounts, or mail servers are skipped to prevent<br />
689720
accidental data loss.<br />

0 commit comments

Comments
 (0)