databricks.getServingEndpoints

Explore with Pulumi AI

Databricks v1.65.0 published on Wednesday, Apr 9, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const all = databricks.getServingEndpoints({});
const mlServingUsage: databricks.Permissions[] = [];
for (const range = {value: 0}; range.value < allDatabricksServingEndpoints.endpoints; range.value++) {
    mlServingUsage.push(new databricks.Permissions(`ml_serving_usage-${range.value}`, {
        servingEndpointId: range.value.id,
        accessControls: [
            {
                groupName: "users",
                permissionLevel: "CAN_VIEW",
            },
            {
                groupName: auto.displayName,
                permissionLevel: "CAN_MANAGE",
            },
            {
                groupName: eng.displayName,
                permissionLevel: "CAN_QUERY",
            },
        ],
    }));
}

import pulumi
import pulumi_databricks as databricks

all = databricks.get_serving_endpoints()
ml_serving_usage = []
for range in [{"value": i} for i in range(0, all_databricks_serving_endpoints.endpoints)]:
    ml_serving_usage.append(databricks.Permissions(f"ml_serving_usage-{range['value']}",
        serving_endpoint_id=range["value"]["id"],
        access_controls=[
            {
                "group_name": "users",
                "permission_level": "CAN_VIEW",
            },
            {
                "group_name": auto["displayName"],
                "permission_level": "CAN_MANAGE",
            },
            {
                "group_name": eng["displayName"],
                "permission_level": "CAN_QUERY",
            },
        ]))

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.GetServingEndpoints(ctx, &databricks.GetServingEndpointsArgs{}, nil)
		if err != nil {
			return err
		}
		var mlServingUsage []*databricks.Permissions
		for index := 0; index < allDatabricksServingEndpoints.Endpoints; index++ {
			key0 := index
			val0 := index
			__res, err := databricks.NewPermissions(ctx, fmt.Sprintf("ml_serving_usage-%v", key0), &databricks.PermissionsArgs{
				ServingEndpointId: pulumi.Any(val0),
				AccessControls: databricks.PermissionsAccessControlArray{
					&databricks.PermissionsAccessControlArgs{
						GroupName:       pulumi.String("users"),
						PermissionLevel: pulumi.String("CAN_VIEW"),
					},
					&databricks.PermissionsAccessControlArgs{
						GroupName:       pulumi.Any(auto.DisplayName),
						PermissionLevel: pulumi.String("CAN_MANAGE"),
					},
					&databricks.PermissionsAccessControlArgs{
						GroupName:       pulumi.Any(eng.DisplayName),
						PermissionLevel: pulumi.String("CAN_QUERY"),
					},
				},
			})
			if err != nil {
				return err
			}
			mlServingUsage = append(mlServingUsage, __res)
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var all = Databricks.GetServingEndpoints.Invoke();

    var mlServingUsage = new List<Databricks.Permissions>();
    for (var rangeIndex = 0; rangeIndex < allDatabricksServingEndpoints.Endpoints; rangeIndex++)
    {
        var range = new { Value = rangeIndex };
        mlServingUsage.Add(new Databricks.Permissions($"ml_serving_usage-{range.Value}", new()
        {
            ServingEndpointId = range.Value.Id,
            AccessControls = new[]
            {
                new Databricks.Inputs.PermissionsAccessControlArgs
                {
                    GroupName = "users",
                    PermissionLevel = "CAN_VIEW",
                },
                new Databricks.Inputs.PermissionsAccessControlArgs
                {
                    GroupName = auto.DisplayName,
                    PermissionLevel = "CAN_MANAGE",
                },
                new Databricks.Inputs.PermissionsAccessControlArgs
                {
                    GroupName = eng.DisplayName,
                    PermissionLevel = "CAN_QUERY",
                },
            },
        }));
    }
});

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.GetServingEndpointsArgs;
import com.pulumi.databricks.Permissions;
import com.pulumi.databricks.PermissionsArgs;
import com.pulumi.databricks.inputs.PermissionsAccessControlArgs;
import com.pulumi.codegen.internal.KeyedValue;
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 all = DatabricksFunctions.getServingEndpoints(GetServingEndpointsArgs.builder()
            .build());

        for (var i = 0; i < allDatabricksServingEndpoints.endpoints(); i++) {
            new Permissions("mlServingUsage-" + i, PermissionsArgs.builder()
                .servingEndpointId(range.value().id())
                .accessControls(                
                    PermissionsAccessControlArgs.builder()
                        .groupName("users")
                        .permissionLevel("CAN_VIEW")
                        .build(),
                    PermissionsAccessControlArgs.builder()
                        .groupName(auto.displayName())
                        .permissionLevel("CAN_MANAGE")
                        .build(),
                    PermissionsAccessControlArgs.builder()
                        .groupName(eng.displayName())
                        .permissionLevel("CAN_QUERY")
                        .build())
                .build());

        
}
    }
}

