Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. StackMonitoring
  5. DiscoveryJob
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.StackMonitoring.DiscoveryJob

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    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

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

const testDiscoveryJob = new oci.stackmonitoring.DiscoveryJob("test_discovery_job", {
    compartmentId: compartmentId,
    discoveryDetails: {
        agentId: managementAgentId,
        properties: {
            propertiesMap: discoveryJobDiscoveryDetailsPropertiesPropertiesMap,
        },
        resourceName: discoveryJobDiscoveryDetailsResourceName,
        resourceType: discoveryJobDiscoveryDetailsResourceType,
        credentials: {
            items: [{
                credentialName: discoveryJobDiscoveryDetailsCredentialsItemsCredentialName,
                credentialType: discoveryJobDiscoveryDetailsCredentialsItemsCredentialType,
                properties: {
                    propertiesMap: discoveryJobDiscoveryDetailsCredentialsItemsPropertiesPropertiesMap,
                },
            }],
        },
        license: discoveryJobDiscoveryDetailsLicense,
        tags: {
            propertiesMap: discoveryJobDiscoveryDetailsTagsPropertiesMap,
        },
    },
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    discoveryClient: discoveryJobDiscoveryClient,
    discoveryType: discoveryJobDiscoveryType,
    freeformTags: {
        "bar-key": "value",
    },
    shouldPropagateTagsToDiscoveredResources: discoveryJobShouldPropagateTagsToDiscoveredResources,
});

    import pulumi
import pulumi_oci as oci

