()
+ .Executes(() => { /* Implementation */ });
+}
+```
+:::
+
+[^1]: Interface default members behave like explicit interface implementations, which means that to access their members, the `this` reference must be cast explicitly to the interface type. For instance, `((IComponent)this).Target`.
diff --git a/docs/04-sharing/_category_.json b/docs/04-sharing/_category_.json
new file mode 100644
index 000000000..873c78fc8
--- /dev/null
+++ b/docs/04-sharing/_category_.json
@@ -0,0 +1,3 @@
+{
+ "label": "Build Sharing"
+}
diff --git a/docs/05-cicd/_category_.json b/docs/05-cicd/_category_.json
new file mode 100644
index 000000000..8d508dedf
--- /dev/null
+++ b/docs/05-cicd/_category_.json
@@ -0,0 +1,3 @@
+{
+ "label": "CI/CD Support"
+}
diff --git a/docs/05-cicd/appveyor-artifacts.png b/docs/05-cicd/appveyor-artifacts.png
new file mode 100644
index 000000000..c48c1ae77
Binary files /dev/null and b/docs/05-cicd/appveyor-artifacts.png differ
diff --git a/docs/05-cicd/appveyor-artifacts.webp b/docs/05-cicd/appveyor-artifacts.webp
new file mode 100644
index 000000000..1040215b4
Binary files /dev/null and b/docs/05-cicd/appveyor-artifacts.webp differ
diff --git a/docs/05-cicd/appveyor.md b/docs/05-cicd/appveyor.md
new file mode 100644
index 000000000..d675570b7
--- /dev/null
+++ b/docs/05-cicd/appveyor.md
@@ -0,0 +1,128 @@
+---
+title: AppVeyor
+---
+
+Running on [AppVeyor](https://www.appveyor.com/) will automatically enable custom theming for your build log output:
+
+
+
+:::info
+Please refer to the official [AppVeyor documentation](https://www.appveyor.com/docs/) for questions not covered here.
+:::
+
+## Environment Variables
+
+You can access [predefined environment variables](https://www.appveyor.com/docs/environment-variables/) by using the `AppVeyor` class:
+
+```csharp
+AppVeyor AppVeyor => AppVeyor.Instance;
+
+Target Print => _ => _
+ .Executes(() =>
+ {
+ Log.Information("Branch = {Branch}", AppVeyor.RepositoryBranch);
+ Log.Information("Commit = {Commit}", AppVeyor.RepositoryCommitSha);
+ });
+```
+
+
+Exhaustive list of strongly-typed properties
+
+```csharp
+class AppVeyor
+{
+ string AccountName { get; }
+ string ApiUrl { get; }
+ string BuildFolder { get; }
+ int BuildId { get; }
+ int BuildNumber { get; }
+ string BuildVersion { get; }
+ string BuildWorkerImage { get; }
+ Tool Cli { get; }
+ string Configuration { get; }
+ bool ForcedBuild { get; }
+ string JobId { get; }
+ string JobName { get; }
+ int JobNumber { get; }
+ string Platform { get; }
+ int ProjectId { get; }
+ string ProjectName { get; }
+ string ProjectSlug { get; }
+ int? PullRequestNumber { get; }
+ string PullRequestTitle { get; }
+ bool Rebuild { get; }
+ string RepositoryBranch { get; }
+ string RepositoryCommitAuthor { get; }
+ string RepositoryCommitAuthorEmail { get; }
+ string RepositoryCommitMessage { get; }
+ string RepositoryCommitMessageExtended { get; }
+ string RepositoryCommitSha { get; }
+ DateTime RepositoryCommitTimestamp { get; }
+ string RepositoryName { get; }
+ string RepositoryProvider { get; }
+ string RepositoryScm { get; }
+ bool RepositoryTag { get; }
+ string RepositoryTagName { get; }
+ bool ScheduledBuild { get; }
+ string Url { get; }
+}
+```
+
+
+
+## Configuration Generation
+
+You can generate [build pipeline files](https://appveyor.com/docs/appveyor-yml/) from your existing target definitions by adding the `AppVeyor` attribute. For instance, you can run the `Compile` target on every push with the latest Ubuntu image:
+
+```csharp title="Build.cs"
+[AppVeyor(
+ AppVeyorImage.VisualStudio2022,
+ InvokedTargets = new[] { nameof(Compile) })]
+class Build : NukeBuild { /* ... */ }
+```
+
+
+Generated output
+
+```yaml title="appveyor.yml"
+
+image:
+ - Visual Studio 2022
+
+build_script:
+ - cmd: .\build.cmd Compile
+ - sh: ./build.cmd Compile
+```
+
+
+
+:::info
+Whenever you make changes to the attribute, you have to [run the build](../01-getting-started/03-execution.md) at least once to regenerate the pipelines file.
+:::
+
+## Artifacts
+
+If your targets produce artifacts, like packages or coverage reports, you can publish those directly from the target definition:
+
+```csharp
+Target Pack => _ => _
+ .Produces(PackagesDirectory / "*.nupkg")
+ .Executes(() => { /* Implementation */ });
+```
+
+
+Generated output
+
+```yaml title="appveyor.yml"
+artifacts:
+ - path: output/packages/*.nupkg
+```
+
+
+After your build has finished, those artifacts will be listed under the artifacts tab:
+
+
+
+
+
+
diff --git a/docs/05-cicd/appveyor.png b/docs/05-cicd/appveyor.png
new file mode 100644
index 000000000..ea0bc93bf
Binary files /dev/null and b/docs/05-cicd/appveyor.png differ
diff --git a/docs/05-cicd/appveyor.webp b/docs/05-cicd/appveyor.webp
new file mode 100644
index 000000000..53b900482
Binary files /dev/null and b/docs/05-cicd/appveyor.webp differ
diff --git a/docs/05-cicd/azure-pipelines-artifacts-dark.png b/docs/05-cicd/azure-pipelines-artifacts-dark.png
new file mode 100644
index 000000000..7c91c55f8
Binary files /dev/null and b/docs/05-cicd/azure-pipelines-artifacts-dark.png differ
diff --git a/docs/05-cicd/azure-pipelines-artifacts-dark.webp b/docs/05-cicd/azure-pipelines-artifacts-dark.webp
new file mode 100644
index 000000000..b87310eab
Binary files /dev/null and b/docs/05-cicd/azure-pipelines-artifacts-dark.webp differ
diff --git a/docs/05-cicd/azure-pipelines-artifacts-light.png b/docs/05-cicd/azure-pipelines-artifacts-light.png
new file mode 100644
index 000000000..bd1a9a557
Binary files /dev/null and b/docs/05-cicd/azure-pipelines-artifacts-light.png differ
diff --git a/docs/05-cicd/azure-pipelines-artifacts-light.webp b/docs/05-cicd/azure-pipelines-artifacts-light.webp
new file mode 100644
index 000000000..fbb4e7dc5
Binary files /dev/null and b/docs/05-cicd/azure-pipelines-artifacts-light.webp differ
diff --git a/docs/05-cicd/azure-pipelines.md b/docs/05-cicd/azure-pipelines.md
new file mode 100644
index 000000000..e18d337a8
--- /dev/null
+++ b/docs/05-cicd/azure-pipelines.md
@@ -0,0 +1,255 @@
+---
+title: Azure Pipelines
+---
+
+Running on [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) will automatically enable custom theming for your build log output including [collapsible sections](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands#formatting-commands) for better structuring:
+
+
+
+:::info
+Please refer to the official [Azure Pipelines documentation](https://docs.microsoft.com/en-us/azure/devops/pipelines/?view=azure-devops) for questions not covered here.
+:::
+
+## Environment Variables
+
+You can access [predefined environment variables](https://docs.microsoft.com/en-us/azure/devops/pipelines/build/variables) by using the `AzurePipelines` class:
+
+```csharp
+AzurePipelines AzurePipelines => AzurePipelines.Instance;
+
+Target Print => _ => _
+ .Executes(() =>
+ {
+ Log.Information("Branch = {Branch}", AzurePipelines.SourceBranch);
+ Log.Information("Commit = {Commit}", AzurePipelines.SourceVersion);
+ });
+```
+
+
+Exhaustive list of strongly-typed properties
+
+```csharp
+class AzurePipelines
+{
+ string AccessToken { get; }
+ string AgentBuildDirectory { get; }
+ string AgentHomeDirectory { get; }
+ long AgentId { get; }
+ AzurePipelinesJobStatus AgentJobStatus { get; }
+ string AgentMachineName { get; }
+ string AgentName { get; }
+ string AgentWorkFolder { get; }
+ string ArtifactStagingDirectory { get; }
+ string BinariesDirectory { get; }
+ long BuildId { get; }
+ string BuildNumber { get; }
+ AzurePipelinesBuildReason BuildReason { get; }
+ string BuildUri { get; }
+ Guid CollectionId { get; }
+ string DefaultWorkingDirectory { get; }
+ long DefinitionId { get; }
+ string DefinitionName { get; }
+ long DefinitionVersion { get; }
+ string JobDisplayName { get; }
+ Guid JobId { get; }
+ string PhaseName { get; }
+ long? PullRequestId { get; }
+ string PullRequestSourceBranch { get; }
+ string PullRequestTargetBranch { get; }
+ string QueuedBy { get; }
+ Guid QueuedById { get; }
+ bool RepositoryClean { get; }
+ bool RepositoryGitSubmoduleCheckout { get; }
+ string RepositoryLocalPath { get; }
+ string RepositoryName { get; }
+ AzurePipelinesRepositoryType RepositoryProvider { get; }
+ string RepositoryTfvcWorkspace { get; }
+ string RepositoryUri { get; }
+ string RequestedFor { get; }
+ string RequestedForEmail { get; }
+ Guid RequestedForId { get; }
+ string SourceBranch { get; }
+ string SourceBranchName { get; }
+ string SourceDirectory { get; }
+ string SourceTfvcShelveset { get; }
+ string SourceVersion { get; }
+ string StageDisplayName { get; }
+ string StageName { get; }
+ string StagingDirectory { get; }
+ Guid TaskInstanceId { get; }
+ string TeamFoundationCollectionUri { get; }
+ string TeamProject { get; }
+ Guid TeamProjectId { get; }
+ string TestResultsDirectory { get; }
+}
+```
+
+
+
+## Configuration Generation
+
+You can generate [build pipeline files](https://docs.microsoft.com/en-us/azure/devops/pipelines/create-first-pipeline) from your existing target definitions by adding the `AzurePipelines` attribute. For instance, you can run the `Compile` target on every push with the latest Ubuntu image:
+
+```csharp title="Build.cs"
+[AzurePipelines(
+ AzurePipelinesImage.UbuntuLatest,
+ InvokedTargets = new[] { nameof(Compile) })]
+class Build : NukeBuild { /* ... */ }
+```
+
+
+Generated output
+
+```yaml title="azure-pipelines.yml"
+stages:
+ - stage: ubuntu_latest
+ displayName: 'ubuntu-latest'
+ pool:
+ vmImage: 'ubuntu-latest'
+ jobs:
+ - job: Compile
+ displayName: 'Compile'
+ steps:
+ - task: CmdLine@2
+ inputs:
+ script: './build.cmd Compile --skip'
+```
+
+
+
+:::info
+Whenever you make changes to the attribute, you have to [run the build](../01-getting-started/03-execution.md) at least once to regenerate the pipelines file.
+:::
+
+### Artifacts
+
+If your targets produce artifacts, like packages or coverage reports, you can publish those directly from the target definition:
+
+```csharp
+Target Pack => _ => _
+ .Produces(PackagesDirectory / "*.nupkg")
+ .Executes(() => { /* Implementation */ });
+```
+
+
+Generated output
+
+```yaml title="azure-pipelines.yml"
+- task: PublishBuildArtifacts@1
+ inputs:
+ artifactName: packages
+ pathtoPublish: 'output/packages'
+```
+
+
+After your build has finished, those artifacts will be listed under the artifacts tab:
+
+
+
+
+
+
+
+
+### Importing Secrets
+
+If you want to use [secret variables](https://docs.microsoft.com/en-us/azure/devops/pipelines/process/variables#secret-variables) from your repository, you can use the `ImportSecrets` property to automatically load them into a [secret parameter](../02-fundamentals/06-parameters.md#secret-parameters) defined in your build:
+
+```csharp title="Build.cs"
+[AzurePipelines(
+ // ...
+ ImportSecrets = new[] { nameof(NuGetApiKey) })]
+class Build : NukeBuild
+{
+ [Parameter] [Secret] readonly string NuGetApiKey;
+}
+```
+
+
+Generated output
+
+```yaml title="azure-pipelines.yml"
+- task: CmdLine@2
+ inputs:
+ script: './build.cmd Publish --skip'
+ env:
+ NuGetApiKey: $(NuGetApiKey)
+```
+
+
+
+:::note
+If you're facing any issues, make sure that the name in the Azure Pipelines settings is the same as generated into the pipelines file.
+:::
+
+### Using Access Tokens
+
+For every pipeline run, Azure Pipelines generates a [one-time token](https://docs.microsoft.com/en-us/azure/devops/pipelines/process/access-tokens) with [adequate permissions](https://docs.microsoft.com/en-us/azure/devops/pipelines/process/access-tokens#manage-build-service-account-permissions) that you can use to authenticate with the Azure Pipelines API. You can enable the access token in the attribute as follows:
+
+```csharp title="Build.cs"
+[AzurePipelines(
+ // ...
+ EnableAccessToken = true)]
+class Build : NukeBuild
+{
+ AzurePipelines AzurePipelines => AzurePipelines.Instance;
+
+ Target Request => _ => _
+ .Executes(() =>
+ {
+ Log.Information("Access Token = {Token}", AzurePipelines.AccessToken);
+ });
+}
+```
+
+
+Generated output
+
+```yaml title="azure-pipelines.yml"
+- task: CmdLine@2
+ inputs:
+ script: './build.cmd Release --skip'
+ env:
+ SYSTEM_ACCESSTOKEN: $(System.AccessToken)
+
+```
+
+
+
+### Caching
+
+By default, the generated pipeline file will include [caching tasks](https://docs.microsoft.com/en-us/azure/devops/pipelines/release/caching) to reduce the time for installing the .NET SDK (if not preinstalled) and restoring NuGet packages.
+
+
+Generated output
+
+```yaml title="azure-pipelines.yml"
+- task: Cache@2
+ displayName: Cache (nuke-temp)
+ inputs:
+ key: $(Agent.OS) | nuke-temp | **/global.json, **/*.csproj
+ restoreKeys: $(Agent.OS) | nuke-temp
+ path: .nuke/temp
+- task: Cache@2
+ displayName: Cache (nuget-packages)
+ inputs:
+ key: $(Agent.OS) | nuget-packages | **/global.json, **/*.csproj
+ restoreKeys: $(Agent.OS) | nuget-packages
+ path: $(HOME)/.nuget/packages
+```
+
+
+
+You can customize the caching tasks by overwriting the following properties:
+
+```csharp title="Build.cs"
+[AzurePipelines(
+ // ...
+ CacheKeyFiles = new[] { "**/global.json", "**/*.csproj" },
+ CachePaths = new[]
+ {
+ AzurePipelinesCachePaths.Nuke,
+ AzurePipelinesCachePaths.NuGet
+ })]
+class Build : NukeBuild { /* ... */ }
+```
diff --git a/docs/05-cicd/azure-pipelines.png b/docs/05-cicd/azure-pipelines.png
new file mode 100644
index 000000000..f0fc36032
Binary files /dev/null and b/docs/05-cicd/azure-pipelines.png differ
diff --git a/docs/05-cicd/azure-pipelines.webp b/docs/05-cicd/azure-pipelines.webp
new file mode 100644
index 000000000..c9bae7cce
Binary files /dev/null and b/docs/05-cicd/azure-pipelines.webp differ
diff --git a/docs/05-cicd/bitbucket.md b/docs/05-cicd/bitbucket.md
new file mode 100644
index 000000000..af6d32f92
--- /dev/null
+++ b/docs/05-cicd/bitbucket.md
@@ -0,0 +1,60 @@
+---
+title: Bitbucket
+---
+
+Running on [Bitbucket](https://bitbucket.org/) will use the standard theming for your build log output.
+
+:::info
+Please refer to the official [Bitbucket documentation](https://confluence.atlassian.com/bitbucketserver/) for questions not covered here.
+:::
+
+## Environment Variables
+
+You can access [predefined environment variables](https://support.atlassian.com/bitbucket-cloud/docs/variables-and-secrets/) by using the `Bitbucket` class:
+
+```csharp
+Bitbucket Bitbucket => Bitbucket.Instance;
+
+Target Print => _ => _
+ .Executes(() =>
+ {
+ Log.Information("Branch = {Branch}", Bitbucket.Branch);
+ Log.Information("Commit = {Commit}", Bitbucket.Commit);
+ });
+```
+
+
+Exhaustive list of strongly-typed properties
+
+```csharp
+class Bitbucket
+{
+ string Bookmark { get; }
+ string Branch { get; }
+ long BuildNumber { get; }
+ string CloneDirectory { get; }
+ string Commit { get; }
+ string DeploymentEnvironment { get; }
+ string DeploymentEnvironmentUuid { get; }
+ string ExitCode { get; }
+ string GitHttpOrigin { get; }
+ string GitSshOrigin { get; }
+ int ParallelStep { get; }
+ int ParallelStepCount { get; }
+ string PipelineUuid { get; }
+ string ProjectKey { get; }
+ string ProjectUuid { get; }
+ string PullRequestDestinationBranch { get; }
+ int PullRequestId { get; }
+ string RepositoryFullName { get; }
+ string RepositorySlug { get; }
+ string RepositoryUuid { get; }
+ string StepOidcToken { get; }
+ string StepTriggererUuid { get; }
+ string StepUuid { get; }
+ string Tag { get; }
+ string Workspace { get; }
+}
+```
+
+
diff --git a/docs/05-cicd/github-actions-artifacts-dark.png b/docs/05-cicd/github-actions-artifacts-dark.png
new file mode 100644
index 000000000..88c704134
Binary files /dev/null and b/docs/05-cicd/github-actions-artifacts-dark.png differ
diff --git a/docs/05-cicd/github-actions-artifacts-dark.webp b/docs/05-cicd/github-actions-artifacts-dark.webp
new file mode 100644
index 000000000..e954cee61
Binary files /dev/null and b/docs/05-cicd/github-actions-artifacts-dark.webp differ
diff --git a/docs/05-cicd/github-actions-artifacts-light.png b/docs/05-cicd/github-actions-artifacts-light.png
new file mode 100644
index 000000000..75f4e5f93
Binary files /dev/null and b/docs/05-cicd/github-actions-artifacts-light.png differ
diff --git a/docs/05-cicd/github-actions-artifacts-light.webp b/docs/05-cicd/github-actions-artifacts-light.webp
new file mode 100644
index 000000000..8fb535a25
Binary files /dev/null and b/docs/05-cicd/github-actions-artifacts-light.webp differ
diff --git a/docs/05-cicd/github-actions.md b/docs/05-cicd/github-actions.md
new file mode 100644
index 000000000..80ec11c9f
--- /dev/null
+++ b/docs/05-cicd/github-actions.md
@@ -0,0 +1,220 @@
+---
+title: GitHub Actions
+---
+
+Running on [GitHub Actions](https://github.com/features/actions) will automatically enable custom theming for your build log output including [collapsible groups](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#grouping-log-lines) for better structuring:
+
+
+
+:::info
+Please refer to the official [GitHub Actions documentation](https://docs.github.com/en/actions) for questions not covered here.
+:::
+
+## Environment Variables
+
+You can access [predefined environment variables](https://docs.github.com/en/actions/learn-github-actions/environment-variables) by using the `GitHubActions` class:
+
+```csharp
+GitHubActions GitHubActions => GitHubActions.Instance;
+
+Target Print => _ => _
+ .Executes(() =>
+ {
+ Log.Information("Branch = {Branch}", GitHubActions.Ref);
+ Log.Information("Commit = {Commit}", GitHubActions.Sha);
+ });
+```
+
+
+Exhaustive list of strongly-typed properties
+
+```csharp
+class GitHubActions
+{
+ string Action { get; }
+ string Actor { get; }
+ string BaseRef { get; }
+ string EventName { get; }
+ string EventPath { get; }
+ JObject GitHubContext { get; }
+ JObject GitHubEvent { get; }
+ string HeadRef { get; }
+ string Home { get; }
+ bool IsPullRequest { get; }
+ string Job { get; }
+ long JobId { get; }
+ string PullRequestAction { get; }
+ int? PullRequestNumber { get; }
+ string Ref { get; }
+ string Repository { get; }
+ string RepositoryOwner { get; }
+ long RunId { get; }
+ long RunNumber { get; }
+ string ServerUrl { get; }
+ string Sha { get; }
+ string Token { get; }
+ string Workflow { get; }
+ string Workspace { get; }
+}
+```
+
+
+
+## Configuration Generation
+
+You can generate [workflow files](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions) from your existing target definitions by adding the `GitHubActions` attribute. For instance, you can run the `Compile` target on every push with the latest Ubuntu image:
+
+```csharp title="Build.cs"
+[GitHubActions(
+ "continuous",
+ GitHubActionsImage.UbuntuLatest,
+ On = new[] { GitHubActionsTrigger.Push },
+ InvokedTargets = new[] { nameof(Compile) })]
+class Build : NukeBuild { /* ... */ }
+```
+
+
+Generated output
+
+```yaml title=".github/workflows/continuous.yml"
+name: continuous
+
+on: [push]
+
+jobs:
+ ubuntu-latest:
+ name: ubuntu-latest
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - name: Run './build.cmd Compile'
+ run: ./build.cmd Compile
+```
+
+
+
+:::info
+Whenever you make changes to the attribute, you have to [run the build](../01-getting-started/03-execution.md) at least once to regenerate the workflow file.
+:::
+
+### Artifacts
+
+If your targets produce artifacts, like packages or coverage reports, you can publish those directly from the target definition:
+
+```csharp
+Target Pack => _ => _
+ .Produces(PackagesDirectory / "*.nupkg")
+ .Executes(() => { /* Implementation */ });
+```
+
+
+Generated output
+
+```yaml title=".github/workflows/continuous.yml"
+- uses: actions/upload-artifact@v1
+ with:
+ name: packages
+ path: output/packages
+```
+
+
+After your build has finished, those artifacts will be listed under the _Summary_ tab:
+
+
+
+
+
+
+
+
+### Importing Secrets
+
+If you want to use [encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#about-encrypted-secrets) from your organization or repository, you can use the `ImportSecrets` property to automatically load them into a [secret parameter](../02-fundamentals/06-parameters.md#secret-parameters) defined in your build:
+
+```csharp title="Build.cs"
+[GitHubActions(
+ // ...
+ ImportSecrets = new[] { nameof(NuGetApiKey) })]
+class Build : NukeBuild
+{
+ [Parameter] [Secret] readonly string NuGetApiKey;
+}
+```
+
+
+Generated output
+
+```yaml title=".github/workflows/continuous.yml"
+- name: Run './build.cmd Publish'
+ run: ./build.cmd Publish
+ env:
+ NuGetApiKey: ${{ secrets.NUGET_API_KEY }}
+```
+
+
+
+:::note
+If you're facing any issues, make sure that the name in the GitHub settings is the same as generated into the workflow file.
+:::
+
+### Using the GitHub Token
+
+For every workflow run, GitHub generates a [one-time token](https://docs.github.com/en/actions/security-guides/automatic-token-authentication) with [adequate permissions](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) that you can use to authenticate with the GitHub API. You can enable the GitHub token in your attribute as follows:
+
+```csharp title="Build.cs"
+[GitHubActions(
+ // ...
+ EnableGitHubToken = true)]
+class Build : NukeBuild
+{
+ GitHubActions GitHubActions => GitHubActions.Instance;
+
+ Target Request => _ => _
+ .Executes(() =>
+ {
+ Log.Information("GitHub Token = {Token}", GitHubActions.Token);
+ });
+}
+```
+
+
+Generated output
+
+```yaml title=".github/workflows/continuous.yml"
+- name: Run './build.cmd Release'
+ run: ./build.cmd Publish
+ env:
+ GITHUB_CONTEXT: ${{ toJSON(github) }}
+```
+
+
+
+### Caching
+
+By default, the generated workflow file will include a [caching step](https://github.com/actions/cache) to reduce the time for installing the .NET SDK (if not preinstalled) and restoring NuGet packages.
+
+
+Generated output
+
+```yaml title=".github/workflows/continuous.yml"
+- name: Cache .nuke/temp, ~/.nuget/packages
+ uses: actions/cache@v2
+ with:
+ path: |
+ .nuke/temp
+ ~/.nuget/packages
+ key: ${{ runner.os }}-${{ hashFiles('global.json', 'source/**/*.csproj') }}
+```
+
+
+
+You can customize the caching step by overwriting the following properties:
+
+```csharp title="Build.cs"
+[GitHubActions(
+ // ...
+ CacheKeyFiles = new[] { "**/global.json", "**/*.csproj" },
+ CacheIncludePatterns = new[] { ".nuke/temp", "~/.nuget/packages" },
+ CacheExcludePatterns = new string[0])]
+class Build : NukeBuild { /* ... */ }
+```
diff --git a/docs/05-cicd/github-actions.png b/docs/05-cicd/github-actions.png
new file mode 100644
index 000000000..3b81365d3
Binary files /dev/null and b/docs/05-cicd/github-actions.png differ
diff --git a/docs/05-cicd/github-actions.webp b/docs/05-cicd/github-actions.webp
new file mode 100644
index 000000000..b0680a987
Binary files /dev/null and b/docs/05-cicd/github-actions.webp differ
diff --git a/docs/05-cicd/gitlab.md b/docs/05-cicd/gitlab.md
new file mode 100644
index 000000000..9c9c9f553
--- /dev/null
+++ b/docs/05-cicd/gitlab.md
@@ -0,0 +1,75 @@
+---
+title: GitLab
+---
+
+Running on [GitLab](https://about.gitlab.com/) will automatically enable custom theming for your build log output including [collapsible sections](https://docs.gitlab.com/ee/ci/jobs/#expand-and-collapse-job-log-sections) for better structuring:
+
+
+
+:::info
+Please refer to the official [GitLab documentation](https://docs.gitlab.com/) for questions not covered here.
+:::
+
+## Environment Variables
+
+You can access [predefined environment variables](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html) by using the `GitLab` class:
+
+```csharp
+GitLab GitLab => GitLab.Instance;
+
+Target Print => _ => _
+ .Executes(() =>
+ {
+ Log.Information("Branch = {Branch}", GitLab.CommitRefName);
+ Log.Information("Commit = {Commit}", GitLab.CommitSha);
+ });
+```
+
+
+Exhaustive list of strongly-typed properties
+
+```csharp
+class GitLab
+{
+ bool Ci { get; }
+ string CommitRefName { get; }
+ string CommitRefSlug { get; }
+ string CommitSha { get; }
+ string CommitTag { get; }
+ string ConfigPath { get; }
+ bool DisposableEnvironment { get; }
+ string GitLabUserEmail { get; }
+ long GitLabUserId { get; }
+ string GitLabUserLogin { get; }
+ string GitLabUserName { get; }
+ long JobId { get; }
+ bool JobManual { get; }
+ string JobName { get; }
+ string JobStage { get; }
+ string JobToken { get; }
+ long PipelineId { get; }
+ string PipelineSource { get; }
+ bool PipelineTriggered { get; }
+ string ProjectDirectory { get; }
+ long ProjectId { get; }
+ string ProjectName { get; }
+ string ProjectNamespace { get; }
+ string ProjectPath { get; }
+ string ProjectPathSlug { get; }
+ string ProjectUrl { get; }
+ GitLabProjectVisibility ProjectVisibility { get; }
+ string Registry { get; }
+ string RegistryImage { get; }
+ string RegistryPassword { get; }
+ string RegistryUser { get; }
+ string RepositoryUrl { get; }
+ string RunnerDescription { get; }
+ long RunnerId { get; }
+ string RunnerTags { get; }
+ string ServerName { get; }
+ string ServerRevision { get; }
+ string ServerVersion { get; }
+}
+```
+
+
diff --git a/docs/05-cicd/gitlab.png b/docs/05-cicd/gitlab.png
new file mode 100644
index 000000000..e156ea699
Binary files /dev/null and b/docs/05-cicd/gitlab.png differ
diff --git a/docs/05-cicd/gitlab.webp b/docs/05-cicd/gitlab.webp
new file mode 100644
index 000000000..802b5daeb
Binary files /dev/null and b/docs/05-cicd/gitlab.webp differ
diff --git a/docs/05-cicd/jenkins.md b/docs/05-cicd/jenkins.md
new file mode 100644
index 000000000..1be78447d
--- /dev/null
+++ b/docs/05-cicd/jenkins.md
@@ -0,0 +1,56 @@
+---
+title: Jenkins
+---
+
+Running on [Jenkins](https://www.jenkins.io/) will use the standard theming for your build log output.
+
+:::info
+Please refer to the official [Jenkins documentation](https://www.jenkins.io/doc/) for questions not covered here.
+:::
+
+## Environment Variables
+
+You can access [predefined environment variables](https://wiki.jenkins.io/display/JENKINS/Building+a+software+project#Buildingasoftwareproject-belowJenkinsSetEnvironmentVariables) by using the `Jenkins` class:
+
+```csharp
+Jenkins Jenkins => Jenkins.Instance;
+
+Target Print => _ => _
+ .Executes(() =>
+ {
+ Log.Information("Branch = {Branch}", Jenkins.GitBranch);
+ Log.Information("Commit = {Commit}", Jenkins.GitCommit);
+ });
+```
+
+
+Exhaustive list of strongly-typed properties
+
+```csharp
+class Jenkins
+{
+ string BranchName { get; }
+ string BuilDisplayName { get; }
+ int BuildNumber { get; }
+ string BuildTag { get; }
+ string ChangeId { get; }
+ int ExecutorNumber { get; }
+ string GitBranch { get; }
+ string GitCommit { get; }
+ string GitPreviousCommit { get; }
+ string GitPreviousSuccessfulCommit { get; }
+ string GitUrl { get; }
+ string JenkinsHome { get; }
+ string JenkinsServerCookie { get; }
+ string JobBaseName { get; }
+ string JobDisplayUrl { get; }
+ string JobName { get; }
+ string NodeLabels { get; }
+ string NodeName { get; }
+ string RunChangesDisplayUrl { get; }
+ string RunDisplayUrl { get; }
+ string Workspace { get; }
+}
+```
+
+
diff --git a/docs/05-cicd/space-automation-dark.png b/docs/05-cicd/space-automation-dark.png
new file mode 100644
index 000000000..2a7e30890
Binary files /dev/null and b/docs/05-cicd/space-automation-dark.png differ
diff --git a/docs/05-cicd/space-automation-dark.webp b/docs/05-cicd/space-automation-dark.webp
new file mode 100644
index 000000000..a2b9904b2
Binary files /dev/null and b/docs/05-cicd/space-automation-dark.webp differ
diff --git a/docs/05-cicd/space-automation-light.png b/docs/05-cicd/space-automation-light.png
new file mode 100644
index 000000000..943507155
Binary files /dev/null and b/docs/05-cicd/space-automation-light.png differ
diff --git a/docs/05-cicd/space-automation-light.webp b/docs/05-cicd/space-automation-light.webp
new file mode 100644
index 000000000..ce5f680d9
Binary files /dev/null and b/docs/05-cicd/space-automation-light.webp differ
diff --git a/docs/05-cicd/space-automation.md b/docs/05-cicd/space-automation.md
new file mode 100644
index 000000000..c2e0f406b
--- /dev/null
+++ b/docs/05-cicd/space-automation.md
@@ -0,0 +1,46 @@
+---
+title: Space Automation
+---
+
+Running on [JetBrains Space](https://www.jetbrains.com/space/) will use the standard theming for your build log output:
+
+
+
+
+:::info
+Please refer to the official [Space Automation documentation](https://www.jetbrains.com/help/space/getting-started.html) for questions not covered here.
+:::
+
+## Environment Variables
+
+You can access [predefined environment variables](https://www.jetbrains.com/help/space/automation-environment-variables.html) by using the `SpaceAutomation` class:
+
+```csharp
+SpaceAutomation SpaceAutomation => SpaceAutomation.Instance;
+
+Target Print => _ => _
+ .Executes(() =>
+ {
+ Log.Information("Branch = {Branch}", SpaceAutomation.GitBranch);
+ Log.Information("Commit = {Commit}", SpaceAutomation.GitRevision);
+ });
+```
+
+
+Exhaustive list of strongly-typed properties
+
+```csharp
+class SpaceAutomation
+{
+ string ApiUrl { get; }
+ string ClientId { get; }
+ string ClientSecret { get; }
+ string ExecutionNumber { get; }
+ string GitBranch { get; }
+ string GitRevision { get; }
+ string ProjectKey { get; }
+ string RepositoryName { get; }
+}
+```
+
+
diff --git a/docs/05-cicd/teamcity-artifacts.png b/docs/05-cicd/teamcity-artifacts.png
new file mode 100644
index 000000000..054f754e8
Binary files /dev/null and b/docs/05-cicd/teamcity-artifacts.png differ
diff --git a/docs/05-cicd/teamcity-artifacts.webp b/docs/05-cicd/teamcity-artifacts.webp
new file mode 100644
index 000000000..a8ec674f1
Binary files /dev/null and b/docs/05-cicd/teamcity-artifacts.webp differ
diff --git a/docs/05-cicd/teamcity-dark.png b/docs/05-cicd/teamcity-dark.png
new file mode 100644
index 000000000..81494487f
Binary files /dev/null and b/docs/05-cicd/teamcity-dark.png differ
diff --git a/docs/05-cicd/teamcity-dark.webp b/docs/05-cicd/teamcity-dark.webp
new file mode 100644
index 000000000..ea0e928d4
Binary files /dev/null and b/docs/05-cicd/teamcity-dark.webp differ
diff --git a/docs/05-cicd/teamcity-light.png b/docs/05-cicd/teamcity-light.png
new file mode 100644
index 000000000..bcd9cefde
Binary files /dev/null and b/docs/05-cicd/teamcity-light.png differ
diff --git a/docs/05-cicd/teamcity-light.webp b/docs/05-cicd/teamcity-light.webp
new file mode 100644
index 000000000..0e2950c89
Binary files /dev/null and b/docs/05-cicd/teamcity-light.webp differ
diff --git a/docs/05-cicd/teamcity.md b/docs/05-cicd/teamcity.md
new file mode 100644
index 000000000..d418795f4
--- /dev/null
+++ b/docs/05-cicd/teamcity.md
@@ -0,0 +1,198 @@
+---
+title: TeamCity
+---
+
+Running on [TeamCity](https://www.jetbrains.com/teamcity/) will automatically enable custom theming for your build log output including [collapsible blocks](https://www.jetbrains.com/help/teamcity/service-messages.html#Blocks+of+Service+Messages) for better structuring:
+
+
+
+
+:::info
+Please refer to the official [TeamCity documentation](https://www.jetbrains.com/help/teamcity/teamcity-documentation.html) for questions not covered here.
+:::
+
+## Environment Variables
+
+You can access [predefined parameters](https://www.jetbrains.com/help/teamcity/predefined-build-parameters.html) by using the `TeamCity` class:
+
+```csharp
+TeamCity TeamCity => TeamCity.Instance;
+
+Target Print => _ => _
+ .Executes(() =>
+ {
+ Log.Information("Branch = {Branch}", TeamCity.BranchName);
+ Log.Information("Commit = {Commit}", TeamCity.BuildVcsNumber);
+ });
+```
+
+
+Exhaustive list of strongly-typed properties
+
+```csharp
+class TeamCity
+{
+ string AuthPassword { get; }
+ string AuthUserId { get; }
+ string BranchName { get; }
+ string BuildConfiguration { get; }
+ long BuildId { get; }
+ string BuildNumber { get; }
+ string BuildTypeId { get; }
+ string BuildVcsNumber { get; }
+ IReadOnlyDictionary ConfigurationProperties { get; }
+ bool IsBuildPersonal { get; }
+ bool IsPullRequest { get; }
+ string ProjectId { get; }
+ string ProjectName { get; }
+ long? PullRequestNumber { get; }
+ string PullRequestSourceBranch { get; }
+ string PullRequestTargetBranch { get; }
+ string PullRequestTitle { get; }
+ IReadOnlyCollection RecentlyFailedTests { get; }
+ IReadOnlyDictionary RunnerProperties { get; }
+ string ServerUrl { get; }
+ IReadOnlyDictionary SystemProperties { get; }
+ string Version { get; }
+}
+```
+
+
+
+## Configuration Generation
+
+You can generate [build configuration files](https://www.jetbrains.com/help/teamcity/kotlin-dsl.html) from your existing target definitions by adding the `TeamCity` attribute. For instance, you can run the `Compile` target on every push with the latest Ubuntu image:
+
+```csharp title="Build.cs"
+[TeamCity(
+ VcsTriggeredTargets = new[] { nameof(Compile) })]
+class Build : NukeBuild { /* ... */ }
+```
+
+
+Generated output
+
+```kotlin title=".teamcity/settings.kts"
+project {
+ buildType(Compile)
+}
+
+object Compile : BuildType({
+ name = "Compile"
+ vcs {
+ root(DslContext.settingsRoot)
+ cleanCheckout = true
+ }
+ steps {
+ exec {
+ path = "build.cmd"
+ arguments = "Compile"
+ conditions { contains("teamcity.agent.jvm.os.name", "Windows") }
+ }
+ exec {
+ path = "build.sh"
+ arguments = "Compile"
+ conditions { doesNotContain("teamcity.agent.jvm.os.name", "Windows") }
+ }
+ }
+ params {
+ text(
+ "teamcity.ui.runButton.caption",
+ "Compile",
+ display = ParameterDisplay.HIDDEN)
+ }
+ triggers {
+ vcs {
+ triggerRules = "+:**"
+ }
+ }
+})
+```
+
+
+
+:::info
+Whenever you make changes to the attribute, you have to [run the build](../01-getting-started/03-execution.md) at least once to regenerate the pipelines file.
+:::
+
+### Artifacts
+
+If your targets produce artifacts, like packages or coverage reports, you can publish those directly from the target definition:
+
+```csharp
+Target Pack => _ => _
+ .Produces(PackagesDirectory / "*.nupkg")
+ .Executes(() => { /* Implementation */ });
+```
+
+
+Generated output
+
+```kotlin title=".teamcity/settings.kts"
+object Pack : BuildType({
+ artifactRules = "output/packages/*.nupkg => output/packages"
+}
+```
+
+
+After your build has finished, those artifacts will be listed under the artifacts tab:
+
+
+
+
+
+
+
+### Importing Secrets
+
+If you want to use [secret variables](https://www.jetbrains.com/help/teamcity/storing-project-settings-in-version-control.html#Storing+Secure+Settings) from your TeamCity project, you can use the `ImportSecrets` property and `TeamCityToken` attribute to automatically load them into a [secret parameter](../02-fundamentals/06-parameters.md#secret-parameters) defined in your build:
+
+```csharp title="Build.cs"
+[TeamCity(
+ // ...
+ ImportSecrets = new[] { nameof(NuGetApiKey) })]
+[TeamCityToken(nameof(NuGetApiKey), "")]
+class Build : NukeBuild
+{
+ [Parameter] [Secret] readonly string NuGetApiKey;
+}
+```
+
+
+Generated output
+
+```yaml title=".teamcity/settings.kts"
+project {
+ params {
+ password (
+ "env.NuGetApiKey",
+ label = "NuGetApiKey",
+ value = "credentialsJSON:",
+ display = ParameterDisplay.HIDDEN)
+ }
+}
+```
+
+
+
+:::note
+If you're facing any issues, make sure that the name in the TeamCity settings is the same as generated into the pipelines file.
+:::
+
+## Using Credentials
+
+For every build run, TeamCity generates a pair of [one-time credentials](https://www.jetbrains.com/help/teamcity/rest/teamcity-rest-api-documentation.html#REST+Authentication) that you can use to authenticate with the [TeamCity API](https://www.jetbrains.com/help/teamcity/rest/teamcity-rest-api-documentation.html):
+
+```csharp title="Build.cs"
+class Build : NukeBuild
+{
+ TeamCity TeamCity => TeamCity.Instance;
+
+ Target Request => _ => _
+ .Executes(() =>
+ {
+ Log.Information("UserId = {UserId}", TeamCity.AuthUserId);
+ Log.Information("Password = {Password}", TeamCity.AuthPassword);
+ });
+}
+```
diff --git a/docs/06-global-tool/00-shell-completion.md b/docs/06-global-tool/00-shell-completion.md
new file mode 100644
index 000000000..0194549b0
--- /dev/null
+++ b/docs/06-global-tool/00-shell-completion.md
@@ -0,0 +1,79 @@
+---
+title: Shell Completion
+---
+
+import AsciinemaPlayer from '@site/src/components/AsciinemaPlayer';
+
+Typing long target names or parameters can be tedious and error-prone. The global tool helps you to invoke commands more quickly and without any typos, similar to [tab completion for the .NET CLI](https://learn.microsoft.com/en-us/dotnet/core/tools/enable-tab-autocomplete).
+
+:::info
+The shell completion feature relies on the presence of an up-to-date `.nuke/build.schema.json` file. This file is updated with every execution of your build project.
+
+Whenever you add or change one of your targets or parameters, it is recommended to trigger your build once, for instance by calling `nuke --help`.
+:::
+
+## Configuration
+
+Add the following snippets to the configuration file of your shell:
+
+
+
+
+```powershell title="Microsoft.PowerShell_profile.ps1"
+Register-ArgumentCompleter -Native -CommandName nuke -ScriptBlock {
+ param($commandName, $wordToComplete, $cursorPosition)
+ nuke :complete "$wordToComplete" | ForEach-Object {
+ [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
+ }
+}
+```
+
+
+
+
+```bash title=".zshrc"
+_nuke_zsh_complete()
+{
+ local completions=("$(nuke :complete "$words")")
+ reply=( "${(ps:\n:)completions}" )
+}
+compctl -K _nuke_zsh_complete nuke
+```
+
+
+
+
+```bash title=".bashrc"
+_nuke_bash_complete()
+{
+ local word=${COMP_WORDS[COMP_CWORD]}
+ local completions="$(nuke :complete "${COMP_LINE}")"
+ COMPREPLY=( $(compgen -W "$completions" -- "$word") )
+}
+complete -f -F _nuke_bash_complete nuke
+```
+
+
+
+
+```bash title="config.fish"
+complete -fc nuke --arguments '(nuke :complete (commandline -cp))'
+```
+
+
+
+
+## Usage
+
+You can complete targets, parameters, and enumeration values by hitting the TAB key:
+
+
+
+
diff --git a/docs/06-global-tool/01-packages.md b/docs/06-global-tool/01-packages.md
new file mode 100644
index 000000000..ef894d17f
--- /dev/null
+++ b/docs/06-global-tool/01-packages.md
@@ -0,0 +1,68 @@
+---
+title: Adding NuGet Packages
+---
+
+In many cases, build automation relies on third-party tools. NUKE provides you with a great [API for working with CLI tools](../03-common/08-cli-tools.md), however, it is the responsibility of a build project to reference these tools in the form of NuGet packages and define their exact versions.
+
+You can add a NuGet package to a build project by calling:
+
+```powershell
+# terminal-command
+nuke :add-package [--version ]
+```
+
+:::info
+When no version is provided, the latest version will be used. The major benefit compared to the `dotnet add package` command is that NUKE will automatically determine if the package should be referenced through `PackageReference`, i.e. as a normal library, or through `PackageDownload`, i.e. [without affecting the dependency resolution graph](https://github.com/NuGet/Home/wiki/%5BSpec%5D-PackageDownload-support#solution):
+
+
+
+
+```xml title="_build.csproj"
+
+
+
+
+
+
+
+```
+
+
+
+
+```xml title="_build.csproj"
+
+
+
+
+
+
+
+```
+
+
+
+
+:::
+
+## NuGet.org Instruction Tab
+
+If you're browsing NuGet packages on [NuGet.org](https://nuget.org), you can also use the dedicated instruction tab to quickly copy the `add-package` command for the respective tool and version (only for global tools):
+
+
+
+
+
+
+
+[//]: # (NuGet Package Installation for NUKE projects)
+
+:::tip
+When you're using a CLI task that depends on a NuGet package that is not yet installed, for instance `coverlet.console`, you will receive an error message with the appropriate `add-package` command:
+
+```text
+Missing package reference/download.
+Run one of the following commands to install the package:
+ - nuke :add-package coverlet.console --version 3.1.0
+```
+:::
diff --git a/docs/06-global-tool/02-secrets.md b/docs/06-global-tool/02-secrets.md
new file mode 100644
index 000000000..bad4a7cfe
--- /dev/null
+++ b/docs/06-global-tool/02-secrets.md
@@ -0,0 +1,62 @@
+---
+title: Managing Secrets
+---
+
+import AsciinemaPlayer from '@site/src/components/AsciinemaPlayer';
+
+Historically, secret values like passwords or auth-tokens are often saved as environment variables on local machines or CI/CD servers. This imposes both, security issues because other processes can access these environment variables and inconveniences when a build must be executed locally for emergency reasons (server downtime). NUKE has an integrated encryption utility, which can be used to save and load secret values to and from [parameter files](../02-fundamentals/06-parameters.md#passing-values-through-parameter-files).
+
+:::danger
+Our [custom encryption utility](https://github.com/nuke-build/nuke/blob/develop/source/Nuke.Common/Utilities/EncryptionUtility.cs) is provided "AS IS" without warranty of any kind.
+
+The implementation uses your password, a static salt, 10.000 iterations, and SHA256 to generate a [key-derivation function](https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.rfc2898derivebytes) ([RFC2898](https://datatracker.ietf.org/doc/html/rfc2898)), which is then used to create a crypto-stream to encrypt and decrypt values via [Advanced Encryption Standard (AES)](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard).
+
+**Please review the implementation carefully and [contact us](mailto:info@nuke.build) about any possible flaws.**
+:::
+
+## Adding & Updating Secrets
+
+You can start managing your secrets by calling:
+
+```powershell
+# terminal-command
+nuke :secrets [profile]
+```
+
+When your parameter file does not contain secrets yet, you'll be prompted to choose a password. Otherwise, you have to provide the original password chosen.
+
+:::tip
+On macOS you can also choose to generate a password and save it to your [keychain](https://support.apple.com/guide/mac-help/use-keychains-to-store-passwords-mchlf375f392/mac) in order to profit from native security tooling.
+
+
+
+
+
+
+:::
+
+Afterwards, you can choose from a list of secret parameters, to either set or update their values, and finally accept or discard your changes:
+
+
+
+
+
+When secrets are saved to a parameters file, they are prefixed with `v1:` to indicate the underlying encryption method:
+
+```json title=".nuke/parameters.json"
+{
+ "$schema": "./build.schema.json",
+ "NuGetApiKey": "v1:4VDyDmFs4Pf6IX8UvosDdjOgb23g0IXs0aP/MBqOK+K6TB8JuthtPgRUrUsi9tLD"
+}
+```
+
+## Removing Secrets
+
+If you want to delete a secret, you can simply remove it from the parameters file. In the event of a lost password, you have to remove all secrets and re-populate the parameters file via `nuke :secrets`.
diff --git a/docs/06-global-tool/03-navigation.md b/docs/06-global-tool/03-navigation.md
new file mode 100644
index 000000000..f6003e510
--- /dev/null
+++ b/docs/06-global-tool/03-navigation.md
@@ -0,0 +1,31 @@
+---
+title: Navigation
+---
+
+Over time, you might accumulate more and more projects that are built using NUKE. Some of these might even form a hierarchical structure, where one root directory contains several other root directories, and so on.
+
+## Configuration
+
+Add the following functions to your shell configuration (similar as for [shell completion](00-shell-completion.md)):
+
+```
+function nuke/ { nuke :PushWithChosenRootDirectory; cd $(nuke :GetNextDirectory) }
+function nuke. { nuke :PushWithCurrentRootDirectory; cd $(nuke :GetNextDirectory) }
+function nuke.. { nuke :PushWithParentRootDirectory; cd $(nuke :GetNextDirectory) }
+function nuke- { nuke :PopDirectory; cd $(nuke :GetNextDirectory) }
+```
+
+## Usage
+
+The global tool comes with a handful of functions for improved navigation:
+
+| Command | Function |
+|:---------|:-----------------------------------------------|
+| `nuke.` | Navigates to the current root directory |
+| `nuke..` | Navigates to the parent root directory |
+| `nuke/` | Lists subdirectories that are root directories |
+| `nuke-` | Navigates to the last root directory |
+
+:::note
+The `nuke-` command is only supported on shells that set the `TERM_SESSION_ID` or `WT_SESSION` environment variable. As of now, this includes [iTerm](https://iterm2.com/) and the [Windows Terminal](https://github.com/microsoft/terminal).
+:::
diff --git a/docs/06-global-tool/04-cake.md b/docs/06-global-tool/04-cake.md
new file mode 100644
index 000000000..3c4afed8d
--- /dev/null
+++ b/docs/06-global-tool/04-cake.md
@@ -0,0 +1,38 @@
+---
+title: Converting from Cake
+---
+
+Over the years, the .NET community has come up with a lot of great build automation tools, including [FAKE](https://fake.build/), [Cake](https://cakebuild.net/), [FlubuCore](https://flubucore.dotnetcore.xyz/), and [BullsEye](https://github.com/adamralph/bullseye). When coming from Cake Scripting, the time for converting build scripts can be greatly reduced with a best-effort approach using [Roslyn](https://github.com/dotnet/roslyn) and its [syntax transformation](https://docs.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/get-started/syntax-transformation) capabilities.
+
+:::caution
+The resulting source code is **expected to contain compilation errors** since there is no direct API mapping between Cake and NUKE. Most notably, the order of `IsDependentOn` on a single target in Cake reflects the order of execution of these dependencies, whereas in NUKE the dependencies are solely defined between the individual targets.
+:::
+
+## Conversion
+
+You can start the conversion by calling:
+
+```powershell
+# terminal-command
+nuke :cake-convert
+```
+
+The global tool searches for all `*.cake` and converts them to `*.cs` files. During this process it transforms:
+
+- Target definitions
+- Default targets
+- Parameter declarations
+- Path usages
+- Globbing patterns
+- Tool invocations
+
+Additionally β if you choose to create a build project file β it will collect NuGet packages from `#addin` and `#tool` directives, and add them as `PackageReference` and `PackageDownload` respectively.
+
+## Cleanup
+
+After you've fully verified the conversion, you can clear all `*.cake` files by calling:
+
+```powershell
+# terminal-command
+nuke :cake-clean
+```
diff --git a/docs/06-global-tool/_category_.json b/docs/06-global-tool/_category_.json
new file mode 100644
index 000000000..0e565a5d6
--- /dev/null
+++ b/docs/06-global-tool/_category_.json
@@ -0,0 +1,3 @@
+{
+ "label": "Global Tool"
+}
diff --git a/docs/06-global-tool/nuget.png b/docs/06-global-tool/nuget.png
new file mode 100644
index 000000000..7ea0e1f17
Binary files /dev/null and b/docs/06-global-tool/nuget.png differ
diff --git a/docs/06-global-tool/nuget.webp b/docs/06-global-tool/nuget.webp
new file mode 100644
index 000000000..ec19791bc
Binary files /dev/null and b/docs/06-global-tool/nuget.webp differ
diff --git a/docs/06-global-tool/secrets-macos.png b/docs/06-global-tool/secrets-macos.png
new file mode 100644
index 000000000..12ba466c8
Binary files /dev/null and b/docs/06-global-tool/secrets-macos.png differ
diff --git a/docs/06-global-tool/secrets-macos.webp b/docs/06-global-tool/secrets-macos.webp
new file mode 100644
index 000000000..11c940ab4
Binary files /dev/null and b/docs/06-global-tool/secrets-macos.webp differ
diff --git a/docs/07-ide/_category_.json b/docs/07-ide/_category_.json
new file mode 100644
index 000000000..59bac6513
--- /dev/null
+++ b/docs/07-ide/_category_.json
@@ -0,0 +1,3 @@
+{
+ "label": "IDE Support"
+}
diff --git a/docs/07-ide/resharper-dark.png b/docs/07-ide/resharper-dark.png
new file mode 100644
index 000000000..ad306e707
Binary files /dev/null and b/docs/07-ide/resharper-dark.png differ
diff --git a/docs/07-ide/resharper-dark.webp b/docs/07-ide/resharper-dark.webp
new file mode 100644
index 000000000..7171272c9
Binary files /dev/null and b/docs/07-ide/resharper-dark.webp differ
diff --git a/docs/07-ide/resharper-light.png b/docs/07-ide/resharper-light.png
new file mode 100644
index 000000000..c4559d5fb
Binary files /dev/null and b/docs/07-ide/resharper-light.png differ
diff --git a/docs/07-ide/resharper-light.webp b/docs/07-ide/resharper-light.webp
new file mode 100644
index 000000000..75ceee095
Binary files /dev/null and b/docs/07-ide/resharper-light.webp differ
diff --git a/docs/07-ide/resharper.md b/docs/07-ide/resharper.md
new file mode 100644
index 000000000..d4066ea90
--- /dev/null
+++ b/docs/07-ide/resharper.md
@@ -0,0 +1,16 @@
+---
+title: ReSharper
+---
+
+import InstallButton from '@site/src/components/InstallButton';
+
+
+
+In [ReSharper](https://www.jetbrains.com/resharper) you can install the [NUKE Support extension](https://plugins.jetbrains.com/plugin/11804-nuke-support) to be more productive in writing, running, and debugging your builds.
+
+You can click the gutter icon next to your targets or hit Alt + Enter from inside their declaration to run and debug them. The top-level item starts a normal execution including all dependencies. From the submenu, you can debug and run/debug without dependencies:
+
+
+
diff --git a/docs/07-ide/rider-macos-dark.png b/docs/07-ide/rider-macos-dark.png
new file mode 100644
index 000000000..ddc5abba4
Binary files /dev/null and b/docs/07-ide/rider-macos-dark.png differ
diff --git a/docs/07-ide/rider-macos-dark.webp b/docs/07-ide/rider-macos-dark.webp
new file mode 100644
index 000000000..55c7c3d82
Binary files /dev/null and b/docs/07-ide/rider-macos-dark.webp differ
diff --git a/docs/07-ide/rider-macos-light.png b/docs/07-ide/rider-macos-light.png
new file mode 100644
index 000000000..54a54a50a
Binary files /dev/null and b/docs/07-ide/rider-macos-light.png differ
diff --git a/docs/07-ide/rider-macos-light.webp b/docs/07-ide/rider-macos-light.webp
new file mode 100644
index 000000000..e86782896
Binary files /dev/null and b/docs/07-ide/rider-macos-light.webp differ
diff --git a/docs/07-ide/rider-win-dark.png b/docs/07-ide/rider-win-dark.png
new file mode 100644
index 000000000..d1eeaf440
Binary files /dev/null and b/docs/07-ide/rider-win-dark.png differ
diff --git a/docs/07-ide/rider-win-dark.webp b/docs/07-ide/rider-win-dark.webp
new file mode 100644
index 000000000..c846a3a53
Binary files /dev/null and b/docs/07-ide/rider-win-dark.webp differ
diff --git a/docs/07-ide/rider-win-light.png b/docs/07-ide/rider-win-light.png
new file mode 100644
index 000000000..e85b998e6
Binary files /dev/null and b/docs/07-ide/rider-win-light.png differ
diff --git a/docs/07-ide/rider-win-light.webp b/docs/07-ide/rider-win-light.webp
new file mode 100644
index 000000000..721b0666a
Binary files /dev/null and b/docs/07-ide/rider-win-light.webp differ
diff --git a/docs/07-ide/rider.md b/docs/07-ide/rider.md
new file mode 100644
index 000000000..df04b850f
--- /dev/null
+++ b/docs/07-ide/rider.md
@@ -0,0 +1,18 @@
+---
+title: JetBrains Rider
+sidebar_position: 1
+---
+
+import RiderInstallButton from '@site/src/components/RiderInstallButton';
+
+
+
+In [JetBrains Rider](https://www.jetbrains.com/rider) you can install the [NUKE Support plugin](https://plugins.jetbrains.com/plugin/10803-nuke-support) to be more productive in writing, running, and debugging your builds.
+
+You can click the gutter icon next to your targets or hit Alt + Enter from inside their declaration to run and debug them. The top-level item starts a normal execution including all dependencies. From the submenu, you can debug and run/debug without dependencies:
+
+
+
diff --git a/docs/07-ide/visual-studio-dark.png b/docs/07-ide/visual-studio-dark.png
new file mode 100644
index 000000000..63924b420
Binary files /dev/null and b/docs/07-ide/visual-studio-dark.png differ
diff --git a/docs/07-ide/visual-studio-dark.webp b/docs/07-ide/visual-studio-dark.webp
new file mode 100644
index 000000000..65f093601
Binary files /dev/null and b/docs/07-ide/visual-studio-dark.webp differ
diff --git a/docs/07-ide/visual-studio-light.png b/docs/07-ide/visual-studio-light.png
new file mode 100644
index 000000000..ddb86f720
Binary files /dev/null and b/docs/07-ide/visual-studio-light.png differ
diff --git a/docs/07-ide/visual-studio-light.webp b/docs/07-ide/visual-studio-light.webp
new file mode 100644
index 000000000..f33e989f2
Binary files /dev/null and b/docs/07-ide/visual-studio-light.webp differ
diff --git a/docs/07-ide/visual-studio.md b/docs/07-ide/visual-studio.md
new file mode 100644
index 000000000..b447c4ac8
--- /dev/null
+++ b/docs/07-ide/visual-studio.md
@@ -0,0 +1,16 @@
+---
+title: Visual Studio
+---
+
+import InstallButton from '@site/src/components/InstallButton';
+
+
+
+In [Visual Studio](https://visualstudio.microsoft.com/) you can install the [NUKE Support extension](https://marketplace.visualstudio.com/items?itemName=nuke.visualstudio) to be more productive in writing, running, and debugging your builds.
+
+From the _Task Runner Explorer_, you can double-click a target to run it. Additionally, you can use toggle buttons to attach the debugger or skip dependencies:
+
+
+
diff --git a/docs/07-ide/vscode-macos-dark.png b/docs/07-ide/vscode-macos-dark.png
new file mode 100644
index 000000000..11452400d
Binary files /dev/null and b/docs/07-ide/vscode-macos-dark.png differ
diff --git a/docs/07-ide/vscode-macos-dark.webp b/docs/07-ide/vscode-macos-dark.webp
new file mode 100644
index 000000000..0d15bc666
Binary files /dev/null and b/docs/07-ide/vscode-macos-dark.webp differ
diff --git a/docs/07-ide/vscode-macos-light.png b/docs/07-ide/vscode-macos-light.png
new file mode 100644
index 000000000..04ffc9f39
Binary files /dev/null and b/docs/07-ide/vscode-macos-light.png differ
diff --git a/docs/07-ide/vscode-macos-light.webp b/docs/07-ide/vscode-macos-light.webp
new file mode 100644
index 000000000..f43a8ae99
Binary files /dev/null and b/docs/07-ide/vscode-macos-light.webp differ
diff --git a/docs/07-ide/vscode-win-dark.png b/docs/07-ide/vscode-win-dark.png
new file mode 100644
index 000000000..e500b2001
Binary files /dev/null and b/docs/07-ide/vscode-win-dark.png differ
diff --git a/docs/07-ide/vscode-win-dark.webp b/docs/07-ide/vscode-win-dark.webp
new file mode 100644
index 000000000..1c3b1fc2a
Binary files /dev/null and b/docs/07-ide/vscode-win-dark.webp differ
diff --git a/docs/07-ide/vscode-win-light.png b/docs/07-ide/vscode-win-light.png
new file mode 100644
index 000000000..2652f35b5
Binary files /dev/null and b/docs/07-ide/vscode-win-light.png differ
diff --git a/docs/07-ide/vscode-win-light.webp b/docs/07-ide/vscode-win-light.webp
new file mode 100644
index 000000000..6c00f9d50
Binary files /dev/null and b/docs/07-ide/vscode-win-light.webp differ
diff --git a/docs/07-ide/vscode.md b/docs/07-ide/vscode.md
new file mode 100644
index 000000000..e70c76b7a
--- /dev/null
+++ b/docs/07-ide/vscode.md
@@ -0,0 +1,18 @@
+---
+title: Visual Studio Code
+---
+
+import InstallButton from '@site/src/components/InstallButton';
+import ControlKey from '@site/src/components/ControlKey';
+
+
+
+In [Visual Studio Code](https://code.visualstudio.com/) you can install the [NUKE Support extension](https://marketplace.visualstudio.com/items?itemName=nuke.support) to be more productive in writing, running, and debugging your builds.
+
+Above each target, you can click the `Run Target` or `Debug Target` CodeLens items. Additionally, you can bring up the command palette via + Shift + P and call one of the actions to run/debug with/without dependencies:
+
+
+
diff --git a/docs/_snippets/Foo.js b/docs/_snippets/Foo.js
new file mode 100644
index 000000000..a612d55e9
--- /dev/null
+++ b/docs/_snippets/Foo.js
@@ -0,0 +1,24 @@
+import React from "react";
+import CodeBlock from '@theme/CodeBlock';
+
+export default function HomepageFeatures() {
+ return (
+
+ {''}using System;{'\n'}
+ {''}using System.Text.RegularExpressions;{'\n'}
+ {''}{'\n'}
+ {''}// ReSharper disable All{'\n'}
+ {''}#pragma warning disable 67{'\n'}
+ {''}#pragma warning disable 169{'\n'}
+ {''}{'\n'}
+ {''}class All{'\n'}
+ {''}{{'\n'}
+ {''} /**{'\n'}
+ {''} * let's C# how it used to be{'\n'}
+ {''} */{'\n'}
+ {''} public delegate void EventHandler(object sender, EventArgs s);{'\n'}
+ {''} public event EventHandler Event;{'\n'}
+ {''}{'\n'}
+
+ );
+}
diff --git a/docs/introduction.md b/docs/introduction.md
new file mode 100644
index 000000000..1401a8d86
--- /dev/null
+++ b/docs/introduction.md
@@ -0,0 +1,61 @@
+---
+title: Introduction
+sidebar_position: 0
+---
+
+
+
+πͺ΄ Write **automation tools and CI/CD pipelines** in plain C# and with access to all .NET libraries.
+
+πΈ Tedious commit cycles are expensive. Instead, **debug and test your builds locally**.
+
+π‘ Install one of the **support extensions** for Visual Studio, Rider, ReSharper, or VS Code.
+
+π₯ Ready for more? Use **advanced features** like CI/CD generation, parallel execution, and build sharing.
+
+## Fast Track β± {#fast-track}
+
+**1. Install the global tool:**
+
+```powershell
+# terminal-command
+dotnet tool install Nuke.GlobalTool --global
+```
+
+**2. Go to a repository of your choice and set up a build:**
+
+```powershell
+# terminal-command
+nuke :setup
+```
+
+**3. Run the build:**
+
+```powershell
+# terminal-command
+nuke
+```
+
+**4. Open the build project and explore the default `Build` class.**
+
+## Coming from Cake? π° {#coming-from-cake}
+
+Get a feeling how your Cake scripts would look like in NUKE.
+
+**1. Install the global tool:**
+
+```powershell
+# terminal-command
+dotnet tool install Nuke.GlobalTool --global
+```
+
+**2. Go to a repository built with Cake.**
+
+**3. Convert your Cake scripts:**
+
+```powershell
+# terminal-command
+nuke :cake-convert
+```
+
+**4. Inspect the outcome (errors are expected).**
diff --git a/source/Nuke.Common.Tests/ChangelogTasksTest.cs b/source/Nuke.Common.Tests/ChangelogTasksTest.cs
index 3f7f265d9..74f9434b7 100644
--- a/source/Nuke.Common.Tests/ChangelogTasksTest.cs
+++ b/source/Nuke.Common.Tests/ChangelogTasksTest.cs
@@ -13,127 +13,128 @@
using VerifyXunit;
using Xunit;
-namespace Nuke.Common.Tests
+// ReSharper disable ReturnValueOfPureMethodIsNotUsed
+
+namespace Nuke.Common.Tests;
+
+[UsesVerify]
+public class ChangelogTasksTest
{
- [UsesVerify]
- public class ChangelogTasksTest
+ private static AbsolutePath RootDirectory => Constants.TryGetRootDirectoryFrom(EnvironmentInfo.WorkingDirectory).NotNull();
+
+ private static AbsolutePath PathToChangelogReferenceFiles => RootDirectory / "source" / "Nuke.Common.Tests" / "ChangelogReferenceFiles";
+
+ [Theory]
+ [MemberData(nameof(AllChangelogReference_1_0_0_Files))]
+ [MemberData(nameof(AllChangelogReference_NUKE_Files))]
+ public void ReadReleaseNotes_ChangelogReferenceFile_ThrowsNoExceptions(AbsolutePath file)
+ {
+ Action act = () => ChangelogTasks.ReadReleaseNotes(file);
+
+ act.Should().NotThrow();
+ }
+
+ [Theory]
+ [MemberData(nameof(AllChangelogReference_1_0_0_Files))]
+ [MemberData(nameof(AllChangelogReference_NUKE_Files))]
+ public void ReadReleaseNotes_ChangelogReferenceFile_ReturnsAnyReleaseNotes(AbsolutePath file)
+ {
+ var releaseNotes = ChangelogTasks.ReadReleaseNotes(file);
+
+ releaseNotes.Should().NotBeEmpty();
+ }
+
+ [Theory]
+ [MemberData(nameof(AllChangelogReference_1_0_0_Files))]
+ [MemberData(nameof(AllChangelogReference_NUKE_Files))]
+ public void ReadChangelog_ChangelogReferenceFile_ThrowsNoExceptions(AbsolutePath file)
+ {
+ Action act = () => ChangelogTasks.ReadChangelog(file);
+
+ act.Should().NotThrow();
+ }
+
+ [Theory]
+ [MemberData(nameof(AllChangelogReference_1_0_0_Files))]
+ [MemberData(nameof(AllChangelogReference_NUKE_Files))]
+ public void ExtractChangelogSectionNotes_ChangelogReferenceFile_ThrowsNoExceptions(AbsolutePath file)
+ {
+ Action act = () => ChangelogTasks.ExtractChangelogSectionNotes(file);
+
+ act.Should().NotThrow();
+ }
+
+ [Theory]
+ [MemberData(nameof(AllChangelogReference_1_0_0_Files))]
+ [MemberData(nameof(AllChangelogReference_NUKE_Files))]
+ public Task ReadReleaseNotes_ChangelogReferenceFile_HasParsedCorrectly(AbsolutePath file)
+ {
+ var releaseNotes = ChangelogTasks.ReadReleaseNotes(file);
+
+ return Verifier.Verify(releaseNotes).UseDirectory(PathToChangelogReferenceFiles).UseFileName(file.NameWithoutExtension);
+ }
+
+ [Fact]
+ public void GetReleaseSections_ChangelogReferenceFileWithoutReleaseHead_ReturnsEmpty()
{
- private static AbsolutePath RootDirectory => Constants.TryGetRootDirectoryFrom(EnvironmentInfo.WorkingDirectory).NotNull();
-
- private static AbsolutePath PathToChangelogReferenceFiles => RootDirectory / "source" / "Nuke.Common.Tests" / "ChangelogReferenceFiles";
-
- [Theory]
- [MemberData(nameof(AllChangelogReference_1_0_0_Files))]
- [MemberData(nameof(AllChangelogReference_NUKE_Files))]
- public void ReadReleaseNotes_ChangelogReferenceFile_ThrowsNoExceptions(AbsolutePath file)
- {
- Action act = () => ChangelogTasks.ReadReleaseNotes(file);
-
- act.Should().NotThrow();
- }
-
- [Theory]
- [MemberData(nameof(AllChangelogReference_1_0_0_Files))]
- [MemberData(nameof(AllChangelogReference_NUKE_Files))]
- public void ReadReleaseNotes_ChangelogReferenceFile_ReturnsAnyReleaseNotes(AbsolutePath file)
- {
- var releaseNotes = ChangelogTasks.ReadReleaseNotes(file);
-
- releaseNotes.Should().NotBeEmpty();
- }
-
- [Theory]
- [MemberData(nameof(AllChangelogReference_1_0_0_Files))]
- [MemberData(nameof(AllChangelogReference_NUKE_Files))]
- public void ReadChangelog_ChangelogReferenceFile_ThrowsNoExceptions(AbsolutePath file)
- {
- Action act = () => ChangelogTasks.ReadChangelog(file);
-
- act.Should().NotThrow();
- }
-
- [Theory]
- [MemberData(nameof(AllChangelogReference_1_0_0_Files))]
- [MemberData(nameof(AllChangelogReference_NUKE_Files))]
- public void ExtractChangelogSectionNotes_ChangelogReferenceFile_ThrowsNoExceptions(AbsolutePath file)
- {
- Action act = () => ChangelogTasks.ExtractChangelogSectionNotes(file);
-
- act.Should().NotThrow();
- }
-
- [Theory]
- [MemberData(nameof(AllChangelogReference_1_0_0_Files))]
- [MemberData(nameof(AllChangelogReference_NUKE_Files))]
- public Task ReadReleaseNotes_ChangelogReferenceFile_HasParsedCorrectly(AbsolutePath file)
- {
- var releaseNotes = ChangelogTasks.ReadReleaseNotes(file);
-
- return Verifier.Verify(releaseNotes).UseDirectory(PathToChangelogReferenceFiles).UseFileName(file.NameWithoutExtension);
- }
-
- [Fact]
- public void GetReleaseSections_ChangelogReferenceFileWithoutReleaseHead_ReturnsEmpty()
- {
- var file = PathToChangelogReferenceFiles / "changelog_reference_invalid_variant_1.md";
- var lines = file.ReadAllLines().ToList();
-
- ChangelogTasks.GetReleaseSections(lines).Should().BeEmpty();
- }
-
- [Theory]
- [InlineData("changelog_reference_1.0.0_variant_5.md", "0.2.3")]
- public Task ExtractChangelogSectionNotes_WithTag_ReturnsSectionThatMatchesProvidedTag(string fileName, string tag)
- {
- var changeLogFilePath = PathToChangelogReferenceFiles / fileName;
- var sectionNotes = ChangelogTasks.ExtractChangelogSectionNotes(changeLogFilePath, tag);
-
- return Verifier.Verify(sectionNotes).UseDirectory(PathToChangelogReferenceFiles)
- .UseFileName($"{changeLogFilePath.NameWithoutExtension}_section_{tag}");
- }
-
- [Theory]
- [InlineData("changelog_reference_1.0.0_variant_5.md", "0.0.0")]
- [InlineData("changelog_reference_1.0.0_variant_5.md", "9.9.9")]
- public void ExtractChangelogSection_WithNonExistingTag_ThrowsInformativeException(string fileName, string tag)
- {
- var file = PathToChangelogReferenceFiles / fileName;
-
- Action act = () => ChangelogTasks.ExtractChangelogSectionNotes(file, tag);
-
- act.Should().Throw().WithMessage($"Could not find release section for '{tag}'.");
- }
-
- [Theory]
- [InlineData("changelog_reference_invalid_variant_2.md")]
- public void ReadChangelog_ChangelogFileThatHasMultipleUnreleasedSection_ThrowsInformativeException(string fileName)
- {
- var file = PathToChangelogReferenceFiles / fileName;
-
- Action act = () => ChangelogTasks.ReadChangelog(file);
-
- act.Should().Throw().WithMessage("Changelog should have only one draft section");
- }
-
- [Theory]
- [InlineData("changelog_reference_invalid_variant_1.md")]
- public void ReadChangelog_EmptyChangelogFile_ThrowsInformativeException(string fileName)
- {
- var file = PathToChangelogReferenceFiles / fileName;
-
- Action act = () => ChangelogTasks.ReadChangelog(file);
-
- act.Should().Throw().WithMessage("Changelog should have at least one release note section");
- }
-
- [UsedImplicitly]
- public static IEnumerable AllChangelogReference_1_0_0_Files
- {
- get => PathToChangelogReferenceFiles.GlobFiles("changelog_reference_1.0.0*.md").Select(x => new object[] { x });
- }
-
- [UsedImplicitly]
- public static IEnumerable AllChangelogReference_NUKE_Files
- => PathToChangelogReferenceFiles.GlobFiles("changelog_reference_NUKE*.md").Select(x => new object[] { x });
+ var file = PathToChangelogReferenceFiles / "changelog_reference_invalid_variant_1.md";
+ var lines = file.ReadAllLines().ToList();
+
+ ChangelogTasks.GetReleaseSections(lines).Should().BeEmpty();
+ }
+
+ [Theory]
+ [InlineData("changelog_reference_1.0.0_variant_5.md", "0.2.3")]
+ public Task ExtractChangelogSectionNotes_WithTag_ReturnsSectionThatMatchesProvidedTag(string fileName, string tag)
+ {
+ var changeLogFilePath = PathToChangelogReferenceFiles / fileName;
+ var sectionNotes = ChangelogTasks.ExtractChangelogSectionNotes(changeLogFilePath, tag);
+
+ return Verifier.Verify(sectionNotes).UseDirectory(PathToChangelogReferenceFiles)
+ .UseFileName($"{changeLogFilePath.NameWithoutExtension}_section_{tag}");
+ }
+
+ [Theory]
+ [InlineData("changelog_reference_1.0.0_variant_5.md", "0.0.0")]
+ [InlineData("changelog_reference_1.0.0_variant_5.md", "9.9.9")]
+ public void ExtractChangelogSection_WithNonExistingTag_ThrowsInformativeException(string fileName, string tag)
+ {
+ var file = PathToChangelogReferenceFiles / fileName;
+
+ Action act = () => ChangelogTasks.ExtractChangelogSectionNotes(file, tag);
+
+ act.Should().Throw().WithMessage($"Could not find release section for '{tag}'.");
+ }
+
+ [Theory]
+ [InlineData("changelog_reference_invalid_variant_2.md")]
+ public void ReadChangelog_ChangelogFileThatHasMultipleUnreleasedSection_ThrowsInformativeException(string fileName)
+ {
+ var file = PathToChangelogReferenceFiles / fileName;
+
+ Action act = () => ChangelogTasks.ReadChangelog(file);
+
+ act.Should().Throw().WithMessage("Changelog should have only one draft section");
+ }
+
+ [Theory]
+ [InlineData("changelog_reference_invalid_variant_1.md")]
+ public void ReadChangelog_EmptyChangelogFile_ThrowsInformativeException(string fileName)
+ {
+ var file = PathToChangelogReferenceFiles / fileName;
+
+ Action act = () => ChangelogTasks.ReadChangelog(file);
+
+ act.Should().Throw().WithMessage("Changelog should have at least one release note section");
+ }
+
+ [UsedImplicitly]
+ public static IEnumerable AllChangelogReference_1_0_0_Files
+ {
+ get => PathToChangelogReferenceFiles.GlobFiles("changelog_reference_1.0.0*.md").Select(x => new object[] { x });
}
+
+ [UsedImplicitly]
+ public static IEnumerable AllChangelogReference_NUKE_Files
+ => PathToChangelogReferenceFiles.GlobFiles("changelog_reference_NUKE*.md").Select(x => new object[] { x });
}
diff --git a/source/Nuke.Common/Tools/MSpec/MSpec.json b/source/Nuke.Common/Tools/MSpec/MSpec.json
index 0d19beaa7..1bbfcbd2a 100644
--- a/source/Nuke.Common/Tools/MSpec/MSpec.json
+++ b/source/Nuke.Common/Tools/MSpec/MSpec.json
@@ -23,34 +23,34 @@
{
"name": "Filters",
"type": "List",
- "format": "-f={value}",
+ "format": "-filters {value}",
"separator": ",",
"help": "Filter file specifying contexts to execute (full type name, one per line). Takes precedence over tags."
},
{
"name": "Includes",
"type": "List",
- "format": "-i={value}",
+ "format": "-include {value}",
"separator": ",",
"help": "Executes all specifications in contexts with these comma delimited tags. Ex. -i 'foo, bar, foo_bar'."
},
{
"name": "Excludes",
"type": "List",
- "format": "-x={value}",
+ "format": "-exclude {value}",
"separator": ",",
"help": "Exclude specifications in contexts with these comma delimited tags. Ex. -x 'foo, bar, foo_bar'."
},
{
"name": "HtmlOutput",
"type": "string",
- "format": "--html={value}",
+ "format": "--html {value}",
"help": "Outputs the HTML report to path, one-per-assembly w/ index.html (if directory, otherwise all are in one file). Ex. --html=output/reports/"
},
{
"name": "XmlOutput",
"type": "string",
- "format": "--xml={value}",
+ "format": "--xml {value}",
"help": "Outputs the XML report to the file referenced by the path. Ex. --xml=output/reports/MSpecResults.xml"
},
{
diff --git a/source/Nuke.Common/Tools/SqlPackage/SqlPackage.json b/source/Nuke.Common/Tools/SqlPackage/SqlPackage.json
new file mode 100644
index 000000000..3d36101d5
--- /dev/null
+++ b/source/Nuke.Common/Tools/SqlPackage/SqlPackage.json
@@ -0,0 +1,3145 @@
+{
+ "$schema": "https://raw.githubusercontent.com/nuke-build/nuke/master/source/Nuke.Tooling.Generator/schema.json",
+ "references": [
+ "https://github.com/MicrosoftDocs/sql-docs/blob/live/docs/tools/sqlpackage/sqlpackage-deploy-drift-report.md",
+ "https://github.com/MicrosoftDocs/sql-docs/blob/live/docs/tools/sqlpackage/sqlpackage-download.md",
+ "https://github.com/MicrosoftDocs/sql-docs/blob/live/docs/tools/sqlpackage/sqlpackage-export.md",
+ "https://github.com/MicrosoftDocs/sql-docs/blob/live/docs/tools/sqlpackage/sqlpackage-extract.md",
+ "https://github.com/MicrosoftDocs/sql-docs/blob/live/docs/tools/sqlpackage/sqlpackage-for-azure-synapse-analytics.md",
+ "https://github.com/MicrosoftDocs/sql-docs/blob/live/docs/tools/sqlpackage/sqlpackage-pipelines.md",
+ "https://github.com/MicrosoftDocs/sql-docs/blob/live/docs/tools/sqlpackage/sqlpackage-publish.md",
+ "https://github.com/MicrosoftDocs/sql-docs/blob/live/docs/tools/sqlpackage/sqlpackage-script.md"
+ ],
+ "name": "SqlPackage",
+ "officialUrl": "https://learn.microsoft.com/en-us/sql/tools/sqlpackage/sqlpackage",
+ "help": "SqlPackage is a command-line utility that automates the following database development tasks by exposing some of the public Data-Tier Application Framework (DacFx) APIs",
+ "packageExecutable": "sqlpackage.exe",
+ "tasks": [
+ {
+ "postfix": "Version",
+ "definiteArgument": "/Version",
+ "officialUrl": "https://learn.microsoft.com/en-us/sql/tools/sqlpackage/sqlpackage?view=sql-server-ver16#version",
+ "settingsClass": {}
+ },
+ {
+ "help": "The SqlPackage publish operation incrementally updates the schema of a target database to match the structure of a source database. Publishing a deployment package that contains user data for all or a subset of tables update the table data in addition to the schema. Data deployment overwrites the schema and data in existing tables of the target database. Data deployment will not change existing schema or data in the target database for tables not included in the deployment package. A new database can be created by the publish action when the authenticated user has create database permissions. The required permissions for the publish action on an existing database is db_owner.
",
+ "postfix": "Publish",
+ "definiteArgument": "/Action:Publish",
+ "officialUrl": "https://learn.microsoft.com/en-us/sql/tools/sqlpackage/sqlpackage-publish",
+ "settingsClass": {
+ "properties": [
+ {
+ "name": "AccessToken",
+ "type": "string",
+ "format": "/AccessToken:{value}",
+ "help": "Specifies the token-based authentication access token to use when connect to the target database."
+ },
+ {
+ "name": "AzureCloudConfig",
+ "type": "string",
+ "format": "/AzureCloudConfig:{value}",
+ "help": "Specifies the custom endpoints for connecting to Azure Active Directory in the format: AzureActiveDirectoryAuthority={value};DatabaseServicePrincipalName={value}\" ."
+ },
+ {
+ "name": "AzureKeyVaultAuthMethod",
+ "type": "AzureKeyVaultAuthMethod",
+ "format": "/AzureKeyVaultAuthMethod:{value}",
+ "help": "Specifies what authentication method is used for accessing Azure KeyVault if a publish operation includes modifications to an encrypted table/column."
+ },
+ {
+ "name": "ClientId",
+ "type": "string",
+ "format": "/ClientId:{value}",
+ "help": "Specifies the Client ID to be used in authenticating against Azure KeyVault, when necessary"
+ },
+ {
+ "name": "DeployReportPath",
+ "type": "string",
+ "format": "/DeployReportPath:{value}",
+ "help": "Specifies an optional file path to output the deployment report xml file."
+ },
+ {
+ "name": "DeployScriptPath",
+ "type": "string",
+ "format": "/DeployScriptPath:{value}",
+ "help": "Specifies an optional file path to output the deployment script. For Azure deployments, if there are TSQL commands to create or modify the master database, a script will be written to the same path but with \"Filename_Master.sql\" as the output file name."
+ },
+ {
+ "name": "Diagnostics",
+ "type": "bool",
+ "format": "/Diagnostics:{value}",
+ "help": "Specifies whether diagnostic logging is output to the console. Defaults to False."
+ },
+ {
+ "name": "DiagnosticsFile",
+ "type": "string",
+ "format": "/DiagnosticsFile:{value}",
+ "help": "Specifies a file to store diagnostic logs."
+ },
+ {
+ "name": "MaxParallelism",
+ "type": "int",
+ "format": "/MaxParallelism:{value}",
+ "help": "Specifies the degree of parallelism for concurrent operations running against a database. The default value is 8."
+ },
+ {
+ "name": "ModelFilePath",
+ "type": "string",
+ "format": "/ModelFilePath:{value}",
+ "help": "Specifies the file path to override the model.xml in the source file. Use of this setting may result in deployment failure and/or unintended data loss. This setting is intended only for use when troubleshooting issues with publish, import, or script generation."
+ },
+ {
+ "name": "OverwriteFiles",
+ "type": "bool",
+ "format": "/OverwriteFiles:{value}",
+ "help": "Specifies if SqlPackage should overwrite existing files. Specifying false causes SqlPackage to abort action if an existing file is encountered. Default value is True."
+ },
+ {
+ "name": "Profile",
+ "type": "string",
+ "format": "/Profile:{value}",
+ "help": "Specifies the file path to a DAC Publish Profile. The profile defines a collection of properties and variables to use when generating outputs."
+ },
+ {
+ "name": "Properties",
+ "type": "Dictionary",
+ "format": "/p:{value}",
+ "itemFormat": "{key}={value}",
+ "help": "Specifies a name value pair for an [action-specific property](#properties-specific-to-the-publish-action);{PropertyName}={Value}.",
+ "delegates": [
+ {
+ "name": "AdditionalDeploymentContributorArguments",
+ "type": "List",
+ "separator": ";",
+ "help": "Specifies additional deployment contributor arguments for the deployment contributors. This property should be a semi-colon delimited list of values."
+ },
+ {
+ "name": "AdditionalDeploymentContributorPaths",
+ "type": "List",
+ "separator": ";",
+ "help": "Specifies paths to load additional deployment contributors. This property should be a semi-colon delimited list of values."
+ },
+ {
+ "name": "AdditionalDeploymentContributors",
+ "type": "List",
+ "separator": ";",
+ "help": "Specifies additional deployment contributors, which should run when the dacpac is deployed. This property should be a semi-colon delimited list of fully qualified build contributor names or IDs."
+ },
+ {
+ "name": "AllowDropBlockingAssemblies",
+ "type": "bool",
+ "help": "This property is used by SqlClr deployment to cause any blocking assemblies to be dropped as part of the deployment plan. By default, any blocking/referencing assemblies will block an assembly update if the referencing assembly needs to be dropped."
+ },
+ {
+ "name": "AllowExternalLanguagePaths",
+ "type": "bool",
+ "help": "Allows file paths, if available, to be used to generate external language statements."
+ },
+ {
+ "name": "AllowExternalLibraryPaths",
+ "type": "bool",
+ "help": "Allows file paths, if available, to be used to generate external library statements."
+ },
+ {
+ "name": "AllowIncompatiblePlatform",
+ "type": "bool",
+ "help": "Specifies whether to attempt the action despite incompatible SQL Server platforms."
+ },
+ {
+ "name": "AllowUnsafeRowLevelSecurityDataMovement",
+ "type": "bool",
+ "help": "Do not block data motion on a table that has Row Level Security if this property is set to true. Default is false."
+ },
+ {
+ "name": "AzureSharedAccessSignatureToken",
+ "type": "string",
+ "help": "Azure shared access signature (SAS) token. See [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#publish-import-data)."
+ },
+ {
+ "name": "AzureStorageBlobEndpoint",
+ "type": "string",
+ "help": "Azure Blob Storage endpoint, see [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#publish-import-data)."
+ },
+ {
+ "name": "AzureStorageContainer",
+ "type": "string",
+ "help": "Azure Blob Storage container, see [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#publish-import-data)."
+ },
+ {
+ "name": "AzureStorageKey",
+ "type": "string",
+ "help": "Azure storage account key, see [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#publish-import-data)."
+ },
+ {
+ "name": "AzureStorageRootPath",
+ "type": "string",
+ "help": "Storage root path within the container. Without this property, the path defaults to `servername/databasename/timestamp/`. See [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#publish-import-data)."
+ },
+ {
+ "name": "BackupDatabaseBeforeChanges",
+ "type": "bool",
+ "help": "Backups the database before deploying any changes. This property is not applicable to Azure SQL Database."
+ },
+ {
+ "name": "BlockOnPossibleDataLoss",
+ "type": "bool",
+ "help": "Specifies that the operation will be terminated during the schema validation step if the resulting schema changes could incur a loss of data, including due to data precision reduction or a data type change that requires a cast operation. The default (`True`) value causes the operation to terminate regardless if the target database contains data. An execution with a `False` value for BlockOnPossibleDataLoss can still fail during deployment plan execution if data is present on the target that cannot be converted to the new column type."
+ },
+ {
+ "name": "BlockWhenDriftDetected",
+ "type": "bool",
+ "help": "Specifies whether to block updating a database whose schema no longer matches its registration or is unregistered."
+ },
+ {
+ "name": "CommandTimeout",
+ "type": "int",
+ "help": "Specifies the command timeout in seconds when executing queries against SQL Server."
+ },
+ {
+ "name": "CommentOutSetVarDeclarations",
+ "type": "bool",
+ "help": "Specifies whether the declaration of SETVAR variables should be commented out in the generated publish script. You might choose to do this if you plan to specify the values on the command line when you publish by using a tool such as SQLCMD.EXE."
+ },
+ {
+ "name": "CompareUsingTargetCollation",
+ "type": "bool",
+ "help": "This setting dictates how the database's collation is handled during deployment; by default the target database's collation will be updated if it does not match the collation specified by the source. When this option is set, the target database's (or server's) collation should be used."
+ },
+ {
+ "name": "CreateNewDatabase",
+ "type": "bool",
+ "help": "Specifies whether the target database should be updated or whether it should be dropped and re-created when you publish to a database."
+ },
+ {
+ "name": "DatabaseEdition",
+ "type": "DatabaseEdition",
+ "help": "Defines the edition of an Azure SQL Database. See [Azure SQL Database service tiers](/azure/azure-sql/database/service-tiers-general-purpose-business-critical)."
+ },
+ {
+ "name": "DatabaseLockTimeout",
+ "type": "int",
+ "help": "Specifies the database lock timeout in seconds when executing queries against SQLServer. Use -1 to wait indefinitely."
+ },
+ {
+ "name": "DatabaseMaximumSize",
+ "type": "int",
+ "help": "Defines the maximum size in GB of an Azure SQL Database."
+ },
+ {
+ "name": "DatabaseServiceObjective",
+ "type": "string",
+ "help": "Defines the performance level of an Azure SQL Database such as \"P0\" or \"S1\"."
+ },
+ {
+ "name": "DeployDatabaseInSingleUserMode",
+ "type": "bool",
+ "help": "if true, the database is set to Single User Mode before deploying."
+ },
+ {
+ "name": "DisableAndReenableDdlTriggers",
+ "type": "bool",
+ "help": "Specifies whether Data Definition Language (DDL) triggers are disabled at the beginning of the publish process and re-enabled at the end of the publish action."
+ },
+ {
+ "name": "DisableIndexesForDataPhase",
+ "type": "bool",
+ "help": "Disable indexes before importing data into SQL Server."
+ },
+ {
+ "name": "DisableParallelismForEnablingIndexes",
+ "type": "bool",
+ "help": "Not using parallelism when rebuilding indexes while importing data into SQL Server."
+ },
+ {
+ "name": "DoNotAlterChangeDataCaptureObjects",
+ "type": "bool",
+ "help": "If true, Change Data Capture objects are not altered."
+ },
+ {
+ "name": "DoNotAlterReplicatedObjects",
+ "type": "bool",
+ "help": "Specifies whether objects that are replicated are identified during verification."
+ },
+ {
+ "name": "DoNotDropDatabaseWorkloadGroups",
+ "type": "bool",
+ "help": "When false, Database WorkloadGroups in the target database that are not defined in the source will be dropped during deployment."
+ },
+ {
+ "name": "DoNotDropObjectType",
+ "type": "string",
+ "help": "An object type that should not be dropped when DropObjectsNotInSource is true. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AssemblyFiles, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseOptions, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, Files, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseEncryptionKeys, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, MasterKeys, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers, ExternalStreams, ExternalStreamingJobs, DatabaseWorkloadGroups, WorkloadClassifiers, ExternalLibraries, ExternalLanguages. This property may be specified multiple times to indicate multiple options."
+ },
+ {
+ "name": "DoNotDropObjectTypes",
+ "type": "List",
+ "separator": ";",
+ "help": "A semicolon-delimited list of object types that should not be dropped when DropObjectsNotInSource is true. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AssemblyFiles, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseOptions, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, Files, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseEncryptionKeys, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, MasterKeys, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers, ExternalStreams, ExternalStreamingJobs, DatabaseWorkloadGroups, WorkloadClassifiers, ExternalLibraries, ExternalLanguages."
+ },
+ {
+ "name": "DoNotDropWorkloadClassifiers",
+ "type": "bool",
+ "help": "When false, WorkloadClassifiers in the target database that are not defined in the source will be dropped during deployment."
+ },
+ {
+ "name": "DoNotEvaluateSqlCmdVariables",
+ "type": "bool",
+ "help": "Specifies whether SQLCMD variables to not replace with values"
+ },
+ {
+ "name": "DropConstraintsNotInSource",
+ "type": "bool",
+ "help": "Specifies whether constraints that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database."
+ },
+ {
+ "name": "DropDmlTriggersNotInSource",
+ "type": "bool",
+ "help": "Specifies whether DML triggers that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database."
+ },
+ {
+ "name": "DropExtendedPropertiesNotInSource",
+ "type": "bool",
+ "help": "Specifies whether extended properties that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database."
+ },
+ {
+ "name": "DropIndexesNotInSource",
+ "type": "bool",
+ "help": "Specifies whether indexes that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database."
+ },
+ {
+ "name": "DropObjectsNotInSource",
+ "type": "bool",
+ "help": "Specifies whether objects that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database. This value takes precedence over DropExtendedProperties."
+ },
+ {
+ "name": "DropPermissionsNotInSource",
+ "type": "bool",
+ "help": "Specifies whether permissions that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish updates to a database."
+ },
+ {
+ "name": "DropRoleMembersNotInSource",
+ "type": "bool",
+ "help": "Specifies whether role members that are not defined in the database snapshot (.dacpac) file will be dropped from the target database when you publish updates to a database."
+ },
+ {
+ "name": "DropStatisticsNotInSource",
+ "type": "bool",
+ "help": "Specifies whether statistics that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database."
+ },
+ {
+ "name": "EnclaveAttestationProtocol",
+ "type": "string",
+ "help": "Specifies an attestation protocol to be used with enclave based Always Encrypted."
+ },
+ {
+ "name": "EnclaveAttestationUrl",
+ "type": "string",
+ "help": "Specifies the enclave attestation URL (an attestation service endpoint) to be used with enclave based Always Encrypted."
+ },
+ {
+ "name": "ExcludeObjectType",
+ "type": "string",
+ "help": "An object type that should be ignored during deployment. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AssemblyFiles, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseOptions, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, Files, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseEncryptionKeys, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, MasterKeys, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers, ExternalStreams, ExternalStreamingJobs, DatabaseWorkloadGroups, WorkloadClassifiers, ExternalLibraries, ExternalLanguages. This property may be specified multiple times to indicate multiple options."
+ },
+ {
+ "name": "ExcludeObjectTypes",
+ "type": "List",
+ "separator": ";",
+ "help": "A semicolon delimited list of object types that should be ignored during deployment. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AssemblyFiles, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseOptions, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, Files, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseEncryptionKeys, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, MasterKeys, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers, ExternalStreams, ExternalStreamingJobs, DatabaseWorkloadGroups, WorkloadClassifiers, ExternalLibraries, ExternalLanguages."
+ },
+ {
+ "name": "GenerateSmartDefaults",
+ "type": "bool",
+ "help": "Automatically provides a default value when updating a table that contains data with a column that does not allow null values."
+ },
+ {
+ "name": "HashObjectNamesInLogs",
+ "type": "bool",
+ "help": "Specifies whether to replace all object names in logs with a random hash value."
+ },
+ {
+ "name": "IgnoreAnsiNulls",
+ "type": "bool",
+ "help": "Specifies whether differences in the ANSI NULLS setting should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreAuthorizer",
+ "type": "bool",
+ "help": "Specifies whether differences in the Authorizer should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreColumnCollation",
+ "type": "bool",
+ "help": "Specifies whether differences in the column collations should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreColumnOrder",
+ "type": "bool",
+ "help": "Specifies whether differences in table column order should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreComments",
+ "type": "bool",
+ "help": "Specifies whether differences in the comments should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreCryptographicProviderFilePath",
+ "type": "bool",
+ "help": "Specifies whether differences in the file path for the cryptographic provider should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreDatabaseWorkloadGroups",
+ "type": "bool",
+ "help": "Specifies whether to exclude workload groups that exist on the target during deployment. No Database Workload Groups will be added, modified, or dropped."
+ },
+ {
+ "name": "IgnoreDdlTriggerOrder",
+ "type": "bool",
+ "help": "Specifies whether differences in the order of Data Definition Language (DDL) triggers should be ignored or updated when you publish to a database or server."
+ },
+ {
+ "name": "IgnoreDdlTriggerState",
+ "type": "bool",
+ "help": "Specifies whether differences in the enabled or disabled state of Data Definition Language (DDL) triggers should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreDefaultSchema",
+ "type": "bool",
+ "help": "Specifies whether differences in the default schema should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreDmlTriggerOrder",
+ "type": "bool",
+ "help": "Specifies whether differences in the order of Data Manipulation Language (DML) triggers should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreDmlTriggerState",
+ "type": "bool",
+ "help": "Specifies whether differences in the enabled or disabled state of DML triggers should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreExtendedProperties",
+ "type": "bool",
+ "help": "Specifies whether differences in the extended properties should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreFileAndLogFilePath",
+ "type": "bool",
+ "help": "Specifies whether differences in the paths for files and log files should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreFilegroupPlacement",
+ "type": "bool",
+ "help": "Specifies whether differences in the placement of objects in FILEGROUPs should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreFileSize",
+ "type": "bool",
+ "help": "Specifies whether differences in the file sizes should be ignored or whether a warning should be issued when you publish to a database."
+ },
+ {
+ "name": "IgnoreFillFactor",
+ "type": "bool",
+ "help": "Specifies whether differences in the fill factor for index storage should be ignored or whether a warning should be issued when you publish to a database."
+ },
+ {
+ "name": "IgnoreFullTextCatalogFilePath",
+ "type": "bool",
+ "help": "Specifies whether differences in the file path for the full-text catalog should be ignored or whether a warning should be issued when you publish to a database."
+ },
+ {
+ "name": "IgnoreIdentitySeed",
+ "type": "bool",
+ "help": "Specifies whether differences in the seed for an identity column should be ignored or updated when you publish updates to a database."
+ },
+ {
+ "name": "IgnoreIncrement",
+ "type": "bool",
+ "help": "Specifies whether differences in the increment for an identity column should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreIndexOptions",
+ "type": "bool",
+ "help": "Specifies whether differences in the index options should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreIndexPadding",
+ "type": "bool",
+ "help": "Specifies whether differences in the index padding should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreKeywordCasing",
+ "type": "bool",
+ "help": "Specifies whether differences in the casing of keywords should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreLockHintsOnIndexes",
+ "type": "bool",
+ "help": "Specifies whether differences in the lock hints on indexes should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreLoginSids",
+ "type": "bool",
+ "help": "Specifies whether differences in the security identification number (SID) should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreNotForReplication",
+ "type": "bool",
+ "help": "Specifies whether the not for replication settings should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreObjectPlacementOnPartitionScheme",
+ "type": "bool",
+ "help": "Specifies whether an object's placement on a partition scheme should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnorePartitionSchemes",
+ "type": "bool",
+ "help": "Specifies whether differences in partition schemes and functions should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnorePermissions",
+ "type": "bool",
+ "help": "Specifies whether differences in the permissions should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreQuotedIdentifiers",
+ "type": "bool",
+ "help": "Specifies whether differences in the quoted identifiers setting should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreRoleMembership",
+ "type": "bool",
+ "help": "Specifies whether differences in the role membership of logins should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreRouteLifetime",
+ "type": "bool",
+ "help": "Specifies whether differences in the amount of time that SQL Server retains the route in the routing table should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreSemicolonBetweenStatements",
+ "type": "bool",
+ "help": "Specifies whether differences in the semi-colons between T-SQL statements will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreSensitivityClassifications",
+ "type": "bool",
+ "help": "Specifies whether data sensitivity classifications on columns should be ignored when comparing schema models. This only works for classifications added with the ADD SENSITIVITY CLASSIFICATION syntax introduced in SQL 2019."
+ },
+ {
+ "name": "IgnoreTableOptions",
+ "type": "bool",
+ "help": "Specifies whether differences in the table options will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreTablePartitionOptions",
+ "type": "bool",
+ "help": "Specifies whether differences in the table partition options will be ignored or updated when you publish to a database. This option applies only to Azure Synapse Analytics dedicated SQL pool databases."
+ },
+ {
+ "name": "IgnoreUserSettingsObjects",
+ "type": "bool",
+ "help": "Specifies whether differences in the user settings objects will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreWhitespace",
+ "type": "bool",
+ "help": "Specifies whether differences in white space will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreWithNocheckOnCheckConstraints",
+ "type": "bool",
+ "help": "Specifies whether differences in the value of the WITH NOCHECK clause for check constraints will be ignored or updated when you publish."
+ },
+ {
+ "name": "IgnoreWithNocheckOnForeignKeys",
+ "type": "bool",
+ "help": "Specifies whether differences in the value of the WITH NOCHECK clause for foreign keys will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreWorkloadClassifiers",
+ "type": "bool",
+ "help": "Specifies whether to exclude workload classifiers that exist on the target during deployment."
+ },
+ {
+ "name": "IncludeCompositeObjects",
+ "type": "bool",
+ "help": "Include all composite elements with the same database as part of a single publish operation."
+ },
+ {
+ "name": "IncludeTransactionalScripts",
+ "type": "bool",
+ "help": "Specifies whether transactional statements should be used where possible when you publish to a database."
+ },
+ {
+ "name": "IsAlwaysEncryptedParameterizationEnabled",
+ "type": "bool",
+ "help": "Enables variable parameterization on Always Encrypted columns in pre/post deployment scripts."
+ },
+ {
+ "name": "LongRunningCommandTimeout",
+ "type": "int",
+ "help": "Specifies the long running command timeout in seconds when executing queries against SQL Server. Use 0 to wait indefinitely."
+ },
+ {
+ "name": "NoAlterStatementsToChangeClrTypes",
+ "type": "bool",
+ "help": "Specifies that publish should always drop and re-create an assembly if there is a difference instead of issuing an ALTER ASSEMBLY statement."
+ },
+ {
+ "name": "PopulateFilesOnFileGroups",
+ "type": "bool",
+ "help": "Specifies whether a new file is also created when a new FileGroup is created in the target database."
+ },
+ {
+ "name": "PreserveIdentityLastValues",
+ "type": "bool",
+ "help": "Specifies whether last values for identity columns should be preserved during deployment."
+ },
+ {
+ "name": "RebuildIndexesOfflineForDataPhase",
+ "type": "bool",
+ "help": "Rebuild indexes offline after importing data."
+ },
+ {
+ "name": "RegisterDataTierApplication",
+ "type": "bool",
+ "help": "Specifies whether the schema is registered with the database server."
+ },
+ {
+ "name": "RestoreSequenceCurrentValue",
+ "type": "bool",
+ "help": "Specifies whether sequence object current value should be deployed with dacpac file, the default value is True."
+ },
+ {
+ "name": "RunDeploymentPlanExecutors",
+ "type": "bool",
+ "help": "Specifies whether DeploymentPlanExecutor contributors should be run when other operations are executed."
+ },
+ {
+ "name": "ScriptDatabaseCollation",
+ "type": "bool",
+ "help": "Specifies whether differences in the database collation should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "ScriptDatabaseCompatibility",
+ "type": "bool",
+ "help": "Specifies whether differences in the database compatibility should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "ScriptDatabaseOptions",
+ "type": "bool",
+ "help": "Specifies whether target database properties should be set or updated as part of the publish action."
+ },
+ {
+ "name": "ScriptDeployStateChecks",
+ "type": "bool",
+ "help": "Specifies whether statements are generated in the publish script to verify that the database name and server name match the names specified in the database project."
+ },
+ {
+ "name": "ScriptFileSize",
+ "type": "bool",
+ "help": "Controls whether size is specified when adding a file to a filegroup."
+ },
+ {
+ "name": "ScriptNewConstraintValidation",
+ "type": "bool",
+ "help": "At the end of publish all of the constraints will be verified as one set, avoiding data errors caused by a check or foreign key constraint in the middle of publish. If set to False, your constraints are published without checking the corresponding data."
+ },
+ {
+ "name": "ScriptRefreshModule",
+ "type": "bool",
+ "help": "Include refresh statements at the end of the publish script."
+ },
+ {
+ "name": "Storage",
+ "type": "StorageType",
+ "help": "Specifies how elements are stored when building the database model. For performance reasons the default is InMemory. For large databases, File backed storage may be required and is only available for .NET Framework version of SqlPackage."
+ },
+ {
+ "name": "TreatVerificationErrorsAsWarnings",
+ "type": "bool",
+ "help": "Specifies whether errors encountered during publish verification should be treated as warnings. The check is performed against the generated deployment plan before the plan is executed against your target database. Plan verification detects problems such as the loss of target-only objects (such as indexes) that must be dropped to make a change. Verification will also detect situations where dependencies (such as a table or view) exist because of a reference to a composite project, but do not exist in the target database. You might choose to do this to get a complete list of all issues, instead of having the publish action stop on the first error."
+ },
+ {
+ "name": "UnmodifiableObjectWarnings",
+ "type": "bool",
+ "help": "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."
+ },
+ {
+ "name": "VerifyCollationCompatibility",
+ "type": "bool",
+ "help": "Specifies whether collation compatibility is verified."
+ },
+ {
+ "name": "VerifyDeployment",
+ "type": "bool",
+ "help": "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."
+ }
+ ]
+ },
+ {
+ "name": "Quiet",
+ "type": "bool",
+ "format": "/Quiet:{value}",
+ "help": "Specifies whether detailed feedback is suppressed. Defaults to False."
+ },
+ {
+ "name": "ReferencePaths",
+ "type": "Dictionary",
+ "format": "/rp:{value}",
+ "itemFormat": "{key}={value}",
+ "help": "Specifies the additional directories to search for .dacpac references."
+ },
+ {
+ "name": "Secret",
+ "type": "string",
+ "format": "/Secret:{value}",
+ "help": "Specifies the Client Secret to be used in authenticating against Azure KeyVault, when necessary"
+ },
+ {
+ "name": "SourceFile",
+ "type": "string",
+ "format": "/SourceFile:{value}",
+ "help": "Specifies a source file to be used as the source of action instead of a database from local storage. If this name is used, no other source name shall be valid."
+ },
+ {
+ "name": "SourceConnectionString",
+ "type": "string",
+ "format": "/SourceConnectionString:{value}",
+ "help": "Specifies a valid [SQL Server/Azure connection string](/dotnet/api/microsoft.data.sqlclient.sqlconnection.connectionstring) to the source database. If this name is specified, it shall be used exclusively of all other source names."
+ },
+ {
+ "name": "SourceDatabaseName",
+ "type": "string",
+ "format": "/SourceDatabaseName:{value}",
+ "help": "Defines the name of the source database."
+ },
+ {
+ "name": "SourceEncryptConnection",
+ "type": "bool",
+ "format": "/SourceEncryptConnection:{value}",
+ "help": "Specifies if SQL encryption should be used for the source database connection. Default value is True."
+ },
+ {
+ "name": "SourceHostNameInCertificate",
+ "type": "string",
+ "format": "/SourceHostNameInCertificate:{value}",
+ "help": "Specifies value that is used to validate the source SQL Server TLS/SSL certificate when the communication layer is encrypted by using TLS."
+ },
+ {
+ "name": "SourcePassword",
+ "type": "string",
+ "format": "/SourcePassword:{value}",
+ "help": "For SQL Server Auth scenarios, defines the password to use to access the source database."
+ },
+ {
+ "name": "SourceServerName",
+ "type": "string",
+ "format": "/SourceServerName:{value}",
+ "help": "Defines the name of the server hosting the source database."
+ },
+ {
+ "name": "SourceTimeout",
+ "type": "int",
+ "format": "/SourceTimeout:{value}",
+ "help": "Specifies the timeout for establishing a connection to the source database in seconds."
+ },
+ {
+ "name": "SourceTrustServerCertificate",
+ "type": "bool",
+ "format": "/SourceTrustServerCertificate:{value}",
+ "help": "Specifies whether to use TLS to encrypt the source database connection and bypass walking the certificate chain to validate trust. Default value is False."
+ },
+ {
+ "name": "SourceUser",
+ "type": "string",
+ "format": "/SourceUser:{value}",
+ "help": "For SQL Server Auth scenarios, defines the SQL Server user to use to access the source database."
+ },
+ {
+ "name": "TargetConnectionString",
+ "type": "string",
+ "format": "/TargetConnectionString:{value}",
+ "help": "Specifies a valid [SQL Server/Azure connection string](/dotnet/api/microsoft.data.sqlclient.sqlconnection.connectionstring) to the target database. If this name is specified, it shall be used exclusively of all other target names."
+ },
+ {
+ "name": "TargetDatabaseName",
+ "type": "string",
+ "format": "/TargetDatabaseName:{value}",
+ "help": "Specifies an override for the name of the database that is the target of SqlPackage Action."
+ },
+ {
+ "name": "TargetEncryptConnection",
+ "type": "bool",
+ "format": "/TargetEncryptConnection:{value}",
+ "help": "Specifies if SQL encryption should be used for the target database connection. Default value is True."
+ },
+ {
+ "name": "TargetHostNameInCertificate",
+ "type": "string",
+ "format": "/TargetHostNameInCertificate:{value}",
+ "help": "Specifies value that is used to validate the target SQL Server TLS/SSL certificate when the communication layer is encrypted by using TLS."
+ },
+ {
+ "name": "TargetPassword",
+ "type": "string",
+ "format": "/TargetPassword:{value}",
+ "help": "For SQL Server Auth scenarios, defines the password to use to access the target database."
+ },
+ {
+ "name": "TargetServerName",
+ "type": "string",
+ "format": "/TargetServerName:{value}",
+ "help": "Defines the name of the server hosting the target database."
+ },
+ {
+ "name": "TargetTimeout",
+ "type": "int",
+ "format": "/TargetTimeout:{value}",
+ "help": "Specifies the timeout for establishing a connection to the target database in seconds. For Azure AD, it is recommended that this value be greater than or equal to 30 seconds."
+ },
+ {
+ "name": "TargetTrustServerCertificate",
+ "type": "bool",
+ "format": "/TargetTrustServerCertificate:{value}",
+ "help": "Specifies whether to use TLS to encrypt the target database connection and bypass walking the certificate chain to validate trust. Default value is False."
+ },
+ {
+ "name": "TargetUser",
+ "type": "string",
+ "format": "/TargetUser:{value}",
+ "help": "For SQL Server Auth scenarios, defines the SQL Server user to use to access the target database."
+ },
+ {
+ "name": "TenantId",
+ "type": "string",
+ "format": "/TenantId:{value}",
+ "help": "Represents the Azure AD tenant ID or domain name. This option is required to support guest or imported Azure AD users as well as Microsoft accounts such as outlook.com, hotmail.com, or live.com. If this name is omitted, the default tenant ID for Azure AD will be used, assuming that the authenticated user is a native user for this AD. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Azure AD are not supported and the operation will fail.
For more information about Active Directory Universal Authentication, see [Universal Authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication)."
+ },
+ {
+ "name": "ThreadMaxStackSize",
+ "type": "int",
+ "format": "/ThreadMaxStackSize:{value}",
+ "help": "Specifies the maximum size in megabytes for the thread running the SqlPackage action. This option should only be used when encountering stack overflow exceptions that occur when parsing very large TSQL statements."
+ },
+ {
+ "name": "UniversalAuthentication",
+ "type": "bool",
+ "format": "/UniversalAuthentication:{value}",
+ "help": "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 Azure AD 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 Azure AD authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Azure AD authentication must be specified in SourceConnectionString (/scs).
For more information about Active Directory Universal Authentication, see [Universal Authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication)."
+ },
+ {
+ "name": "Variables",
+ "type": "Dictionary",
+ "format": "/v:{value}",
+ "itemFormat": "{key}={value}",
+ "help": "Specifies a name value pair for an action-specific variable;{VariableName}={Value}. The DACPAC file contains the list of valid SQLCMD variables. An error results if a value is not provided for every variable."
+ }
+ ]
+ }
+ },
+ {
+ "help": "The SqlPackage DeployReport action creates an XML report of the changes that would be made by a publish action",
+ "postfix": "DeployReport",
+ "definiteArgument": "/Action:DeployReport",
+ "officialUrl": "https://learn.microsoft.com/en-us/sql/tools/sqlpackage/sqlpackage-deploy-drift-report",
+ "settingsClass": {
+ "properties": [
+ {
+ "name": "AccessToken",
+ "type": "string",
+ "format": "/AccessToken:{value}",
+ "help": "Specifies the token based authentication access token to use when connect to the target database."
+ },
+ {
+ "name": "Diagnostics",
+ "type": "bool",
+ "format": "/Diagnostics:{value}",
+ "help": "Specifies whether diagnostic logging is output to the console. Defaults to False."
+ },
+ {
+ "name": "DiagnosticsFile",
+ "type": "string",
+ "format": "/DiagnosticsFile:{value}",
+ "help": "Specifies a file to store diagnostic logs."
+ },
+ {
+ "name": "MaxParallelism",
+ "type": "int",
+ "format": "/MaxParallelism:{value}",
+ "help": "Specifies the degree of parallelism for concurrent operations running against a database. The default value is 8."
+ },
+ {
+ "name": "OutputPath",
+ "type": "string",
+ "format": "/OutputPath:{value}",
+ "help": "Specifies the file path where the output files are generated."
+ },
+ {
+ "name": "OverwriteFiles",
+ "type": "bool",
+ "format": "/OverwriteFiles:{value}",
+ "help": "Specifies if SqlPackage should overwrite existing files. Specifying false causes SqlPackage to abort action if an existing file is encountered. Default value is True."
+ },
+ {
+ "name": "Profile",
+ "type": "string",
+ "format": "/Profile:{value}",
+ "help": "Specifies the file path to a DAC Publish Profile. The profile defines a collection of properties and variables to use when generating outputs."
+ },
+ {
+ "name": "Properties",
+ "type": "Dictionary",
+ "format": "/p:{value}",
+ "itemFormat": "{key}={value}",
+ "help": "Specifies a name value pair for an [action-specific property](#deployreport-action-properties); {key}={value}.",
+ "delegates": [
+ {
+ "name": "AdditionalDeploymentContributorArguments",
+ "type": "List",
+ "separator": ";",
+ "help": "Specifies additional deployment contributor arguments for the deployment contributors. This should be a semi-colon delimited list of values."
+ },
+ {
+ "name": "AdditionalDeploymentContributors",
+ "type": "List",
+ "separator": ";",
+ "help": "Specifies additional deployment contributors, which should run when the dacpac is deployed. This should be a semi-colon delimited list of fully qualified build contributor names or IDs."
+ },
+ {
+ "name": "AdditionalDeploymentContributorPaths",
+ "type": "List",
+ "separator": ";",
+ "help": "Specifies paths to load additional deployment contributors. This should be a semi-colon delimited list of values."
+ },
+ {
+ "name": "AllowDropBlockingAssemblies",
+ "type": "bool",
+ "help": "This property is used by SqlClr deployment to cause any blocking assemblies to be dropped as part of the deployment plan. By default, any blocking/referencing assemblies will block an assembly update if the referencing assembly needs to be dropped."
+ },
+ {
+ "name": "AllowIncompatiblePlatform",
+ "type": "bool",
+ "help": "Specifies whether to attempt the action despite incompatible SQL Server platforms."
+ },
+ {
+ "name": "AllowUnsafeRowLevelSecurityDataMovement",
+ "type": "bool",
+ "help": "Do not block data motion on a table that has Row Level Security if this property is set to true. Default is false."
+ },
+ {
+ "name": "BackupDatabaseBeforeChanges",
+ "type": "bool",
+ "help": "Backups the database before deploying any changes."
+ },
+ {
+ "name": "BlockOnPossibleDataLoss",
+ "type": "bool",
+ "help": "Specifies that the operation will be terminated during the schema validation step if the resulting schema changes could incur a loss of data, including due to data precision reduction or a data type change that requires a cast operation. The default (`True`) value causes the operation to terminate regardless if the target database contains data. An execution with a `False` value for BlockOnPossibleDataLoss can still fail during deployment plan execution if data is present on the target that cannot be converted to the new column type."
+ },
+ {
+ "name": "BlockWhenDriftDetected",
+ "type": "bool",
+ "help": "Specifies whether to block updating a database whose schema no longer matches its registration or is unregistered."
+ },
+ {
+ "name": "CommandTimeout",
+ "type": "int",
+ "help": "Specifies the command timeout in seconds when executing queries against SQL Server."
+ },
+ {
+ "name": "CommentOutSetVarDeclarations",
+ "type": "bool",
+ "help": "Specifies whether the declaration of SETVAR variables should be commented out in the generated publish script. You might choose to do this if you plan to specify the values on the command line when you publish by using a tool such as SQLCMD.EXE."
+ },
+ {
+ "name": "CompareUsingTargetCollation",
+ "type": "bool",
+ "help": "This setting dictates how the database's collation is handled during deployment; by default the target database's collation will be updated if it does not match the collation specified by the source. When this option is set, the target database's (or server's) collation should be used."
+ },
+ {
+ "name": "CreateNewDatabase",
+ "type": "bool",
+ "help": "Specifies whether the target database should be updated or whether it should be dropped and re-created when you publish to a database."
+ },
+ {
+ "name": "DatabaseEdition",
+ "type": "DatabaseEdition",
+ "help": "Defines the edition of an Azure SQL Database. See [Azure SQL Database service tiers](/azure/azure-sql/database/service-tiers-general-purpose-business-critical)."
+ },
+ {
+ "name": "DatabaseLockTimeout",
+ "type": "int",
+ "help": "Specifies the database lock timeout in seconds when executing queries against SQLServer. Use -1 to wait indefinitely."
+ },
+ {
+ "name": "DatabaseMaximumSize",
+ "type": "int",
+ "help": "Defines the maximum size in GB of an Azure SQL Database."
+ },
+ {
+ "name": "DatabaseServiceObjective",
+ "type": "string",
+ "help": "Defines the performance level of an Azure SQL Database such as \"P0\" or \"S1\"."
+ },
+ {
+ "name": "DeployDatabaseInSingleUserMode",
+ "type": "bool",
+ "help": "if true, the database is set to Single User Mode before deploying."
+ },
+ {
+ "name": "DisableAndReenableDdlTriggers",
+ "type": "bool",
+ "help": "Specifies whether Data Definition Language (DDL) triggers are disabled at the beginning of the publish process and re-enabled at the end of the publish action."
+ },
+ {
+ "name": "DoNotAlterChangeDataCaptureObjects",
+ "type": "bool",
+ "help": "If true, Change Data Capture objects are not altered."
+ },
+ {
+ "name": "DoNotAlterReplicatedObjects",
+ "type": "bool",
+ "help": "Specifies whether objects that are replicated are identified during verification."
+ },
+ {
+ "name": "DoNotDropObjectType",
+ "type": "string",
+ "help": "An object type that should not be dropped when DropObjectsNotInSource is true. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers. This property may be specified multiple times to indicate multiple options."
+ },
+ {
+ "name": "DoNotDropObjectTypes",
+ "type": "List",
+ "separator": ";",
+ "help": "A semicolon-delimited list of object types that should not be dropped when DropObjectsNotInSource is true. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers."
+ },
+ {
+ "name": "DropConstraintsNotInSource",
+ "type": "bool",
+ "help": "Specifies whether constraints that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database."
+ },
+ {
+ "name": "DropDmlTriggersNotInSource",
+ "type": "bool",
+ "help": "Specifies whether DML triggers that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database."
+ },
+ {
+ "name": "DropExtendedPropertiesNotInSource",
+ "type": "bool",
+ "help": "Specifies whether extended properties that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database."
+ },
+ {
+ "name": "DropIndexesNotInSource",
+ "type": "bool",
+ "help": "Specifies whether indexes that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database."
+ },
+ {
+ "name": "DropObjectsNotInSource",
+ "type": "bool",
+ "help": "Specifies whether objects that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database. This value takes precedence over DropExtendedProperties."
+ },
+ {
+ "name": "DropPermissionsNotInSource",
+ "type": "bool",
+ "help": "Specifies whether permissions that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish updates to a database."
+ },
+ {
+ "name": "DropRoleMembersNotInSource",
+ "type": "bool",
+ "help": "Specifies whether role members that are not defined in the database snapshot (.dacpac) file will be dropped from the target database when you publish updates to a database."
+ },
+ {
+ "name": "DropStatisticsNotInSource",
+ "type": "bool",
+ "help": "Specifies whether statistics that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database."
+ },
+ {
+ "name": "ExcludeObjectType",
+ "type": "string",
+ "help": "An object type that should be ignored during deployment. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers."
+ },
+ {
+ "name": "ExcludeObjectTypes",
+ "type": "List",
+ "separator": ";",
+ "help": "A semicolon-delimited list of object types that should be ignored during deployment. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers."
+ },
+ {
+ "name": "GenerateSmartDefaults",
+ "type": "bool",
+ "help": "Automatically provides a default value when updating a table that contains data with a column that does not allow null values."
+ },
+ {
+ "name": "IgnoreAnsiNulls",
+ "type": "bool",
+ "help": "Specifies whether differences in the ANSI NULLS setting should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreAuthorizer",
+ "type": "bool",
+ "help": "Specifies whether differences in the Authorizer should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreColumnCollation",
+ "type": "bool",
+ "help": "Specifies whether differences in the column collations should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreColumnOrder",
+ "type": "bool",
+ "help": "Specifies whether differences in table column order should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreComments",
+ "type": "bool",
+ "help": "Specifies whether differences in the comments should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreCryptographicProviderFilePath",
+ "type": "bool",
+ "help": "Specifies whether differences in the file path for the cryptographic provider should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreDdlTriggerOrder",
+ "type": "bool",
+ "help": "Specifies whether differences in the order of Data Definition Language (DDL) triggers should be ignored or updated when you publish to a database or server."
+ },
+ {
+ "name": "IgnoreDdlTriggerState",
+ "type": "bool",
+ "help": "Specifies whether differences in the enabled or disabled state of Data Definition Language (DDL) triggers should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreDefaultSchema",
+ "type": "bool",
+ "help": "Specifies whether differences in the default schema should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreDmlTriggerOrder",
+ "type": "bool",
+ "help": "Specifies whether differences in the order of Data Manipulation Language (DML) triggers should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreDmlTriggerState",
+ "type": "bool",
+ "help": "Specifies whether differences in the enabled or disabled state of DML triggers should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreExtendedProperties",
+ "type": "bool",
+ "help": "Specifies whether differences in the extended properties should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreFileAndLogFilePath",
+ "type": "bool",
+ "help": "Specifies whether differences in the paths for files and log files should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreFilegroupPlacement",
+ "type": "bool",
+ "help": "Specifies whether differences in the placement of objects in FILEGROUPs should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreFileSize",
+ "type": "bool",
+ "help": "Specifies whether differences in the file sizes should be ignored or whether a warning should be issued when you publish to a database."
+ },
+ {
+ "name": "IgnoreFillFactor",
+ "type": "bool",
+ "help": "Specifies whether differences in the fill factor for index storage should be ignored or whether a warning should be issued when you publish to a database"
+ },
+ {
+ "name": "IgnoreFullTextCatalogFilePath",
+ "type": "bool",
+ "help": "Specifies whether differences in the file path for the full-text catalog should be ignored or whether a warning should be issued when you publish to a database."
+ },
+ {
+ "name": "IgnoreIdentitySeed",
+ "type": "bool",
+ "help": "Specifies whether differences in the seed for an identity column should be ignored or updated when you publish updates to a database."
+ },
+ {
+ "name": "IgnoreIncrement",
+ "type": "bool",
+ "help": "Specifies whether differences in the increment for an identity column should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreIndexOptions",
+ "type": "bool",
+ "help": "Specifies whether differences in the index options should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreIndexPadding",
+ "type": "bool",
+ "help": "Specifies whether differences in the index padding should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreKeywordCasing",
+ "type": "bool",
+ "help": "Specifies whether differences in the casing of keywords should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreLockHintsOnIndexes",
+ "type": "bool",
+ "help": "Specifies whether differences in the lock hints on indexes should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreLoginSids",
+ "type": "bool",
+ "help": "Specifies whether differences in the security identification number (SID) should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreNotForReplication",
+ "type": "bool",
+ "help": "Specifies whether the not for replication settings should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreObjectPlacementOnPartitionScheme",
+ "type": "bool",
+ "help": "Specifies whether an object's placement on a partition scheme should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnorePartitionSchemes",
+ "type": "bool",
+ "help": "Stypepecifies whether differences in partition schemes and functions should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnorePermissions",
+ "type": "bool",
+ "help": "Specifies whether differences in the permissions should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreQuotedIdentifiers",
+ "type": "bool",
+ "help": "Specifies whether differences in the quoted identifiers setting should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreRoleMembership",
+ "type": "bool",
+ "help": "Specifies whether differences in the role membership of logins should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreRouteLifetime",
+ "type": "bool",
+ "help": "Specifies whether differences in the amount of time that SQL Server retains the route in the routing table should be ignored or updated when you publish to a database"
+ },
+ {
+ "name": "IgnoreSemicolonBetweenStatements",
+ "type": "bool",
+ "help": "Specifies whether differences in the semi-colons between T-SQL statements will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreTableOptions",
+ "type": "bool",
+ "help": "Specifies whether differences in the table options will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreTablePartitionOptions",
+ "type": "bool",
+ "help": "Specifies whether differences in the table partition options will be ignored or updated when you publish to a database. This option applies only to Azure Synapse Analytics data warehouse databases."
+ },
+ {
+ "name": "IgnoreUserSettingsObjects",
+ "type": "bool",
+ "help": "Specifies whether differences in the user settings objects will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreWhitespace",
+ "type": "bool",
+ "help": "Specifies whether differences in white space will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreWithNocheckOnCheckConstraints",
+ "type": "bool",
+ "help": "Specifies whether differences in the value of the WITH NOCHECK clause for check constraints will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreWithNocheckOnForeignKeys",
+ "type": "bool",
+ "help": "Specifies whether differences in the value of the WITH NOCHECK clause for foreign keys will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IncludeCompositeObjects",
+ "type": "bool",
+ "help": "Include all composite elements with the same database as part of a single publish operation."
+ },
+ {
+ "name": "IncludeTransactionalScripts",
+ "type": "bool",
+ "help": "Specifies whether transactional statements should be used where possible when you publish to a database."
+ },
+ {
+ "name": "LongRunningCommandTimeout",
+ "type": "int",
+ "help": "Specifies the long running command timeout in seconds when executing queries against SQL Server. Use 0 to wait indefinitely."
+ },
+ {
+ "name": "NoAlterStatementsToChangeClrTypes",
+ "type": "bool",
+ "help": "Specifies that publish should always drop and re-create an assembly if there is a difference instead of issuing an ALTER ASSEMBLY statement."
+ },
+ {
+ "name": "PopulateFilesOnFileGroups",
+ "type": "bool",
+ "help": "Specifies whether a new file is also created when a new FileGroup is created in the target database."
+ },
+ {
+ "name": "RegisterDataTierApplication",
+ "type": "bool",
+ "help": "Specifies whether the schema is registered with the database server."
+ },
+ {
+ "name": "RunDeploymentPlanExecutors",
+ "type": "bool",
+ "help": "Specifies whether DeploymentPlanExecutor contributors should be run when other operations are executed."
+ },
+ {
+ "name": "ScriptDatabaseCollation",
+ "type": "bool",
+ "help": "Specifies whether differences in the database collation should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "ScriptDatabaseCompatibility",
+ "type": "bool",
+ "help": "Specifies whether differences in the database compatibility should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "ScriptDatabaseOptions",
+ "type": "bool",
+ "help": "Specifies whether target database properties should be set or updated as part of the publish action."
+ },
+ {
+ "name": "ScriptDeployStateChecks",
+ "type": "bool",
+ "help": "Specifies whether statements are generated in the publish script to verify that the database name and server name match the names specified in the database project."
+ },
+ {
+ "name": "ScriptFileSize",
+ "type": "bool",
+ "help": "Controls whether size is specified when adding a file to a filegroup."
+ },
+ {
+ "name": "ScriptNewConstraintValidation",
+ "type": "bool",
+ "help": "At the end of publish all of the constraints will be verified as one set, avoiding data errors caused by a check or foreign key constraint in the middle of publish. If set to False, your constraints are published without checking the corresponding data."
+ },
+ {
+ "name": "ScriptRefreshModule",
+ "type": "bool",
+ "help": "Include refresh statements at the end of the publish script."
+ },
+ {
+ "name": "Storage",
+ "type": "StorageType",
+ "help": "Specifies how elements are stored when building the database model. For performance reasons the default is InMemory. For large databases, File backed storage may be required and is only available for .NET Framework version of SqlPackage."
+ },
+ {
+ "name": "TreatVerificationErrorsAsWarnings",
+ "type": "bool",
+ "help": "Specifies whether errors encountered during publish verification should be treated as warnings. The check is performed against the generated deployment plan before the plan is executed against your target database. Plan verification detects problems such as the loss of target-only objects (such as indexes) that must be dropped to make a change. Verification will also detect situations where dependencies (such as a table or view) exist because of a reference to a composite project, but do not exist in the target database. You might choose to do this to get a complete list of all issues, instead of having the publish action stop on the first error."
+ },
+ {
+ "name": "UnmodifiableObjectWarnings",
+ "type": "bool",
+ "help": "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."
+ },
+ {
+ "name": "VerifyCollationCompatibility",
+ "type": "bool",
+ "help": "Specifies whether collation compatibility is verified."
+ },
+ {
+ "name": "VerifyDeployment",
+ "type": "bool",
+ "help": "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."
+ }
+ ]
+ },
+ {
+ "name": "Quiet",
+ "type": "bool",
+ "format": "/Quiet:{value}",
+ "help": "Specifies whether detailed feedback is suppressed. Defaults to False."
+ },
+ {
+ "name": "SourceFile",
+ "type": "string",
+ "format": "/SourceFile:{value}",
+ "help": "Specifies a source file to be used as the source of action instead of a database. If this name is ed, no other source name sha beva."
+ },
+ {
+ "name": "SourceConnectionString",
+ "type": "string",
+ "format": "/SourceConnectionString:{value}",
+ "help": "Specifies a valid [SQL Server/Azure connection string](/dotnet/api/microsoft.data.sqlclient.sqlconnection.connectionstring) to the source database. If this name is ecified, it shall be used exclusively of all other sourcen."
+ },
+ {
+ "name": "SourceDatabaseName",
+ "type": "string",
+ "format": "/SourceDatabaseName:{value}",
+ "help": "Defines the name of the source database."
+ },
+ {
+ "name": "SourceEncryptConnection",
+ "type": "EncryptionType",
+ "format": "/SourceEncryptConnection:{value}",
+ "help": "Specifies if SQL encryption should be used for the source database connection. Default value is True."
+ },
+ {
+ "name": "SourceHostNameInCertificate",
+ "type": "string",
+ "format": "/SourceHostNameInCertificate:{value}",
+ "help": "Specifies value that is used to validate the source SQL Server TLS/SSL certificate when the communication layer is encrypted by using TLS."
+ },
+ {
+ "name": "SourcePassword",
+ "type": "string",
+ "format": "/SourcePassword:{value}",
+ "help": "For SQL Server Auth scenarios, defines the password to use to access the source database."
+ },
+ {
+ "name": "SourceServerName",
+ "type": "string",
+ "format": "/SourceServerName:{value}",
+ "help": "Defines the name of the server hosting the source database."
+ },
+ {
+ "name": "SourceTimeout",
+ "type": "int",
+ "format": "/SourceTimeout:{value}",
+ "help": "Specifies the timeout for establishing a connection to the source database in seconds."
+ },
+ {
+ "name": "SourceTrustServerCertificate",
+ "type": "bool",
+ "format": "/SourceTrustServerCertificate:{value}",
+ "help": "Specifies whether to use TLS to encrypt the source database connection and bypass walking the certificate chain to validate trust. Default value is False."
+ },
+ {
+ "name": "SourceUser",
+ "type": "string",
+ "format": "/SourceUser:{value}",
+ "help": "For SQL Server Auth scenarios, defines the SQL Server user to use to access the source database."
+ },
+ {
+ "name": "TargetFile",
+ "type": "string",
+ "format": "/TargetFile:{value}",
+ "help": "Specifies a target file (that is, a .dacpac file) to be used as the target of action instead of a database. If this name is ed, no other target name sha be valid. This name sha be invalid for actions that only support databasetarg."
+ },
+ {
+ "name": "TargetConnectionString",
+ "type": "string",
+ "format": "/TargetConnectionString:{value}",
+ "help": "Specifies a valid [SQL Server/Azure connection string](/dotnet/api/microsoft.data.sqlclient.sqlconnection.connectionstring) to the target database. If this name is ecified, it shall be used exclusively of all other targetn "
+ },
+ {
+ "name": "TargetDatabaseName",
+ "type": "string",
+ "format": "/TargetDatabaseName:{value}",
+ "help": "Specifies an override for the name of the database that is the target of SqlPackage Action."
+ },
+ {
+ "name": "TargetEncryptConnection",
+ "type": "EncryptionType",
+ "format": "/TargetEncryptConnection:{value}",
+ "help": "Specifies if SQL encryption should be used for the target database connection. Default value is True."
+ },
+ {
+ "name": "TargetHostNameInCertificate",
+ "type": "string",
+ "format": "/TargetHostNameInCertificate:{value}",
+ "help": "Specifies value that is used to validate the target SQL Server TLS/SSL certificate when the communication layer is encrypted by using TLS."
+ },
+ {
+ "name": "TargetPassword",
+ "type": "string",
+ "format": "/TargetPassword:{value}",
+ "help": "For SQL Server Auth scenarios, defines the password to use to access the target database."
+ },
+ {
+ "name": "TargetServerName",
+ "type": "string",
+ "format": "/TargetServerName:{value}",
+ "help": "Defines the name of the server hosting the target database."
+ },
+ {
+ "name": "TargetTimeout",
+ "type": "int",
+ "format": "/TargetTimeout:{value}",
+ "help": "Specifies the timeout for establishing a connection to the target database in seconds. For Azure AD, it is recommended that this value be greater than or equal to 30 seconds."
+ },
+ {
+ "name": "TargetTrustServerCertificate",
+ "type": "bool",
+ "format": "/TargetTrustServerCertificate:{value}",
+ "help": "Specifies whether to use TLS to encrypt the target database connection and bypass walking the certificate chain to validate trust. Default value is False."
+ },
+ {
+ "name": "TargetUser",
+ "type": "string",
+ "format": "/TargetUser:{value}",
+ "help": "For SQL Server Auth scenarios, defines the SQL Server user to use to access the target database."
+ },
+ {
+ "name": "TenantId",
+ "type": "string",
+ "format": "/TenantId:{value}",
+ "help": "Represents the Azure AD tenant ID or domain name. This option is required to support guest or imported Azure AD users as well as Microsoft accounts such as outlook.com, hotmail.com, or live.com. If this name is itted, the default tenant ID for Azure AD will be used, assuming that the authenticated user is a native user for this AD. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Azure AD are not supported and the operation will fail.
For more information about Active Directory Universal Authentication, see [Universal Authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfaauthenticati."
+ },
+ {
+ "name": "UniversalAuthentication",
+ "type": "bool",
+ "format": "/UniversalAuthentication:{value}",
+ "help": "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 Azure AD 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 Azure AD authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Azure AD authentication must be specified in SourceConnectionString (/scs).
For more information about Active Directory Universal Authentication, see [Universal Authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication)."
+ },
+ {
+ "name": "Variables",
+ "type": "Dictionary",
+ "format": "/v:{value}",
+ "itemFormat": "{key}={value}",
+ "help": "Specifies a name value pair for an action-specific variable; {VariableName}={Value}. The DACPAC file contains the list of valid SQLCMD variables. An error results if a value is not provided for every variable."
+ }
+ ]
+ }
+ },
+ {
+ "help": "The SqlPackage DriftReport action creates an XML report of the changes that have been made to the registered database since it was last registered.",
+ "postfix": "DriftReport",
+ "definiteArgument": "/Action:DriftReport",
+ "officialUrl": "https://learn.microsoft.com/en-us/sql/tools/sqlpackage/sqlpackage-deploy-drift-report",
+ "settingsClass": {
+ "properties": [
+ {
+ "name": "AccessToken",
+ "type": "string",
+ "format": "/AccessToken:{value}",
+ "help": "Specifies the token based authentication access token to use when connect to the target database."
+ },
+ {
+ "name": "Diagnostics",
+ "type": "bool",
+ "format": "/Diagnostics:{value}",
+ "help": "Specifies whether diagnostic logging is output to the console. Defaults to False."
+ },
+ {
+ "name": "DiagnosticsFile",
+ "type": "string",
+ "format": "/DiagnosticsFile:{value}",
+ "help": "Specifies a file to store diagnostic logs."
+ },
+ {
+ "name": "MaxParallelism",
+ "type": "int",
+ "format": "/MaxParallelism:{value}",
+ "help": "Specifies the degree of parallelism for concurrent operations running against a database. The default value is 8."
+ },
+ {
+ "name": "OutputPath",
+ "type": "string",
+ "format": "/OutputPath:{value}",
+ "help": "Specifies the file path where the output files are generated."
+ },
+ {
+ "name": "OverwriteFiles",
+ "type": "bool",
+ "format": "/OverwriteFiles:{value}",
+ "help": "Specifies if SqlPackage should overwrite existing files. Specifying false causes SqlPackage to abort action if an existing file is encountered. Default value is True."
+ },
+ {
+ "name": "Quiet",
+ "type": "bool",
+ "format": "/Quiet:{value}",
+ "help": "Specifies whether detailed feedback is suppressed. Defaults to False."
+ },
+ {
+ "name": "TargetConnectionString",
+ "type": "string",
+ "format": "/TargetConnectionString:{value}",
+ "help": "Specifies a valid SQL Server/Azure connection string to the target database. If this parameter is specified, it shall be used exclusively of all other target parameters."
+ },
+ {
+ "name": "TargetDatabaseName",
+ "type": "string",
+ "format": "/TargetDatabaseName:{value}",
+ "help": "Specifies an override for the name of the database that is the target of SqlPackage Action."
+ },
+ {
+ "name": "TargetEncryptConnection",
+ "type": "EncryptionType",
+ "format": "/TargetEncryptConnection:{value}",
+ "help": "Specifies if SQL encryption should be used for the target database connection. Default value is True."
+ },
+ {
+ "name": "TargetHostNameInCertificate",
+ "type": "string",
+ "format": "/TargetHostNameInCertificate:{value}",
+ "help": "Specifies value that is used to validate the target SQL Server TLS/SSL certificate when the communication layer is encrypted by using TLS."
+ },
+ {
+ "name": "TargetPassword",
+ "type": "string",
+ "format": "/TargetPassword:{value}",
+ "help": "For SQL Server Auth scenarios, defines the password to use to access the target database."
+ },
+ {
+ "name": "TargetServerName",
+ "type": "string",
+ "format": "/TargetServerName:{value}",
+ "help": "Defines the name of the server hosting the target database."
+ },
+ {
+ "name": "TargetTimeout",
+ "type": "int",
+ "format": "/TargetTimeout:{value}",
+ "help": "Specifies the timeout for establishing a connection to the target database in seconds. For Azure AD, it is recommended that this value be greater than or equal to 30 seconds."
+ },
+ {
+ "name": "TargetTrustServerCertificate",
+ "type": "bool",
+ "format": "/TargetTrustServerCertificate:{value}",
+ "help": "Specifies whether to use TLS to encrypt the target database connection and bypass walking the certificate chain to validate trust. Default value is False."
+ },
+ {
+ "name": "TargetUser",
+ "type": "string",
+ "format": "/TargetUser:{value}",
+ "help": "For SQL Server Auth scenarios, defines the SQL Server user to use to access the target database."
+ },
+ {
+ "name": "TenantId",
+ "type": "string",
+ "format": "/TenantId:{value}",
+ "help": "Represents the Azure AD tenant ID or domain name. This option is required to support guest or imported Azure AD 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 Azure AD will be used, assuming that the authenticated user is a native user for this AD. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Azure AD are not supported and the operation will fail.
For more information about Active Directory Universal Authentication, see [Universal Authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication)."
+ },
+ {
+ "name": "UniversalAuthentication",
+ "type": "bool",
+ "format": "/UniversalAuthentication:{value}",
+ "help": "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 Azure AD 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 Azure AD authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Azure AD authentication must be specified in SourceConnectionString (/scs).
For more information about Active Directory Universal Authentication, see [Universal Authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication)."
+ }
+ ]
+ }
+ },
+ {
+ "help": "The SqlPackage Script action creates a Transact-SQL incremental update script that updates the schema of a target database to match the schema of a source database.",
+ "postfix": "Script",
+ "definiteArgument": "/Action:Script",
+ "officialUrl": "https://learn.microsoft.com/en-us/sql/tools/sqlpackage/sqlpackage-script",
+ "settingsClass": {
+ "properties": [
+ {
+ "name": "AccessToken",
+ "type": "string",
+ "format": "/AccessToken:{value}",
+ "help": "Specifies the token based authentication access token to use when connect to the target database."
+ },
+ {
+ "name": "AzureCloudConfig",
+ "type": "string",
+ "format": "/AzureCloudConfig:{value}",
+ "help": "Specifies the custom endpoints for connecting to Azure Active Directory in the format: AzureActiveDirectoryAuthority={value};DatabaseServicePrincipalName={value}\" ."
+ },
+ {
+ "name": "DeployReportPath",
+ "type": "string",
+ "format": "/DeployReportPath:{value}",
+ "help": "Specifies an optional file path to output the deployment report xml file."
+ },
+ {
+ "name": "DeployScriptPath",
+ "type": "string",
+ "format": "/DeployScriptPath:{value}",
+ "help": "Specifies an optional file path to output the deployment script. For Azure deployments, if there are TSQL commands to create or modify the master database, a script will be written to the same path but with \"Filename_Master.sql\" as the output file name."
+ },
+ {
+ "name": "Diagnostics",
+ "type": "bool",
+ "format": "/Diagnostics:{value}",
+ "help": "Specifies whether diagnostic logging is output to the console. Defaults to False."
+ },
+ {
+ "name": "DiagnosticsFile",
+ "type": "string",
+ "format": "/DiagnosticsFile:{value}",
+ "help": "Specifies a file to store diagnostic logs."
+ },
+ {
+ "name": "MaxParallelism",
+ "type": "int",
+ "format": "/MaxParallelism:{value}",
+ "help": "Specifies the degree of parallelism for concurrent operations running against a database. The default value is 8."
+ },
+ {
+ "name": "ModelFilePath",
+ "type": "string",
+ "format": "/ModelFilePath:{value}",
+ "help": "Specifies the file path to override the model.xml in the source file. Use of this setting may result in deployment failure and/or unintended data loss. This setting is intended only for use when troubleshooting issues with publish, import, or script generation."
+ },
+ {
+ "name": "OutputPath",
+ "type": "string",
+ "format": "/OutputPath:{value}",
+ "help": "Specifies the file path where the output files are generated."
+ },
+ {
+ "name": "OverwriteFiles",
+ "type": "bool",
+ "format": "/OverwriteFiles:{value}",
+ "help": "Specifies if SqlPackage should overwrite existing files. Specifying false causes SqlPackage to abort action if an existing file is encountered. Default value is True."
+ },
+ {
+ "name": "Profile",
+ "type": "string",
+ "format": "/Profile:{value}",
+ "help": "Specifies the file path to a DAC Publish Profile. The profile defines a collection of properties and variables to use when generating outputs."
+ },
+ {
+ "name": "Properties",
+ "type": "Dictionary",
+ "format": "/p:{value}",
+ "itemFormat": "{key}={value}",
+ "help": "Specifies a name value pair for an [action-specific property](#properties-specific-to-the-script-action); {PropertyValue}={Value}.",
+ "delegates": [
+ {
+ "name": "AdditionalDeploymentContributorArguments",
+ "type": "List",
+ "separator": ";",
+ "help": "Specifies additional deployment contributor arguments for the deployment contributors. This should be a semi-colon delimited list of values."
+ },
+ {
+ "name": "AdditionalDeploymentContributors",
+ "type": "List",
+ "separator": ";",
+ "help": "Specifies additional deployment contributors, which should run when the dacpac is deployed. This should be a semi-colon delimited list of fully qualified build contributor names or IDs."
+ },
+ {
+ "name": "AdditionalDeploymentContributorPaths",
+ "type": "List",
+ "separator": ";",
+ "help": "Specifies paths to load additional deployment contributors. This should be a semi-colon delimited list of values."
+ },
+ {
+ "name": "AllowDropBlockingAssemblies",
+ "type": "bool",
+ "help": "This property is used by SqlClr deployment to cause any blocking assemblies to be dropped as part of the deployment plan. By default, any blocking/referencing assemblies will block an assembly update if the referencing assembly needs to be dropped."
+ },
+ {
+ "name": "AllowExternalLanguagePaths",
+ "type": "bool",
+ "help": "Allows file paths, if available, to be used to generate external language statements."
+ },
+ {
+ "name": "AllowExternalLibraryPaths",
+ "type": "bool",
+ "help": "Allows file paths, if available, to be used to generate external library statements."
+ },
+ {
+ "name": "AllowIncompatiblePlatform",
+ "type": "bool",
+ "help": "Specifies whether to attempt the action despite incompatible SQL Server platforms."
+ },
+ {
+ "name": "AllowUnsafeRowLevelSecurityDataMovement",
+ "type": "bool",
+ "help": "Do not block data motion on a table that has Row Level Security if this property is set to true. Default is false."
+ },
+ {
+ "name": "BackupDatabaseBeforeChanges",
+ "type": "bool",
+ "help": "Backups the database before deploying any changes."
+ },
+ {
+ "name": "BlockOnPossibleDataLoss",
+ "type": "bool",
+ "help": "Specifies that the operation will be terminated during the schema validation step if the resulting schema changes could incur a loss of data, including due to data precision reduction or a data type change that requires a cast operation. The default (`True`) value causes the operation to terminate regardless if the target database contains data. An execution with a `False` value for BlockOnPossibleDataLoss can still fail during deployment plan execution if data is present on the target that cannot be converted to the new column type."
+ },
+ {
+ "name": "BlockWhenDriftDetected",
+ "type": "bool",
+ "help": "Specifies whether to block updating a database whose schema no longer matches its registration or is unregistered."
+ },
+ {
+ "name": "CommandTimeout",
+ "type": "int",
+ "help": "Specifies the command timeout in seconds when executing queries against SQL Server."
+ },
+ {
+ "name": "CommentOutSetVarDeclarations",
+ "type": "bool",
+ "help": "Specifies whether the declaration of SETVAR variables should be commented out in the generated publish script. You might choose to do this if you plan to specify the values on the command line when you publish by using a tool such as SQLCMD.EXE."
+ },
+ {
+ "name": "CompareUsingTargetCollation",
+ "type": "bool",
+ "help": "This setting dictates how the database's collation is handled during deployment; by default the target database's collation will be updated if it does not match the collation specified by the source. When this option is set, the target database's (or server's) collation should be used."
+ },
+ {
+ "name": "CreateNewDatabase",
+ "type": "bool",
+ "help": "Specifies whether the target database should be updated or whether it should be dropped and re-created when you publish to a database."
+ },
+ {
+ "name": "DatabaseEdition",
+ "type": "DatabaseEdition",
+ "help": "Defines the edition of an Azure SQL Database. See [Azure SQL Database service tiers](/azure/azure-sql/database/service-tiers-general-purpose-business-critical)."
+ },
+ {
+ "name": "DatabaseLockTimeout",
+ "type": "int",
+ "help": "Specifies the database lock timeout in seconds when executing queries against SQLServer. Use -1 to wait indefinitely."
+ },
+ {
+ "name": "DatabaseMaximumSize",
+ "type": "int",
+ "help": "Defines the maximum size in GB of an Azure SQL Database."
+ },
+ {
+ "name": "DatabaseServiceObjective",
+ "type": "string",
+ "help": "Defines the performance level of an Azure SQL Database such as \"P0\" or \"S1\"."
+ },
+ {
+ "name": "DeployDatabaseInSingleUserMode",
+ "type": "bool",
+ "help": "if true, the database is set to Single User Mode before deploying."
+ },
+ {
+ "name": "DisableAndReenableDdlTriggers",
+ "type": "bool",
+ "help": "Specifies whether Data Definition Language (DDL) triggers are disabled at the beginning of the publish process and re-enabled at the end of the publish action."
+ },
+ {
+ "name": "DoNotAlterChangeDataCaptureObjects",
+ "type": "bool",
+ "help": "If true, Change Data Capture objects are not altered."
+ },
+ {
+ "name": "DoNotAlterReplicatedObjects",
+ "type": "bool",
+ "help": "Specifies whether objects that are replicated are identified during verification."
+ },
+ {
+ "name": "DoNotDropObjectType",
+ "type": "string",
+ "help": "An object type that should not be dropped when DropObjectsNotInSource is true. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AssemblyFiles, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseOptions, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, Files, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseEncryptionKeys, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, MasterKeys, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers, ExternalStreams, ExternalStreamingJobs, DatabaseWorkloadGroups, WorkloadClassifiers, ExternalLibraries, ExternalLanguages. This property may be specified multiple times to indicate multiple options."
+ },
+ {
+ "name": "DoNotDropObjectTypes",
+ "type": "List",
+ "separator": ";",
+ "help": "A semicolon-delimited list of object types that should not be dropped whenDropObjectsNotInSource is true. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AssemblyFiles, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseOptions, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, Files, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseEncryptionKeys, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, MasterKeys, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers, ExternalStreams, ExternalStreamingJobs, DatabaseWorkloadGroups, WorkloadClassifiers, ExternalLibraries, ExternalLanguages."
+ },
+ {
+ "name": "DoNotDropWorkloadClassifiers",
+ "type": "bool",
+ "help": "When false, WorkloadClassifiers in the target database that are not defined in the source will be dropped during deployment."
+ },
+ {
+ "name": "DoNotEvaluateSqlCmdVariables",
+ "type": "bool",
+ "help": "Specifies whether SQLCMD variables to not replace with values"
+ },
+ {
+ "name": "DropConstraintsNotInSource",
+ "type": "bool",
+ "help": "Specifies whether constraints that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database."
+ },
+ {
+ "name": "DropDmlTriggersNotInSource",
+ "type": "bool",
+ "help": "Specifies whether DML triggers that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database."
+ },
+ {
+ "name": "DropExtendedPropertiesNotInSource",
+ "type": "bool",
+ "help": "Specifies whether extended properties that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database."
+ },
+ {
+ "name": "DropIndexesNotInSource",
+ "type": "bool",
+ "help": "Specifies whether indexes that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database."
+ },
+ {
+ "name": "DropObjectsNotInSource",
+ "type": "bool",
+ "help": "Specifies whether objects that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database. This value takes precedence over DropExtendedProperties."
+ },
+ {
+ "name": "DropPermissionsNotInSource",
+ "type": "bool",
+ "help": "Specifies whether permissions that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish updates to a database."
+ },
+ {
+ "name": "DropRoleMembersNotInSource",
+ "type": "bool",
+ "help": "Specifies whether role members that are not defined in the database snapshot (.dacpac) file will be dropped from the target database when you publish updates to a database."
+ },
+ {
+ "name": "DropStatisticsNotInSource",
+ "type": "bool",
+ "help": "Specifies whether statistics that do not exist in the database snapshot (.dacpac) file will be dropped from the target database when you publish to a database."
+ },
+ {
+ "name": "EnclaveAttestationProtocol",
+ "type": "string",
+ "help": "Specifies an attestation protocol to be used with enclave based Always Encrypted."
+ },
+ {
+ "name": "EnclaveAttestationUrl",
+ "type": "string",
+ "help": "Specifies the enclave attestation URL (an attestation service endpoint) to be used with enclave based Always Encrypted."
+ },
+ {
+ "name": "ExcludeObjectType",
+ "type": "string",
+ "help": "An object type that should be ignored during deployment. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AssemblyFiles, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseOptions, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, Files, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseEncryptionKeys, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, MasterKeys, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers, ExternalStreams, ExternalStreamingJobs, DatabaseWorkloadGroups, WorkloadClassifiers, ExternalLibraries, ExternalLanguages."
+ },
+ {
+ "name": "ExcludeObjectTypes",
+ "type": "List",
+ "separator": ";",
+ "help": "A semicolon-delimited list of object types that should be ignored during deployment. Valid object type names are Aggregates, ApplicationRoles, Assemblies, AssemblyFiles, AsymmetricKeys, BrokerPriorities, Certificates, ColumnEncryptionKeys, ColumnMasterKeys, Contracts, DatabaseOptions, DatabaseRoles, DatabaseTriggers, Defaults, ExtendedProperties, ExternalDataSources, ExternalFileFormats, ExternalTables, Filegroups, Files, FileTables, FullTextCatalogs, FullTextStoplists, MessageTypes, PartitionFunctions, PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, ScalarValuedFunctions, SearchPropertyLists, SecurityPolicies, Sequences, Services, Signatures, StoredProcedures, SymmetricKeys, Synonyms, Tables, TableValuedFunctions, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, Views, XmlSchemaCollections, Audits, Credentials, CryptographicProviders, DatabaseAuditSpecifications, DatabaseEncryptionKeys, DatabaseScopedCredentials, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, MasterKeys, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers, ExternalStreams, ExternalStreamingJobs, DatabaseWorkloadGroups, WorkloadClassifiers, ExternalLibraries, ExternalLanguages."
+ },
+ {
+ "name": "GenerateSmartDefaults",
+ "type": "bool",
+ "help": "Automatically provides a default value when updating a table that contains data with a column that does not allow null values."
+ },
+ {
+ "name": "HashObjectNamesInLogs",
+ "type": "bool",
+ "help": "Specifies whether to replace all object names in logs with a random hash value."
+ },
+ {
+ "name": "IgnoreAnsiNulls",
+ "type": "bool",
+ "help": "Specifies whether differences in the ANSI NULLS setting should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreAuthorizer",
+ "type": "bool",
+ "help": "Specifies whether differences in the Authorizer should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreColumnCollation",
+ "type": "bool",
+ "help": "Specifies whether differences in the column collations should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreColumnOrder",
+ "type": "bool",
+ "help": "Specifies whether differences in table column order should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreComments",
+ "type": "bool",
+ "help": "Specifies whether differences in the comments should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreCryptographicProviderFilePath",
+ "type": "bool",
+ "help": "Specifies whether differences in the file path for the cryptographic provider should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreDatabaseWorkloadGroups",
+ "type": "bool",
+ "help": "Specifies whether to exclude workload groups that exist on the target during deployment. No Database Workload Groups will be added, modified, or dropped."
+ },
+ {
+ "name": "IgnoreDdlTriggerOrder",
+ "type": "bool",
+ "help": "Specifies whether differences in the order of Data Definition Language (DDL) triggers should be ignored or updated when you publish to a database or server."
+ },
+ {
+ "name": "IgnoreDdlTriggerState",
+ "type": "bool",
+ "help": "Specifies whether differences in the enabled or disabled state of Data Definition Language (DDL) triggers should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreDefaultSchema",
+ "type": "bool",
+ "help": "Specifies whether differences in the default schema should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreDmlTriggerOrder",
+ "type": "bool",
+ "help": "Specifies whether differences in the order of Data Manipulation Language (DML) triggers should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreDmlTriggerState",
+ "type": "bool",
+ "help": "Specifies whether differences in the enabled or disabled state of DML triggers should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreExtendedProperties",
+ "type": "bool",
+ "help": "Specifies whether differences in the extended properties should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreFileAndLogFilePath",
+ "type": "bool",
+ "help": "Specifies whether differences in the paths for files and log files should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreFilegroupPlacement",
+ "type": "bool",
+ "help": "Specifies whether differences in the placement of objects in FILEGROUPs should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreFileSize",
+ "type": "bool",
+ "help": "Specifies whether differences in the file sizes should be ignored or whether a warning should be issued when you publish to a database."
+ },
+ {
+ "name": "IgnoreFillFactor",
+ "type": "bool",
+ "help": "Specifies whether differences in the fill factor for index storage should be ignored or whether a warning should be issued when you publish."
+ },
+ {
+ "name": "IgnoreFullTextCatalogFilePath",
+ "type": "bool",
+ "help": "Specifies whether differences in the file path for the full-text be ignored or whether a warning should be issued when you publish to a database."
+ },
+ {
+ "name": "IgnoreIdentitySeed",
+ "type": "bool",
+ "help": "Specifies whether differences in the seed for an identity column should be ignored or updated when you publish updates to a database."
+ },
+ {
+ "name": "IgnoreIncrement",
+ "type": "bool",
+ "help": "Specifies whether differences in the increment for an identity column should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreIndexOptions",
+ "type": "bool",
+ "help": "Specifies whether differences in the index options should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreIndexPadding",
+ "type": "bool",
+ "help": "Specifies whether differences in the index padding should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreKeywordCasing",
+ "type": "bool",
+ "help": "Specifies whether differences in the casing of keywords should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreLockHintsOnIndexes",
+ "type": "bool",
+ "help": "Specifies whether differences in the lock hints on indexes should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreLoginSids",
+ "type": "bool",
+ "help": "Specifies whether differences in the security identification number (SID) should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreNotForReplication",
+ "type": "bool",
+ "help": "Specifies whether the not for replication settings should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreObjectPlacementOnPartitionScheme",
+ "type": "bool",
+ "help": "Specifies whether an object's placement on a partition scheme should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnorePartitionSchemes",
+ "type": "bool",
+ "help": "Specifies whether differences in partition schemes and functions should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnorePermissions",
+ "type": "bool",
+ "help": "Specifies whether differences in the permissions should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreQuotedIdentifiers",
+ "type": "bool",
+ "help": "Specifies whether differences in the quoted identifiers setting should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreRoleMembership",
+ "type": "bool",
+ "help": "Specifies whether differences in the role membership of logins should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreRouteLifetime",
+ "type": "bool",
+ "help": "Specifies whether differences in the amount of time that SQL Server retains the route in the routing table should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreSemicolonBetweenStatements",
+ "type": "bool",
+ "help": "Specifies whether differences in the semi-colons between T-SQL statements will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreSensitivityClassifications",
+ "type": "bool",
+ "help": "Specifies whether data sensitivity classifications on columns should be ignored when comparing schema models. This only works for classifications added with the ADD SENSITIVITY CLASSIFICATION syntax introduced in SQL 2019."
+ },
+ {
+ "name": "IgnoreTableOptions",
+ "type": "bool",
+ "help": "Specifies whether differences in the table options will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreTablePartitionOptions",
+ "type": "bool",
+ "help": "Specifies whether differences in the table partition options will be ignored or updated when you publish to a database. This option applies only to Azure Synapse Analytics data warehouse databases."
+ },
+ {
+ "name": "IgnoreUserSettingsObjects",
+ "type": "bool",
+ "help": "Specifies whether differences in the user settings objects will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreWhitespace",
+ "type": "bool",
+ "help": "Specifies whether differences in white space will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreWithNocheckOnCheckConstraints",
+ "type": "bool",
+ "help": "Specifies whether differences in the value of the WITH NOCHECK clause for check constraints will be ignored or updated when you publish."
+ },
+ {
+ "name": "IgnoreWithNocheckOnForeignKeys",
+ "type": "bool",
+ "help": "Specifies whether differences in the value of the WITH NOCHECK clause for foreign keys will be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "IgnoreWorkloadClassifiers",
+ "type": "bool",
+ "help": "Specifies whether to exclude workload classifiers that exist on the target during deployment."
+ },
+ {
+ "name": "IncludeCompositeObjects",
+ "type": "bool",
+ "help": "Include all composite elements with the same database as part of a single publish operation."
+ },
+ {
+ "name": "IncludeTransactionalScripts",
+ "type": "bool",
+ "help": "Specifies whether transactional statements should be used where possible when you publish to a database."
+ },
+ {
+ "name": "IsAlwaysEncryptedParameterizationEnabled",
+ "type": "bool",
+ "help": "Enables variable parameterization on Always Encrypted columns in pre/post deployment scripts."
+ },
+ {
+ "name": "LongRunningCommandTimeout",
+ "type": "int",
+ "help": "Specifies the long running command timeout in seconds when executing queries against SQL Server. Use 0 to wait indefinitely."
+ },
+ {
+ "name": "NoAlterStatementsToChangeClrTypes",
+ "type": "bool",
+ "help": "Specifies that publish should always drop and re-create an assembly if there is a difference instead of issuing an ALTER ASSEMBLY statement."
+ },
+ {
+ "name": "PopulateFilesOnFileGroups",
+ "type": "bool",
+ "help": "Specifies whether a new file is also created when a new FileGroup is created in the target database."
+ },
+ {
+ "name": "PreserveIdentityLastValues",
+ "type": "bool",
+ "help": "Specifies whether last values for identity columns should be preserved during deployment."
+ },
+ {
+ "name": "RegisterDataTierApplication",
+ "type": "bool",
+ "help": "Specifies whether the schema is registered with the database server."
+ },
+ {
+ "name": "RestoreSequenceCurrentValue",
+ "type": "bool",
+ "help": "Specifies whether sequence object current value should be deployed with dacpac file, the default value is True."
+ },
+ {
+ "name": "RunDeploymentPlanExecutors",
+ "type": "bool",
+ "help": "Specifies whether DeploymentPlanExecutor contributors should be run when other operations are executed."
+ },
+ {
+ "name": "ScriptDatabaseCollation",
+ "type": "bool",
+ "help": "Specifies whether differences in the database collation should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "ScriptDatabaseCompatibility",
+ "type": "bool",
+ "help": "Specifies whether differences in the database compatibility should be ignored or updated when you publish to a database."
+ },
+ {
+ "name": "ScriptDatabaseOptions",
+ "type": "bool",
+ "help": "Specifies whether target database properties should be set or updated as part of the publish action."
+ },
+ {
+ "name": "ScriptDeployStateChecks",
+ "type": "bool",
+ "help": "Specifies whether statements are generated in the publish script to verify that the database name and server name match the names specified in the database project."
+ },
+ {
+ "name": "ScriptFileSize",
+ "type": "bool",
+ "help": "Controls whether size is specified when adding a file to a filegroup."
+ },
+ {
+ "name": "ScriptNewConstraintValidation",
+ "type": "bool",
+ "help": "At the end of publish all of the constraints will be verified as one set, avoiding data errors caused by a check or foreign key constraint in the middle of publish. If set to False, your constraints are published without checking the corresponding data."
+ },
+ {
+ "name": "ScriptRefreshModule",
+ "type": "bool",
+ "help": "Include refresh statements at the end of the publish script."
+ },
+ {
+ "name": "Storage",
+ "type": "StorageType",
+ "help": "Specifies how elements are stored when building the database model. For performance reasons the default is InMemory. For large databases, File backed storage may be required and is only available for .NET Framework version of SqlPackage."
+ },
+ {
+ "name": "TreatVerificationErrorsAsWarnings",
+ "type": "bool",
+ "help": "Specifies whether errors encountered during publish verification should be treated as warnings. The check is performed against the generated deployment plan before the plan is executed against your target database. Plan verification detects problems such as the loss of target-only objects (such as indexes) that must be dropped to make a change. Verification will also detect situations where dependencies (such as a table or view) exist because of a reference to a composite project, but do not exist in the target database. You might choose to do this to get a complete list of all issues, instead of having the publish action stop on the first error."
+ },
+ {
+ "name": "UnmodifiableObjectWarnings",
+ "type": "bool",
+ "help": "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."
+ },
+ {
+ "name": "VerifyCollationCompatibility",
+ "type": "bool",
+ "help": "Specifies whether collation compatibility is verified."
+ },
+ {
+ "name": "VerifyDeployment",
+ "type": "bool",
+ "help": "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."
+ }
+ ]
+ },
+ {
+ "name": "Quiet",
+ "type": "bool",
+ "format": "/Quiet:{value}",
+ "help": "Specifies whether detailed feedback is suppressed. Defaults to False."
+ },
+ {
+ "name": "ReferencePaths",
+ "type": "Dictionary",
+ "format": "/rp:{value}",
+ "itemFormat": "{key}={value}",
+ "help": "Specifies the additional directories to search for .dacpac references."
+ },
+ {
+ "name": "SourceFile",
+ "type": "string",
+ "format": "/SourceFile:{value}",
+ "help": "Specifies a source file to be used as the source of action. If this parameter is used, no other source parameter shall be valid."
+ },
+ {
+ "name": "SourceConnectionString",
+ "type": "string",
+ "format": "/SourceConnectionString:{value}",
+ "help": "Specifies a valid [SQL Server/Azure connection string](/dotnet/api/microsoft.data.sqlclient.sqlconnection.connectionstring) to the source database. If this parameter is specified, it shall be used exclusively of all other source parameters."
+ },
+ {
+ "name": "SourceDatabaseName",
+ "type": "string",
+ "format": "/SourceDatabaseName:{value}",
+ "help": "Defines the name of the source database."
+ },
+ {
+ "name": "SourceEncryptConnection",
+ "type": "EncryptionType",
+ "format": "/SourceEncryptConnection:{value}",
+ "help": "Specifies if SQL encryption should be used for the source database connection. Default value is True."
+ },
+ {
+ "name": "SourceHostNameInCertificate",
+ "type": "string",
+ "format": "/SourceHostNameInCertificate:{value}",
+ "help": "Specifies value that is used to validate the source SQL Server TLS/SSL certificate when the communication layer is encrypted by using TLS."
+ },
+ {
+ "name": "SourcePassword",
+ "type": "string",
+ "format": "/SourcePassword:{value}",
+ "help": "For SQL Server Auth scenarios, defines the password to use to access the source database."
+ },
+ {
+ "name": "SourceServerName",
+ "type": "string",
+ "format": "/SourceServerName:{value}",
+ "help": "Defines the name of the server hosting the source database."
+ },
+ {
+ "name": "SourceTimeout",
+ "type": "int",
+ "format": "/SourceTimeout:{value}",
+ "help": "Specifies the timeout for establishing a connection to the source database in seconds."
+ },
+ {
+ "name": "SourceTrustServerCertificate",
+ "type": "bool",
+ "format": "/SourceTrustServerCertificate:{value}",
+ "help": "Specifies whether to use TLS to encrypt the source database connection and bypass walking the certificate chain to validate trust. Default value is False."
+ },
+ {
+ "name": "SourceUser",
+ "type": "string",
+ "format": "/SourceUser:{value}",
+ "help": "For SQL Server Auth scenarios, defines the SQL Server user to use to access the source database."
+ },
+ {
+ "name": "TargetFile",
+ "type": "string",
+ "format": "/TargetFile:{value}",
+ "help": "Specifies a target file (that is, a .dacpac file) to be used as the target of action instead of a database. If this parameter is used, no other target parameter shall be valid. This parameter shall be invalid for actions that only support database targets."
+ },
+ {
+ "name": "TargetConnectionString",
+ "type": "string",
+ "format": "/TargetConnectionString:{value}",
+ "help": "Specifies a valid [SQL Server/Azure connection string](/dotnet/api/microsoft.data.sqlclient.sqlconnection.connectionstring) to the target database. If this parameter is specified, it shall be used exclusively of all other target parameters."
+ },
+ {
+ "name": "TargetDatabaseName",
+ "type": "string",
+ "format": "/TargetDatabaseName:{value}",
+ "help": "Specifies an override for the name of the database that is the target of SqlPackage Action."
+ },
+ {
+ "name": "TargetEncryptConnection",
+ "type": "EncryptionType",
+ "format": "/TargetEncryptConnection:{value}",
+ "help": "Specifies if SQL encryption should be used for the target database connection. Default value is True."
+ },
+ {
+ "name": "TargetHostNameInCertificate",
+ "type": "string",
+ "format": "/TargetHostNameInCertificate:{value}",
+ "help": "Specifies value that is used to validate the target SQL Server TLS/SSL certificate when the communication layer is encrypted by using TLS."
+ },
+ {
+ "name": "TargetPassword",
+ "type": "string",
+ "format": "/TargetPassword:{value}",
+ "help": "For SQL Server Auth scenarios, defines the password to use to access the target database."
+ },
+ {
+ "name": "TargetServerName",
+ "type": "string",
+ "format": "/TargetServerName:{value}",
+ "help": "Defines the name of the server hosting the target database."
+ },
+ {
+ "name": "TargetTimeout",
+ "type": "int",
+ "format": "/TargetTimeout:{value}",
+ "help": "Specifies the timeout for establishing a connection to the target database in seconds. For Azure AD, it is recommended that this value be greater than or equal to 30 seconds."
+ },
+ {
+ "name": "TargetTrustServerCertificate",
+ "type": "bool",
+ "format": "/TargetTrustServerCertificate:{value}",
+ "help": "Specifies whether to use TLS to encrypt the target database connection and bypass walking the certificate chain to validate trust. Default value is False."
+ },
+ {
+ "name": "TargetUser",
+ "type": "string",
+ "format": "/TargetUser:{value}",
+ "help": "For SQL Server Auth scenarios, defines the SQL Server user to use to access the target database."
+ },
+ {
+ "name": "TenantId",
+ "type": "string",
+ "format": "/TenantId:{value}",
+ "help": "Represents the Azure AD tenant ID or domain name. This option is required to support guest or imported Azure AD 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 Azure AD will be used, assuming that the authenticated user is a native user for this AD. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Azure AD are not supported and the operation will fail.
For more information about Active Directory Universal Authentication, see [Universal Authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication)."
+ },
+ {
+ "name": "ThreadMaxStackSize",
+ "type": "int",
+ "format": "/ThreadMaxStackSize:{value}",
+ "help": "Specifies the maximum size in megabytes for the thread running the SqlPackage action. This option should only be used when encountering stack overflow exceptions that occur when parsing very large TSQL statements."
+ },
+ {
+ "name": "UniversalAuthentication",
+ "type": "bool",
+ "format": "/UniversalAuthentication:{value}",
+ "help": "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 Azure AD 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 Azure AD authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Azure AD authentication must be specified in SourceConnectionString (/scs).
For more information about Active Directory Universal Authentication, see [Universal Authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication)."
+ },
+ {
+ "name": "Variables",
+ "type": "Dictionary",
+ "format": "/v:{value}",
+ "itemFormat": "{key}={value}",
+ "help": "Specifies a name value pair for an action-specific variable;{VariableName}={Value}. The DACPAC file contains the list of valid SQLCMD variables. An error results if a value is not provided for every variable."
+ }
+ ]
+ }
+ },
+ {
+ "help": "The SqlPackage Import action imports the schema and table data from a BACPAC file (.bacpac) into a new or empty database in SQL Server or Azure SQL Database. At the time of the import operation to an existing database the target database cannot contain any user-defined schema objects. Alternatively, a new database can be created by the import action when the authenticated user has create database permissions.",
+ "postfix": "Import",
+ "definiteArgument": "/Action:Import",
+ "officialUrl": "https://learn.microsoft.com/en-us/sql/tools/sqlpackage/sqlpackage-import",
+ "settingsClass": {
+ "properties": [
+ {
+ "name": "AccessToken",
+ "type": "string",
+ "format": "/AccessToken:{value}",
+ "help": "Specifies the token-based authentication access token to use when connect to the target database."
+ },
+ {
+ "name": "AzureCloudConfig",
+ "type": "string",
+ "format": "/AzureCloudConfig:{value}",
+ "help": "Specifies the custom endpoints for connecting to Azure Active Directory in the format: AzureActiveDirectoryAuthority={value};DatabaseServicePrincipalName={value}\" ."
+ },
+ {
+ "name": "Diagnostics",
+ "type": "bool",
+ "format": "/Diagnostics:{value}",
+ "help": "Specifies whether diagnostic logging is output to the console. Defaults to False."
+ },
+ {
+ "name": "DiagnosticsFile",
+ "type": "string",
+ "format": "/DiagnosticsFile:{value}",
+ "help": "Specifies a file to store diagnostic logs."
+ },
+ {
+ "name": "MaxParallelism",
+ "type": "int",
+ "format": "/MaxParallelism:{value}",
+ "help": "Specifies the degree of parallelism for concurrent operations running against a database. The default value is 8."
+ },
+ {
+ "name": "ModelFilePath",
+ "type": "string",
+ "format": "/ModelFilePath:{value}",
+ "help": "Specifies the file path to override the model.xml in the source file. Use of this setting may result in deployment failure and/or unintended data loss. This setting is intended only for use when troubleshooting issues with publish, import, or script generation."
+ },
+ {
+ "name": "Properties",
+ "type": "Dictionary",
+ "format": "/p:{value}",
+ "itemFormat": "{key}={value}",
+ "help": "Specifies a name value pair for an [action-specific property](#properties-specific-to-the-import-action); {PropertyName}={Value}.",
+ "delegates": [
+ {
+ "name": "CommandTimeout",
+ "type": "int",
+ "help": "Specifies the command timeout in seconds when executing queries against SQL Server."
+ },
+ {
+ "name": "DatabaseEdition",
+ "type": "DatabaseEdition",
+ "help": "Defines the edition of an Azure SQL Database. See [Azure SQL Database service tiers](/azure/azure-sql/database/service-tiers-general-purpose-business-critical)."
+ },
+ {
+ "name": "DatabaseLockTimeout",
+ "type": "int",
+ "help": "Specifies the database lock timeout in seconds when executing queries against SQLServer. Use -1 to wait indefinitely."
+ },
+ {
+ "name": "DatabaseMaximumSize",
+ "type": "int",
+ "help": "Defines the maximum size in GB of an Azure SQL Database."
+ },
+ {
+ "name": "DatabaseServiceObjective",
+ "type": "string",
+ "help": "Defines the performance level of an Azure SQL Database such as \"P0\" or \"S1\"."
+ },
+ {
+ "name": "DisableIndexesForDataPhase",
+ "type": "bool",
+ "help": "When true (default), disables indexes before importing data. When false, indexes are not rebuilt."
+ },
+ {
+ "name": "DisableParallelismForEnablingIndexes",
+ "type": "bool",
+ "help": "Not using parallelism when rebuilding indexes while importing data into SQL Server."
+ },
+ {
+ "name": "HashObjectNamesInLogs",
+ "type": "bool",
+ "help": "Specifies whether to replace all object names in logs with a random hash value."
+ },
+ {
+ "name": "ImportContributorArguments",
+ "type": "List",
+ "separator": ";",
+ "help": "Specifies deployment contributor arguments for the deployment contributors. This property should be a semi-colon delimited list of values."
+ },
+ {
+ "name": "ImportContributorPaths",
+ "type": "List",
+ "separator": ";",
+ "help": "Specifies paths to load additional import contributors. This property should be a semi-colon delimited list of values."
+ },
+ {
+ "name": "ImportContributors",
+ "type": "List",
+ "separator": ";",
+ "help": "Specifies the deployment contributors, which should run when the bacpac is imported. This property should be a semi-colon delimited list of fully qualified build contributor names or IDs."
+ },
+ {
+ "name": "LongRunningCommandTimeout",
+ "type": "int",
+ "help": "Specifies the long running command timeout in seconds when executing queries against SQL Server. Use 0 to wait indefinitely."
+ },
+ {
+ "name": "PreserveIdentityLastValues",
+ "type": "bool",
+ "help": "Specifies whether last values for identity columns should be preserved during deployment."
+ },
+ {
+ "name": "RebuildIndexesOfflineForDataPhase",
+ "type": "bool",
+ "help": "When true, rebuilds indexes offline after importing data into SQL Server."
+ },
+ {
+ "name": "Storage",
+ "type": "StorageType",
+ "help": "Specifies how elements are stored when building the database model. For performance reasons the default is InMemory. For large databases, File backed storage is required."
+ }
+ ]
+ },
+ {
+ "name": "Quiet",
+ "type": "bool",
+ "format": "/Quiet:{value}",
+ "help": "Specifies whether detailed feedback is suppressed. Defaults to False."
+ },
+ {
+ "name": "SourceFile",
+ "type": "string",
+ "format": "/SourceFile:{value}",
+ "help": "Specifies a source file to be used as the source of action from local storage. If this parameter is used, no other source parameter shall be valid."
+ },
+ {
+ "name": "TargetConnectionString",
+ "type": "string",
+ "format": "/TargetConnectionString:{value}",
+ "help": "Specifies a valid [SQL Server/Azure connection string](/dotnet/api/microsoft.data.sqlclient.sqlconnection.connectionstring) to the target database. If this parameter is specified, it shall be used exclusively of all other target parameters."
+ },
+ {
+ "name": "TargetDatabaseName",
+ "type": "string",
+ "format": "/TargetDatabaseName:{value}",
+ "help": "Specifies an override for the name of the database that is the target of SqlPackage Action."
+ },
+ {
+ "name": "TargetEncryptConnection",
+ "type": "EncryptionType",
+ "format": "/TargetEncryptConnection:{value}",
+ "help": "Specifies if SQL encryption should be used for the target database connection. Default value is True."
+ },
+ {
+ "name": "TargetHostNameInCertificate",
+ "type": "string",
+ "format": "/TargetHostNameInCertificate:{value}",
+ "help": "Specifies value that is used to validate the target SQL Server TLS/SSL certificate when the communication layer is encrypted by using TLS."
+ },
+ {
+ "name": "TargetPassword",
+ "type": "string",
+ "format": "/TargetPassword:{value}",
+ "help": "For SQL Server Auth scenarios, defines the password to use to access the target database."
+ },
+ {
+ "name": "TargetServerName",
+ "type": "string",
+ "format": "/TargetServerName:{value}",
+ "help": "Defines the name of the server hosting the target database."
+ },
+ {
+ "name": "TargetTimeout",
+ "type": "int",
+ "format": "/TargetTimeout:{value}",
+ "help": "Specifies the timeout for establishing a connection to the target database in seconds. For Azure AD, it is recommended that this value be greater than or equal to 30 seconds."
+ },
+ {
+ "name": "TargetTrustServerCertificate",
+ "type": "bool",
+ "format": "/TargetTrustServerCertificate:{value}",
+ "help": "Specifies whether to use TLS to encrypt the target database connection and bypass walking the certificate chain to validate trust. Default value is False."
+ },
+ {
+ "name": "TargetUser",
+ "type": "string",
+ "format": "/TargetUser:{value}",
+ "help": "For SQL Server Auth scenarios, defines the SQL Server user to use to access the target database."
+ },
+ {
+ "name": "TenantId",
+ "type": "string",
+ "format": "/TenantId:{value}",
+ "help": "Represents the Azure AD tenant ID or domain name. This option is required to support guest or imported Azure AD 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 Azure AD will be used, assuming that the authenticated user is a native user for this AD. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Azure AD are not supported and the operation will fail.
For more information about Active Directory Universal Authentication, see [Universal Authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication)."
+ },
+ {
+ "name": "ThreadMaxStackSize",
+ "type": "int",
+ "format": "/ThreadMaxStackSize:{value}",
+ "help": "Specifies the maximum size in megabytes for the thread running the SqlPackage action. This option should only be used when encountering stack overflow exceptions that occur when parsing very large TSQL statements."
+ },
+ {
+ "name": "UniversalAuthentication",
+ "type": "bool",
+ "format": "/UniversalAuthentication:{value}",
+ "help": "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 Azure AD 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 Azure AD authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Azure AD authentication must be specified in SourceConnectionString (/scs).
For more information about Active Directory Universal Authentication, see [Universal Authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication)."
+ }
+ ]
+ }
+ },
+ {
+ "help": "The SqlPackage Export action exports a connected database to a BACPAC file (.bacpac). By default, data for all tables will be included in the .bacpac file. Optionally, you can specify only a subset of tables for which to export data. Validation for the Export action ensures Azure SQL Database compatibility for the complete targeted database even if a subset of tables is specified for the export.",
+ "postfix": "Export",
+ "definiteArgument": "/Action:Export",
+ "officialUrl": "https://learn.microsoft.com/en-us/sql/tools/sqlpackage/sqlpackage-export",
+ "settingsClass": {
+ "properties": [
+ {
+ "name": "AccessToken",
+ "type": "string",
+ "format": "/AccessToken:{value}",
+ "help": "Specifies the token-based authentication access token to use when connect to the target database."
+ },
+ {
+ "name": "AzureCloudConfig",
+ "type": "string",
+ "format": "/AzureCloudConfig:{value}",
+ "help": "Specifies the custom endpoints for connecting to Azure Active Directory in the format: AzureActiveDirectoryAuthority={value};DatabaseServicePrincipalName={value}\" ."
+ },
+ {
+ "name": "Diagnostics",
+ "type": "bool",
+ "format": "/Diagnostics:{value}",
+ "help": "Specifies whether diagnostic logging is output to the console. Defaults to False."
+ },
+ {
+ "name": "DiagnosticsFile",
+ "type": "string",
+ "format": "/DiagnosticsFile:{value}",
+ "help": "Specifies a file to store diagnostic logs."
+ },
+ {
+ "name": "MaxParallelism",
+ "type": "int",
+ "format": "/MaxParallelism:{value}",
+ "help": "Specifies the degree of parallelism for concurrent operations running against a database. The default value is 8."
+ },
+ {
+ "name": "OverwriteFiles",
+ "type": "bool",
+ "format": "/OverwriteFiles:{value}",
+ "help": "Specifies if SqlPackage should overwrite existing files. Specifying false causes SqlPackage to abort action if an existing file is encountered. Default value is True."
+ },
+ {
+ "name": "Properties",
+ "type": "Dictionary",
+ "format": "/p:{value}",
+ "itemFormat": "{key}={value}",
+ "help": "Specifies a name value pair for an [action-specific property](#properties-specific-to-the-export-action);{PropertyName}={Value}.",
+ "delegates": [
+ {
+ "name": "CommandTimeout",
+ "type": "int",
+ "help": "Specifies the command timeout in seconds when executing queries against SQL Server."
+ },
+ {
+ "name": "CompressionOption",
+ "type": "CompressionOption",
+ "help": "Specifies the type of compression."
+ },
+ {
+ "name": "DatabaseLockTimeout",
+ "type": "int",
+ "help": "Specifies the database lock timeout in seconds when executing queries against SQLServer. Use -1 to wait indefinitely."
+ },
+ {
+ "name": "HashObjectNamesInLogs",
+ "type": "bool",
+ "help": "Specifies whether to replace all object names in logs with a random hash value."
+ },
+ {
+ "name": "IgnoreIndexesStatisticsOnEnclaveEnabledColumns",
+ "type": "bool",
+ "help": "Specifies whether indexes or statistics on columns encrypted using randomized encryption and enclave-enabled column encryption keys should be ignored (not included in the generated bacpac). By default (false) any index or a statistic on a column encrypted using randomized encryption and an enclave-enabled column encryption key will block the export action."
+ },
+ {
+ "name": "LongRunningCommandTimeout",
+ "type": "int",
+ "help": "Specifies the long running command timeout in seconds when executing queries against SQL Server. Use 0 to wait indefinitely."
+ },
+ {
+ "name": "Storage",
+ "type": "StorageType",
+ "help": "Specifies the type of backing storage for the schema model used during extraction. 'Memory' is default for .NET Core version of SqlPackage. 'File' is only available and default for .NET Framework version of SqlPackage."
+ },
+ {
+ "name": "TableData",
+ "type": "string",
+ "help": "Indicates the table from which data will be extracted. Specify the table name with or without the brackets surrounding the name parts in the following format: schema_name.table_identifier. This property may be specified multiple times to indicate multiple options."
+ },
+ {
+ "name": "TargetEngineVersion",
+ "type": "TargetEngineVersion",
+ "help": "This property is deprecated and use is not recommended. Specifies the version the target engine for Azure SQL Database is expected to be."
+ },
+ {
+ "name": "TempDirectoryForTableData",
+ "type": "string",
+ "help": "Specifies an alternative temporary directory used to buffer table data before being written to the package file. The space required in this location may be large and is relative to the full size of the database."
+ },
+ {
+ "name": "VerifyExtraction",
+ "type": "bool",
+ "help": "Specifies whether the extracted schema model should be verified. If set to true, schema validation rules are run on the dacpac or bacpac."
+ },
+ {
+ "name": "VerifyFullTextDocumentTypesSupported",
+ "type": "bool",
+ "help": "Specifies whether the supported full-text document types for Microsoft Azure SQL Database v12 should be verified."
+ }
+ ]
+ },
+ {
+ "name": "Quiet",
+ "type": "bool",
+ "format": "/Quiet:{value}",
+ "help": "Specifies whether detailed feedback is suppressed. Defaults to False."
+ },
+ {
+ "name": "SourceConnectionString",
+ "type": "string",
+ "format": "/SourceConnectionString:{value}",
+ "help": "Specifies a valid [SQL Server/Azure connection string](/dotnet/api/microsoft.data.sqlclient.sqlconnection.connectionstring) to the source database. If this parameter is specified, it shall be used exclusively of all other source parameters."
+ },
+ {
+ "name": "SourceDatabaseName",
+ "type": "string",
+ "format": "/SourceDatabaseName:{value}",
+ "help": "Defines the name of the source database."
+ },
+ {
+ "name": "SourceEncryptConnection",
+ "type": "EncryptionType",
+ "format": "/SourceEncryptConnection:{value}",
+ "help": "Specifies if SQL encryption should be used for the source database connection. Default value is True."
+ },
+ {
+ "name": "SourceHostNameInCertificate",
+ "type": "string",
+ "format": "/SourceHostNameInCertificate:{value}",
+ "help": "Specifies value that is used to validate the source SQL Server TLS/SSL certificate when the communication layer is encrypted by using TLS."
+ },
+ {
+ "name": "SourcePassword",
+ "type": "string",
+ "format": "/SourcePassword:{value}",
+ "help": "For SQL Server Auth scenarios, defines the password to use to access the source database."
+ },
+ {
+ "name": "SourceServerName",
+ "type": "string",
+ "format": "/SourceServerName:{value}",
+ "help": "Defines the name of the server hosting the source database."
+ },
+ {
+ "name": "SourceTimeout",
+ "type": "int",
+ "format": "/SourceTimeout:{value}",
+ "help": "Specifies the timeout for establishing a connection to the source database in seconds."
+ },
+ {
+ "name": "SourceTrustServerCertificate",
+ "type": "bool",
+ "format": "/SourceTrustServerCertificate:{value}",
+ "help": "Specifies whether to use TLS to encrypt the source database connection and bypass walking the certificate chain to validate trust. Default value is False."
+ },
+ {
+ "name": "SourceUser",
+ "type": "string",
+ "format": "/SourceUser:{value}",
+ "help": "For SQL Server Auth scenarios, defines the SQL Server user to use to access the source database."
+ },
+ {
+ "name": "TargetFile",
+ "type": "string",
+ "format": "/TargetFile:{value}",
+ "help": "Specifies a target file (that is, a .dacpac file) to be used as the target of action instead of a database. If this parameter is used, no other target parameter shall be valid. This parameter shall be invalid for actions that only support database targets."
+ },
+ {
+ "name": "TenantId",
+ "type": "string",
+ "format": "/TenantId:{value}",
+ "help": "Represents the Azure AD tenant ID or domain name. This option is required to support guest or imported Azure AD 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 Azure AD will be used, assuming that the authenticated user is a native user for this AD. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Azure AD are not supported and the operation will fail.
For more information about Active Directory Universal Authentication, see [Universal Authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication)."
+ },
+ {
+ "name": "ThreadMaxStackSize",
+ "type": "int",
+ "format": "/ThreadMaxStackSize:{value}",
+ "help": "Specifies the maximum size in megabytes for the thread running the SqlPackage action. This option should only be used when encountering stack overflow exceptions that occur when parsing very large TSQL statements."
+ },
+ {
+ "name": "UniversalAuthentication",
+ "type": "bool",
+ "format": "/UniversalAuthentication:{value}",
+ "help": "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 Azure AD 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 Azure AD authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Azure AD authentication must be specified in SourceConnectionString (/scs).
For more information about Active Directory Universal Authentication, see [Universal Authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication)."
+ }
+ ]
+ }
+ },
+ {
+ "help": "The SqlPackage Extract action creates a schema of a connected database in a DACPAC file (.dacpac). By default, data is not included in the .dacpac file. To include data, utilize the Export action or use the Extract properties ExtractAllTableData/TableData.",
+ "postfix": "Extract",
+ "definiteArgument": "/Action:Extract",
+ "officialUrl": "https://learn.microsoft.com/en-us/sql/tools/sqlpackage/sqlpackage-extract",
+ "settingsClass": {
+ "properties": [
+ {
+ "name": "AccessToken",
+ "type": "string",
+ "format": "/AccessToken:{value}",
+ "help": "Specifies the token based authentication access token to use when connect to the target database."
+ },
+ {
+ "name": "AzureCloudConfig",
+ "type": "string",
+ "format": "/AzureCloudConfig:{value}",
+ "help": "Specifies the custom endpoints for connecting to Azure Active Directory in the format: AzureActiveDirectoryAuthority={value};DatabaseServicePrincipalName={value}\" ."
+ },
+ {
+ "name": "Diagnostics",
+ "type": "bool",
+ "format": "/Diagnostics:{value}",
+ "help": "Specifies whether diagnostic logging is output to the console. Defaults to False."
+ },
+ {
+ "name": "DiagnosticsFile",
+ "type": "string",
+ "format": "/DiagnosticsFile:{value}",
+ "help": "Specifies a file to store diagnostic logs."
+ },
+ {
+ "name": "MaxParallelism",
+ "type": "int",
+ "format": "/MaxParallelism:{value}",
+ "help": "Specifies the degree of parallelism for concurrent operations running against a database. The default value is 8."
+ },
+ {
+ "name": "OverwriteFiles",
+ "type": "bool",
+ "format": "/OverwriteFiles:{value}",
+ "help": "Specifies if SqlPackage should overwrite existing files. Specifying false causes SqlPackage to abort action if an existing file is encountered. Default value is True."
+ },
+ {
+ "name": "Properties",
+ "type": "Dictionary",
+ "format": "/p:{value}",
+ "itemFormat": "{key}={value}",
+ "help": "Specifies a name value pair for an [action-specific property](#properties-specific-to-the-extract-action); {PropertyName}={Value}.",
+ "delegates": [
+ {
+ "name": "AzureStorageBlobEndpoint",
+ "type": "string",
+ "help": "Azure Blob Storage endpoint. See [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#extract-export-data)."
+ },
+ {
+ "name": "AzureStorageContainer",
+ "type": "string",
+ "help": "Azure Blob Storage container. See [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#extract-export-data)."
+ },
+ {
+ "name": "AzureStorageKey",
+ "type": "string",
+ "help": "Azure storage account key. See [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#extract-export-data)."
+ },
+ {
+ "name": "AzureStorageRootPath",
+ "type": "string",
+ "help": "Storage root path within the container. Without this property, the path defaults to `servername/databasename/timestamp/`. See [SqlPackage for Azure Synapse Analytics](sqlpackage-for-azure-synapse-analytics.md#extract-export-data)."
+ },
+ {
+ "name": "CommandTimeout",
+ "type": "int",
+ "help": "Specifies the command timeout in seconds when executing queries against SQL Server."
+ },
+ {
+ "name": "CompressionOption",
+ "type": "CompressionOption",
+ "help": "Specifies the type of compression."
+ },
+ {
+ "name": "DacApplicationDescription",
+ "type": "string",
+ "help": "Defines the Application description to be stored in the DACPAC metadata."
+ },
+ {
+ "name": "DacApplicationName",
+ "type": "string",
+ "help": "Defined the Application name to be stored in the DACPAC metadata. The default value is the database name."
+ },
+ {
+ "name": "DacMajorVersion",
+ "type": "int",
+ "help": "Defines the major version to be stored in the DACPAC metadata."
+ },
+ {
+ "name": "DacMinorVersion",
+ "type": "int",
+ "help": "Defines the minor version to be stored in the DACPAC metadata."
+ },
+ {
+ "name": "DatabaseLockTimeout",
+ "type": "int",
+ "help": "Specifies the database lock timeout in seconds when executing queries against SQLServer. Use -1 to wait indefinitely."
+ },
+ {
+ "name": "ExtractAllTableData",
+ "type": "bool",
+ "help": "Indicates whether data from all user tables is extracted. If 'true', data from all user tables is extracted, and you cannot specify individual user tables for extracting data. If 'false', specify one or more user tables to extract data from."
+ },
+ {
+ "name": "ExtractApplicationScopedObjectsOnly",
+ "type": "bool",
+ "help": "If true, only extract application-scoped objects for the specified source. If false, extract all objects for the specified source."
+ },
+ {
+ "name": "ExtractReferencedServerScopedElements",
+ "type": "bool",
+ "help": "If true, extract login, server audit, and credential objects referenced by source database objects."
+ },
+ {
+ "name": "ExtractTarget",
+ "type": "ExtractTarget",
+ "help": "Specifies alternative output formats of the database schema, default is 'DacPac' to output a `.dacpac` single file. Additional options output one or more `.sql` files organized by either 'SchemaObjectType' (files in folders for each schema and object type), 'Schema' (files in folders for each schema), 'ObjectType' (files in folders for each object type), 'Flat' (all files in the same folder), or 'File' (1 single file)."
+ },
+ {
+ "name": "ExtractUsageProperties",
+ "type": "bool",
+ "help": "Specifies whether usage properties, such as table row count and index size, will be extracted from the database."
+ },
+ {
+ "name": "HashObjectNamesInLogs",
+ "type": "bool",
+ "help": "Specifies whether to replace all object names in logs with a random hash value."
+ },
+ {
+ "name": "IgnoreExtendedProperties",
+ "type": "bool",
+ "help": "Specifies whether extended properties should be ignored."
+ },
+ {
+ "name": "IgnorePermissions",
+ "type": "bool",
+ "help": "Specifies whether permissions should be ignored."
+ },
+ {
+ "name": "IgnoreUserLoginMappings",
+ "type": "bool",
+ "help": "Specifies whether relationships between users and logins are ignored."
+ },
+ {
+ "name": "LongRunningCommandTimeout",
+ "type": "int",
+ "help": "Specifies the long running command timeout in seconds when executing queries against SQL Server. Use 0 to wait indefinitely."
+ },
+ {
+ "name": "Storage",
+ "type": "StorageType",
+ "help": "Specifies the type of backing storage for the schema model used during extraction. 'Memory' is default for .NET Core version of SqlPackage. 'File' is only available and default for .NET Framework version of SqlPackage."
+ },
+ {
+ "name": "TableData",
+ "type": "string",
+ "help": "Indicates the table from which data will be extracted. Specify the table name with or without the brackets surrounding the name parts in the following format: schema_name.table_identifier. This property may be specified multiple times to indicate multiple options."
+ },
+ {
+ "name": "TempDirectoryForTableData",
+ "type": "string",
+ "help": "Specifies the temporary directory used to buffer table data before being written to the package file."
+ },
+ {
+ "name": "VerifyExtraction",
+ "type": "bool",
+ "help": "Specifies whether the extracted schema model should be verified."
+ }
+ ]
+ },
+ {
+ "name": "Quiet",
+ "type": "bool",
+ "format": "/Quiet:{value}",
+ "help": "Specifies whether detailed feedback is suppressed. Defaults to False."
+ },
+ {
+ "name": "SourceConnectionString",
+ "type": "string",
+ "format": "/SourceConnectionString:{value}",
+ "help": "Specifies a valid [SQL Server/Azure connection string](/dotnet/api/microsoft.data.sqlclient.sqlconnection.connectionstring) to the source database. If this parameter is specified, it shall be used exclusively of all other source parameters."
+ },
+ {
+ "name": "SourceDatabaseName",
+ "type": "string",
+ "format": "/SourceDatabaseName:{value}",
+ "help": "Defines the name of the source database."
+ },
+ {
+ "name": "SourceEncryptConnection",
+ "type": "EncryptionType",
+ "format": "/SourceEncryptConnection:{value}",
+ "help": "Specifies if SQL encryption should be used for the source database connection. Default value is True."
+ },
+ {
+ "name": "SourceHostNameInCertificate",
+ "type": "string",
+ "format": "/SourceHostNameInCertificate:{value}",
+ "help": "Specifies value that is used to validate the source SQL Server TLS/SSL certificate when the communication layer is encrypted by using TLS."
+ },
+ {
+ "name": "SourcePassword",
+ "type": "string",
+ "format": "/SourcePassword:{value}",
+ "help": "For SQL Server Auth scenarios, defines the password to use to access the source database."
+ },
+ {
+ "name": "SourceServerName",
+ "type": "string",
+ "format": "/SourceServerName:{value}",
+ "help": "Defines the name of the server hosting the source database."
+ },
+ {
+ "name": "SourceTimeout",
+ "type": "int",
+ "format": "/SourceTimeout:{value}",
+ "help": "Specifies the timeout for establishing a connection to the source database in seconds."
+ },
+ {
+ "name": "SourceTrustServerCertificate",
+ "type": "bool",
+ "format": "/SourceTrustServerCertificate:{value}",
+ "help": "Specifies whether to use TLS to encrypt the source database connection and bypass walking the certificate chain to validate trust. Default value is False."
+ },
+ {
+ "name": "SourceUser",
+ "type": "string",
+ "format": "/SourceUser:{value}",
+ "help": "For SQL Server Auth scenarios, defines the SQL Server user to use to access the source database."
+ },
+ {
+ "name": "TargetFile",
+ "type": "string",
+ "format": "/TargetFile:{value}",
+ "help": "Specifies a target file (that is, a .dacpac file) in local storage to be used as the target of action instead of a database. If this parameter is used, no other target parameter shall be valid. This parameter shall be invalid for actions that only support database targets."
+ },
+ {
+ "name": "TenantId",
+ "type": "string",
+ "format": "/TenantId:{value}",
+ "help": "Represents the Azure AD tenant ID or domain name. This option is required to support guest or imported Azure AD 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 Azure AD will be used, assuming that the authenticated user is a native user for this AD. However, in this case any guest or imported users and/or Microsoft accounts hosted in this Azure AD are not supported and the operation will fail.
For more information about Active Directory Universal Authentication, see [Universal Authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication)."
+ },
+ {
+ "name": "ThreadMaxStackSize",
+ "type": "int",
+ "format": "/ThreadMaxStackSize:{value}",
+ "help": "Specifies the maximum size in megabytes for the thread running the SqlPackage action. This option should only be used when encountering stack overflow exceptions that occur when parsing very large TSQL statements."
+ },
+ {
+ "name": "UniversalAuthentication",
+ "type": "bool",
+ "format": "/UniversalAuthentication:{value}",
+ "help": "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 Azure AD 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 Azure AD authentication can be specified in SourceConnectionString (/scs). When /UniversalAuthentication is set to False, Azure AD authentication must be specified in SourceConnectionString (/scs).
For more information about Active Directory Universal Authentication, see [Universal Authentication with SQL Database and Azure Synapse Analytics (SSMS support for MFA)](/azure/sql-database/sql-database-ssms-mfa-authentication)."
+ }
+ ]
+ }
+ }
+ ],
+ "enumerations": [
+ {
+ "name": "AzureKeyVaultAuthMethod",
+ "values": [
+ "Interactive",
+ "ClientIdSecret"
+ ]
+ },
+ {
+ "name": "EncryptionType",
+ "values": [
+ "Optional",
+ "Mandatory",
+ "Strict",
+ "True",
+ "False"
+ ]
+ },
+ {
+ "name": "DatabaseEdition",
+ "values": [
+ "Basic",
+ "Standard",
+ "Premium",
+ "Datawarehouse",
+ "GeneralPurpose",
+ "BusinessCritical",
+ "Hyperscale",
+ "Default"
+ ]
+ },
+ {
+ "name": "StorageType",
+ "values": [
+ "File",
+ "Memory"
+ ]
+ },
+ {
+ "name": "CompressionOption",
+ "values": [
+ "Normal",
+ "Maximum",
+ "Fast",
+ "SuperFast",
+ "NotCompressed"
+ ]
+ },
+ {
+ "name": "TargetEngineVersion",
+ "values": [
+ "Default",
+ "Latest",
+ "V11",
+ "V12"
+ ]
+ },
+ {
+ "name": "ExtractTarget",
+ "values": [
+ "DacPac",
+ "File",
+ "Flat",
+ "ObjectType",
+ "Schema",
+ "SchemaObjectType"
+ ]
+ }
+ ]
+}
diff --git a/source/Nuke.Common/Tools/SqlPackage/SqlPackage.md b/source/Nuke.Common/Tools/SqlPackage/SqlPackage.md
new file mode 100644
index 000000000..b2caefe80
--- /dev/null
+++ b/source/Nuke.Common/Tools/SqlPackage/SqlPackage.md
@@ -0,0 +1,16 @@
+Using SqlPackage Tool Wrapper
+
+Overview
+
+The [SqlPackage](https://learn.microsoft.com/en-us/sql/tools/sqlpackage/sqlpackage) is a command-line utility that automates the following database development tasks by exposing some of the public Data-Tier Application Framework (DacFx) APIs.
+
+This package wraps [SqlPackage Global .NET Tool](https://learn.microsoft.com/en-us/sql/tools/sqlpackage/sqlpackage-download) Nuget package into Nuke tasks
+
+
+Usage
+
+Install SqlPackage Global tool into Nuke build project.
+
+ nuke :add-package Microsoft.SqlPackage --version
+
+SqlPackage as a Nuke Task (SqlPackageTasks) uses Microsoft.SqlPackage location to find entry point executable.
diff --git a/source/Nuke.Common/Tools/SqlPackage/SqlPackageTasks.cs b/source/Nuke.Common/Tools/SqlPackage/SqlPackageTasks.cs
new file mode 100644
index 000000000..9bf4899e7
--- /dev/null
+++ b/source/Nuke.Common/Tools/SqlPackage/SqlPackageTasks.cs
@@ -0,0 +1,12 @@
+ο»Ώusing Nuke.Common.Tooling;
+
+namespace Nuke.Common.Tools.SqlPackage;
+
+public partial class SqlPackageTasks
+{
+ internal static string GetToolPath()
+ {
+ return NuGetToolPathResolver.GetPackageExecutable(packageId: "Microsoft.SqlPackage", packageExecutable: "sqlpackage.dll|sqlpackage.exe");
+ }
+}
+
diff --git a/source/Nuke.Common/Tools/Teams/TeamsTasks.cs b/source/Nuke.Common/Tools/Teams/TeamsTasks.cs
index a1821f028..4c029e372 100644
--- a/source/Nuke.Common/Tools/Teams/TeamsTasks.cs
+++ b/source/Nuke.Common/Tools/Teams/TeamsTasks.cs
@@ -7,7 +7,6 @@
using System.Net.Http;
using System.Threading.Tasks;
using JetBrains.Annotations;
-using Newtonsoft.Json;
using Nuke.Common.Tooling;
using Nuke.Common.Utilities.Net;
@@ -24,12 +23,11 @@ public static void SendTeamsMessage(Configure configurator, string
public static async Task SendTeamsMessageAsync(Configure configurator, string webhook)
{
var message = configurator(new TeamsMessage());
- var messageJson = JsonConvert.SerializeObject(message);
using var client = new HttpClient();
var response = await client.CreateRequest(HttpMethod.Post, webhook)
- .WithJsonContent(messageJson)
+ .WithJsonContent(message)
.GetResponseAsync();
var responseText = await response.GetBodyAsync();
diff --git a/source/Nuke.Tooling.Tests/ArgumentStringHandlerTest.cs b/source/Nuke.Tooling.Tests/ArgumentStringHandlerTest.cs
index f30a9ee54..cbcd0e3c0 100644
--- a/source/Nuke.Tooling.Tests/ArgumentStringHandlerTest.cs
+++ b/source/Nuke.Tooling.Tests/ArgumentStringHandlerTest.cs
@@ -7,6 +7,8 @@
using Nuke.Common.Tooling;
using Xunit;
+// ReSharper disable StringLiteralAsInterpolationArgument
+
namespace Nuke.Common.Tests;
public class ArgumentStringHandlerTest
@@ -80,5 +82,5 @@ public void TestSecret()
filteredOutput.Should().Be("There is a [REDACTED]!");
}
- string ArgsToString(ArgumentStringHandler args) => args.ToStringAndClear();
+ private string ArgsToString(ArgumentStringHandler args) => args.ToStringAndClear();
}
diff --git a/source/Nuke.Tooling/ProcessTasks.cs b/source/Nuke.Tooling/ProcessTasks.cs
index 2b98b52b5..5a184e6f5 100644
--- a/source/Nuke.Tooling/ProcessTasks.cs
+++ b/source/Nuke.Tooling/ProcessTasks.cs
@@ -211,9 +211,8 @@ private static BlockingCollection