resources:
  mlServingUsage:
    type: databricks:Permissions
    name: ml_serving_usage
    properties:
      servingEndpointId: ${range.value.id}
      accessControls:
        - groupName: users
          permissionLevel: CAN_VIEW
        - groupName: ${auto.displayName}
          permissionLevel: CAN_MANAGE
        - groupName: ${eng.displayName}
          permissionLevel: CAN_QUERY
    options: {}
variables:
  all:
    fn::invoke:
      function: databricks:getServingEndpoints
      arguments: {}

The following resources are often used in the same context:

databricks.Permissions can control which groups or individual users can Manage, Query or View individual serving endpoints.

Using getServingEndpoints

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.

TypeScript
Python
Go
C#
Java
YAML

function getServingEndpoints(args: GetServingEndpointsArgs, opts?: InvokeOptions): Promise<GetServingEndpointsResult>
function getServingEndpointsOutput(args: GetServingEndpointsOutputArgs, opts?: InvokeOptions): Output<GetServingEndpointsResult>

def get_serving_endpoints(endpoints: Optional[Sequence[GetServingEndpointsEndpoint]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetServingEndpointsResult
def get_serving_endpoints_output(endpoints: Optional[pulumi.Input[Sequence[pulumi.Input[GetServingEndpointsEndpointArgs]]]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetServingEndpointsResult]

func GetServingEndpoints(ctx *Context, args *GetServingEndpointsArgs, opts ...InvokeOption) (*GetServingEndpointsResult, error)
func GetServingEndpointsOutput(ctx *Context, args *GetServingEndpointsOutputArgs, opts ...InvokeOption) GetServingEndpointsResultOutput

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

public static class GetServingEndpoints 
{
    public static Task<GetServingEndpointsResult> InvokeAsync(GetServingEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetServingEndpointsResult> Invoke(GetServingEndpointsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetServingEndpointsResult> getServingEndpoints(GetServingEndpointsArgs args, InvokeOptions options)
public static Output<GetServingEndpointsResult> getServingEndpoints(GetServingEndpointsArgs args, InvokeOptions options)

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

The following arguments are supported:

Endpoints List<GetServingEndpointsEndpoint>: List of objects describing the serving endpoints. Each object consists of following attributes:

Endpoints []GetServingEndpointsEndpoint: List of objects describing the serving endpoints. Each object consists of following attributes:

endpoints List<GetServingEndpointsEndpoint>: List of objects describing the serving endpoints. Each object consists of following attributes:

endpoints GetServingEndpointsEndpoint[]: List of objects describing the serving endpoints. Each object consists of following attributes:

endpoints Sequence[GetServingEndpointsEndpoint]: List of objects describing the serving endpoints. Each object consists of following attributes:

endpoints List<Property Map>: List of objects describing the serving endpoints. Each object consists of following attributes:

getServingEndpoints Result

The following output properties are available:

Endpoints List<GetServingEndpointsEndpoint>: List of objects describing the serving endpoints. Each object consists of following attributes:
Id string: The provider-assigned unique ID for this managed resource.

Endpoints []GetServingEndpointsEndpoint: List of objects describing the serving endpoints. Each object consists of following attributes:
Id string: The provider-assigned unique ID for this managed resource.

endpoints List<GetServingEndpointsEndpoint>: List of objects describing the serving endpoints. Each object consists of following attributes:
id String: The provider-assigned unique ID for this managed resource.

endpoints GetServingEndpointsEndpoint[]: List of objects describing the serving endpoints. Each object consists of following attributes:
id string: The provider-assigned unique ID for this managed resource.

endpoints Sequence[GetServingEndpointsEndpoint]: List of objects describing the serving endpoints. Each object consists of following attributes:
id str: The provider-assigned unique ID for this managed resource.

endpoints List<Property Map>: List of objects describing the serving endpoints. Each object consists of following attributes:
id String: The provider-assigned unique ID for this managed resource.

Supporting Types

GetServingEndpointsEndpoint

AiGateways List<GetServingEndpointsEndpointAiGateway>: A block with AI Gateway configuration for the serving endpoint.
BudgetPolicyId string
Configs List<GetServingEndpointsEndpointConfig>: The model serving endpoint configuration.
CreationTimestamp int
Creator string
Id string
LastUpdatedTimestamp int
Name string: The name of the model serving endpoint.
States List<GetServingEndpointsEndpointState>
Tags List<GetServingEndpointsEndpointTag>: Tags to be attached to the serving endpoint and automatically propagated to billing logs.
Task string

AiGateways []GetServingEndpointsEndpointAiGateway: A block with AI Gateway configuration for the serving endpoint.
BudgetPolicyId string
Configs []GetServingEndpointsEndpointConfig: The model serving endpoint configuration.
CreationTimestamp int
Creator string
Id string
LastUpdatedTimestamp int
Name string: The name of the model serving endpoint.
States []GetServingEndpointsEndpointState
Tags []GetServingEndpointsEndpointTag: Tags to be attached to the serving endpoint and automatically propagated to billing logs.
Task string

aiGateways List<GetServingEndpointsEndpointAiGateway>: A block with AI Gateway configuration for the serving endpoint.
budgetPolicyId String
configs List<GetServingEndpointsEndpointConfig>: The model serving endpoint configuration.
creationTimestamp Integer
creator String
id String
lastUpdatedTimestamp Integer
name String: The name of the model serving endpoint.
states List<GetServingEndpointsEndpointState>
tags List<GetServingEndpointsEndpointTag>: Tags to be attached to the serving endpoint and automatically propagated to billing logs.
task String

aiGateways GetServingEndpointsEndpointAiGateway[]: A block with AI Gateway configuration for the serving endpoint.
budgetPolicyId string
configs GetServingEndpointsEndpointConfig[]: The model serving endpoint configuration.
creationTimestamp number
creator string
id string
lastUpdatedTimestamp number
name string: The name of the model serving endpoint.
states GetServingEndpointsEndpointState[]
tags GetServingEndpointsEndpointTag[]: Tags to be attached to the serving endpoint and automatically propagated to billing logs.
task string

ai_gateways Sequence[GetServingEndpointsEndpointAiGateway]: A block with AI Gateway configuration for the serving endpoint.
budget_policy_id str
configs Sequence[GetServingEndpointsEndpointConfig]: The model serving endpoint configuration.
creation_timestamp int
creator str
id str
last_updated_timestamp int
name str: The name of the model serving endpoint.
states Sequence[GetServingEndpointsEndpointState]
tags Sequence[GetServingEndpointsEndpointTag]: Tags to be attached to the serving endpoint and automatically propagated to billing logs.
task str

aiGateways List<Property Map>: A block with AI Gateway configuration for the serving endpoint.
budgetPolicyId String
configs List<Property Map>: The model serving endpoint configuration.
creationTimestamp Number
creator String
id String
lastUpdatedTimestamp Number
name String: The name of the model serving endpoint.
states List<Property Map>
tags List<Property Map>: Tags to be attached to the serving endpoint and automatically propagated to billing logs.
task String