dbtcloud.getSynapseCredential

Explore with Pulumi AI

dbt Cloud v1.0.0 published on Wednesday, Jun 11, 2025 by Pulumi

Using getSynapseCredential

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSynapseCredential(args: GetSynapseCredentialArgs, opts?: InvokeOptions): Promise<GetSynapseCredentialResult>
function getSynapseCredentialOutput(args: GetSynapseCredentialOutputArgs, opts?: InvokeOptions): Output<GetSynapseCredentialResult>

def get_synapse_credential(credential_id: Optional[int] = None,
                           project_id: Optional[int] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSynapseCredentialResult
def get_synapse_credential_output(credential_id: Optional[pulumi.Input[int]] = None,
                           project_id: Optional[pulumi.Input[int]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSynapseCredentialResult]

func LookupSynapseCredential(ctx *Context, args *LookupSynapseCredentialArgs, opts ...InvokeOption) (*LookupSynapseCredentialResult, error)
func LookupSynapseCredentialOutput(ctx *Context, args *LookupSynapseCredentialOutputArgs, opts ...InvokeOption) LookupSynapseCredentialResultOutput

> Note: This function is named LookupSynapseCredential in the Go SDK.

public static class GetSynapseCredential 
{
    public static Task<GetSynapseCredentialResult> InvokeAsync(GetSynapseCredentialArgs args, InvokeOptions? opts = null)
    public static Output<GetSynapseCredentialResult> Invoke(GetSynapseCredentialInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSynapseCredentialResult> getSynapseCredential(GetSynapseCredentialArgs args, InvokeOptions options)
public static Output<GetSynapseCredentialResult> getSynapseCredential(GetSynapseCredentialArgs args, InvokeOptions options)

fn::invoke:
  function: dbtcloud:index/getSynapseCredential:getSynapseCredential
  arguments:
    # arguments dictionary

The following arguments are supported:

CredentialId int: Credential ID
ProjectId int: Project ID

CredentialId int: Credential ID
ProjectId int: Project ID

credentialId Integer: Credential ID
projectId Integer: Project ID

credentialId number: Credential ID
projectId number: Project ID

credential_id int: Credential ID
project_id int: Project ID

credentialId Number: Credential ID
projectId Number: Project ID

getSynapseCredential Result

The following output properties are available:

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.
CredentialId int: Credential ID
Id string: The ID of this data source. Contains the project ID and the credential ID.
ProjectId int: Project ID
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.
CredentialId int: Credential ID
Id string: The ID of this data source. Contains the project ID and the credential ID.
ProjectId int: Project ID
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.
credentialId Integer: Credential ID
id String: The ID of this data source. Contains the project ID and the credential ID.
projectId Integer: Project ID
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.
credentialId number: Credential ID
id string: The ID of this data source. Contains the project ID and the credential ID.
projectId number: Project ID
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.
credential_id int: Credential ID
id str: The ID of this data source. Contains the project ID and the credential ID.
project_id int: Project ID
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.
credentialId Number: Credential ID
id String: The ID of this data source. Contains the project ID and the credential ID.
projectId Number: Project ID
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

Package Details

Repository: dbtcloud pulumi/pulumi-dbtcloud
License: Apache-2.0
Notes: This Pulumi package is based on the dbtcloud Terraform Provider.

dbt Cloud v1.0.0 published on Wednesday, Jun 11, 2025 by Pulumi

pulumi/pulumi-dbtcloud

dbtcloud.getSynapseCredential

On this page

On this page

Using getSynapseCredential

getSynapseCredential Result

Package Details

On this page

On this page