1. Packages
  2. Databricks Provider
  3. API Docs
  4. getBudgetPolicy
Databricks v1.76.0 published on Thursday, Sep 18, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.getBudgetPolicy

Get Started
databricks logo
Databricks v1.76.0 published on Thursday, Sep 18, 2025 by Pulumi
pulumi/pulumi-databricks

    This data source can be used to get a single budget policy.

    Note This data source can only be used with an account-level provider!

    Example Usage

    Referring to a budget policy by id:

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

const _this = databricks.getBudgetPolicy({
    policyId: "test",
});

    import pulumi
import pulumi_databricks as databricks

this = databricks.get_budget_policy(policy_id="test")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.LookupBudgetPolicy(ctx, &databricks.LookupBudgetPolicyArgs{
			PolicyId: pulumi.StringRef("test"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @this = Databricks.GetBudgetPolicy.Invoke(new()
    {
        PolicyId = "test",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
import com.pulumi.databricks.inputs.GetBudgetPolicyArgs;
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 this = DatabricksFunctions.getBudgetPolicy(GetBudgetPolicyArgs.builder()
            .policyId("test")
            .build());

    }
}

    variables:
  this:
    fn::invoke:
      function: databricks:getBudgetPolicy
      arguments:
        policyId: test

    Using getBudgetPolicy

    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 getBudgetPolicy(args: GetBudgetPolicyArgs, opts?: InvokeOptions): Promise<GetBudgetPolicyResult>
function getBudgetPolicyOutput(args: GetBudgetPolicyOutputArgs, opts?: InvokeOptions): Output<GetBudgetPolicyResult>
    def get_budget_policy(binding_workspace_ids: Optional[Sequence[int]] = None,
                      custom_tags: Optional[Sequence[GetBudgetPolicyCustomTag]] = None,
                      policy_id: Optional[str] = None,
                      policy_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetBudgetPolicyResult
def get_budget_policy_output(binding_workspace_ids: Optional[pulumi.Input[Sequence[pulumi.Input[int]]]] = None,
                      custom_tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetBudgetPolicyCustomTagArgs]]]] = None,
                      policy_id: Optional[pulumi.Input[str]] = None,
                      policy_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetBudgetPolicyResult]
    func LookupBudgetPolicy(ctx *Context, args *LookupBudgetPolicyArgs, opts ...InvokeOption) (*LookupBudgetPolicyResult, error)
