Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataIntegration
  5. getWorkspace
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

oci.DataIntegration.getWorkspace

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides details about a specific Workspace resource in Oracle Cloud Infrastructure Data Integration service.

Retrieves a Data Integration workspace using the specified identifier.

Example Usage

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

const testWorkspace = oci.DataIntegration.getWorkspace({
    workspaceId: testWorkspaceOciDataintegrationWorkspace.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_workspace = oci.DataIntegration.get_workspace(workspace_id=test_workspace_oci_dataintegration_workspace["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/dataintegration"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dataintegration.GetWorkspace(ctx, &dataintegration.GetWorkspaceArgs{
			WorkspaceId: testWorkspaceOciDataintegrationWorkspace.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testWorkspace = Oci.DataIntegration.GetWorkspace.Invoke(new()
    {
        WorkspaceId = testWorkspaceOciDataintegrationWorkspace.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataIntegration.DataIntegrationFunctions;
import com.pulumi.oci.DataIntegration.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 testWorkspace = DataIntegrationFunctions.getWorkspace(GetWorkspaceArgs.builder()
            .workspaceId(testWorkspaceOciDataintegrationWorkspace.id())
            .build());

    }
}
Copy
variables:
  testWorkspace:
    fn::invoke:
      function: oci:DataIntegration:getWorkspace
      arguments:
        workspaceId: ${testWorkspaceOciDataintegrationWorkspace.id}
Copy

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>
Copy
def get_workspace(workspace_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
def get_workspace_output(workspace_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceResult]
Copy
func GetWorkspace(ctx *Context, args *GetWorkspaceArgs, opts ...InvokeOption) (*GetWorkspaceResult, error)
func GetWorkspaceOutput(ctx *Context, args *GetWorkspaceOutputArgs, opts ...InvokeOption) GetWorkspaceResultOutput
Copy

> Note: This function is named GetWorkspace 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)
}
Copy
public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
public static Output<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:DataIntegration/getWorkspace:getWorkspace
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

WorkspaceId This property is required. string
The workspace ID.
WorkspaceId This property is required. string
The workspace ID.
workspaceId This property is required. String
The workspace ID.
workspaceId This property is required. string
The workspace ID.
workspace_id This property is required. str
The workspace ID.
workspaceId This property is required. String
The workspace ID.

getWorkspace Result

The following output properties are available:

CompartmentId string
The OCID of the compartment that contains the workspace.
DefinedTags Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string
A user defined description for the workspace.
DisplayName string
A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
DnsServerIp string
The IP of the custom DNS.
DnsServerZone string
The DNS zone of the custom DNS to use to resolve names.
EndpointCompartmentId string
EndpointId string
DCMS endpoint associated with the container/workspace. Returns null if there is none.
EndpointName string
Name of the private endpoint associated with the container/workspace. Returns null if there is none.
FreeformTags Dictionary<string, string>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
Id string
A system-generated and immutable identifier assigned to the workspace upon creation.
IsForceOperation bool
IsPrivateNetworkEnabled bool
Specifies whether the private network connection is enabled or disabled.
QuiesceTimeout int
RegistryCompartmentId string
RegistryId string
DCMS registry associated with the container/workspace. Returns null if there is none.
RegistryName string
State string
Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
StateMessage string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
SubnetId string
The OCID of the subnet for customer connected databases.
TimeCreated string
The date and time the workspace was created, in the timestamp format defined by RFC3339.
TimeUpdated string
The date and time the workspace was updated, in the timestamp format defined by RFC3339.
VcnId string
The OCID of the VCN the subnet is in.
WorkspaceId string
CompartmentId string
The OCID of the compartment that contains the workspace.
DefinedTags map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string
A user defined description for the workspace.
DisplayName string
A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
DnsServerIp string
The IP of the custom DNS.
DnsServerZone string
The DNS zone of the custom DNS to use to resolve names.
EndpointCompartmentId string
EndpointId string
DCMS endpoint associated with the container/workspace. Returns null if there is none.
EndpointName string
Name of the private endpoint associated with the container/workspace. Returns null if there is none.
FreeformTags map[string]string
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
Id string
A system-generated and immutable identifier assigned to the workspace upon creation.
IsForceOperation bool
IsPrivateNetworkEnabled bool
Specifies whether the private network connection is enabled or disabled.
QuiesceTimeout int
RegistryCompartmentId string
RegistryId string
DCMS registry associated with the container/workspace. Returns null if there is none.
RegistryName string
State string
Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
StateMessage string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
SubnetId string
The OCID of the subnet for customer connected databases.
TimeCreated string
The date and time the workspace was created, in the timestamp format defined by RFC3339.
TimeUpdated string
The date and time the workspace was updated, in the timestamp format defined by RFC3339.
VcnId string
The OCID of the VCN the subnet is in.
WorkspaceId string
compartmentId String
The OCID of the compartment that contains the workspace.
definedTags Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description String
A user defined description for the workspace.
displayName String
A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
dnsServerIp String
The IP of the custom DNS.
dnsServerZone String
The DNS zone of the custom DNS to use to resolve names.
endpointCompartmentId String
endpointId String
DCMS endpoint associated with the container/workspace. Returns null if there is none.
endpointName String
Name of the private endpoint associated with the container/workspace. Returns null if there is none.
freeformTags Map<String,String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
id String
A system-generated and immutable identifier assigned to the workspace upon creation.
isForceOperation Boolean
isPrivateNetworkEnabled Boolean
Specifies whether the private network connection is enabled or disabled.
quiesceTimeout Integer
registryCompartmentId String
registryId String
DCMS registry associated with the container/workspace. Returns null if there is none.
registryName String
state String
Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
stateMessage String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
subnetId String
The OCID of the subnet for customer connected databases.
timeCreated String
The date and time the workspace was created, in the timestamp format defined by RFC3339.
timeUpdated String
The date and time the workspace was updated, in the timestamp format defined by RFC3339.
vcnId String
The OCID of the VCN the subnet is in.
workspaceId String
compartmentId string
The OCID of the compartment that contains the workspace.
definedTags {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description string
A user defined description for the workspace.
displayName string
A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
dnsServerIp string
The IP of the custom DNS.
dnsServerZone string
The DNS zone of the custom DNS to use to resolve names.
endpointCompartmentId string
endpointId string
DCMS endpoint associated with the container/workspace. Returns null if there is none.
endpointName string
Name of the private endpoint associated with the container/workspace. Returns null if there is none.
freeformTags {[key: string]: string}
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
id string
A system-generated and immutable identifier assigned to the workspace upon creation.
isForceOperation boolean
isPrivateNetworkEnabled boolean
Specifies whether the private network connection is enabled or disabled.
quiesceTimeout number
registryCompartmentId string
registryId string
DCMS registry associated with the container/workspace. Returns null if there is none.
registryName string
state string
Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
stateMessage string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
subnetId string
The OCID of the subnet for customer connected databases.
timeCreated string
The date and time the workspace was created, in the timestamp format defined by RFC3339.
timeUpdated string
The date and time the workspace was updated, in the timestamp format defined by RFC3339.
vcnId string
The OCID of the VCN the subnet is in.
workspaceId string
compartment_id str
The OCID of the compartment that contains the workspace.
defined_tags Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description str
A user defined description for the workspace.
display_name str
A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
dns_server_ip str
The IP of the custom DNS.
dns_server_zone str
The DNS zone of the custom DNS to use to resolve names.
endpoint_compartment_id str
endpoint_id str
DCMS endpoint associated with the container/workspace. Returns null if there is none.
endpoint_name str
Name of the private endpoint associated with the container/workspace. Returns null if there is none.
freeform_tags Mapping[str, str]
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
id str
A system-generated and immutable identifier assigned to the workspace upon creation.
is_force_operation bool
is_private_network_enabled bool
Specifies whether the private network connection is enabled or disabled.
quiesce_timeout int
registry_compartment_id str
registry_id str
DCMS registry associated with the container/workspace. Returns null if there is none.
registry_name str
state str
Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
state_message str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
subnet_id str
The OCID of the subnet for customer connected databases.
time_created str
The date and time the workspace was created, in the timestamp format defined by RFC3339.
time_updated str
The date and time the workspace was updated, in the timestamp format defined by RFC3339.
vcn_id str
The OCID of the VCN the subnet is in.
workspace_id str
compartmentId String
The OCID of the compartment that contains the workspace.
definedTags Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description String
A user defined description for the workspace.
displayName String
A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
dnsServerIp String
The IP of the custom DNS.
dnsServerZone String
The DNS zone of the custom DNS to use to resolve names.
endpointCompartmentId String
endpointId String
DCMS endpoint associated with the container/workspace. Returns null if there is none.
endpointName String
Name of the private endpoint associated with the container/workspace. Returns null if there is none.
freeformTags Map<String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
id String
A system-generated and immutable identifier assigned to the workspace upon creation.
isForceOperation Boolean
isPrivateNetworkEnabled Boolean
Specifies whether the private network connection is enabled or disabled.
quiesceTimeout Number
registryCompartmentId String
registryId String
DCMS registry associated with the container/workspace. Returns null if there is none.
registryName String
state String
Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.
stateMessage String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
subnetId String
The OCID of the subnet for customer connected databases.
timeCreated String
The date and time the workspace was created, in the timestamp format defined by RFC3339.
timeUpdated String
The date and time the workspace was updated, in the timestamp format defined by RFC3339.
vcnId String
The OCID of the VCN the subnet is in.
workspaceId String

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci