Oracle Cloud Infrastructure v2.15.0 published on Thursday, Oct 31, 2024 by Pulumi
oci.DataIntegration.getWorkspace
Explore with Pulumi AI
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,
});
import pulumi
import pulumi_oci as oci
test_workspace = oci.DataIntegration.get_workspace(workspace_id=test_workspace_oci_dataintegration_workspace["id"])
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
})
}
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,
});
});
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());
}
}
variables:
testWorkspace:
fn::invoke:
Function: oci:DataIntegration:getWorkspace
Arguments:
workspaceId: ${testWorkspaceOciDataintegrationWorkspace.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(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]
func GetWorkspace(ctx *Context, args *GetWorkspaceArgs, opts ...InvokeOption) (*GetWorkspaceResult, error)
func GetWorkspaceOutput(ctx *Context, args *GetWorkspaceOutputArgs, opts ...InvokeOption) GetWorkspaceResultOutput
> 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)
}
public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:DataIntegration/getWorkspace:getWorkspace
arguments:
# arguments dictionary
The following arguments are supported:
- Workspace
Id string - The workspace ID.
- Workspace
Id string - The workspace ID.
- workspace
Id String - The workspace ID.
- workspace
Id string - The workspace ID.
- workspace_
id str - The workspace ID.
- workspace
Id String - The workspace ID.
getWorkspace Result
The following output properties are available:
- Compartment
Id string - The OCID of the compartment that contains the workspace.
- 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.
- Display
Name string - A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
- Dns
Server stringIp - The IP of the custom DNS.
- Dns
Server stringZone - The DNS zone of the custom DNS to use to resolve names.
- Endpoint
Compartment stringId - Endpoint
Id string - DCMS endpoint associated with the container/workspace. Returns null if there is none.
- Endpoint
Name string - Name of the private endpoint associated with the container/workspace. Returns null if there is none.
- 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.
- Is
Force boolOperation - Is
Private boolNetwork Enabled - Specifies whether the private network connection is enabled or disabled.
- Quiesce
Timeout int - Registry
Compartment stringId - Registry
Id string - DCMS registry associated with the container/workspace. Returns null if there is none.
- Registry
Name 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.
- State
Message 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.
- Subnet
Id string - The OCID of the subnet for customer connected databases.
- Time
Created string - The date and time the workspace was created, in the timestamp format defined by RFC3339.
- Time
Updated string - The date and time the workspace was updated, in the timestamp format defined by RFC3339.
- Vcn
Id string - The OCID of the VCN the subnet is in.
- Workspace
Id string
- Compartment
Id string - The OCID of the compartment that contains the workspace.
- 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.
- Display
Name string - A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
- Dns
Server stringIp - The IP of the custom DNS.
- Dns
Server stringZone - The DNS zone of the custom DNS to use to resolve names.
- Endpoint
Compartment stringId - Endpoint
Id string - DCMS endpoint associated with the container/workspace. Returns null if there is none.
- Endpoint
Name string - Name of the private endpoint associated with the container/workspace. Returns null if there is none.
- 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.
- Is
Force boolOperation - Is
Private boolNetwork Enabled - Specifies whether the private network connection is enabled or disabled.
- Quiesce
Timeout int - Registry
Compartment stringId - Registry
Id string - DCMS registry associated with the container/workspace. Returns null if there is none.
- Registry
Name 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.
- State
Message 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.
- Subnet
Id string - The OCID of the subnet for customer connected databases.
- Time
Created string - The date and time the workspace was created, in the timestamp format defined by RFC3339.
- Time
Updated string - The date and time the workspace was updated, in the timestamp format defined by RFC3339.
- Vcn
Id string - The OCID of the VCN the subnet is in.
- Workspace
Id string
- compartment
Id String - The OCID of the compartment that contains the workspace.
- 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.
- display
Name String - A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
- dns
Server StringIp - The IP of the custom DNS.
- dns
Server StringZone - The DNS zone of the custom DNS to use to resolve names.
- endpoint
Compartment StringId - endpoint
Id String - DCMS endpoint associated with the container/workspace. Returns null if there is none.
- endpoint
Name String - Name of the private endpoint associated with the container/workspace. Returns null if there is none.
- 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.
- is
Force BooleanOperation - is
Private BooleanNetwork Enabled - Specifies whether the private network connection is enabled or disabled.
- quiesce
Timeout Integer - registry
Compartment StringId - registry
Id String - DCMS registry associated with the container/workspace. Returns null if there is none.
- registry
Name 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.
- state
Message 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.
- subnet
Id String - The OCID of the subnet for customer connected databases.
- time
Created String - The date and time the workspace was created, in the timestamp format defined by RFC3339.
- time
Updated String - The date and time the workspace was updated, in the timestamp format defined by RFC3339.
- vcn
Id String - The OCID of the VCN the subnet is in.
- workspace
Id String
- compartment
Id string - The OCID of the compartment that contains the workspace.
- {[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.
- display
Name string - A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
- dns
Server stringIp - The IP of the custom DNS.
- dns
Server stringZone - The DNS zone of the custom DNS to use to resolve names.
- endpoint
Compartment stringId - endpoint
Id string - DCMS endpoint associated with the container/workspace. Returns null if there is none.
- endpoint
Name string - Name of the private endpoint associated with the container/workspace. Returns null if there is none.
- {[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.
- is
Force booleanOperation - is
Private booleanNetwork Enabled - Specifies whether the private network connection is enabled or disabled.
- quiesce
Timeout number - registry
Compartment stringId - registry
Id string - DCMS registry associated with the container/workspace. Returns null if there is none.
- registry
Name 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.
- state
Message 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.
- subnet
Id string - The OCID of the subnet for customer connected databases.
- time
Created string - The date and time the workspace was created, in the timestamp format defined by RFC3339.
- time
Updated string - The date and time the workspace was updated, in the timestamp format defined by RFC3339.
- vcn
Id string - The OCID of the VCN the subnet is in.
- workspace
Id string
- compartment_
id str - The OCID of the compartment that contains the workspace.
- 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_ strip - The IP of the custom DNS.
- dns_
server_ strzone - The DNS zone of the custom DNS to use to resolve names.
- endpoint_
compartment_ strid - 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.
- 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_ booloperation - is_
private_ boolnetwork_ enabled - Specifies whether the private network connection is enabled or disabled.
- quiesce_
timeout int - registry_
compartment_ strid - 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
- compartment
Id String - The OCID of the compartment that contains the workspace.
- 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.
- display
Name String - A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.
- dns
Server StringIp - The IP of the custom DNS.
- dns
Server StringZone - The DNS zone of the custom DNS to use to resolve names.
- endpoint
Compartment StringId - endpoint
Id String - DCMS endpoint associated with the container/workspace. Returns null if there is none.
- endpoint
Name String - Name of the private endpoint associated with the container/workspace. Returns null if there is none.
- 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.
- is
Force BooleanOperation - is
Private BooleanNetwork Enabled - Specifies whether the private network connection is enabled or disabled.
- quiesce
Timeout Number - registry
Compartment StringId - registry
Id String - DCMS registry associated with the container/workspace. Returns null if there is none.
- registry
Name 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.
- state
Message 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.
- subnet
Id String - The OCID of the subnet for customer connected databases.
- time
Created String - The date and time the workspace was created, in the timestamp format defined by RFC3339.
- time
Updated String - The date and time the workspace was updated, in the timestamp format defined by RFC3339.
- vcn
Id String - The OCID of the VCN the subnet is in.
- workspace
Id String
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.