published on Wednesday, Apr 15, 2026 by Pulumi
published on Wednesday, Apr 15, 2026 by Pulumi
Synapse credential resource
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:
- Adapter
Type string - The type of the adapter (synapse)
- Authentication string
- Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
- Project
Id int - Project ID to create the Synapse credential in
- Schema string
- The schema where to create the dbt models
- Client
Id 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.
- Client
Secret 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
clientSecretWoinstead, which is not stored in state. - Client
Secret stringWo - 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. RequiresclientSecretWoVersionto trigger updates. - Client
Secret intWo Version - Version number for
clientSecretWo. Increment this value to trigger an update of the client secret when usingclientSecretWo. - Password string
- The password for the account to connect to. Only used when connection with AD user/pass. Consider using
passwordWoinstead, which is not stored in state. - Password
Wo 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. RequirespasswordWoVersionto trigger updates. - Password
Wo intVersion - Version number for
passwordWo. Increment this value to trigger an update of the password when usingpasswordWo. - string
- Optionally set this to the principal who should own the schemas created by dbt
- Tenant
Id 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 string - The type of the adapter (synapse)
- Authentication string
- Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
- Project
Id int - Project ID to create the Synapse credential in
- Schema string
- The schema where to create the dbt models
- Client
Id 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.
- Client
Secret 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
clientSecretWoinstead, which is not stored in state. - Client
Secret stringWo - 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. RequiresclientSecretWoVersionto trigger updates. - Client
Secret intWo Version - Version number for
clientSecretWo. Increment this value to trigger an update of the client secret when usingclientSecretWo. - Password string
- The password for the account to connect to. Only used when connection with AD user/pass. Consider using
passwordWoinstead, which is not stored in state. - Password
Wo 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. RequirespasswordWoVersionto trigger updates. - Password
Wo intVersion - Version number for
passwordWo. Increment this value to trigger an update of the password when usingpasswordWo. - string
- Optionally set this to the principal who should own the schemas created by dbt
- Tenant
Id 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 String - The type of the adapter (synapse)
- authentication String
- Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
- project
Id Integer - Project ID to create the Synapse credential in
- schema String
- The schema where to create the dbt models
- client
Id 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.
- client
Secret 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
clientSecretWoinstead, which is not stored in state. - client
Secret StringWo - 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. RequiresclientSecretWoVersionto trigger updates. - client
Secret IntegerWo Version - Version number for
clientSecretWo. Increment this value to trigger an update of the client secret when usingclientSecretWo. - password String
- The password for the account to connect to. Only used when connection with AD user/pass. Consider using
passwordWoinstead, which is not stored in state. - password
Wo 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. RequirespasswordWoVersionto trigger updates. - password
Wo IntegerVersion - Version number for
passwordWo. Increment this value to trigger an update of the password when usingpasswordWo. - String
- Optionally set this to the principal who should own the schemas created by dbt
- tenant
Id 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 string - The type of the adapter (synapse)
- authentication string
- Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
- project
Id number - Project ID to create the Synapse credential in
- schema string
- The schema where to create the dbt models
- client
Id 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.
- client
Secret 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
clientSecretWoinstead, which is not stored in state. - client
Secret stringWo - 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. RequiresclientSecretWoVersionto trigger updates. - client
Secret numberWo Version - Version number for
clientSecretWo. Increment this value to trigger an update of the client secret when usingclientSecretWo. - password string
- The password for the account to connect to. Only used when connection with AD user/pass. Consider using
passwordWoinstead, which is not stored in state. - password
Wo 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. RequirespasswordWoVersionto trigger updates. - password
Wo numberVersion - Version number for
passwordWo. Increment this value to trigger an update of the password when usingpasswordWo. - string
- Optionally set this to the principal who should own the schemas created by dbt
- tenant
Id 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
clientSecretWoinstead, which is not stored in state. - client_
secret_ strwo - 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. RequiresclientSecretWoVersionto trigger updates. - client_
secret_ intwo_ version - Version number for
clientSecretWo. Increment this value to trigger an update of the client secret when usingclientSecretWo. - password str
- The password for the account to connect to. Only used when connection with AD user/pass. Consider using
passwordWoinstead, 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. RequirespasswordWoVersionto trigger updates. - password_
wo_ intversion - Version number for
passwordWo. Increment this value to trigger an update of the password when usingpasswordWo. - 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
- adapter
Type String - The type of the adapter (synapse)
- authentication String
- Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
- project
Id Number - Project ID to create the Synapse credential in
- schema String
- The schema where to create the dbt models
- client
Id 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.
- client
Secret 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
clientSecretWoinstead, which is not stored in state. - client
Secret StringWo - 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. RequiresclientSecretWoVersionto trigger updates. - client
Secret NumberWo Version - Version number for
clientSecretWo. Increment this value to trigger an update of the client secret when usingclientSecretWo. - password String
- The password for the account to connect to. Only used when connection with AD user/pass. Consider using
passwordWoinstead, which is not stored in state. - password
Wo 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. RequirespasswordWoVersionto trigger updates. - password
Wo NumberVersion - Version number for
passwordWo. Increment this value to trigger an update of the password when usingpasswordWo. - String
- Optionally set this to the principal who should own the schemas created by dbt
- tenant
Id 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:
- Credential
Id int - The internal credential ID
- Id string
- The provider-assigned unique ID for this managed resource.
- Credential
Id int - The internal credential ID
- Id string
- The provider-assigned unique ID for this managed resource.
- credential
Id Integer - The internal credential ID
- id String
- The provider-assigned unique ID for this managed resource.
- credential
Id 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.
- credential
Id 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) -> SynapseCredentialfunc 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.
- Adapter
Type string - The type of the adapter (synapse)
- Authentication string
- Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
- Client
Id 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.
- Client
Secret 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
clientSecretWoinstead, which is not stored in state. - Client
Secret stringWo - 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. RequiresclientSecretWoVersionto trigger updates. - Client
Secret intWo Version - Version number for
clientSecretWo. Increment this value to trigger an update of the client secret when usingclientSecretWo. - Credential
Id 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
passwordWoinstead, which is not stored in state. - Password
Wo 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. RequirespasswordWoVersionto trigger updates. - Password
Wo intVersion - Version number for
passwordWo. Increment this value to trigger an update of the password when usingpasswordWo. - Project
Id int - Project ID to create the Synapse credential in
- Schema string
- The schema where to create the dbt models
- string
- Optionally set this to the principal who should own the schemas created by dbt
- Tenant
Id 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 string - The type of the adapter (synapse)
- Authentication string
- Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
- Client
Id 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.
- Client
Secret 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
clientSecretWoinstead, which is not stored in state. - Client
Secret stringWo - 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. RequiresclientSecretWoVersionto trigger updates. - Client
Secret intWo Version - Version number for
clientSecretWo. Increment this value to trigger an update of the client secret when usingclientSecretWo. - Credential
Id 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
passwordWoinstead, which is not stored in state. - Password
Wo 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. RequirespasswordWoVersionto trigger updates. - Password
Wo intVersion - Version number for
passwordWo. Increment this value to trigger an update of the password when usingpasswordWo. - Project
Id int - Project ID to create the Synapse credential in
- Schema string
- The schema where to create the dbt models
- string
- Optionally set this to the principal who should own the schemas created by dbt
- Tenant
Id 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 String - The type of the adapter (synapse)
- authentication String
- Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
- client
Id 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.
- client
Secret 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
clientSecretWoinstead, which is not stored in state. - client
Secret StringWo - 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. RequiresclientSecretWoVersionto trigger updates. - client
Secret IntegerWo Version - Version number for
clientSecretWo. Increment this value to trigger an update of the client secret when usingclientSecretWo. - credential
Id 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
passwordWoinstead, which is not stored in state. - password
Wo 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. RequirespasswordWoVersionto trigger updates. - password
Wo IntegerVersion - Version number for
passwordWo. Increment this value to trigger an update of the password when usingpasswordWo. - project
Id Integer - Project ID to create the Synapse credential in
- schema String
- The schema where to create the dbt models
- String
- Optionally set this to the principal who should own the schemas created by dbt
- tenant
Id 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 string - The type of the adapter (synapse)
- authentication string
- Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
- client
Id 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.
- client
Secret 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
clientSecretWoinstead, which is not stored in state. - client
Secret stringWo - 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. RequiresclientSecretWoVersionto trigger updates. - client
Secret numberWo Version - Version number for
clientSecretWo. Increment this value to trigger an update of the client secret when usingclientSecretWo. - credential
Id 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
passwordWoinstead, which is not stored in state. - password
Wo 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. RequirespasswordWoVersionto trigger updates. - password
Wo numberVersion - Version number for
passwordWo. Increment this value to trigger an update of the password when usingpasswordWo. - project
Id number - Project ID to create the Synapse credential in
- schema string
- The schema where to create the dbt models
- string
- Optionally set this to the principal who should own the schemas created by dbt
- tenant
Id 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
clientSecretWoinstead, which is not stored in state. - client_
secret_ strwo - 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. RequiresclientSecretWoVersionto trigger updates. - client_
secret_ intwo_ version - Version number for
clientSecretWo. Increment this value to trigger an update of the client secret when usingclientSecretWo. - 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
passwordWoinstead, 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. RequirespasswordWoVersionto trigger updates. - password_
wo_ intversion - Version number for
passwordWo. Increment this value to trigger an update of the password when usingpasswordWo. - project_
id int - Project ID to create the Synapse credential in
- schema str
- The schema where to create the dbt models
- 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
- adapter
Type String - The type of the adapter (synapse)
- authentication String
- Authentication type (SQL, ActiveDirectoryPassword, ServicePrincipal)
- client
Id 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.
- client
Secret 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
clientSecretWoinstead, which is not stored in state. - client
Secret StringWo - 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. RequiresclientSecretWoVersionto trigger updates. - client
Secret NumberWo Version - Version number for
clientSecretWo. Increment this value to trigger an update of the client secret when usingclientSecretWo. - credential
Id 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
passwordWoinstead, which is not stored in state. - password
Wo 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. RequirespasswordWoVersionto trigger updates. - password
Wo NumberVersion - Version number for
passwordWo. Increment this value to trigger an update of the password when usingpasswordWo. - project
Id Number - Project ID to create the Synapse credential in
- schema String
- The schema where to create the dbt models
- String
- Optionally set this to the principal who should own the schemas created by dbt
- tenant
Id 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
dbtcloudTerraform Provider.
published on Wednesday, Apr 15, 2026 by Pulumi
