From 52e81911aae8437b7177cf55281e35fb3c61f2b3 Mon Sep 17 00:00:00 2001 From: Jason Horner Date: Wed, 11 Feb 2026 22:16:20 -0700 Subject: [PATCH 1/2] Enhance sqlpackage-deploy-drift-report with examples Added examples for DeployReport and DriftReport actions. --- .../sqlpackage-deploy-drift-report.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/tools/sqlpackage/sqlpackage-deploy-drift-report.md b/docs/tools/sqlpackage/sqlpackage-deploy-drift-report.md index 33252e69588..ac0c75a4ca9 100644 --- a/docs/tools/sqlpackage/sqlpackage-deploy-drift-report.md +++ b/docs/tools/sqlpackage/sqlpackage-deploy-drift-report.md @@ -163,7 +163,15 @@ SqlPackage {parameters}{properties}{SQLCMD Variables} |**/p:**|UnmodifiableObjectWarnings=(BOOLEAN 'True')|Specifies whether warnings should be generated when differences are found in objects that cannot be modified, for example, if the file size or file paths were different for a file.| |**/p:**|VerifyCollationCompatibility=(BOOLEAN 'True')|Specifies whether collation compatibility is verified.| |**/p:**|VerifyDeployment=(BOOLEAN 'True')|Specifies whether checks should be performed before publishing that will stop the publish action if issues are present that might block successful publishing. For example, your publish action might stop if you have foreign keys on the target database that do not exist in the database project, and that causes errors when you publish. | - + +### DeployReport Examples +```bash +# example deploy report using a source .dacpac file and a target connection string (Azure SQL) +SqlPackage /Action:DeployReport /SourceFile:"C:\AdventureWorksLT.dacpac" \ + /TargetConnectionString:"Server=tcp:{yourserver}.database.windows.net,1433;Initial Catalog=DW;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;" \ + /DeployReportPath:"C:\AdventureWorksLTDeployReport.xml" +``` + ## DriftReport action parameters |Parameter|Short Form|Value|Description| @@ -188,6 +196,14 @@ SqlPackage {parameters}{properties}{SQLCMD Variables} |**/TenantId:**|**/tid:**|{string}|Represents the Microsoft Entra tenant ID or domain name. This option is required to support guest or imported Microsoft Entra users as well as Microsoft accounts such as outlook.com, hotmail.com, or live.com. If this parameter is omitted, the default tenant ID for Microsoft Entra ID will be used, assuming that the authenticated user is a native user for this tenant. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Microsoft Entra ID are not supported and the operation will fail.
For more information, see [Universal authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication).| |**/UniversalAuthentication:**|**/ua:**|{True|False}|Specifies if universal authentication should be used. When set to True, the interactive authentication protocol is activated supporting MFA. This option can also be used for Microsoft Entra authentication without MFA, using an interactive protocol requiring the user to enter their username and password or integrated authentication (Windows credentials). When /UniversalAuthentication is set to True, no Microsoft Entra authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Microsoft Entra authentication must be specified in SourceConnectionString (/scs).
For more information, see [Universal authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication).| +### Drift Report Examples +```bash +# example drift report using a target connection string (Azure SQL) +SqlPackage /Action:DriftReport \ + /TargetConnectionString:"Server=tcp:{yourserver}.database.windows.net,1433;Initial Catalog=AdventureWorksLT;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;" \ + /OutputPath:"C:\AdventureWorksLT.DriftReport.xml" +``` + ## Next Steps - Learn more about [SqlPackage](sqlpackage.md) From d19a174481164b79b29ee325e80ea7417881887a Mon Sep 17 00:00:00 2001 From: Tracey Torble <56347952+ttorble@users.noreply.github.com> Date: Thu, 12 Feb 2026 15:48:02 +0000 Subject: [PATCH 2/2] Fix formatting and update examples in documentation --- docs/tools/sqlpackage/sqlpackage-deploy-drift-report.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/tools/sqlpackage/sqlpackage-deploy-drift-report.md b/docs/tools/sqlpackage/sqlpackage-deploy-drift-report.md index ac0c75a4ca9..3e8310f1aff 100644 --- a/docs/tools/sqlpackage/sqlpackage-deploy-drift-report.md +++ b/docs/tools/sqlpackage/sqlpackage-deploy-drift-report.md @@ -164,7 +164,7 @@ SqlPackage {parameters}{properties}{SQLCMD Variables} |**/p:**|VerifyCollationCompatibility=(BOOLEAN 'True')|Specifies whether collation compatibility is verified.| |**/p:**|VerifyDeployment=(BOOLEAN 'True')|Specifies whether checks should be performed before publishing that will stop the publish action if issues are present that might block successful publishing. For example, your publish action might stop if you have foreign keys on the target database that do not exist in the database project, and that causes errors when you publish. | -### DeployReport Examples +### DeployReport examples ```bash # example deploy report using a source .dacpac file and a target connection string (Azure SQL) SqlPackage /Action:DeployReport /SourceFile:"C:\AdventureWorksLT.dacpac" \ @@ -196,7 +196,7 @@ SqlPackage /Action:DeployReport /SourceFile:"C:\AdventureWorksLT.dacpac" \ |**/TenantId:**|**/tid:**|{string}|Represents the Microsoft Entra tenant ID or domain name. This option is required to support guest or imported Microsoft Entra users as well as Microsoft accounts such as outlook.com, hotmail.com, or live.com. If this parameter is omitted, the default tenant ID for Microsoft Entra ID will be used, assuming that the authenticated user is a native user for this tenant. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Microsoft Entra ID are not supported and the operation will fail.
For more information, see [Universal authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication).| |**/UniversalAuthentication:**|**/ua:**|{True|False}|Specifies if universal authentication should be used. When set to True, the interactive authentication protocol is activated supporting MFA. This option can also be used for Microsoft Entra authentication without MFA, using an interactive protocol requiring the user to enter their username and password or integrated authentication (Windows credentials). When /UniversalAuthentication is set to True, no Microsoft Entra authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Microsoft Entra authentication must be specified in SourceConnectionString (/scs).
For more information, see [Universal authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication).| -### Drift Report Examples +### DriftReport examples ```bash # example drift report using a target connection string (Azure SQL) SqlPackage /Action:DriftReport \ @@ -204,6 +204,6 @@ SqlPackage /Action:DriftReport \ /OutputPath:"C:\AdventureWorksLT.DriftReport.xml" ``` -## Next Steps +## Next steps - Learn more about [SqlPackage](sqlpackage.md)