1. Packages
  2. stackit
  3. API Docs
  4. getObservabilityScrapeconfig
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

stackit.getObservabilityScrapeconfig

stackit logo
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

    Observability scrape config data source schema. Must have a region specified in the provider configuration.

    Example Usage

    data "stackit_observability_scrapeconfig" "example" {
  project_id  = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  instance_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  name        = "example"
}

    Using getObservabilityScrapeconfig

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getObservabilityScrapeconfig(args: GetObservabilityScrapeconfigArgs, opts?: InvokeOptions): Promise<GetObservabilityScrapeconfigResult>
function getObservabilityScrapeconfigOutput(args: GetObservabilityScrapeconfigOutputArgs, opts?: InvokeOptions): Output<GetObservabilityScrapeconfigResult>
    def get_observability_scrapeconfig(instance_id: Optional[str] = None,
                                   name: Optional[str] = None,
                                   project_id: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetObservabilityScrapeconfigResult
def get_observability_scrapeconfig_output(instance_id: Optional[pulumi.Input[str]] = None,
                                   name: Optional[pulumi.Input[str]] = None,
                                   project_id: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetObservabilityScrapeconfigResult]
    func LookupObservabilityScrapeconfig(ctx *Context, args *LookupObservabilityScrapeconfigArgs, opts ...InvokeOption) (*LookupObservabilityScrapeconfigResult, error)
func LookupObservabilityScrapeconfigOutput(ctx *Context, args *LookupObservabilityScrapeconfigOutputArgs, opts ...InvokeOption) LookupObservabilityScrapeconfigResultOutput

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

    public static class GetObservabilityScrapeconfig 
{
    public static Task<GetObservabilityScrapeconfigResult> InvokeAsync(GetObservabilityScrapeconfigArgs args, InvokeOptions? opts = null)
    public static Output<GetObservabilityScrapeconfigResult> Invoke(GetObservabilityScrapeconfigInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetObservabilityScrapeconfigResult> getObservabilityScrapeconfig(GetObservabilityScrapeconfigArgs args, InvokeOptions options)
public static Output<GetObservabilityScrapeconfigResult> getObservabilityScrapeconfig(GetObservabilityScrapeconfigArgs args, InvokeOptions options)

    fn::invoke:
  function: stackit:index/getObservabilityScrapeconfig:getObservabilityScrapeconfig
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    Observability instance ID to which the scraping job is associated.
    Name string
    Specifies the name of the scraping job
    ProjectId string
    STACKIT project ID to which the scraping job is associated.
    InstanceId string
    Observability instance ID to which the scraping job is associated.
    Name string
    Specifies the name of the scraping job
    ProjectId string
    STACKIT project ID to which the scraping job is associated.
    instanceId String
    Observability instance ID to which the scraping job is associated.
    name String
    Specifies the name of the scraping job
    projectId String
    STACKIT project ID to which the scraping job is associated.
    instanceId string
    Observability instance ID to which the scraping job is associated.
    name string
    Specifies the name of the scraping job
    projectId string
    STACKIT project ID to which the scraping job is associated.
    instance_id str
    Observability instance ID to which the scraping job is associated.
    name str
    Specifies the name of the scraping job
    project_id str
    STACKIT project ID to which the scraping job is associated.
    instanceId String
    Observability instance ID to which the scraping job is associated.
    name String
    Specifies the name of the scraping job
    projectId String
    STACKIT project ID to which the scraping job is associated.

    getObservabilityScrapeconfig Result

    The following output properties are available:

    BasicAuth GetObservabilityScrapeconfigBasicAuth
    A basic authentication block.
    Id string
    InstanceId string
    Observability instance ID to which the scraping job is associated.
    MetricsPath string
    Specifies the job scraping url path.
    Name string
    Specifies the name of the scraping job
    ProjectId string
    STACKIT project ID to which the scraping job is associated.
    Saml2 GetObservabilityScrapeconfigSaml2
    A SAML2 configuration block.
    SampleLimit int
    Specifies the scrape sample limit.
    Scheme string
    Specifies the http scheme.
    ScrapeInterval string
    Specifies the scrape interval as duration string.
    ScrapeTimeout string
    Specifies the scrape timeout as duration string.
    Targets List<GetObservabilityScrapeconfigTarget>
    The targets list (specified by the static config).
    BasicAuth GetObservabilityScrapeconfigBasicAuth
    A basic authentication block.
    Id string
    InstanceId string
    Observability instance ID to which the scraping job is associated.
    MetricsPath string
    Specifies the job scraping url path.
    Name string
    Specifies the name of the scraping job
    ProjectId string
    STACKIT project ID to which the scraping job is associated.
    Saml2 GetObservabilityScrapeconfigSaml2
    A SAML2 configuration block.
    SampleLimit int
    Specifies the scrape sample limit.
    Scheme string
    Specifies the http scheme.
    ScrapeInterval string
    Specifies the scrape interval as duration string.
    ScrapeTimeout string
    Specifies the scrape timeout as duration string.
    Targets []GetObservabilityScrapeconfigTarget
    The targets list (specified by the static config).
    basicAuth GetObservabilityScrapeconfigBasicAuth
    A basic authentication block.
    id String
    instanceId String
    Observability instance ID to which the scraping job is associated.
    metricsPath String
    Specifies the job scraping url path.
    name String
    Specifies the name of the scraping job
    projectId String
    STACKIT project ID to which the scraping job is associated.
    saml2 GetObservabilityScrapeconfigSaml2
    A SAML2 configuration block.
    sampleLimit Integer
    Specifies the scrape sample limit.
    scheme String
    Specifies the http scheme.
    scrapeInterval String
    Specifies the scrape interval as duration string.
    scrapeTimeout String
    Specifies the scrape timeout as duration string.
    targets List<GetObservabilityScrapeconfigTarget>
    The targets list (specified by the static config).
    basicAuth GetObservabilityScrapeconfigBasicAuth
    A basic authentication block.
    id string
    instanceId string
    Observability instance ID to which the scraping job is associated.
    metricsPath string
    Specifies the job scraping url path.
    name string
    Specifies the name of the scraping job
    projectId string
    STACKIT project ID to which the scraping job is associated.
    saml2 GetObservabilityScrapeconfigSaml2
    A SAML2 configuration block.
    sampleLimit number
    Specifies the scrape sample limit.
    scheme string
    Specifies the http scheme.
    scrapeInterval string
    Specifies the scrape interval as duration string.
    scrapeTimeout string
    Specifies the scrape timeout as duration string.
    targets GetObservabilityScrapeconfigTarget[]
    The targets list (specified by the static config).
    basic_auth GetObservabilityScrapeconfigBasicAuth
    A basic authentication block.
    id str
    instance_id str
    Observability instance ID to which the scraping job is associated.
    metrics_path str
    Specifies the job scraping url path.
    name str
    Specifies the name of the scraping job
    project_id str
    STACKIT project ID to which the scraping job is associated.
    saml2 GetObservabilityScrapeconfigSaml2
    A SAML2 configuration block.
    sample_limit int
    Specifies the scrape sample limit.
    scheme str
    Specifies the http scheme.
    scrape_interval str
    Specifies the scrape interval as duration string.
    scrape_timeout str
    Specifies the scrape timeout as duration string.
    targets Sequence[GetObservabilityScrapeconfigTarget]
    The targets list (specified by the static config).
    basicAuth Property Map
    A basic authentication block.
    id String
    instanceId String
    Observability instance ID to which the scraping job is associated.
    metricsPath String
    Specifies the job scraping url path.
    name String
    Specifies the name of the scraping job
    projectId String
    STACKIT project ID to which the scraping job is associated.
    saml2 Property Map
    A SAML2 configuration block.
    sampleLimit Number
    Specifies the scrape sample limit.
    scheme String
    Specifies the http scheme.
    scrapeInterval String
    Specifies the scrape interval as duration string.
    scrapeTimeout String
    Specifies the scrape timeout as duration string.
    targets List<Property Map>
    The targets list (specified by the static config).

    Supporting Types

    GetObservabilityScrapeconfigBasicAuth

    Password string
    Specifies basic auth password.
    Username string
    Specifies basic auth username.
    Password string
    Specifies basic auth password.
    Username string
    Specifies basic auth username.
    password String
    Specifies basic auth password.
    username String
    Specifies basic auth username.
    password string
    Specifies basic auth password.
    username string
    Specifies basic auth username.
    password str
    Specifies basic auth password.
    username str
    Specifies basic auth username.
    password String
    Specifies basic auth password.
    username String
    Specifies basic auth username.

    GetObservabilityScrapeconfigSaml2

    EnableUrlParameters bool
    Specifies if URL parameters are enabled
    EnableUrlParameters bool
    Specifies if URL parameters are enabled
    enableUrlParameters Boolean
    Specifies if URL parameters are enabled
    enableUrlParameters boolean
    Specifies if URL parameters are enabled
    enable_url_parameters bool
    Specifies if URL parameters are enabled
    enableUrlParameters Boolean
    Specifies if URL parameters are enabled

    GetObservabilityScrapeconfigTarget

    Labels Dictionary<string, string>
    Specifies labels.
    Urls List<string>
    Specifies target URLs.
    Labels map[string]string
    Specifies labels.
    Urls []string
    Specifies target URLs.
    labels Map<String,String>
    Specifies labels.
    urls List<String>
    Specifies target URLs.
    labels {[key: string]: string}
    Specifies labels.
    urls string[]
    Specifies target URLs.
    labels Mapping[str, str]
    Specifies labels.
    urls Sequence[str]
    Specifies target URLs.
    labels Map<String>
    Specifies labels.
    urls List<String>
    Specifies target URLs.

    Package Details

    Repository
    stackit stackitcloud/pulumi-stackit
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the stackit Terraform Provider.
    stackit logo
    Viewing docs for stackit v0.0.4
    published on Friday, Feb 20, 2026 by stackitcloud
    Schema (JSON)
    stackitcloud/pulumi-stackit
      Try Pulumi Cloud free. Your team will thank you.