test_discovery_job = oci.stack_monitoring.DiscoveryJob("test_discovery_job",
    compartment_id=compartment_id,
    discovery_details={
        "agent_id": management_agent_id,
        "properties": {
            "properties_map": discovery_job_discovery_details_properties_properties_map,
        },
        "resource_name": discovery_job_discovery_details_resource_name,
        "resource_type": discovery_job_discovery_details_resource_type,
        "credentials": {
            "items": [{
                "credential_name": discovery_job_discovery_details_credentials_items_credential_name,
                "credential_type": discovery_job_discovery_details_credentials_items_credential_type,
                "properties": {
                    "properties_map": discovery_job_discovery_details_credentials_items_properties_properties_map,
                },
            }],
        },
        "license": discovery_job_discovery_details_license,
        "tags": {
            "properties_map": discovery_job_discovery_details_tags_properties_map,
        },
    },
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    discovery_client=discovery_job_discovery_client,
    discovery_type=discovery_job_discovery_type,
    freeform_tags={
        "bar-key": "value",
    },
    should_propagate_tags_to_discovered_resources=discovery_job_should_propagate_tags_to_discovered_resources)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := StackMonitoring.NewDiscoveryJob(ctx, "test_discovery_job", &StackMonitoring.DiscoveryJobArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DiscoveryDetails: &stackmonitoring.DiscoveryJobDiscoveryDetailsArgs{
				AgentId: pulumi.Any(managementAgentId),
				Properties: &stackmonitoring.DiscoveryJobDiscoveryDetailsPropertiesArgs{
					PropertiesMap: pulumi.Any(discoveryJobDiscoveryDetailsPropertiesPropertiesMap),
				},
				ResourceName: pulumi.Any(discoveryJobDiscoveryDetailsResourceName),
				ResourceType: pulumi.Any(discoveryJobDiscoveryDetailsResourceType),
				Credentials: &stackmonitoring.DiscoveryJobDiscoveryDetailsCredentialsArgs{
					Items: stackmonitoring.DiscoveryJobDiscoveryDetailsCredentialsItemArray{
						&stackmonitoring.DiscoveryJobDiscoveryDetailsCredentialsItemArgs{
							CredentialName: pulumi.Any(discoveryJobDiscoveryDetailsCredentialsItemsCredentialName),
							CredentialType: pulumi.Any(discoveryJobDiscoveryDetailsCredentialsItemsCredentialType),
							Properties: &stackmonitoring.DiscoveryJobDiscoveryDetailsCredentialsItemPropertiesArgs{
								PropertiesMap: pulumi.Any(discoveryJobDiscoveryDetailsCredentialsItemsPropertiesPropertiesMap),
							},
						},
					},
				},
				License: pulumi.Any(discoveryJobDiscoveryDetailsLicense),
				Tags: &stackmonitoring.DiscoveryJobDiscoveryDetailsTagsArgs{
					PropertiesMap: pulumi.Any(discoveryJobDiscoveryDetailsTagsPropertiesMap),
				},
			},
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			DiscoveryClient: pulumi.Any(discoveryJobDiscoveryClient),
			DiscoveryType:   pulumi.Any(discoveryJobDiscoveryType),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			ShouldPropagateTagsToDiscoveredResources: pulumi.Any(discoveryJobShouldPropagateTagsToDiscoveredResources),
		})
		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 testDiscoveryJob = new Oci.StackMonitoring.DiscoveryJob("test_discovery_job", new()
    {
        CompartmentId = compartmentId,
        DiscoveryDetails = new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsArgs
        {
            AgentId = managementAgentId,
            Properties = new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsPropertiesArgs
            {
                PropertiesMap = discoveryJobDiscoveryDetailsPropertiesPropertiesMap,
            },
            ResourceName = discoveryJobDiscoveryDetailsResourceName,
            ResourceType = discoveryJobDiscoveryDetailsResourceType,
            Credentials = new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsCredentialsArgs
            {
                Items = new[]
                {
                    new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsCredentialsItemArgs
                    {
                        CredentialName = discoveryJobDiscoveryDetailsCredentialsItemsCredentialName,
                        CredentialType = discoveryJobDiscoveryDetailsCredentialsItemsCredentialType,
                        Properties = new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsCredentialsItemPropertiesArgs
                        {
                            PropertiesMap = discoveryJobDiscoveryDetailsCredentialsItemsPropertiesPropertiesMap,
                        },
                    },
                },
            },
            License = discoveryJobDiscoveryDetailsLicense,
            Tags = new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsTagsArgs
            {
                PropertiesMap = discoveryJobDiscoveryDetailsTagsPropertiesMap,
            },
        },
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        DiscoveryClient = discoveryJobDiscoveryClient,
        DiscoveryType = discoveryJobDiscoveryType,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        ShouldPropagateTagsToDiscoveredResources = discoveryJobShouldPropagateTagsToDiscoveredResources,
    });

});

    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(compartmentId)
            .discoveryDetails(DiscoveryJobDiscoveryDetailsArgs.builder()
                .agentId(managementAgentId)
                .properties(DiscoveryJobDiscoveryDetailsPropertiesArgs.builder()
                    .propertiesMap(discoveryJobDiscoveryDetailsPropertiesPropertiesMap)
                    .build())
                .resourceName(discoveryJobDiscoveryDetailsResourceName)
                .resourceType(discoveryJobDiscoveryDetailsResourceType)
                .credentials(DiscoveryJobDiscoveryDetailsCredentialsArgs.builder()
                    .items(DiscoveryJobDiscoveryDetailsCredentialsItemArgs.builder()
                        .credentialName(discoveryJobDiscoveryDetailsCredentialsItemsCredentialName)
                        .credentialType(discoveryJobDiscoveryDetailsCredentialsItemsCredentialType)
                        .properties(DiscoveryJobDiscoveryDetailsCredentialsItemPropertiesArgs.builder()
                            .propertiesMap(discoveryJobDiscoveryDetailsCredentialsItemsPropertiesPropertiesMap)
                            .build())
                        .build())
                    .build())
                .license(discoveryJobDiscoveryDetailsLicense)
                .tags(DiscoveryJobDiscoveryDetailsTagsArgs.builder()
                    .propertiesMap(discoveryJobDiscoveryDetailsTagsPropertiesMap)
                    .build())
                .build())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .discoveryClient(discoveryJobDiscoveryClient)
            .discoveryType(discoveryJobDiscoveryType)
            .freeformTags(Map.of("bar-key", "value"))
            .shouldPropagateTagsToDiscoveredResources(discoveryJobShouldPropagateTagsToDiscoveredResources)
            .build());

    }
}

    resources:
  testDiscoveryJob:
    type: oci:StackMonitoring:DiscoveryJob
    name: test_discovery_job
    properties:
      compartmentId: ${compartmentId}
      discoveryDetails:
        agentId: ${managementAgentId}
        properties:
          propertiesMap: ${discoveryJobDiscoveryDetailsPropertiesPropertiesMap}
        resourceName: ${discoveryJobDiscoveryDetailsResourceName}
        resourceType: ${discoveryJobDiscoveryDetailsResourceType}
        credentials:
          items:
            - credentialName: ${discoveryJobDiscoveryDetailsCredentialsItemsCredentialName}
              credentialType: ${discoveryJobDiscoveryDetailsCredentialsItemsCredentialType}
              properties:
                propertiesMap: ${discoveryJobDiscoveryDetailsCredentialsItemsPropertiesPropertiesMap}
        license: ${discoveryJobDiscoveryDetailsLicense}
        tags:
          propertiesMap: ${discoveryJobDiscoveryDetailsTagsPropertiesMap}
      definedTags:
        foo-namespace.bar-key: value
      discoveryClient: ${discoveryJobDiscoveryClient}
      discoveryType: ${discoveryJobDiscoveryType}
      freeformTags:
        bar-key: value
      shouldPropagateTagsToDiscoveredResources: ${discoveryJobShouldPropagateTagsToDiscoveredResources}

    Create DiscoveryJob Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DiscoveryJob(name: string, args: DiscoveryJobArgs, opts?: CustomResourceOptions);
    @overload
