1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. StackMonitoring
  5. DiscoveryJob
Oracle Cloud Infrastructure v1.16.0 published on Thursday, Nov 2, 2023 by Pulumi

oci.StackMonitoring.DiscoveryJob

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.16.0 published on Thursday, Nov 2, 2023 by Pulumi

    This resource provides the Discovery Job resource in Oracle Cloud Infrastructure Stack Monitoring service.

    API to create discovery Job and submit discovery Details to agent.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testDiscoveryJob = new Oci.StackMonitoring.DiscoveryJob("testDiscoveryJob", new()
        {
            CompartmentId = @var.Compartment_id,
            DiscoveryDetails = new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsArgs
            {
                AgentId = @var.Management_agent_id,
                Properties = new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsPropertiesArgs
                {
                    PropertiesMap = @var.Discovery_job_discovery_details_properties_properties_map,
                },
                ResourceName = @var.Discovery_job_discovery_details_resource_name,
                ResourceType = @var.Discovery_job_discovery_details_resource_type,
                Credentials = new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsCredentialsArgs
                {
                    Items = new[]
                    {
                        new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsCredentialsItemArgs
                        {
                            CredentialName = @var.Discovery_job_discovery_details_credentials_items_credential_name,
                            CredentialType = @var.Discovery_job_discovery_details_credentials_items_credential_type,
                            Properties = new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsCredentialsItemPropertiesArgs
                            {
                                PropertiesMap = @var.Discovery_job_discovery_details_credentials_items_properties_properties_map,
                            },
                        },
                    },
                },
                License = @var.Discovery_job_discovery_details_license,
                Tags = new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsTagsArgs
                {
                    PropertiesMap = @var.Discovery_job_discovery_details_tags_properties_map,
                },
            },
            DefinedTags = 
            {
                { "foo-namespace.bar-key", "value" },
            },
            DiscoveryClient = @var.Discovery_job_discovery_client,
            DiscoveryType = @var.Discovery_job_discovery_type,
            FreeformTags = 
            {
                { "bar-key", "value" },
            },
            ShouldPropagateTagsToDiscoveredResources = @var.Discovery_job_should_propagate_tags_to_discovered_resources,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/StackMonitoring"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := StackMonitoring.NewDiscoveryJob(ctx, "testDiscoveryJob", &StackMonitoring.DiscoveryJobArgs{
    			CompartmentId: pulumi.Any(_var.Compartment_id),
    			DiscoveryDetails: &stackmonitoring.DiscoveryJobDiscoveryDetailsArgs{
    				AgentId: pulumi.Any(_var.Management_agent_id),
    				Properties: &stackmonitoring.DiscoveryJobDiscoveryDetailsPropertiesArgs{
    					PropertiesMap: pulumi.Any(_var.Discovery_job_discovery_details_properties_properties_map),
    				},
    				ResourceName: pulumi.Any(_var.Discovery_job_discovery_details_resource_name),
    				ResourceType: pulumi.Any(_var.Discovery_job_discovery_details_resource_type),
    				Credentials: &stackmonitoring.DiscoveryJobDiscoveryDetailsCredentialsArgs{
    					Items: stackmonitoring.DiscoveryJobDiscoveryDetailsCredentialsItemArray{
    						&stackmonitoring.DiscoveryJobDiscoveryDetailsCredentialsItemArgs{
    							CredentialName: pulumi.Any(_var.Discovery_job_discovery_details_credentials_items_credential_name),
    							CredentialType: pulumi.Any(_var.Discovery_job_discovery_details_credentials_items_credential_type),
    							Properties: &stackmonitoring.DiscoveryJobDiscoveryDetailsCredentialsItemPropertiesArgs{
    								PropertiesMap: pulumi.Any(_var.Discovery_job_discovery_details_credentials_items_properties_properties_map),
    							},
    						},
    					},
    				},
    				License: pulumi.Any(_var.Discovery_job_discovery_details_license),
    				Tags: &stackmonitoring.DiscoveryJobDiscoveryDetailsTagsArgs{
    					PropertiesMap: pulumi.Any(_var.Discovery_job_discovery_details_tags_properties_map),
    				},
    			},
    			DefinedTags: pulumi.Map{
    				"foo-namespace.bar-key": pulumi.Any("value"),
    			},
    			DiscoveryClient: pulumi.Any(_var.Discovery_job_discovery_client),
    			DiscoveryType:   pulumi.Any(_var.Discovery_job_discovery_type),
    			FreeformTags: pulumi.Map{
    				"bar-key": pulumi.Any("value"),
    			},
    			ShouldPropagateTagsToDiscoveredResources: pulumi.Any(_var.Discovery_job_should_propagate_tags_to_discovered_resources),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.StackMonitoring.DiscoveryJob;
    import com.pulumi.oci.StackMonitoring.DiscoveryJobArgs;
    import com.pulumi.oci.StackMonitoring.inputs.DiscoveryJobDiscoveryDetailsArgs;
    import com.pulumi.oci.StackMonitoring.inputs.DiscoveryJobDiscoveryDetailsPropertiesArgs;
    import com.pulumi.oci.StackMonitoring.inputs.DiscoveryJobDiscoveryDetailsCredentialsArgs;
    import com.pulumi.oci.StackMonitoring.inputs.DiscoveryJobDiscoveryDetailsTagsArgs;
    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) {
            var testDiscoveryJob = new DiscoveryJob("testDiscoveryJob", DiscoveryJobArgs.builder()        
                .compartmentId(var_.compartment_id())
                .discoveryDetails(DiscoveryJobDiscoveryDetailsArgs.builder()
                    .agentId(var_.management_agent_id())
                    .properties(DiscoveryJobDiscoveryDetailsPropertiesArgs.builder()
                        .propertiesMap(var_.discovery_job_discovery_details_properties_properties_map())
                        .build())
                    .resourceName(var_.discovery_job_discovery_details_resource_name())
                    .resourceType(var_.discovery_job_discovery_details_resource_type())
                    .credentials(DiscoveryJobDiscoveryDetailsCredentialsArgs.builder()
                        .items(DiscoveryJobDiscoveryDetailsCredentialsItemArgs.builder()
                            .credentialName(var_.discovery_job_discovery_details_credentials_items_credential_name())
                            .credentialType(var_.discovery_job_discovery_details_credentials_items_credential_type())
                            .properties(DiscoveryJobDiscoveryDetailsCredentialsItemPropertiesArgs.builder()
                                .propertiesMap(var_.discovery_job_discovery_details_credentials_items_properties_properties_map())
                                .build())
                            .build())
                        .build())
                    .license(var_.discovery_job_discovery_details_license())
                    .tags(DiscoveryJobDiscoveryDetailsTagsArgs.builder()
                        .propertiesMap(var_.discovery_job_discovery_details_tags_properties_map())
                        .build())
                    .build())
                .definedTags(Map.of("foo-namespace.bar-key", "value"))
                .discoveryClient(var_.discovery_job_discovery_client())
                .discoveryType(var_.discovery_job_discovery_type())
                .freeformTags(Map.of("bar-key", "value"))
                .shouldPropagateTagsToDiscoveredResources(var_.discovery_job_should_propagate_tags_to_discovered_resources())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_discovery_job = oci.stack_monitoring.DiscoveryJob("testDiscoveryJob",
        compartment_id=var["compartment_id"],
        discovery_details=oci.stack_monitoring.DiscoveryJobDiscoveryDetailsArgs(
            agent_id=var["management_agent_id"],
            properties=oci.stack_monitoring.DiscoveryJobDiscoveryDetailsPropertiesArgs(
                properties_map=var["discovery_job_discovery_details_properties_properties_map"],
            ),
            resource_name=var["discovery_job_discovery_details_resource_name"],
            resource_type=var["discovery_job_discovery_details_resource_type"],
            credentials=oci.stack_monitoring.DiscoveryJobDiscoveryDetailsCredentialsArgs(
                items=[oci.stack_monitoring.DiscoveryJobDiscoveryDetailsCredentialsItemArgs(
                    credential_name=var["discovery_job_discovery_details_credentials_items_credential_name"],
                    credential_type=var["discovery_job_discovery_details_credentials_items_credential_type"],
                    properties=oci.stack_monitoring.DiscoveryJobDiscoveryDetailsCredentialsItemPropertiesArgs(
                        properties_map=var["discovery_job_discovery_details_credentials_items_properties_properties_map"],
                    ),
                )],
            ),
            license=var["discovery_job_discovery_details_license"],
            tags=oci.stack_monitoring.DiscoveryJobDiscoveryDetailsTagsArgs(
                properties_map=var["discovery_job_discovery_details_tags_properties_map"],
            ),
        ),
        defined_tags={
            "foo-namespace.bar-key": "value",
        },
        discovery_client=var["discovery_job_discovery_client"],
        discovery_type=var["discovery_job_discovery_type"],
        freeform_tags={
            "bar-key": "value",
        },
        should_propagate_tags_to_discovered_resources=var["discovery_job_should_propagate_tags_to_discovered_resources"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDiscoveryJob = new oci.stackmonitoring.DiscoveryJob("testDiscoveryJob", {
        compartmentId: _var.compartment_id,
        discoveryDetails: {
            agentId: _var.management_agent_id,
            properties: {
                propertiesMap: _var.discovery_job_discovery_details_properties_properties_map,
            },
            resourceName: _var.discovery_job_discovery_details_resource_name,
            resourceType: _var.discovery_job_discovery_details_resource_type,
            credentials: {
                items: [{
                    credentialName: _var.discovery_job_discovery_details_credentials_items_credential_name,
                    credentialType: _var.discovery_job_discovery_details_credentials_items_credential_type,
                    properties: {
                        propertiesMap: _var.discovery_job_discovery_details_credentials_items_properties_properties_map,
                    },
                }],
            },
            license: _var.discovery_job_discovery_details_license,
            tags: {
                propertiesMap: _var.discovery_job_discovery_details_tags_properties_map,
            },
        },
        definedTags: {
            "foo-namespace.bar-key": "value",
        },
        discoveryClient: _var.discovery_job_discovery_client,
        discoveryType: _var.discovery_job_discovery_type,
        freeformTags: {
            "bar-key": "value",
        },
        shouldPropagateTagsToDiscoveredResources: _var.discovery_job_should_propagate_tags_to_discovered_resources,
    });
    
    resources:
      testDiscoveryJob:
        type: oci:StackMonitoring:DiscoveryJob
        properties:
          #Required
          compartmentId: ${var.compartment_id}
          discoveryDetails:
            agentId: ${var.management_agent_id}
            properties:
              propertiesMap: ${var.discovery_job_discovery_details_properties_properties_map}
            resourceName: ${var.discovery_job_discovery_details_resource_name}
            resourceType: ${var.discovery_job_discovery_details_resource_type}
            credentials:
              items:
                - credentialName: ${var.discovery_job_discovery_details_credentials_items_credential_name}
                  credentialType: ${var.discovery_job_discovery_details_credentials_items_credential_type}
                  properties:
                    propertiesMap: ${var.discovery_job_discovery_details_credentials_items_properties_properties_map}
            license: ${var.discovery_job_discovery_details_license}
            tags:
              propertiesMap: ${var.discovery_job_discovery_details_tags_properties_map}
          #Optional
          definedTags:
            foo-namespace.bar-key: value
          discoveryClient: ${var.discovery_job_discovery_client}
          discoveryType: ${var.discovery_job_discovery_type}
          freeformTags:
            bar-key: value
          shouldPropagateTagsToDiscoveredResources: ${var.discovery_job_should_propagate_tags_to_discovered_resources}
    

    Create DiscoveryJob Resource

    new DiscoveryJob(name: string, args: DiscoveryJobArgs, opts?: CustomResourceOptions);
    @overload
    def DiscoveryJob(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     compartment_id: Optional[str] = None,
                     defined_tags: Optional[Mapping[str, Any]] = None,
                     discovery_client: Optional[str] = None,
                     discovery_details: Optional[_stackmonitoring.DiscoveryJobDiscoveryDetailsArgs] = None,
                     discovery_type: Optional[str] = None,
                     freeform_tags: Optional[Mapping[str, Any]] = None,
                     should_propagate_tags_to_discovered_resources: Optional[bool] = None)
    @overload
    def DiscoveryJob(resource_name: str,
                     args: DiscoveryJobArgs,
                     opts: Optional[ResourceOptions] = None)
    func NewDiscoveryJob(ctx *Context, name string, args DiscoveryJobArgs, opts ...ResourceOption) (*DiscoveryJob, error)
    public DiscoveryJob(string name, DiscoveryJobArgs args, CustomResourceOptions? opts = null)
    public DiscoveryJob(String name, DiscoveryJobArgs args)
    public DiscoveryJob(String name, DiscoveryJobArgs args, CustomResourceOptions options)
    
    type: oci:StackMonitoring:DiscoveryJob
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DiscoveryJobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DiscoveryJobArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DiscoveryJobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DiscoveryJobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DiscoveryJobArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DiscoveryJob Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DiscoveryJob resource accepts the following input properties:

    CompartmentId string

    The OCID of Compartment

    DiscoveryDetails DiscoveryJobDiscoveryDetails

    The request of DiscoveryJob Resource details.

    DefinedTags Dictionary<string, object>

    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    DiscoveryClient string

    Client who submits discovery job.

    DiscoveryType string

    Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

    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"}

    ShouldPropagateTagsToDiscoveredResources bool

    If this parameter set to true, the specified tags will be applied to all resources discovered in the current request. Default is true.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string

    The OCID of Compartment

    DiscoveryDetails DiscoveryJobDiscoveryDetailsArgs

    The request of DiscoveryJob Resource details.

    DefinedTags map[string]interface{}

    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    DiscoveryClient string

    Client who submits discovery job.

    DiscoveryType string

    Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

    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"}

    ShouldPropagateTagsToDiscoveredResources bool

    If this parameter set to true, the specified tags will be applied to all resources discovered in the current request. Default is true.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String

    The OCID of Compartment

    discoveryDetails DiscoveryJobDiscoveryDetails

    The request of DiscoveryJob Resource details.

    definedTags Map<String,Object>

    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    discoveryClient String

    Client who submits discovery job.

    discoveryType String

    Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

    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"}

    shouldPropagateTagsToDiscoveredResources Boolean

    If this parameter set to true, the specified tags will be applied to all resources discovered in the current request. Default is true.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string

    The OCID of Compartment

    discoveryDetails DiscoveryJobDiscoveryDetails

    The request of DiscoveryJob Resource details.

    definedTags {[key: string]: any}

    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    discoveryClient string

    Client who submits discovery job.

    discoveryType string

    Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

    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"}

    shouldPropagateTagsToDiscoveredResources boolean

    If this parameter set to true, the specified tags will be applied to all resources discovered in the current request. Default is true.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str

    The OCID of Compartment

    discovery_details DiscoveryJobDiscoveryDetailsArgs

    The request of DiscoveryJob Resource details.

    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"}

    discovery_client str

    Client who submits discovery job.

    discovery_type str

    Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

    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"}

    should_propagate_tags_to_discovered_resources bool

    If this parameter set to true, the specified tags will be applied to all resources discovered in the current request. Default is true.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String

    The OCID of Compartment

    discoveryDetails Property Map

    The request of DiscoveryJob Resource details.

    definedTags Map<Any>

    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    discoveryClient String

    Client who submits discovery job.

    discoveryType String

    Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

    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"}

    shouldPropagateTagsToDiscoveredResources Boolean

    If this parameter set to true, the specified tags will be applied to all resources discovered in the current request. Default is true.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DiscoveryJob resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    State string

    The current state of the DiscoveryJob Resource.

    Status string

    Specifies the status of the discovery job

    StatusMessage string

    The short summary of the status of the discovery job

    SystemTags Dictionary<string, object>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    TenantId string

    The OCID of Tenant

    TimeUpdated string

    The time the discovery Job was updated.

    UserId string

    The OCID of user in which the job is submitted

    Id string

    The provider-assigned unique ID for this managed resource.

    State string

    The current state of the DiscoveryJob Resource.

    Status string

    Specifies the status of the discovery job

    StatusMessage string

    The short summary of the status of the discovery job

    SystemTags map[string]interface{}

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    TenantId string

    The OCID of Tenant

    TimeUpdated string

    The time the discovery Job was updated.

    UserId string

    The OCID of user in which the job is submitted

    id String

    The provider-assigned unique ID for this managed resource.

    state String

    The current state of the DiscoveryJob Resource.

    status String

    Specifies the status of the discovery job

    statusMessage String

    The short summary of the status of the discovery job

    systemTags Map<String,Object>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    tenantId String

    The OCID of Tenant

    timeUpdated String

    The time the discovery Job was updated.

    userId String

    The OCID of user in which the job is submitted

    id string

    The provider-assigned unique ID for this managed resource.

    state string

    The current state of the DiscoveryJob Resource.

    status string

    Specifies the status of the discovery job

    statusMessage string

    The short summary of the status of the discovery job

    systemTags {[key: string]: any}

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    tenantId string

    The OCID of Tenant

    timeUpdated string

    The time the discovery Job was updated.

    userId string

    The OCID of user in which the job is submitted

    id str

    The provider-assigned unique ID for this managed resource.

    state str

    The current state of the DiscoveryJob Resource.

    status str

    Specifies the status of the discovery job

    status_message str

    The short summary of the status of the discovery job

    system_tags Mapping[str, Any]

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    tenant_id str

    The OCID of Tenant

    time_updated str

    The time the discovery Job was updated.

    user_id str

    The OCID of user in which the job is submitted

    id String

    The provider-assigned unique ID for this managed resource.

    state String

    The current state of the DiscoveryJob Resource.

    status String

    Specifies the status of the discovery job

    statusMessage String

    The short summary of the status of the discovery job

    systemTags Map<Any>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    tenantId String

    The OCID of Tenant

    timeUpdated String

    The time the discovery Job was updated.

    userId String

    The OCID of user in which the job is submitted

    Look up Existing DiscoveryJob Resource

    Get an existing DiscoveryJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DiscoveryJobState, opts?: CustomResourceOptions): DiscoveryJob
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            discovery_client: Optional[str] = None,
            discovery_details: Optional[_stackmonitoring.DiscoveryJobDiscoveryDetailsArgs] = None,
            discovery_type: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            should_propagate_tags_to_discovered_resources: Optional[bool] = None,
            state: Optional[str] = None,
            status: Optional[str] = None,
            status_message: Optional[str] = None,
            system_tags: Optional[Mapping[str, Any]] = None,
            tenant_id: Optional[str] = None,
            time_updated: Optional[str] = None,
            user_id: Optional[str] = None) -> DiscoveryJob
    func GetDiscoveryJob(ctx *Context, name string, id IDInput, state *DiscoveryJobState, opts ...ResourceOption) (*DiscoveryJob, error)
    public static DiscoveryJob Get(string name, Input<string> id, DiscoveryJobState? state, CustomResourceOptions? opts = null)
    public static DiscoveryJob get(String name, Output<String> id, DiscoveryJobState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string

    The OCID of 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"}

    DiscoveryClient string

    Client who submits discovery job.

    DiscoveryDetails DiscoveryJobDiscoveryDetails

    The request of DiscoveryJob Resource details.

    DiscoveryType string

    Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

    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"}

    ShouldPropagateTagsToDiscoveredResources bool

    If this parameter set to true, the specified tags will be applied to all resources discovered in the current request. Default is true.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    State string

    The current state of the DiscoveryJob Resource.

    Status string

    Specifies the status of the discovery job

    StatusMessage string

    The short summary of the status of the discovery job

    SystemTags Dictionary<string, object>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    TenantId string

    The OCID of Tenant

    TimeUpdated string

    The time the discovery Job was updated.

    UserId string

    The OCID of user in which the job is submitted

    CompartmentId string

    The OCID of 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"}

    DiscoveryClient string

    Client who submits discovery job.

    DiscoveryDetails DiscoveryJobDiscoveryDetailsArgs

    The request of DiscoveryJob Resource details.

    DiscoveryType string

    Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

    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"}

    ShouldPropagateTagsToDiscoveredResources bool

    If this parameter set to true, the specified tags will be applied to all resources discovered in the current request. Default is true.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    State string

    The current state of the DiscoveryJob Resource.

    Status string

    Specifies the status of the discovery job

    StatusMessage string

    The short summary of the status of the discovery job

    SystemTags map[string]interface{}

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    TenantId string

    The OCID of Tenant

    TimeUpdated string

    The time the discovery Job was updated.

    UserId string

    The OCID of user in which the job is submitted

    compartmentId String

    The OCID of 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"}

    discoveryClient String

    Client who submits discovery job.

    discoveryDetails DiscoveryJobDiscoveryDetails

    The request of DiscoveryJob Resource details.

    discoveryType String

    Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

    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"}

    shouldPropagateTagsToDiscoveredResources Boolean

    If this parameter set to true, the specified tags will be applied to all resources discovered in the current request. Default is true.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state String

    The current state of the DiscoveryJob Resource.

    status String

    Specifies the status of the discovery job

    statusMessage String

    The short summary of the status of the discovery job

    systemTags Map<String,Object>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    tenantId String

    The OCID of Tenant

    timeUpdated String

    The time the discovery Job was updated.

    userId String

    The OCID of user in which the job is submitted

    compartmentId string

    The OCID of 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"}

    discoveryClient string

    Client who submits discovery job.

    discoveryDetails DiscoveryJobDiscoveryDetails

    The request of DiscoveryJob Resource details.

    discoveryType string

    Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

    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"}

    shouldPropagateTagsToDiscoveredResources boolean

    If this parameter set to true, the specified tags will be applied to all resources discovered in the current request. Default is true.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state string

    The current state of the DiscoveryJob Resource.

    status string

    Specifies the status of the discovery job

    statusMessage string

    The short summary of the status of the discovery job

    systemTags {[key: string]: any}

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    tenantId string

    The OCID of Tenant

    timeUpdated string

    The time the discovery Job was updated.

    userId string

    The OCID of user in which the job is submitted

    compartment_id str

    The OCID of 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"}

    discovery_client str

    Client who submits discovery job.

    discovery_details DiscoveryJobDiscoveryDetailsArgs

    The request of DiscoveryJob Resource details.

    discovery_type str

    Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

    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"}

    should_propagate_tags_to_discovered_resources bool

    If this parameter set to true, the specified tags will be applied to all resources discovered in the current request. Default is true.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state str

    The current state of the DiscoveryJob Resource.

    status str

    Specifies the status of the discovery job

    status_message str

    The short summary of the status of the discovery job

    system_tags Mapping[str, Any]

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    tenant_id str

    The OCID of Tenant

    time_updated str

    The time the discovery Job was updated.

    user_id str

    The OCID of user in which the job is submitted

    compartmentId String

    The OCID of Compartment

    definedTags Map<Any>

    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

    discoveryClient String

    Client who submits discovery job.

    discoveryDetails Property Map

    The request of DiscoveryJob Resource details.

    discoveryType String

    Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

    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"}

    shouldPropagateTagsToDiscoveredResources Boolean

    If this parameter set to true, the specified tags will be applied to all resources discovered in the current request. Default is true.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    state String

    The current state of the DiscoveryJob Resource.

    status String

    Specifies the status of the discovery job

    statusMessage String

    The short summary of the status of the discovery job

    systemTags Map<Any>

    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}

    tenantId String

    The OCID of Tenant

    timeUpdated String

    The time the discovery Job was updated.

    userId String

    The OCID of user in which the job is submitted

    Supporting Types

    DiscoveryJobDiscoveryDetails, DiscoveryJobDiscoveryDetailsArgs

    AgentId string

    The OCID of Management Agent

    Properties DiscoveryJobDiscoveryDetailsProperties

    Property Details

    ResourceName string

    The Name of resource type

    ResourceType string

    Resource Type.

    Credentials DiscoveryJobDiscoveryDetailsCredentials

    List of DiscoveryJob Credential Details.

    License string

    License edition of the monitored resource.

    Tags DiscoveryJobDiscoveryDetailsTags

    Property Details

    AgentId string

    The OCID of Management Agent

    Properties DiscoveryJobDiscoveryDetailsProperties

    Property Details

    ResourceName string

    The Name of resource type

    ResourceType string

    Resource Type.

    Credentials DiscoveryJobDiscoveryDetailsCredentials

    List of DiscoveryJob Credential Details.

    License string

    License edition of the monitored resource.

    Tags DiscoveryJobDiscoveryDetailsTags

    Property Details

    agentId String

    The OCID of Management Agent

    properties DiscoveryJobDiscoveryDetailsProperties

    Property Details

    resourceName String

    The Name of resource type

    resourceType String

    Resource Type.

    credentials DiscoveryJobDiscoveryDetailsCredentials

    List of DiscoveryJob Credential Details.

    license String

    License edition of the monitored resource.

    tags DiscoveryJobDiscoveryDetailsTags

    Property Details

    agentId string

    The OCID of Management Agent

    properties DiscoveryJobDiscoveryDetailsProperties

    Property Details

    resourceName string

    The Name of resource type

    resourceType string

    Resource Type.

    credentials DiscoveryJobDiscoveryDetailsCredentials

    List of DiscoveryJob Credential Details.

    license string

    License edition of the monitored resource.

    tags DiscoveryJobDiscoveryDetailsTags

    Property Details

    agent_id str

    The OCID of Management Agent

    properties DiscoveryJobDiscoveryDetailsProperties

    Property Details

    resource_name str

    The Name of resource type

    resource_type str

    Resource Type.

    credentials DiscoveryJobDiscoveryDetailsCredentials

    List of DiscoveryJob Credential Details.

    license str

    License edition of the monitored resource.

    tags DiscoveryJobDiscoveryDetailsTags

    Property Details

    agentId String

    The OCID of Management Agent

    properties Property Map

    Property Details

    resourceName String

    The Name of resource type

    resourceType String

    Resource Type.

    credentials Property Map

    List of DiscoveryJob Credential Details.

    license String

    License edition of the monitored resource.

    tags Property Map

    Property Details

    DiscoveryJobDiscoveryDetailsCredentials, DiscoveryJobDiscoveryDetailsCredentialsArgs

    Items []DiscoveryJobDiscoveryDetailsCredentialsItem

    List of DiscoveryJob credentials.

    items DiscoveryJobDiscoveryDetailsCredentialsItem[]

    List of DiscoveryJob credentials.

    items DiscoveryJobDiscoveryDetailsCredentialsItem]

    List of DiscoveryJob credentials.

    items List<Property Map>

    List of DiscoveryJob credentials.

    DiscoveryJobDiscoveryDetailsCredentialsItem, DiscoveryJobDiscoveryDetailsCredentialsItemArgs

    CredentialName string

    Name of Credential

    CredentialType string

    Name of Credential Type

    Properties DiscoveryJobDiscoveryDetailsCredentialsItemProperties

    Property Details

    CredentialName string

    Name of Credential

    CredentialType string

    Name of Credential Type

    Properties DiscoveryJobDiscoveryDetailsCredentialsItemProperties

    Property Details

    credentialName String

    Name of Credential

    credentialType String

    Name of Credential Type

    properties DiscoveryJobDiscoveryDetailsCredentialsItemProperties

    Property Details

    credentialName string

    Name of Credential

    credentialType string

    Name of Credential Type

    properties DiscoveryJobDiscoveryDetailsCredentialsItemProperties

    Property Details

    credential_name str

    Name of Credential

    credential_type str

    Name of Credential Type

    properties DiscoveryJobDiscoveryDetailsCredentialsItemProperties

    Property Details

    credentialName String

    Name of Credential

    credentialType String

    Name of Credential Type

    properties Property Map

    Property Details

    DiscoveryJobDiscoveryDetailsCredentialsItemProperties, DiscoveryJobDiscoveryDetailsCredentialsItemPropertiesArgs

    PropertiesMap Dictionary<string, object>

    Key/Value pair of Property

    PropertiesMap map[string]interface{}

    Key/Value pair of Property

    propertiesMap Map<String,Object>

    Key/Value pair of Property

    propertiesMap {[key: string]: any}

    Key/Value pair of Property

    properties_map Mapping[str, Any]

    Key/Value pair of Property

    propertiesMap Map<Any>

    Key/Value pair of Property

    DiscoveryJobDiscoveryDetailsProperties, DiscoveryJobDiscoveryDetailsPropertiesArgs

    PropertiesMap Dictionary<string, object>

    Key/Value pair of Property

    PropertiesMap map[string]interface{}

    Key/Value pair of Property

    propertiesMap Map<String,Object>

    Key/Value pair of Property

    propertiesMap {[key: string]: any}

    Key/Value pair of Property

    properties_map Mapping[str, Any]

    Key/Value pair of Property

    propertiesMap Map<Any>

    Key/Value pair of Property

    DiscoveryJobDiscoveryDetailsTags, DiscoveryJobDiscoveryDetailsTagsArgs

    PropertiesMap Dictionary<string, object>

    Key/Value pair of Property

    PropertiesMap map[string]interface{}

    Key/Value pair of Property

    propertiesMap Map<String,Object>

    Key/Value pair of Property

    propertiesMap {[key: string]: any}

    Key/Value pair of Property

    properties_map Mapping[str, Any]

    Key/Value pair of Property

    propertiesMap Map<Any>

    Key/Value pair of Property

    Import

    DiscoveryJobs can be imported using the id, e.g.

     $ pulumi import oci:StackMonitoring/discoveryJob:DiscoveryJob test_discovery_job "id"
    

    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 v1.16.0 published on Thursday, Nov 2, 2023 by Pulumi