1. Packages
  2. Packages
  3. dbt Cloud Provider
  4. API Docs
  5. SynapseCredential
Viewing docs for dbt Cloud v1.8.1
published on Friday, May 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-dbtcloud

dbtcloud.SynapseCredential

dbtcloud logo
Viewing docs for dbt Cloud v1.8.1
published on Friday, May 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-dbtcloud

    Synapse credential resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as dbtcloud from "@pulumi/dbtcloud";

// Using the classic sensitive attributes (stored in state)
// when using sql authentication
const mySynapseCredSql = new dbtcloud.SynapseCredential("my_synapse_cred_sql", {
    projectId: dbtProject.id,
    authentication: "sql",
    schema: "my_schema",
    user: "my_user",
    password: "my_password",
    schemaAuthorization: "abcd",
});
// when using AD authentication
const mySynapseCredAd = new dbtcloud.SynapseCredential("my_synapse_cred_ad", {
    projectId: dbtProject.id,
    authentication: "ActiveDirectoryPassword",
    schema: "my_schema",
    user: "my_user",
    password: "my_password",
    schemaAuthorization: "abcd",
});
// when using service principal authentication
const mySynapseCredServPrinc = new dbtcloud.SynapseCredential("my_synapse_cred_serv_princ", {
    projectId: dbtProject.id,
    authentication: "ServicePrincipal",
    schema: "my_schema",
    clientId: "my_client_id",
    tenantId: "my_tenant_id",
    clientSecret: "my_secret",
    schemaAuthorization: "abcd",
});
const config = new pulumi.Config();
const synapsePassword = config.require("synapsePassword");
const synapseClientSecret = config.require("synapseClientSecret");
// when using AD authentication with write-only password
const mySynapseCredAdWo = new dbtcloud.SynapseCredential("my_synapse_cred_ad_wo", {
    projectId: dbtProject.id,
    authentication: "ActiveDirectoryPassword",
    schema: "my_schema",
    user: "my_user",
    passwordWo: synapsePassword,
    passwordWoVersion: 1,
    schemaAuthorization: "abcd",
});
// when using service principal authentication with write-only client secret
const mySynapseCredServPrincWo = new dbtcloud.SynapseCredential("my_synapse_cred_serv_princ_wo", {
    projectId: dbtProject.id,
    authentication: "ServicePrincipal",
    schema: "my_schema",
    clientId: "my_client_id",
    tenantId: "my_tenant_id",
    clientSecretWo: synapseClientSecret,
    clientSecretWoVersion: 1,
    schemaAuthorization: "abcd",
});

    import pulumi
import pulumi_dbtcloud as dbtcloud

# Using the classic sensitive attributes (stored in state)
# when using sql authentication
my_synapse_cred_sql = dbtcloud.SynapseCredential("my_synapse_cred_sql",
    project_id=dbt_project["id"],
    authentication="sql",
    schema="my_schema",
    user="my_user",
    password="my_password",
    schema_authorization="abcd")
# when using AD authentication
my_synapse_cred_ad = dbtcloud.SynapseCredential("my_synapse_cred_ad",
    project_id=dbt_project["id"],
    authentication="ActiveDirectoryPassword",
    schema="my_schema",
    user="my_user",
    password="my_password",
    schema_authorization="abcd")
# when using service principal authentication
my_synapse_cred_serv_princ = dbtcloud.SynapseCredential("my_synapse_cred_serv_princ",
    project_id=dbt_project["id"],
    authentication="ServicePrincipal",
    schema="my_schema",
    client_id="my_client_id",
    tenant_id="my_tenant_id",
    client_secret="my_secret",
    schema_authorization="abcd")
config = pulumi.Config()
synapse_password = config.require("synapsePassword")
synapse_client_secret = config.require("synapseClientSecret")
# when using AD authentication with write-only password
my_synapse_cred_ad_wo = dbtcloud.SynapseCredential("my_synapse_cred_ad_wo",
    project_id=dbt_project["id"],
    authentication="ActiveDirectoryPassword",
    schema="my_schema",
    user="my_user",
    password_wo=synapse_password,
    password_wo_version=1,
    schema_authorization="abcd")
# when using service principal authentication with write-only client secret
my_synapse_cred_serv_princ_wo = dbtcloud.SynapseCredential("my_synapse_cred_serv_princ_wo",
    project_id=dbt_project["id"],
    authentication="ServicePrincipal",
    schema="my_schema",
    client_id="my_client_id",
    tenant_id="my_tenant_id",
    client_secret_wo=synapse_client_secret,
    client_secret_wo_version=1,
    schema_authorization="abcd")

    package main

