1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ServiceMesh
  5. getVirtualDeployment
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

oci.ServiceMesh.getVirtualDeployment

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

    This data source provides details about a specific Virtual Deployment resource in Oracle Cloud Infrastructure Service Mesh service.

    Gets a VirtualDeployment by identifier.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testVirtualDeployment = oci.ServiceMesh.getVirtualDeployment({
        virtualDeploymentId: testVirtualDeploymentOciServiceMeshVirtualDeployment.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_virtual_deployment = oci.ServiceMesh.get_virtual_deployment(virtual_deployment_id=test_virtual_deployment_oci_service_mesh_virtual_deployment["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/ServiceMesh"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ServiceMesh.GetVirtualDeployment(ctx, &servicemesh.GetVirtualDeploymentArgs{
    			VirtualDeploymentId: testVirtualDeploymentOciServiceMeshVirtualDeployment.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 testVirtualDeployment = Oci.ServiceMesh.GetVirtualDeployment.Invoke(new()
        {
            VirtualDeploymentId = testVirtualDeploymentOciServiceMeshVirtualDeployment.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.ServiceMesh.ServiceMeshFunctions;
    import com.pulumi.oci.ServiceMesh.inputs.GetVirtualDeploymentArgs;
    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 testVirtualDeployment = ServiceMeshFunctions.getVirtualDeployment(GetVirtualDeploymentArgs.builder()
                .virtualDeploymentId(testVirtualDeploymentOciServiceMeshVirtualDeployment.id())
                .build());
    
        }
    }
    
    variables:
      testVirtualDeployment:
        fn::invoke:
          Function: oci:ServiceMesh:getVirtualDeployment
          Arguments:
            virtualDeploymentId: ${testVirtualDeploymentOciServiceMeshVirtualDeployment.id}
    

    Using getVirtualDeployment

    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 getVirtualDeployment(args: GetVirtualDeploymentArgs, opts?: InvokeOptions): Promise<GetVirtualDeploymentResult>
    function getVirtualDeploymentOutput(args: GetVirtualDeploymentOutputArgs, opts?: InvokeOptions): Output<GetVirtualDeploymentResult>
    def get_virtual_deployment(virtual_deployment_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetVirtualDeploymentResult
    def get_virtual_deployment_output(virtual_deployment_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetVirtualDeploymentResult]
    func GetVirtualDeployment(ctx *Context, args *GetVirtualDeploymentArgs, opts ...InvokeOption) (*GetVirtualDeploymentResult, error)
    func GetVirtualDeploymentOutput(ctx *Context, args *GetVirtualDeploymentOutputArgs, opts ...InvokeOption) GetVirtualDeploymentResultOutput

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

    public static class GetVirtualDeployment 
    {
        public static Task<GetVirtualDeploymentResult> InvokeAsync(GetVirtualDeploymentArgs args, InvokeOptions? opts = null)
        public static Output<GetVirtualDeploymentResult> Invoke(GetVirtualDeploymentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVirtualDeploymentResult> getVirtualDeployment(GetVirtualDeploymentArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:ServiceMesh/getVirtualDeployment:getVirtualDeployment
      arguments:
        # arguments dictionary

    The following arguments are supported:

    VirtualDeploymentId string
    Unique VirtualDeployment identifier.
    VirtualDeploymentId string
    Unique VirtualDeployment identifier.
    virtualDeploymentId String
    Unique VirtualDeployment identifier.
    virtualDeploymentId string
    Unique VirtualDeployment identifier.
    virtual_deployment_id str
    Unique VirtualDeployment identifier.
    virtualDeploymentId String
    Unique VirtualDeployment identifier.

    getVirtualDeployment Result

    The following output properties are available:

    AccessLoggings List<GetVirtualDeploymentAccessLogging>
    This configuration determines if logging is enabled and where the logs will be output.
    CompartmentId string
    The OCID of the compartment.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    FreeformTags Dictionary<string, object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    Unique identifier that is immutable on creation.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    Listeners List<GetVirtualDeploymentListener>
    The listeners for the virtual deployment
    Name string
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    ServiceDiscoveries List<GetVirtualDeploymentServiceDiscovery>
    Service Discovery configuration for virtual deployments.
    State string
    The current state of the Resource.
    SystemTags Dictionary<string, object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time when this resource was created in an RFC3339 formatted datetime string.
    TimeUpdated string
    The time when this resource was updated in an RFC3339 formatted datetime string.
    VirtualDeploymentId string
    VirtualServiceId string
    The OCID of the virtual service in which this virtual deployment is created.
    AccessLoggings []GetVirtualDeploymentAccessLogging
    This configuration determines if logging is enabled and where the logs will be output.
    CompartmentId string
    The OCID of the compartment.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    FreeformTags map[string]interface{}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    Unique identifier that is immutable on creation.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    Listeners []GetVirtualDeploymentListener
    The listeners for the virtual deployment
    Name string
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    ServiceDiscoveries []GetVirtualDeploymentServiceDiscovery
    Service Discovery configuration for virtual deployments.
    State string
    The current state of the Resource.
    SystemTags map[string]interface{}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time when this resource was created in an RFC3339 formatted datetime string.
    TimeUpdated string
    The time when this resource was updated in an RFC3339 formatted datetime string.
    VirtualDeploymentId string
    VirtualServiceId string
    The OCID of the virtual service in which this virtual deployment is created.
    accessLoggings List<GetVirtualDeploymentAccessLogging>
    This configuration determines if logging is enabled and where the logs will be output.
    compartmentId String
    The OCID of the compartment.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    freeformTags Map<String,Object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    Unique identifier that is immutable on creation.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    listeners List<GetVirtualDeploymentListener>
    The listeners for the virtual deployment
    name String
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    serviceDiscoveries List<GetVirtualDeploymentServiceDiscovery>
    Service Discovery configuration for virtual deployments.
    state String
    The current state of the Resource.
    systemTags Map<String,Object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time when this resource was created in an RFC3339 formatted datetime string.
    timeUpdated String
    The time when this resource was updated in an RFC3339 formatted datetime string.
    virtualDeploymentId String
    virtualServiceId String
    The OCID of the virtual service in which this virtual deployment is created.
    accessLoggings GetVirtualDeploymentAccessLogging[]
    This configuration determines if logging is enabled and where the logs will be output.
    compartmentId string
    The OCID of the compartment.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    freeformTags {[key: string]: any}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    Unique identifier that is immutable on creation.
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    listeners GetVirtualDeploymentListener[]
    The listeners for the virtual deployment
    name string
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    serviceDiscoveries GetVirtualDeploymentServiceDiscovery[]
    Service Discovery configuration for virtual deployments.
    state string
    The current state of the Resource.
    systemTags {[key: string]: any}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time when this resource was created in an RFC3339 formatted datetime string.
    timeUpdated string
    The time when this resource was updated in an RFC3339 formatted datetime string.
    virtualDeploymentId string
    virtualServiceId string
    The OCID of the virtual service in which this virtual deployment is created.
    access_loggings Sequence[servicemesh.GetVirtualDeploymentAccessLogging]
    This configuration determines if logging is enabled and where the logs will be output.
    compartment_id str
    The OCID of the compartment.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    freeform_tags Mapping[str, Any]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    Unique identifier that is immutable on creation.
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    listeners Sequence[servicemesh.GetVirtualDeploymentListener]
    The listeners for the virtual deployment
    name str
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    service_discoveries Sequence[servicemesh.GetVirtualDeploymentServiceDiscovery]
    Service Discovery configuration for virtual deployments.
    state str
    The current state of the Resource.
    system_tags Mapping[str, Any]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time when this resource was created in an RFC3339 formatted datetime string.
    time_updated str
    The time when this resource was updated in an RFC3339 formatted datetime string.
    virtual_deployment_id str
    virtual_service_id str
    The OCID of the virtual service in which this virtual deployment is created.
    accessLoggings List<Property Map>
    This configuration determines if logging is enabled and where the logs will be output.
    compartmentId String
    The OCID of the compartment.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    Description of the resource. It can be changed after creation. Avoid entering confidential information. Example: This is my new resource
    freeformTags Map<Any>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    Unique identifier that is immutable on creation.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
    listeners List<Property Map>
    The listeners for the virtual deployment
    name String
    A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information. Example: My unique resource name
    serviceDiscoveries List<Property Map>
    Service Discovery configuration for virtual deployments.
    state String
    The current state of the Resource.
    systemTags Map<Any>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time when this resource was created in an RFC3339 formatted datetime string.
    timeUpdated String
    The time when this resource was updated in an RFC3339 formatted datetime string.
    virtualDeploymentId String
    virtualServiceId String
    The OCID of the virtual service in which this virtual deployment is created.

    Supporting Types

    GetVirtualDeploymentAccessLogging

    IsEnabled bool
    Determines if the logging configuration is enabled.
    IsEnabled bool
    Determines if the logging configuration is enabled.
    isEnabled Boolean
    Determines if the logging configuration is enabled.
    isEnabled boolean
    Determines if the logging configuration is enabled.
    is_enabled bool
    Determines if the logging configuration is enabled.
    isEnabled Boolean
    Determines if the logging configuration is enabled.

    GetVirtualDeploymentListener

    IdleTimeoutInMs string
    The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.
    Port int
    Port in which virtual deployment is running.
    Protocol string
    Type of protocol used in virtual deployment.
    RequestTimeoutInMs string
    The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.
    IdleTimeoutInMs string
    The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.
    Port int
    Port in which virtual deployment is running.
    Protocol string
    Type of protocol used in virtual deployment.
    RequestTimeoutInMs string
    The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.
    idleTimeoutInMs String
    The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.
    port Integer
    Port in which virtual deployment is running.
    protocol String
    Type of protocol used in virtual deployment.
    requestTimeoutInMs String
    The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.
    idleTimeoutInMs string
    The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.
    port number
    Port in which virtual deployment is running.
    protocol string
    Type of protocol used in virtual deployment.
    requestTimeoutInMs string
    The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.
    idle_timeout_in_ms str
    The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.
    port int
    Port in which virtual deployment is running.
    protocol str
    Type of protocol used in virtual deployment.
    request_timeout_in_ms str
    The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.
    idleTimeoutInMs String
    The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.
    port Number
    Port in which virtual deployment is running.
    protocol String
    Type of protocol used in virtual deployment.
    requestTimeoutInMs String
    The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.

    GetVirtualDeploymentServiceDiscovery

    Hostname string
    The hostname of the virtual deployments.
    Type string
    Type of service discovery.
    Hostname string
    The hostname of the virtual deployments.
    Type string
    Type of service discovery.
    hostname String
    The hostname of the virtual deployments.
    type String
    Type of service discovery.
    hostname string
    The hostname of the virtual deployments.
    type string
    Type of service discovery.
    hostname str
    The hostname of the virtual deployments.
    type str
    Type of service discovery.
    hostname String
    The hostname of the virtual deployments.
    type String
    Type of service discovery.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi