Azure Classic v5.49.0, Aug 29 23

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

pulumi/pulumi-azure

azure.synapse.getWorkspace

Explore with Pulumi AI

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

pulumi/pulumi-azure

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Azure.Synapse.GetWorkspace.Invoke(new()
    {
        Name = "existing",
        ResourceGroupName = "example-resource-group",
    });

    return new Dictionary<string, object?>
    {
        ["id"] = example.Apply(getWorkspaceResult => getWorkspaceResult.Id),
    };
});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/synapse"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := synapse.LookupWorkspace(ctx, &synapse.LookupWorkspaceArgs{
			Name:              "existing",
			ResourceGroupName: "example-resource-group",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", example.Id)
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.synapse.SynapseFunctions;
import com.pulumi.azure.synapse.inputs.GetWorkspaceArgs;
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 = SynapseFunctions.getWorkspace(GetWorkspaceArgs.builder()
            .name("existing")
            .resourceGroupName("example-resource-group")
            .build());

        ctx.export("id", example.applyValue(getWorkspaceResult -> getWorkspaceResult.id()));
    }
}

import pulumi
import pulumi_azure as azure

example = azure.synapse.get_workspace(name="existing",
    resource_group_name="example-resource-group")
pulumi.export("id", example.id)

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

const example = azure.synapse.getWorkspace({
    name: "existing",
    resourceGroupName: "example-resource-group",
});
export const id = example.then(example => example.id);

variables:
  example:
    fn::invoke:
      Function: azure:synapse:getWorkspace
      Arguments:
        name: existing
        resourceGroupName: example-resource-group
outputs:
  id: ${example.id}

Using getWorkspace

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 getWorkspace(args: GetWorkspaceArgs, opts?: InvokeOptions): Promise<GetWorkspaceResult>
function getWorkspaceOutput(args: GetWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceResult>

def get_workspace(name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
def get_workspace_output(name: Optional[pulumi.Input[str]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceResult]

func LookupWorkspace(ctx *Context, args *LookupWorkspaceArgs, opts ...InvokeOption) (*LookupWorkspaceResult, error)
func LookupWorkspaceOutput(ctx *Context, args *LookupWorkspaceOutputArgs, opts ...InvokeOption) LookupWorkspaceResultOutput

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

public static class GetWorkspace 
{
    public static Task<GetWorkspaceResult> InvokeAsync(GetWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceResult> Invoke(GetWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure:synapse/getWorkspace:getWorkspace
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of this Synapse Workspace.
ResourceGroupName string: The name of the Resource Group where the Synapse Workspace exists.

Name string: The name of this Synapse Workspace.
ResourceGroupName string: The name of the Resource Group where the Synapse Workspace exists.

name String: The name of this Synapse Workspace.
resourceGroupName String: The name of the Resource Group where the Synapse Workspace exists.

name string: The name of this Synapse Workspace.
resourceGroupName string: The name of the Resource Group where the Synapse Workspace exists.

name str: The name of this Synapse Workspace.
resource_group_name str: The name of the Resource Group where the Synapse Workspace exists.

name String: The name of this Synapse Workspace.
resourceGroupName String: The name of the Resource Group where the Synapse Workspace exists.

getWorkspace Result

The following output properties are available:

ConnectivityEndpoints Dictionary<string, string>: A list of Connectivity endpoints for this Synapse Workspace.
Id string: The provider-assigned unique ID for this managed resource.
Identities List<GetWorkspaceIdentity>: An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
Location string: The Azure location where the Synapse Workspace exists.
Name string
ResourceGroupName string
Tags Dictionary<string, string>: A mapping of tags assigned to the resource.

ConnectivityEndpoints map[string]string: A list of Connectivity endpoints for this Synapse Workspace.
Id string: The provider-assigned unique ID for this managed resource.
Identities []GetWorkspaceIdentity: An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
Location string: The Azure location where the Synapse Workspace exists.
Name string
ResourceGroupName string
Tags map[string]string: A mapping of tags assigned to the resource.

connectivityEndpoints Map<String,String>: A list of Connectivity endpoints for this Synapse Workspace.
id String: The provider-assigned unique ID for this managed resource.
identities List<GetWorkspaceIdentity>: An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
location String: The Azure location where the Synapse Workspace exists.
name String
resourceGroupName String
tags Map<String,String>: A mapping of tags assigned to the resource.

connectivityEndpoints {[key: string]: string}: A list of Connectivity endpoints for this Synapse Workspace.
id string: The provider-assigned unique ID for this managed resource.
identities GetWorkspaceIdentity[]: An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
location string: The Azure location where the Synapse Workspace exists.
name string
resourceGroupName string
tags {[key: string]: string}: A mapping of tags assigned to the resource.

connectivity_endpoints Mapping[str, str]: A list of Connectivity endpoints for this Synapse Workspace.
id str: The provider-assigned unique ID for this managed resource.
identities Sequence[GetWorkspaceIdentity]: An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
location str: The Azure location where the Synapse Workspace exists.
name str
resource_group_name str
tags Mapping[str, str]: A mapping of tags assigned to the resource.

connectivityEndpoints Map<String>: A list of Connectivity endpoints for this Synapse Workspace.
id String: The provider-assigned unique ID for this managed resource.
identities List<Property Map>: An identity block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
location String: The Azure location where the Synapse Workspace exists.
name String
resourceGroupName String
tags Map<String>: A mapping of tags assigned to the resource.

Supporting Types

GetWorkspaceIdentity

IdentityIds List<string>
PrincipalId string: The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
TenantId string: The Tenant ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
Type string: The Identity Type for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

IdentityIds []string
PrincipalId string: The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
TenantId string: The Tenant ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
Type string: The Identity Type for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

identityIds List<String>
principalId String: The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
tenantId String: The Tenant ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
type String: The Identity Type for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

identityIds string[]
principalId string: The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
tenantId string: The Tenant ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
type string: The Identity Type for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

identity_ids Sequence[str]
principal_id str: The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
tenant_id str: The Tenant ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
type str: The Identity Type for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

identityIds List<String>
principalId String: The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
tenantId String: The Tenant ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
type String: The Identity Type for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

Package Details

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

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

pulumi/pulumi-azure

azure.synapse.getWorkspace

On this page

On this page

Example Usage

Using getWorkspace

getWorkspace Result

Supporting Types

GetWorkspaceIdentity

Package Details

On this page

On this page