def DiscoveryJob(resource_name: str,
                 args: DiscoveryJobArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def DiscoveryJob(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 compartment_id: Optional[str] = None,
                 discovery_details: Optional[_stackmonitoring.DiscoveryJobDiscoveryDetailsArgs] = None,
                 defined_tags: Optional[Mapping[str, str]] = None,
                 discovery_client: Optional[str] = None,
                 discovery_type: Optional[str] = None,
                 freeform_tags: Optional[Mapping[str, str]] = None,
                 should_propagate_tags_to_discovered_resources: Optional[bool] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var discoveryJobResource = new Oci.StackMonitoring.DiscoveryJob("discoveryJobResource", new()
{
    CompartmentId = "string",
    DiscoveryDetails = new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsArgs
    {
        AgentId = "string",
        Properties = new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsPropertiesArgs
        {
            PropertiesMap = 
            {
                { "string", "string" },
            },
        },
        ResourceName = "string",
        ResourceType = "string",
        Credentials = new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsCredentialsArgs
        {
            Items = new[]
            {
                new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsCredentialsItemArgs
                {
                    CredentialName = "string",
                    CredentialType = "string",
                    Properties = new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsCredentialsItemPropertiesArgs
                    {
                        PropertiesMap = 
                        {
                            { "string", "string" },
                        },
                    },
                },
            },
        },
        License = "string",
        Tags = new Oci.StackMonitoring.Inputs.DiscoveryJobDiscoveryDetailsTagsArgs
        {
            PropertiesMap = 
            {
                { "string", "string" },
            },
        },
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    DiscoveryClient = "string",
    DiscoveryType = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    ShouldPropagateTagsToDiscoveredResources = false,
});

    example, err := StackMonitoring.NewDiscoveryJob(ctx, "discoveryJobResource", &StackMonitoring.DiscoveryJobArgs{
	CompartmentId: pulumi.String("string"),
	DiscoveryDetails: &stackmonitoring.DiscoveryJobDiscoveryDetailsArgs{
		AgentId: pulumi.String("string"),
		Properties: &stackmonitoring.DiscoveryJobDiscoveryDetailsPropertiesArgs{
			PropertiesMap: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
		ResourceName: pulumi.String("string"),
		ResourceType: pulumi.String("string"),
		Credentials: &stackmonitoring.DiscoveryJobDiscoveryDetailsCredentialsArgs{
			Items: stackmonitoring.DiscoveryJobDiscoveryDetailsCredentialsItemArray{
				&stackmonitoring.DiscoveryJobDiscoveryDetailsCredentialsItemArgs{
					CredentialName: pulumi.String("string"),
					CredentialType: pulumi.String("string"),
					Properties: &stackmonitoring.DiscoveryJobDiscoveryDetailsCredentialsItemPropertiesArgs{
						PropertiesMap: pulumi.StringMap{
							"string": pulumi.String("string"),
						},
					},
				},
			},
		},
		License: pulumi.String("string"),
		Tags: &stackmonitoring.DiscoveryJobDiscoveryDetailsTagsArgs{
			PropertiesMap: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DiscoveryClient: pulumi.String("string"),
	DiscoveryType:   pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ShouldPropagateTagsToDiscoveredResources: pulumi.Bool(false),
})

    var discoveryJobResource = new DiscoveryJob("discoveryJobResource", DiscoveryJobArgs.builder()
    .compartmentId("string")
    .discoveryDetails(DiscoveryJobDiscoveryDetailsArgs.builder()
        .agentId("string")
        .properties(DiscoveryJobDiscoveryDetailsPropertiesArgs.builder()
            .propertiesMap(Map.of("string", "string"))
            .build())
        .resourceName("string")
        .resourceType("string")
        .credentials(DiscoveryJobDiscoveryDetailsCredentialsArgs.builder()
            .items(DiscoveryJobDiscoveryDetailsCredentialsItemArgs.builder()
                .credentialName("string")
                .credentialType("string")
                .properties(DiscoveryJobDiscoveryDetailsCredentialsItemPropertiesArgs.builder()
                    .propertiesMap(Map.of("string", "string"))
                    .build())
                .build())
            .build())
        .license("string")
        .tags(DiscoveryJobDiscoveryDetailsTagsArgs.builder()
            .propertiesMap(Map.of("string", "string"))
            .build())
        .build())
    .definedTags(Map.of("string", "string"))
    .discoveryClient("string")
    .discoveryType("string")
    .freeformTags(Map.of("string", "string"))
    .shouldPropagateTagsToDiscoveredResources(false)
    .build());

    discovery_job_resource = oci.stack_monitoring.DiscoveryJob("discoveryJobResource",
    compartment_id="string",
    discovery_details={
        "agent_id": "string",
        "properties": {
            "properties_map": {
                "string": "string",
            },
        },
        "resource_name": "string",
        "resource_type": "string",
        "credentials": {
            "items": [{
                "credential_name": "string",
                "credential_type": "string",
                "properties": {
                    "properties_map": {
                        "string": "string",
                    },
                },
            }],
        },
        "license": "string",
        "tags": {
            "properties_map": {
                "string": "string",
            },
        },
    },
    defined_tags={
        "string": "string",
    },
    discovery_client="string",
    discovery_type="string",
    freeform_tags={
        "string": "string",
    },
    should_propagate_tags_to_discovered_resources=False)

    const discoveryJobResource = new oci.stackmonitoring.DiscoveryJob("discoveryJobResource", {
    compartmentId: "string",
    discoveryDetails: {
        agentId: "string",
        properties: {
            propertiesMap: {
                string: "string",
            },
        },
        resourceName: "string",
        resourceType: "string",
        credentials: {
            items: [{
                credentialName: "string",
                credentialType: "string",
                properties: {
                    propertiesMap: {
                        string: "string",
                    },
                },
            }],
        },
        license: "string",
        tags: {
            propertiesMap: {
                string: "string",
            },
        },
    },
    definedTags: {
        string: "string",
    },
    discoveryClient: "string",
    discoveryType: "string",
    freeformTags: {
        string: "string",
    },
    shouldPropagateTagsToDiscoveredResources: false,
});

    type: oci:StackMonitoring:DiscoveryJob
properties:
    compartmentId: string
    definedTags:
        string: string
    discoveryClient: string
    discoveryDetails:
        agentId: string
        credentials:
            items:
                - credentialName: string
                  credentialType: string
                  properties:
                    propertiesMap:
                        string: string
        license: string
        properties:
            propertiesMap:
                string: string
        resourceName: string
        resourceType: string
        tags:
            propertiesMap:
                string: string
    discoveryType: string
    freeformTags:
        string: string
    shouldPropagateTagsToDiscoveredResources: false

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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, string>
    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, string>
    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]string
    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]string
    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,String>
    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,String>
    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]: string}
    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]: string}
    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 stackmonitoring.DiscoveryJobDiscoveryDetailsArgs
    The request of DiscoveryJob Resource details.
    defined_tags Mapping[str, str]
    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, str]
    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<String>
    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>
    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, string>
    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]string
    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,String>
    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]: string}
    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, str]
    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<String>
    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, str]] = None,
        discovery_client: Optional[str] = None,
        discovery_details: Optional[_stackmonitoring.DiscoveryJobDiscoveryDetailsArgs] = None,
        discovery_type: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = 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, str]] = 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, string>
    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, string>
    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, string>
    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]string
    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]string
    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]string
    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,String>
    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,String>
    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,String>
    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]: string}
    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]: string}
    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]: string}
    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, str]
    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 stackmonitoring.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, str]
    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, str]
    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<String>
    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<String>
    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>
    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 stackmonitoring.DiscoveryJobDiscoveryDetailsProperties
    Property Details
    resource_name str
    The Name of resource type
    resource_type str
    Resource Type.
    credentials stackmonitoring.DiscoveryJobDiscoveryDetailsCredentials
    List of DiscoveryJob Credential Details.
    license str
    License edition of the monitored resource.
    tags stackmonitoring.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 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
    credentialName String
    Name of Credential
    credentialType String
    Name of Credential Type
    properties Property Map
    Property Details

    DiscoveryJobDiscoveryDetailsCredentialsItemProperties, DiscoveryJobDiscoveryDetailsCredentialsItemPropertiesArgs

    PropertiesMap Dictionary<string, string>
    Key/Value pair of Property
    PropertiesMap map[string]string
    Key/Value pair of Property
    propertiesMap Map<String,String>
    Key/Value pair of Property
    propertiesMap {[key: string]: string}
    Key/Value pair of Property
    properties_map Mapping[str, str]
    Key/Value pair of Property
    propertiesMap Map<String>
    Key/Value pair of Property

    DiscoveryJobDiscoveryDetailsProperties, DiscoveryJobDiscoveryDetailsPropertiesArgs

    PropertiesMap Dictionary<string, string>
    Key/Value pair of Property
    PropertiesMap map[string]string
    Key/Value pair of Property
    propertiesMap Map<String,String>
    Key/Value pair of Property
    propertiesMap {[key: string]: string}
    Key/Value pair of Property
    properties_map Mapping[str, str]
    Key/Value pair of Property
    propertiesMap Map<String>
    Key/Value pair of Property

    DiscoveryJobDiscoveryDetailsTags, DiscoveryJobDiscoveryDetailsTagsArgs

    PropertiesMap Dictionary<string, string>
    Key/Value pair of Property
    PropertiesMap map[string]string
    Key/Value pair of Property
    propertiesMap Map<String,String>
    Key/Value pair of Property
    propertiesMap {[key: string]: string}
    Key/Value pair of Property
    properties_map Mapping[str, str]
    Key/Value pair of Property
    propertiesMap Map<String>
    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"

    To learn more about importing existing cloud resources, see Importing resources.

    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.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci