1. Packages
  2. Azure Classic
  3. API Docs
  4. databricks
  5. getWorkspacePrivateEndpointConnection

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi

azure.databricks.getWorkspacePrivateEndpointConnection

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi

    Use this data source to access information on an existing Databricks Workspace private endpoint connection state.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.databricks.getWorkspacePrivateEndpointConnection({
        workspaceId: exampleAzurermDatabricksWorkspace.id,
        privateEndpointId: exampleAzurermPrivateEndpoint.id,
    });
    export const databricksWorkspacePrivateEndpointConnectionStatus = example.then(example => example.connections?.[0]?.status);
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.databricks.get_workspace_private_endpoint_connection(workspace_id=example_azurerm_databricks_workspace["id"],
        private_endpoint_id=example_azurerm_private_endpoint["id"])
    pulumi.export("databricksWorkspacePrivateEndpointConnectionStatus", example.connections[0].status)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/databricks"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := databricks.GetWorkspacePrivateEndpointConnection(ctx, &databricks.GetWorkspacePrivateEndpointConnectionArgs{
    			WorkspaceId:       exampleAzurermDatabricksWorkspace.Id,
    			PrivateEndpointId: exampleAzurermPrivateEndpoint.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("databricksWorkspacePrivateEndpointConnectionStatus", example.Connections[0].Status)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Azure.DataBricks.GetWorkspacePrivateEndpointConnection.Invoke(new()
        {
            WorkspaceId = exampleAzurermDatabricksWorkspace.Id,
            PrivateEndpointId = exampleAzurermPrivateEndpoint.Id,
        });
    
        return new Dictionary<string, object?>
        {
            ["databricksWorkspacePrivateEndpointConnectionStatus"] = example.Apply(getWorkspacePrivateEndpointConnectionResult => getWorkspacePrivateEndpointConnectionResult.Connections[0]?.Status),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.databricks.DatabricksFunctions;
    import com.pulumi.azure.databricks.inputs.GetWorkspacePrivateEndpointConnectionArgs;
    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 example = DatabricksFunctions.getWorkspacePrivateEndpointConnection(GetWorkspacePrivateEndpointConnectionArgs.builder()
                .workspaceId(exampleAzurermDatabricksWorkspace.id())
                .privateEndpointId(exampleAzurermPrivateEndpoint.id())
                .build());
    
            ctx.export("databricksWorkspacePrivateEndpointConnectionStatus", example.applyValue(getWorkspacePrivateEndpointConnectionResult -> getWorkspacePrivateEndpointConnectionResult.connections()[0].status()));
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: azure:databricks:getWorkspacePrivateEndpointConnection
          Arguments:
            workspaceId: ${exampleAzurermDatabricksWorkspace.id}
            privateEndpointId: ${exampleAzurermPrivateEndpoint.id}
    outputs:
      databricksWorkspacePrivateEndpointConnectionStatus: ${example.connections[0].status}
    

    Using getWorkspacePrivateEndpointConnection

    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 getWorkspacePrivateEndpointConnection(args: GetWorkspacePrivateEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetWorkspacePrivateEndpointConnectionResult>
    function getWorkspacePrivateEndpointConnectionOutput(args: GetWorkspacePrivateEndpointConnectionOutputArgs, opts?: InvokeOptions): Output<GetWorkspacePrivateEndpointConnectionResult>
    def get_workspace_private_endpoint_connection(private_endpoint_id: Optional[str] = None,
                                                  workspace_id: Optional[str] = None,
                                                  opts: Optional[InvokeOptions] = None) -> GetWorkspacePrivateEndpointConnectionResult
    def get_workspace_private_endpoint_connection_output(private_endpoint_id: Optional[pulumi.Input[str]] = None,
                                                  workspace_id: Optional[pulumi.Input[str]] = None,
                                                  opts: Optional[InvokeOptions] = None) -> Output[GetWorkspacePrivateEndpointConnectionResult]
    func GetWorkspacePrivateEndpointConnection(ctx *Context, args *GetWorkspacePrivateEndpointConnectionArgs, opts ...InvokeOption) (*GetWorkspacePrivateEndpointConnectionResult, error)
    func GetWorkspacePrivateEndpointConnectionOutput(ctx *Context, args *GetWorkspacePrivateEndpointConnectionOutputArgs, opts ...InvokeOption) GetWorkspacePrivateEndpointConnectionResultOutput

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

    public static class GetWorkspacePrivateEndpointConnection 
    {
        public static Task<GetWorkspacePrivateEndpointConnectionResult> InvokeAsync(GetWorkspacePrivateEndpointConnectionArgs args, InvokeOptions? opts = null)
        public static Output<GetWorkspacePrivateEndpointConnectionResult> Invoke(GetWorkspacePrivateEndpointConnectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetWorkspacePrivateEndpointConnectionResult> getWorkspacePrivateEndpointConnection(GetWorkspacePrivateEndpointConnectionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure:databricks/getWorkspacePrivateEndpointConnection:getWorkspacePrivateEndpointConnection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PrivateEndpointId string
    The resource ID of the Private Endpoint.
    WorkspaceId string
    The resource ID of the Databricks Workspace.
    PrivateEndpointId string
    The resource ID of the Private Endpoint.
    WorkspaceId string
    The resource ID of the Databricks Workspace.
    privateEndpointId String
    The resource ID of the Private Endpoint.
    workspaceId String
    The resource ID of the Databricks Workspace.
    privateEndpointId string
    The resource ID of the Private Endpoint.
    workspaceId string
    The resource ID of the Databricks Workspace.
    private_endpoint_id str
    The resource ID of the Private Endpoint.
    workspace_id str
    The resource ID of the Databricks Workspace.
    privateEndpointId String
    The resource ID of the Private Endpoint.
    workspaceId String
    The resource ID of the Databricks Workspace.

    getWorkspacePrivateEndpointConnection Result

    The following output properties are available:

    Connections List<Pulumi.Azure.DataBricks.Outputs.GetWorkspacePrivateEndpointConnectionConnection>
    A connections block as documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateEndpointId string
    The resource ID of the Private Endpoint.
    WorkspaceId string
    The resource ID of the Databricks Workspace.
    Connections []GetWorkspacePrivateEndpointConnectionConnection
    A connections block as documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateEndpointId string
    The resource ID of the Private Endpoint.
    WorkspaceId string
    The resource ID of the Databricks Workspace.
    connections List<GetWorkspacePrivateEndpointConnectionConnection>
    A connections block as documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    privateEndpointId String
    The resource ID of the Private Endpoint.
    workspaceId String
    The resource ID of the Databricks Workspace.
    connections GetWorkspacePrivateEndpointConnectionConnection[]
    A connections block as documented below.
    id string
    The provider-assigned unique ID for this managed resource.
    privateEndpointId string
    The resource ID of the Private Endpoint.
    workspaceId string
    The resource ID of the Databricks Workspace.
    connections Sequence[GetWorkspacePrivateEndpointConnectionConnection]
    A connections block as documented below.
    id str
    The provider-assigned unique ID for this managed resource.
    private_endpoint_id str
    The resource ID of the Private Endpoint.
    workspace_id str
    The resource ID of the Databricks Workspace.
    connections List<Property Map>
    A connections block as documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    privateEndpointId String
    The resource ID of the Private Endpoint.
    workspaceId String
    The resource ID of the Databricks Workspace.

    Supporting Types

    GetWorkspacePrivateEndpointConnectionConnection

    ActionRequired string
    Actions required for a private endpoint connection.
    Description string
    The description for the current state of a private endpoint connection.
    Name string
    The name of the Databricks Workspace.
    Status string
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    WorkspacePrivateEndpointId string
    The Databricks Workspace resource ID for the private link endpoint.
    ActionRequired string
    Actions required for a private endpoint connection.
    Description string
    The description for the current state of a private endpoint connection.
    Name string
    The name of the Databricks Workspace.
    Status string
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    WorkspacePrivateEndpointId string
    The Databricks Workspace resource ID for the private link endpoint.
    actionRequired String
    Actions required for a private endpoint connection.
    description String
    The description for the current state of a private endpoint connection.
    name String
    The name of the Databricks Workspace.
    status String
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    workspacePrivateEndpointId String
    The Databricks Workspace resource ID for the private link endpoint.
    actionRequired string
    Actions required for a private endpoint connection.
    description string
    The description for the current state of a private endpoint connection.
    name string
    The name of the Databricks Workspace.
    status string
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    workspacePrivateEndpointId string
    The Databricks Workspace resource ID for the private link endpoint.
    action_required str
    Actions required for a private endpoint connection.
    description str
    The description for the current state of a private endpoint connection.
    name str
    The name of the Databricks Workspace.
    status str
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    workspace_private_endpoint_id str
    The Databricks Workspace resource ID for the private link endpoint.
    actionRequired String
    Actions required for a private endpoint connection.
    description String
    The description for the current state of a private endpoint connection.
    name String
    The name of the Databricks Workspace.
    status String
    The status of a private endpoint connection. Possible values are Pending, Approved, Rejected or Disconnected.
    workspacePrivateEndpointId String
    The Databricks Workspace resource ID for the private link endpoint.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi