1. Packages
  2. dbt Cloud
  3. API Docs
  4. getEnvironments
dbt Cloud v0.1.10 published on Thursday, Jul 18, 2024 by Pulumi

dbtcloud.getEnvironments

Explore with Pulumi AI

dbtcloud logo
dbt Cloud v0.1.10 published on Thursday, Jul 18, 2024 by Pulumi

    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>
    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]
    func GetEnvironments(ctx *Context, args *GetEnvironmentsArgs, opts ...InvokeOption) (*GetEnvironmentsResult, error)
    func GetEnvironmentsOutput(ctx *Context, args *GetEnvironmentsOutputArgs, opts ...InvokeOption) GetEnvironmentsResultOutput

    > 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)
    }
    public static CompletableFuture<GetEnvironmentsResult> getEnvironments(GetEnvironmentsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: dbtcloud:index/getEnvironments:getEnvironments
      arguments:
        # arguments dictionary

    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

    CredentialsId int
    Credential ID to create the environment with. A credential is not required for development environments but is required for deployment environments
    CustomBranch string
    The custom branch name to use
    DbtVersion string
    Version number of dbt to use in this environment.
    DeploymentType string
    The type of deployment environment (currently 'production', 'staging' or empty)
    EnvironmentId int
    The ID of the environment
    ExtendedAttributesId int
    The ID of the extended attributes applied
    Name string
    The name of the environment
    ProjectId int
    The project ID to which the environment belong
    Type string
    The type of environment (must be either development or deployment)
    UseCustomBranch bool
    Whether to use a custom git branch in this environment
    CredentialsId int
    Credential ID to create the environment with. A credential is not required for development environments but is required for deployment environments
    CustomBranch string
    The custom branch name to use
    DbtVersion string
    Version number of dbt to use in this environment.
    DeploymentType string
    The type of deployment environment (currently 'production', 'staging' or empty)
    EnvironmentId int
    The ID of the environment
    ExtendedAttributesId int
    The ID of the extended attributes applied
    Name string
    The name of the environment
    ProjectId int
    The project ID to which the environment belong
    Type string
    The type of environment (must be either development or deployment)
    UseCustomBranch bool
    Whether to use a custom git branch in this environment
    credentialsId Integer
    Credential ID to create the environment with. A credential is not required for development environments but is required for deployment environments
    customBranch String
    The custom branch name to use
    dbtVersion String
    Version number of dbt to use in this environment.
    deploymentType String
    The type of deployment environment (currently 'production', 'staging' or empty)
    environmentId Integer
    The ID of the environment
    extendedAttributesId Integer
    The ID of the extended attributes applied
    name String
    The name of the environment
    projectId Integer
    The project ID to which the environment belong
    type String
    The type of environment (must be either development or deployment)
    useCustomBranch Boolean
    Whether to use a custom git branch in this environment
    credentialsId number
    Credential ID to create the environment with. A credential is not required for development environments but is required for deployment environments
    customBranch string
    The custom branch name to use
    dbtVersion string
    Version number of dbt to use in this environment.
    deploymentType string
    The type of deployment environment (currently 'production', 'staging' or empty)
    environmentId number
    The ID of the environment
    extendedAttributesId number
    The ID of the extended attributes applied
    name string
    The name of the environment
    projectId number
    The project ID to which the environment belong
    type string
    The type of environment (must be either development or deployment)
    useCustomBranch boolean
    Whether to use a custom git branch in this environment
    credentials_id int
    Credential ID to create the environment with. A credential is not required for development environments but is required for deployment environments
    custom_branch str
    The custom branch name to use
    dbt_version str
    Version number of dbt to use in this environment.
    deployment_type str
    The type of deployment environment (currently 'production', 'staging' or empty)
    environment_id int
    The ID of the environment
    extended_attributes_id int
    The ID of the extended attributes applied
    name str
    The name of the environment
    project_id int
    The project ID to which the environment belong
    type str
    The type of environment (must be either development or deployment)
    use_custom_branch bool
    Whether to use a custom git branch in this environment
    credentialsId Number
    Credential ID to create the environment with. A credential is not required for development environments but is required for deployment environments
    customBranch String
    The custom branch name to use
    dbtVersion String
    Version number of dbt to use in this environment.
    deploymentType String
    The type of deployment environment (currently 'production', 'staging' or empty)
    environmentId Number
    The ID of the environment
    extendedAttributesId Number
    The ID of the extended attributes applied
    name String
    The name of the environment
    projectId Number
    The project ID to which the environment belong
    type String
    The type of environment (must be either development or deployment)
    useCustomBranch 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.
    dbtcloud logo
    dbt Cloud v0.1.10 published on Thursday, Jul 18, 2024 by Pulumi