import (
	"github.com/pulumi/pulumi-dbtcloud/sdk/go/dbtcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Using the classic sensitive attributes (stored in state)
		// when using sql authentication
		_, err := dbtcloud.NewSynapseCredential(ctx, "my_synapse_cred_sql", &dbtcloud.SynapseCredentialArgs{
			ProjectId:           pulumi.Any(dbtProject.Id),
			Authentication:      pulumi.String("sql"),
			Schema:              pulumi.String("my_schema"),
			User:                pulumi.String("my_user"),
			Password:            pulumi.String("my_password"),
			SchemaAuthorization: pulumi.String("abcd"),
		})
		if err != nil {
			return err
		}
		// when using AD authentication
		_, err = dbtcloud.NewSynapseCredential(ctx, "my_synapse_cred_ad", &dbtcloud.SynapseCredentialArgs{
			ProjectId:           pulumi.Any(dbtProject.Id),
			Authentication:      pulumi.String("ActiveDirectoryPassword"),
			Schema:              pulumi.String("my_schema"),
			User:                pulumi.String("my_user"),
			Password:            pulumi.String("my_password"),
			SchemaAuthorization: pulumi.String("abcd"),
		})
		if err != nil {
			return err
		}
		// when using service principal authentication
		_, err = dbtcloud.NewSynapseCredential(ctx, "my_synapse_cred_serv_princ", &dbtcloud.SynapseCredentialArgs{
			ProjectId:           pulumi.Any(dbtProject.Id),
			Authentication:      pulumi.String("ServicePrincipal"),
			Schema:              pulumi.String("my_schema"),
			ClientId:            pulumi.String("my_client_id"),
			TenantId:            pulumi.String("my_tenant_id"),
			ClientSecret:        pulumi.String("my_secret"),
			SchemaAuthorization: pulumi.String("abcd"),
		})
		if err != nil {
			return err
		}
		cfg := config.New(ctx, "")
		synapsePassword := cfg.Require("synapsePassword")
		synapseClientSecret := cfg.Require("synapseClientSecret")
		// when using AD authentication with write-only password
		_, err = dbtcloud.NewSynapseCredential(ctx, "my_synapse_cred_ad_wo", &dbtcloud.SynapseCredentialArgs{
			ProjectId:           pulumi.Any(dbtProject.Id),
			Authentication:      pulumi.String("ActiveDirectoryPassword"),
			Schema:              pulumi.String("my_schema"),
			User:                pulumi.String("my_user"),
			PasswordWo:          pulumi.String(pulumi.String(synapsePassword)),
			PasswordWoVersion:   pulumi.Int(1),
			SchemaAuthorization: pulumi.String("abcd"),
		})
		if err != nil {
			return err
		}
		// when using service principal authentication with write-only client secret
		_, err = dbtcloud.NewSynapseCredential(ctx, "my_synapse_cred_serv_princ_wo", &dbtcloud.SynapseCredentialArgs{
			ProjectId:             pulumi.Any(dbtProject.Id),
			Authentication:        pulumi.String("ServicePrincipal"),
			Schema:                pulumi.String("my_schema"),
			ClientId:              pulumi.String("my_client_id"),
			TenantId:              pulumi.String("my_tenant_id"),
			ClientSecretWo:        pulumi.String(pulumi.String(synapseClientSecret)),
			ClientSecretWoVersion: pulumi.Int(1),
			SchemaAuthorization:   pulumi.String("abcd"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DbtCloud = Pulumi.DbtCloud;

return await Deployment.RunAsync(() => 
{
    // Using the classic sensitive attributes (stored in state)
    // when using sql authentication
    var mySynapseCredSql = new DbtCloud.Index.SynapseCredential("my_synapse_cred_sql", new()
    {
        ProjectId = dbtProject.Id,
        Authentication = "sql",
        Schema = "my_schema",
        User = "my_user",
        Password = "my_password",
        SchemaAuthorization = "abcd",
    });

    // when using AD authentication
    var mySynapseCredAd = new DbtCloud.Index.SynapseCredential("my_synapse_cred_ad", new()
    {
        ProjectId = dbtProject.Id,
        Authentication = "ActiveDirectoryPassword",
        Schema = "my_schema",
        User = "my_user",
        Password = "my_password",
        SchemaAuthorization = "abcd",
    });

    // when using service principal authentication
    var mySynapseCredServPrinc = new DbtCloud.Index.SynapseCredential("my_synapse_cred_serv_princ", new()
    {
        ProjectId = dbtProject.Id,
        Authentication = "ServicePrincipal",
        Schema = "my_schema",
        ClientId = "my_client_id",
        TenantId = "my_tenant_id",
        ClientSecret = "my_secret",
        SchemaAuthorization = "abcd",
    });

    var config = new Config();
    var synapsePassword = config.Require("synapsePassword");
    var synapseClientSecret = config.Require("synapseClientSecret");
    // when using AD authentication with write-only password
    var mySynapseCredAdWo = new DbtCloud.Index.SynapseCredential("my_synapse_cred_ad_wo", new()
    {
        ProjectId = dbtProject.Id,
        Authentication = "ActiveDirectoryPassword",
        Schema = "my_schema",
        User = "my_user",
        PasswordWo = synapsePassword,
        PasswordWoVersion = 1,
        SchemaAuthorization = "abcd",
    });

    // when using service principal authentication with write-only client secret
    var mySynapseCredServPrincWo = new DbtCloud.Index.SynapseCredential("my_synapse_cred_serv_princ_wo", new()
    {
        ProjectId = dbtProject.Id,
        Authentication = "ServicePrincipal",
        Schema = "my_schema",
        ClientId = "my_client_id",
        TenantId = "my_tenant_id",
        ClientSecretWo = synapseClientSecret,
        ClientSecretWoVersion = 1,
        SchemaAuthorization = "abcd",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dbtcloud.SynapseCredential;
import com.pulumi.dbtcloud.SynapseCredentialArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        // Using the classic sensitive attributes (stored in state)
        // when using sql authentication
        var mySynapseCredSql = new SynapseCredential("mySynapseCredSql", SynapseCredentialArgs.builder()
            .projectId(dbtProject.id())
            .authentication("sql")
            .schema("my_schema")
            .user("my_user")
            .password("my_password")
            .schemaAuthorization("abcd")
            .build());

        // when using AD authentication
        var mySynapseCredAd = new SynapseCredential("mySynapseCredAd", SynapseCredentialArgs.builder()
            .projectId(dbtProject.id())
            .authentication("ActiveDirectoryPassword")
            .schema("my_schema")
            .user("my_user")
            .password("my_password")
            .schemaAuthorization("abcd")
            .build());

        // when using service principal authentication
        var mySynapseCredServPrinc = new SynapseCredential("mySynapseCredServPrinc", SynapseCredentialArgs.builder()
            .projectId(dbtProject.id())
            .authentication("ServicePrincipal")
            .schema("my_schema")
            .clientId("my_client_id")
            .tenantId("my_tenant_id")
            .clientSecret("my_secret")
            .schemaAuthorization("abcd")
            .build());

        final var synapsePassword = config.require("synapsePassword");
        final var synapseClientSecret = config.require("synapseClientSecret");
        // when using AD authentication with write-only password
        var mySynapseCredAdWo = new SynapseCredential("mySynapseCredAdWo", SynapseCredentialArgs.builder()
            .projectId(dbtProject.id())
            .authentication("ActiveDirectoryPassword")
            .schema("my_schema")
            .user("my_user")
            .passwordWo(synapsePassword)
            .passwordWoVersion(1)
            .schemaAuthorization("abcd")
            .build());

        // when using service principal authentication with write-only client secret
        var mySynapseCredServPrincWo = new SynapseCredential("mySynapseCredServPrincWo", SynapseCredentialArgs.builder()
            .projectId(dbtProject.id())
            .authentication("ServicePrincipal")
            .schema("my_schema")
            .clientId("my_client_id")
            .tenantId("my_tenant_id")
            .clientSecretWo(synapseClientSecret)
            .clientSecretWoVersion(1)
            .schemaAuthorization("abcd")
            .build());

    }
}

    configuration:
  # Using write-only attributes (not stored in state, requires Terraform >= 1.11)
  # //
  # // The password_wo and client_secret_wo values are never persisted in the Terraform state file.
  # // Use password_wo_version / client_secret_wo_version to trigger an update when the secret changes.
  synapsePassword:
    type: string
  synapseClientSecret:
    type: string
resources:
  # Using the classic sensitive attributes (stored in state)

  # when using sql authentication
  mySynapseCredSql:
    type: dbtcloud:SynapseCredential
    name: my_synapse_cred_sql
    properties:
      projectId: ${dbtProject.id}
      authentication: sql
      schema: my_schema
      user: my_user
      password: my_password
      schemaAuthorization: abcd
  # when using AD authentication
  mySynapseCredAd:
    type: dbtcloud:SynapseCredential
    name: my_synapse_cred_ad
    properties:
      projectId: ${dbtProject.id}
      authentication: ActiveDirectoryPassword
      schema: my_schema
      user: my_user
      password: my_password
      schemaAuthorization: abcd
  # when using service principal authentication
  mySynapseCredServPrinc:
    type: dbtcloud:SynapseCredential
    name: my_synapse_cred_serv_princ
    properties:
      projectId: ${dbtProject.id}
      authentication: ServicePrincipal
      schema: my_schema
      clientId: my_client_id
      tenantId: my_tenant_id
      clientSecret: my_secret
      schemaAuthorization: abcd
  # when using AD authentication with write-only password
  mySynapseCredAdWo:
    type: dbtcloud:SynapseCredential
    name: my_synapse_cred_ad_wo
    properties:
      projectId: ${dbtProject.id}
      authentication: ActiveDirectoryPassword
      schema: my_schema
      user: my_user
      passwordWo: ${synapsePassword}
      passwordWoVersion: 1
      schemaAuthorization: abcd
  # when using service principal authentication with write-only client secret
  mySynapseCredServPrincWo:
    type: dbtcloud:SynapseCredential
    name: my_synapse_cred_serv_princ_wo
    properties:
      projectId: ${dbtProject.id}
      authentication: ServicePrincipal
      schema: my_schema
      clientId: my_client_id
      tenantId: my_tenant_id
      clientSecretWo: ${synapseClientSecret}
      clientSecretWoVersion: 1
      schemaAuthorization: abcd

    Create SynapseCredential Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SynapseCredential(name: string, args: SynapseCredentialArgs, opts?: CustomResourceOptions);
    @overload
def SynapseCredential(resource_name: str,
                      args: SynapseCredentialArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def SynapseCredential(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      project_id: Optional[int] = None,
                      authentication: Optional[str] = None,
                      schema: Optional[str] = None,
                      adapter_type: Optional[str] = None,
                      client_secret: Optional[str] = None,
                      client_secret_wo_version: Optional[int] = None,
                      password: Optional[str] = None,
                      password_wo: Optional[str] = None,
                      password_wo_version: Optional[int] = None,
                      client_secret_wo: Optional[str] = None,
                      client_id: Optional[str] = None,
                      schema_authorization: Optional[str] = None,
                      tenant_id: Optional[str] = None,
                      user: Optional[str] = None)
    func NewSynapseCredential(ctx *Context, name string, args SynapseCredentialArgs, opts ...ResourceOption) (*SynapseCredential, error)
    public SynapseCredential(string name, SynapseCredentialArgs args, CustomResourceOptions? opts = null)
    public SynapseCredential(String name, SynapseCredentialArgs args)
public SynapseCredential(String name, SynapseCredentialArgs args, CustomResourceOptions options)

    type: dbtcloud:SynapseCredential
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SynapseCredentialArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SynapseCredentialArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SynapseCredentialArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SynapseCredentialArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SynapseCredentialArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var synapseCredentialResource = new DbtCloud.SynapseCredential("synapseCredentialResource", new()
{
    ProjectId = 0,
    Authentication = "string",
    Schema = "string",
    AdapterType = "string",
    ClientSecret = "string",
    ClientSecretWoVersion = 0,
    Password = "string",
    PasswordWo = "string",
    PasswordWoVersion = 0,
    ClientSecretWo = "string",
    ClientId = "string",
    SchemaAuthorization = "string",
    TenantId = "string",
    User = "string",
});

    example, err := dbtcloud.NewSynapseCredential(ctx, "synapseCredentialResource", &dbtcloud.SynapseCredentialArgs{
	ProjectId:             pulumi.Int(0),
	Authentication:        pulumi.String("string"),
	Schema:                pulumi.String("string"),
	AdapterType:           pulumi.String("string"),
	ClientSecret:          pulumi.String("string"),
	ClientSecretWoVersion: pulumi.Int(0),
	Password:              pulumi.String("string"),
	PasswordWo:            pulumi.String("string"),
	PasswordWoVersion:     pulumi.Int(0),
	ClientSecretWo:        pulumi.String("string"),
	ClientId:              pulumi.String("string"),
	SchemaAuthorization:   pulumi.String("string"),
	TenantId:              pulumi.String("string"),
	User:                  pulumi.String("string"),
})

    var synapseCredentialResource = new SynapseCredential("synapseCredentialResource", SynapseCredentialArgs.builder()
    .projectId(0)
    .authentication("string")
    .schema("string")
    .adapterType("string")
    .clientSecret("string")
    .clientSecretWoVersion(0)
    .password("string")
    .passwordWo("string")
    .passwordWoVersion(0)
    .clientSecretWo("string")
    .clientId("string")
    .schemaAuthorization("string")
    .tenantId("string")
    .user("string")
    .build());

    synapse_credential_resource = dbtcloud.SynapseCredential("synapseCredentialResource",
    project_id=0,
    authentication="string",
    schema="string",
    adapter_type="string",
    client_secret="string",
    client_secret_wo_version=0,
    password="string",
    password_wo="string",
    password_wo_version=0,
    client_secret_wo="string",
    client_id="string",
    schema_authorization="string",
    tenant_id="string",
    user="string")

    const synapseCredentialResource = new dbtcloud.SynapseCredential("synapseCredentialResource", {
    projectId: 0,
    authentication: "string",
    schema: "string",
    adapterType: "string",
    clientSecret: "string",
    clientSecretWoVersion: 0,
    password: "string",
    passwordWo: "string",
    passwordWoVersion: 0,
    clientSecretWo: "string",
    clientId: "string",
    schemaAuthorization: "string",
    tenantId: "string",
    user: "string",
});

    type: dbtcloud:SynapseCredential
properties:
    adapterType: string
    authentication: string
    clientId: string
    clientSecret: string
    clientSecretWo: string
    clientSecretWoVersion: 0
    password: string
    passwordWo: string
    passwordWoVersion: 0
    projectId: 0
    schema: string
    schemaAuthorization: string
    tenantId: string
    user: string

    SynapseCredential Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SynapseCredential resource accepts the following input properties:

    AdapterType string
    The type of the adapter (synapse)
    Authentication string
    Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
    ProjectId int
    Project ID to create the Synapse credential in
    Schema string
    The schema where to create the dbt models
    ClientId string
    The client ID of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal.
    ClientSecret string
    The client secret of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal. Consider using clientSecretWo instead, which is not stored in state.
    ClientSecretWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to clientSecret. The value is not stored in state. Requires clientSecretWoVersion to trigger updates.
    ClientSecretWoVersion int
    Version number for clientSecretWo. Increment this value to trigger an update of the client secret when using clientSecretWo.
    Password string
    The password for the account to connect to. Only used when connection with AD user/pass. Consider using passwordWo instead, which is not stored in state.
    PasswordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    PasswordWoVersion int
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    SchemaAuthorization string
    Optionally set this to the principal who should own the schemas created by dbt
    TenantId string
    The tenant ID of the Azure Active Directory instance. This is only used when connecting to Azure SQL with a service principal.
    User string
    The username of the Synapse account to connect to. Only used when connection with AD user/pass
    AdapterType string
    The type of the adapter (synapse)
    Authentication string
    Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
    ProjectId int
    Project ID to create the Synapse credential in
    Schema string
    The schema where to create the dbt models
    ClientId string
    The client ID of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal.
    ClientSecret string
    The client secret of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal. Consider using clientSecretWo instead, which is not stored in state.
    ClientSecretWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to clientSecret. The value is not stored in state. Requires clientSecretWoVersion to trigger updates.
    ClientSecretWoVersion int
    Version number for clientSecretWo. Increment this value to trigger an update of the client secret when using clientSecretWo.
    Password string
    The password for the account to connect to. Only used when connection with AD user/pass. Consider using passwordWo instead, which is not stored in state.
    PasswordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    PasswordWoVersion int
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    SchemaAuthorization string
    Optionally set this to the principal who should own the schemas created by dbt
    TenantId string
    The tenant ID of the Azure Active Directory instance. This is only used when connecting to Azure SQL with a service principal.
    User string
    The username of the Synapse account to connect to. Only used when connection with AD user/pass
    adapterType String
    The type of the adapter (synapse)
    authentication String
    Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
    projectId Integer
    Project ID to create the Synapse credential in
    schema String
    The schema where to create the dbt models
    clientId String
    The client ID of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal.
    clientSecret String
    The client secret of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal. Consider using clientSecretWo instead, which is not stored in state.
    clientSecretWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to clientSecret. The value is not stored in state. Requires clientSecretWoVersion to trigger updates.
    clientSecretWoVersion Integer
    Version number for clientSecretWo. Increment this value to trigger an update of the client secret when using clientSecretWo.
    password String
    The password for the account to connect to. Only used when connection with AD user/pass. Consider using passwordWo instead, which is not stored in state.
    passwordWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    passwordWoVersion Integer
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    schemaAuthorization String
    Optionally set this to the principal who should own the schemas created by dbt
    tenantId String
    The tenant ID of the Azure Active Directory instance. This is only used when connecting to Azure SQL with a service principal.
    user String
    The username of the Synapse account to connect to. Only used when connection with AD user/pass
    adapterType string
    The type of the adapter (synapse)
    authentication string
    Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
    projectId number
    Project ID to create the Synapse credential in
    schema string
    The schema where to create the dbt models
    clientId string
    The client ID of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal.
    clientSecret string
    The client secret of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal. Consider using clientSecretWo instead, which is not stored in state.
    clientSecretWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to clientSecret. The value is not stored in state. Requires clientSecretWoVersion to trigger updates.
    clientSecretWoVersion number
    Version number for clientSecretWo. Increment this value to trigger an update of the client secret when using clientSecretWo.
    password string
    The password for the account to connect to. Only used when connection with AD user/pass. Consider using passwordWo instead, which is not stored in state.
    passwordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    passwordWoVersion number
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    schemaAuthorization string
    Optionally set this to the principal who should own the schemas created by dbt
    tenantId string
    The tenant ID of the Azure Active Directory instance. This is only used when connecting to Azure SQL with a service principal.
    user string
    The username of the Synapse account to connect to. Only used when connection with AD user/pass
    adapter_type str
    The type of the adapter (synapse)
    authentication str
    Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
    project_id int
    Project ID to create the Synapse credential in
    schema str
    The schema where to create the dbt models
    client_id str
    The client ID of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal.
    client_secret str
    The client secret of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal. Consider using clientSecretWo instead, which is not stored in state.
    client_secret_wo str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to clientSecret. The value is not stored in state. Requires clientSecretWoVersion to trigger updates.
    client_secret_wo_version int
    Version number for clientSecretWo. Increment this value to trigger an update of the client secret when using clientSecretWo.
    password str
    The password for the account to connect to. Only used when connection with AD user/pass. Consider using passwordWo instead, which is not stored in state.
    password_wo str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    password_wo_version int
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    schema_authorization str
    Optionally set this to the principal who should own the schemas created by dbt
    tenant_id str
    The tenant ID of the Azure Active Directory instance. This is only used when connecting to Azure SQL with a service principal.
    user str
    The username of the Synapse account to connect to. Only used when connection with AD user/pass
    adapterType String
    The type of the adapter (synapse)
    authentication String
    Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
    projectId Number
    Project ID to create the Synapse credential in
    schema String
    The schema where to create the dbt models
    clientId String
    The client ID of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal.
    clientSecret String
    The client secret of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal. Consider using clientSecretWo instead, which is not stored in state.
    clientSecretWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to clientSecret. The value is not stored in state. Requires clientSecretWoVersion to trigger updates.
    clientSecretWoVersion Number
    Version number for clientSecretWo. Increment this value to trigger an update of the client secret when using clientSecretWo.
    password String
    The password for the account to connect to. Only used when connection with AD user/pass. Consider using passwordWo instead, which is not stored in state.
    passwordWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    passwordWoVersion Number
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    schemaAuthorization String
    Optionally set this to the principal who should own the schemas created by dbt
    tenantId String
    The tenant ID of the Azure Active Directory instance. This is only used when connecting to Azure SQL with a service principal.
    user String
    The username of the Synapse account to connect to. Only used when connection with AD user/pass

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SynapseCredential resource produces the following output properties:

    CredentialId int
    The internal credential ID
    Id string
    The provider-assigned unique ID for this managed resource.
    CredentialId int
    The internal credential ID
    Id string
    The provider-assigned unique ID for this managed resource.
    credentialId Integer
    The internal credential ID
    id String
    The provider-assigned unique ID for this managed resource.
    credentialId number
    The internal credential ID
    id string
    The provider-assigned unique ID for this managed resource.
    credential_id int
    The internal credential ID
    id str
    The provider-assigned unique ID for this managed resource.
    credentialId Number
    The internal credential ID
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SynapseCredential Resource

    Get an existing SynapseCredential resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SynapseCredentialState, opts?: CustomResourceOptions): SynapseCredential
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adapter_type: Optional[str] = None,
        authentication: Optional[str] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        client_secret_wo: Optional[str] = None,
        client_secret_wo_version: Optional[int] = None,
        credential_id: Optional[int] = None,
        password: Optional[str] = None,
        password_wo: Optional[str] = None,
        password_wo_version: Optional[int] = None,
        project_id: Optional[int] = None,
        schema: Optional[str] = None,
        schema_authorization: Optional[str] = None,
        tenant_id: Optional[str] = None,
        user: Optional[str] = None) -> SynapseCredential
    func GetSynapseCredential(ctx *Context, name string, id IDInput, state *SynapseCredentialState, opts ...ResourceOption) (*SynapseCredential, error)
    public static SynapseCredential Get(string name, Input<string> id, SynapseCredentialState? state, CustomResourceOptions? opts = null)
    public static SynapseCredential get(String name, Output<String> id, SynapseCredentialState state, CustomResourceOptions options)
    resources:  _:    type: dbtcloud:SynapseCredential    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdapterType string
    The type of the adapter (synapse)
    Authentication string
    Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
    ClientId string
    The client ID of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal.
    ClientSecret string
    The client secret of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal. Consider using clientSecretWo instead, which is not stored in state.
    ClientSecretWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to clientSecret. The value is not stored in state. Requires clientSecretWoVersion to trigger updates.
    ClientSecretWoVersion int
    Version number for clientSecretWo. Increment this value to trigger an update of the client secret when using clientSecretWo.
    CredentialId int
    The internal credential ID
    Password string
    The password for the account to connect to. Only used when connection with AD user/pass. Consider using passwordWo instead, which is not stored in state.
    PasswordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    PasswordWoVersion int
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    ProjectId int
    Project ID to create the Synapse credential in
    Schema string
    The schema where to create the dbt models
    SchemaAuthorization string
    Optionally set this to the principal who should own the schemas created by dbt
    TenantId string
    The tenant ID of the Azure Active Directory instance. This is only used when connecting to Azure SQL with a service principal.
    User string
    The username of the Synapse account to connect to. Only used when connection with AD user/pass
    AdapterType string
    The type of the adapter (synapse)
    Authentication string
    Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
    ClientId string
    The client ID of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal.
    ClientSecret string
    The client secret of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal. Consider using clientSecretWo instead, which is not stored in state.
    ClientSecretWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to clientSecret. The value is not stored in state. Requires clientSecretWoVersion to trigger updates.
    ClientSecretWoVersion int
    Version number for clientSecretWo. Increment this value to trigger an update of the client secret when using clientSecretWo.
    CredentialId int
    The internal credential ID
    Password string
    The password for the account to connect to. Only used when connection with AD user/pass. Consider using passwordWo instead, which is not stored in state.
    PasswordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    PasswordWoVersion int
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    ProjectId int
    Project ID to create the Synapse credential in
    Schema string
    The schema where to create the dbt models
    SchemaAuthorization string
    Optionally set this to the principal who should own the schemas created by dbt
    TenantId string
    The tenant ID of the Azure Active Directory instance. This is only used when connecting to Azure SQL with a service principal.
    User string
    The username of the Synapse account to connect to. Only used when connection with AD user/pass
    adapterType String
    The type of the adapter (synapse)
    authentication String
    Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
    clientId String
    The client ID of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal.
    clientSecret String
    The client secret of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal. Consider using clientSecretWo instead, which is not stored in state.
    clientSecretWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to clientSecret. The value is not stored in state. Requires clientSecretWoVersion to trigger updates.
    clientSecretWoVersion Integer
    Version number for clientSecretWo. Increment this value to trigger an update of the client secret when using clientSecretWo.
    credentialId Integer
    The internal credential ID
    password String
    The password for the account to connect to. Only used when connection with AD user/pass. Consider using passwordWo instead, which is not stored in state.
    passwordWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    passwordWoVersion Integer
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    projectId Integer
    Project ID to create the Synapse credential in
    schema String
    The schema where to create the dbt models
    schemaAuthorization String
    Optionally set this to the principal who should own the schemas created by dbt
    tenantId String
    The tenant ID of the Azure Active Directory instance. This is only used when connecting to Azure SQL with a service principal.
    user String
    The username of the Synapse account to connect to. Only used when connection with AD user/pass
    adapterType string
    The type of the adapter (synapse)
    authentication string
    Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
    clientId string
    The client ID of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal.
    clientSecret string
    The client secret of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal. Consider using clientSecretWo instead, which is not stored in state.
    clientSecretWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to clientSecret. The value is not stored in state. Requires clientSecretWoVersion to trigger updates.
    clientSecretWoVersion number
    Version number for clientSecretWo. Increment this value to trigger an update of the client secret when using clientSecretWo.
    credentialId number
    The internal credential ID
    password string
    The password for the account to connect to. Only used when connection with AD user/pass. Consider using passwordWo instead, which is not stored in state.
    passwordWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    passwordWoVersion number
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    projectId number
    Project ID to create the Synapse credential in
    schema string
    The schema where to create the dbt models
    schemaAuthorization string
    Optionally set this to the principal who should own the schemas created by dbt
    tenantId string
    The tenant ID of the Azure Active Directory instance. This is only used when connecting to Azure SQL with a service principal.
    user string
    The username of the Synapse account to connect to. Only used when connection with AD user/pass
    adapter_type str
    The type of the adapter (synapse)
    authentication str
    Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
    client_id str
    The client ID of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal.
    client_secret str
    The client secret of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal. Consider using clientSecretWo instead, which is not stored in state.
    client_secret_wo str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to clientSecret. The value is not stored in state. Requires clientSecretWoVersion to trigger updates.
    client_secret_wo_version int
    Version number for clientSecretWo. Increment this value to trigger an update of the client secret when using clientSecretWo.
    credential_id int
    The internal credential ID
    password str
    The password for the account to connect to. Only used when connection with AD user/pass. Consider using passwordWo instead, which is not stored in state.
    password_wo str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    password_wo_version int
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    project_id int
    Project ID to create the Synapse credential in
    schema str
    The schema where to create the dbt models
    schema_authorization str
    Optionally set this to the principal who should own the schemas created by dbt
    tenant_id str
    The tenant ID of the Azure Active Directory instance. This is only used when connecting to Azure SQL with a service principal.
    user str
    The username of the Synapse account to connect to. Only used when connection with AD user/pass
    adapterType String
    The type of the adapter (synapse)
    authentication String
    Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
    clientId String
    The client ID of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal.
    clientSecret String
    The client secret of the Azure Active Directory service principal. This is only used when connecting to Azure SQL with an AAD service principal. Consider using clientSecretWo instead, which is not stored in state.
    clientSecretWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to clientSecret. The value is not stored in state. Requires clientSecretWoVersion to trigger updates.
    clientSecretWoVersion Number
    Version number for clientSecretWo. Increment this value to trigger an update of the client secret when using clientSecretWo.
    credentialId Number
    The internal credential ID
    password String
    The password for the account to connect to. Only used when connection with AD user/pass. Consider using passwordWo instead, which is not stored in state.
    passwordWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only alternative to password. The value is not stored in state. Requires passwordWoVersion to trigger updates.
    passwordWoVersion Number
    Version number for passwordWo. Increment this value to trigger an update of the password when using passwordWo.
    projectId Number
    Project ID to create the Synapse credential in
    schema String
    The schema where to create the dbt models
    schemaAuthorization String
    Optionally set this to the principal who should own the schemas created by dbt
    tenantId String
    The tenant ID of the Azure Active Directory instance. This is only used when connecting to Azure SQL with a service principal.
    user String
    The username of the Synapse account to connect to. Only used when connection with AD user/pass

    Import

    using import blocks (requires Terraform >= 1.5) import { to = dbtcloud_synapse_credential.my_synapse_credential id = “project_id:credential_id” }

    import { to = dbtcloud_synapse_credential.my_synapse_credential id = “12345:6789” }

    using the older import command

    $ pulumi import dbtcloud:index/synapseCredential:SynapseCredential my_synapse_credential "project_id:credential_id"
$ pulumi import dbtcloud:index/synapseCredential:SynapseCredential my_synapse_credential 12345:6789

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    dbtcloud pulumi/pulumi-dbtcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the dbtcloud Terraform Provider.
    dbtcloud logo
    Viewing docs for dbt Cloud v1.8.1
    published on Friday, May 8, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-dbtcloud
      Try Pulumi Cloud free. Your team will thank you.