Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. dbt Cloud Provider
  3. API Docs
  4. getEnvironments
dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-dbtcloud

dbtcloud.getEnvironments

Explore with Pulumi AI

dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-dbtcloud

Retrieve data for multiple environments

Using getEnvironments

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 getEnvironments(args: GetEnvironmentsArgs, opts?: InvokeOptions): Promise<GetEnvironmentsResult>
function getEnvironmentsOutput(args: GetEnvironmentsOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentsResult>
Copy
def get_environments(project_id: Optional[int] = None,
                     opts: Optional[InvokeOptions] = None) -> GetEnvironmentsResult
def get_environments_output(project_id: Optional[pulumi.Input[int]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentsResult]
Copy
func GetEnvironments(ctx *Context, args *GetEnvironmentsArgs, opts ...InvokeOption) (*GetEnvironmentsResult, error)
func GetEnvironmentsOutput(ctx *Context, args *GetEnvironmentsOutputArgs, opts ...InvokeOption) GetEnvironmentsResultOutput
Copy

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

public static class GetEnvironments 
{
    public static Task<GetEnvironmentsResult> InvokeAsync(GetEnvironmentsArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentsResult> Invoke(GetEnvironmentsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEnvironmentsResult> getEnvironments(GetEnvironmentsArgs args, InvokeOptions options)
public static Output<GetEnvironmentsResult> getEnvironments(GetEnvironmentsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: dbtcloud:index/getEnvironments:getEnvironments
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ProjectId int
The project ID to filter the environments for [Optional]
ProjectId int
The project ID to filter the environments for [Optional]
projectId Integer
The project ID to filter the environments for [Optional]
projectId number
The project ID to filter the environments for [Optional]
project_id int
The project ID to filter the environments for [Optional]
projectId Number
The project ID to filter the environments for [Optional]

getEnvironments Result

The following output properties are available:

Environments List<Pulumi.DbtCloud.Outputs.GetEnvironmentsEnvironment>
The list of environments
Id string
The provider-assigned unique ID for this managed resource.
ProjectId int
The project ID to filter the environments for [Optional]
Environments []GetEnvironmentsEnvironment
The list of environments
Id string
The provider-assigned unique ID for this managed resource.
ProjectId int
The project ID to filter the environments for [Optional]
environments List<GetEnvironmentsEnvironment>
The list of environments
id String
The provider-assigned unique ID for this managed resource.
projectId Integer
The project ID to filter the environments for [Optional]
environments GetEnvironmentsEnvironment[]
The list of environments
id string
The provider-assigned unique ID for this managed resource.
projectId number
The project ID to filter the environments for [Optional]
environments Sequence[GetEnvironmentsEnvironment]
The list of environments
id str
The provider-assigned unique ID for this managed resource.
project_id int
The project ID to filter the environments for [Optional]
environments List<Property Map>
The list of environments
id String
The provider-assigned unique ID for this managed resource.
projectId Number
The project ID to filter the environments for [Optional]

Supporting Types

GetEnvironmentsEnvironment

ConnectionId This property is required. int
A connection ID (used with Global Connections)
CredentialsId This property is required. int
Credential ID to create the environment with. A credential is not required for development environments but is required for deployment environments
CustomBranch This property is required. string
The custom branch name to use
DbtVersion This property is required. string
Version number of dbt to use in this environment.
DeploymentType This property is required. string
The type of deployment environment (currently 'production', 'staging' or empty)
EnableModelQueryHistory This property is required. bool
Whether model query history is on
EnvironmentId This property is required. int
The ID of the environment
ExtendedAttributesId This property is required. int
The ID of the extended attributes applied
Name This property is required. string
The name of the environment
ProjectId This property is required. int
The project ID to which the environment belong
Type This property is required. string
The type of environment (must be either development or deployment)
UseCustomBranch This property is required. bool
Whether to use a custom git branch in this environment
ConnectionId This property is required. int
A connection ID (used with Global Connections)
CredentialsId This property is required. int
Credential ID to create the environment with. A credential is not required for development environments but is required for deployment environments
CustomBranch This property is required. string
The custom branch name to use
DbtVersion This property is required. string
Version number of dbt to use in this environment.
DeploymentType This property is required. string
The type of deployment environment (currently 'production', 'staging' or empty)
EnableModelQueryHistory This property is required. bool
Whether model query history is on
EnvironmentId This property is required. int
The ID of the environment
ExtendedAttributesId This property is required. int
The ID of the extended attributes applied
Name This property is required. string
The name of the environment
ProjectId This property is required. int
The project ID to which the environment belong
Type This property is required. string
The type of environment (must be either development or deployment)
UseCustomBranch This property is required. bool
Whether to use a custom git branch in this environment
connectionId This property is required. Integer
A connection ID (used with Global Connections)
credentialsId This property is required. Integer
Credential ID to create the environment with. A credential is not required for development environments but is required for deployment environments
customBranch This property is required. String
The custom branch name to use
dbtVersion This property is required. String
Version number of dbt to use in this environment.
deploymentType This property is required. String
The type of deployment environment (currently 'production', 'staging' or empty)
enableModelQueryHistory This property is required. Boolean
Whether model query history is on
environmentId This property is required. Integer
The ID of the environment
extendedAttributesId This property is required. Integer
The ID of the extended attributes applied
name This property is required. String
The name of the environment
projectId This property is required. Integer
The project ID to which the environment belong
type This property is required. String
The type of environment (must be either development or deployment)
useCustomBranch This property is required. Boolean
Whether to use a custom git branch in this environment
connectionId This property is required. number
A connection ID (used with Global Connections)
credentialsId This property is required. number
Credential ID to create the environment with. A credential is not required for development environments but is required for deployment environments
customBranch This property is required. string
The custom branch name to use
dbtVersion This property is required. string
Version number of dbt to use in this environment.
deploymentType This property is required. string
The type of deployment environment (currently 'production', 'staging' or empty)
enableModelQueryHistory This property is required. boolean
Whether model query history is on
environmentId This property is required. number
The ID of the environment
extendedAttributesId This property is required. number
The ID of the extended attributes applied
name This property is required. string
The name of the environment
projectId This property is required. number
The project ID to which the environment belong
type This property is required. string
The type of environment (must be either development or deployment)
useCustomBranch This property is required. boolean
Whether to use a custom git branch in this environment
connection_id This property is required. int
A connection ID (used with Global Connections)
credentials_id This property is required. int
Credential ID to create the environment with. A credential is not required for development environments but is required for deployment environments
custom_branch This property is required. str
The custom branch name to use
dbt_version This property is required. str
Version number of dbt to use in this environment.
deployment_type This property is required. str
The type of deployment environment (currently 'production', 'staging' or empty)
enable_model_query_history This property is required. bool
Whether model query history is on
environment_id This property is required. int
The ID of the environment
extended_attributes_id This property is required. int
The ID of the extended attributes applied
name This property is required. str
The name of the environment
project_id This property is required. int
The project ID to which the environment belong
type This property is required. str
The type of environment (must be either development or deployment)
use_custom_branch This property is required. bool
Whether to use a custom git branch in this environment
connectionId This property is required. Number
A connection ID (used with Global Connections)
credentialsId This property is required. Number
Credential ID to create the environment with. A credential is not required for development environments but is required for deployment environments
customBranch This property is required. String
The custom branch name to use
dbtVersion This property is required. String
Version number of dbt to use in this environment.
deploymentType This property is required. String
The type of deployment environment (currently 'production', 'staging' or empty)
enableModelQueryHistory This property is required. Boolean
Whether model query history is on
environmentId This property is required. Number
The ID of the environment
extendedAttributesId This property is required. Number
The ID of the extended attributes applied
name This property is required. String
The name of the environment
projectId This property is required. Number
The project ID to which the environment belong
type This property is required. String
The type of environment (must be either development or deployment)
useCustomBranch This property is required. Boolean
Whether to use a custom git branch in this environment

Package Details

Repository
dbtcloud pulumi/pulumi-dbtcloud
License
Apache-2.0
Notes
This Pulumi package is based on the dbtcloud Terraform Provider.
dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-dbtcloud