func LookupBudgetPolicyOutput(ctx *Context, args *LookupBudgetPolicyOutputArgs, opts ...InvokeOption) LookupBudgetPolicyResultOutput

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

    public static class GetBudgetPolicy 
{
    public static Task<GetBudgetPolicyResult> InvokeAsync(GetBudgetPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetBudgetPolicyResult> Invoke(GetBudgetPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBudgetPolicyResult> getBudgetPolicy(GetBudgetPolicyArgs args, InvokeOptions options)
public static Output<GetBudgetPolicyResult> getBudgetPolicy(GetBudgetPolicyArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getBudgetPolicy:getBudgetPolicy
  arguments:
    # arguments dictionary

    The following arguments are supported:

    BindingWorkspaceIds List<int>
    (list of integer) - List of workspaces that this budget policy will be exclusively bound to. An empty binding implies that this budget policy is open to any workspace in the account
    CustomTags List<GetBudgetPolicyCustomTag>
    (list of CustomPolicyTag) - A list of tags defined by the customer. At most 20 entries are allowed per policy
    PolicyId string
    The Id of the policy. This field is generated by Databricks and globally unique
    PolicyName string
    (string) - The name of the policy.

    • Must be unique among active policies.
    • Can contain only characters from the ISO 8859-1 (latin1) set.
    • Can't start with reserved keywords such as databricks:default-policy
    BindingWorkspaceIds []int
    (list of integer) - List of workspaces that this budget policy will be exclusively bound to. An empty binding implies that this budget policy is open to any workspace in the account
    CustomTags []GetBudgetPolicyCustomTag
    (list of CustomPolicyTag) - A list of tags defined by the customer. At most 20 entries are allowed per policy
    PolicyId string
    The Id of the policy. This field is generated by Databricks and globally unique
    PolicyName string
    (string) - The name of the policy.

    • Must be unique among active policies.
    • Can contain only characters from the ISO 8859-1 (latin1) set.
    • Can't start with reserved keywords such as databricks:default-policy
    bindingWorkspaceIds List<Integer>
    (list of integer) - List of workspaces that this budget policy will be exclusively bound to. An empty binding implies that this budget policy is open to any workspace in the account
    customTags List<GetBudgetPolicyCustomTag>
    (list of CustomPolicyTag) - A list of tags defined by the customer. At most 20 entries are allowed per policy
    policyId String
    The Id of the policy. This field is generated by Databricks and globally unique
    policyName String
    (string) - The name of the policy.

    • Must be unique among active policies.
    • Can contain only characters from the ISO 8859-1 (latin1) set.
    • Can't start with reserved keywords such as databricks:default-policy
    bindingWorkspaceIds number[]
    (list of integer) - List of workspaces that this budget policy will be exclusively bound to. An empty binding implies that this budget policy is open to any workspace in the account
    customTags GetBudgetPolicyCustomTag[]
    (list of CustomPolicyTag) - A list of tags defined by the customer. At most 20 entries are allowed per policy
    policyId string
    The Id of the policy. This field is generated by Databricks and globally unique
    policyName string
    (string) - The name of the policy.

    • Must be unique among active policies.
    • Can contain only characters from the ISO 8859-1 (latin1) set.
    • Can't start with reserved keywords such as databricks:default-policy
    binding_workspace_ids Sequence[int]
    (list of integer) - List of workspaces that this budget policy will be exclusively bound to. An empty binding implies that this budget policy is open to any workspace in the account
    custom_tags Sequence[GetBudgetPolicyCustomTag]
    (list of CustomPolicyTag) - A list of tags defined by the customer. At most 20 entries are allowed per policy
    policy_id str
    The Id of the policy. This field is generated by Databricks and globally unique
    policy_name str
    (string) - The name of the policy.

    • Must be unique among active policies.
    • Can contain only characters from the ISO 8859-1 (latin1) set.
    • Can't start with reserved keywords such as databricks:default-policy
    bindingWorkspaceIds List<Number>
    (list of integer) - List of workspaces that this budget policy will be exclusively bound to. An empty binding implies that this budget policy is open to any workspace in the account
    customTags List<Property Map>
    (list of CustomPolicyTag) - A list of tags defined by the customer. At most 20 entries are allowed per policy
    policyId String
    The Id of the policy. This field is generated by Databricks and globally unique
    policyName String
    (string) - The name of the policy.

    • Must be unique among active policies.
    • Can contain only characters from the ISO 8859-1 (latin1) set.
    • Can't start with reserved keywords such as databricks:default-policy

    getBudgetPolicy Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    PolicyId string
    (string) - The Id of the policy. This field is generated by Databricks and globally unique
    BindingWorkspaceIds List<int>
    (list of integer) - List of workspaces that this budget policy will be exclusively bound to. An empty binding implies that this budget policy is open to any workspace in the account
    CustomTags List<GetBudgetPolicyCustomTag>
    (list of CustomPolicyTag) - A list of tags defined by the customer. At most 20 entries are allowed per policy
    PolicyName string
    (string) - The name of the policy.

    • Must be unique among active policies.
    • Can contain only characters from the ISO 8859-1 (latin1) set.
    • Can't start with reserved keywords such as databricks:default-policy
    Id string
    The provider-assigned unique ID for this managed resource.
    PolicyId string
    (string) - The Id of the policy. This field is generated by Databricks and globally unique
    BindingWorkspaceIds []int
    (list of integer) - List of workspaces that this budget policy will be exclusively bound to. An empty binding implies that this budget policy is open to any workspace in the account
    CustomTags []GetBudgetPolicyCustomTag
    (list of CustomPolicyTag) - A list of tags defined by the customer. At most 20 entries are allowed per policy
    PolicyName string
    (string) - The name of the policy.

    • Must be unique among active policies.
    • Can contain only characters from the ISO 8859-1 (latin1) set.
    • Can't start with reserved keywords such as databricks:default-policy
    id String
    The provider-assigned unique ID for this managed resource.
    policyId String
    (string) - The Id of the policy. This field is generated by Databricks and globally unique
    bindingWorkspaceIds List<Integer>
    (list of integer) - List of workspaces that this budget policy will be exclusively bound to. An empty binding implies that this budget policy is open to any workspace in the account
    customTags List<GetBudgetPolicyCustomTag>
    (list of CustomPolicyTag) - A list of tags defined by the customer. At most 20 entries are allowed per policy
    policyName String
    (string) - The name of the policy.

    • Must be unique among active policies.
    • Can contain only characters from the ISO 8859-1 (latin1) set.
    • Can't start with reserved keywords such as databricks:default-policy
    id string
    The provider-assigned unique ID for this managed resource.
    policyId string
    (string) - The Id of the policy. This field is generated by Databricks and globally unique
    bindingWorkspaceIds number[]
    (list of integer) - List of workspaces that this budget policy will be exclusively bound to. An empty binding implies that this budget policy is open to any workspace in the account
    customTags GetBudgetPolicyCustomTag[]
    (list of CustomPolicyTag) - A list of tags defined by the customer. At most 20 entries are allowed per policy
    policyName string
    (string) - The name of the policy.

    • Must be unique among active policies.
    • Can contain only characters from the ISO 8859-1 (latin1) set.
    • Can't start with reserved keywords such as databricks:default-policy
    id str
    The provider-assigned unique ID for this managed resource.
    policy_id str
    (string) - The Id of the policy. This field is generated by Databricks and globally unique
    binding_workspace_ids Sequence[int]
    (list of integer) - List of workspaces that this budget policy will be exclusively bound to. An empty binding implies that this budget policy is open to any workspace in the account
    custom_tags Sequence[GetBudgetPolicyCustomTag]
    (list of CustomPolicyTag) - A list of tags defined by the customer. At most 20 entries are allowed per policy
    policy_name str
    (string) - The name of the policy.

    • Must be unique among active policies.
    • Can contain only characters from the ISO 8859-1 (latin1) set.
    • Can't start with reserved keywords such as databricks:default-policy
    id String
    The provider-assigned unique ID for this managed resource.
    policyId String
    (string) - The Id of the policy. This field is generated by Databricks and globally unique
    bindingWorkspaceIds List<Number>
    (list of integer) - List of workspaces that this budget policy will be exclusively bound to. An empty binding implies that this budget policy is open to any workspace in the account
    customTags List<Property Map>
    (list of CustomPolicyTag) - A list of tags defined by the customer. At most 20 entries are allowed per policy
    policyName String
    (string) - The name of the policy.

    • Must be unique among active policies.
    • Can contain only characters from the ISO 8859-1 (latin1) set.
    • Can't start with reserved keywords such as databricks:default-policy

    Supporting Types

    GetBudgetPolicyCustomTag

    Key string
    (string) - The key of the tag.

    • Must be unique among all custom tags of the same policy
    • Cannot be “budget-policy-name”, “budget-policy-id” or "budget-policy-resolution-result" - these tags are preserved
    Value string
    (string) - The value of the tag
    Key string
    (string) - The key of the tag.

    • Must be unique among all custom tags of the same policy
    • Cannot be “budget-policy-name”, “budget-policy-id” or "budget-policy-resolution-result" - these tags are preserved
    Value string
    (string) - The value of the tag
    key String
    (string) - The key of the tag.

    • Must be unique among all custom tags of the same policy
    • Cannot be “budget-policy-name”, “budget-policy-id” or "budget-policy-resolution-result" - these tags are preserved
    value String
    (string) - The value of the tag
    key string
    (string) - The key of the tag.

    • Must be unique among all custom tags of the same policy
    • Cannot be “budget-policy-name”, “budget-policy-id” or "budget-policy-resolution-result" - these tags are preserved
    value string
    (string) - The value of the tag
    key str
    (string) - The key of the tag.

    • Must be unique among all custom tags of the same policy
    • Cannot be “budget-policy-name”, “budget-policy-id” or "budget-policy-resolution-result" - these tags are preserved
    value str
    (string) - The value of the tag
    key String
    (string) - The key of the tag.

    • Must be unique among all custom tags of the same policy
    • Cannot be “budget-policy-name”, “budget-policy-id” or "budget-policy-resolution-result" - these tags are preserved
    value String
    (string) - The value of the tag

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.76.0 published on Thursday, Sep 18, 2025 by Pulumi
    pulumi/pulumi-databricks
      Meet Neo: Your AI Platform Teammate