1. Packages
  2. Coralogix Provider
  3. API Docs
  4. Scope
coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix

coralogix.Scope

Explore with Pulumi AI

coralogix logo
coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix

    Coralogix Scope.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as coralogix from "@pulumi/coralogix";
    
    const example = new coralogix.Scope("example", {
        defaultExpression: "<v1>true",
        displayName: "ExampleScope",
        filters: [{
            entityType: "logs",
            expression: "<v1>(subsystemName == 'purchases') || (subsystemName == 'signups')",
        }],
    });
    
    import pulumi
    import pulumi_coralogix as coralogix
    
    example = coralogix.Scope("example",
        default_expression="<v1>true",
        display_name="ExampleScope",
        filters=[{
            "entity_type": "logs",
            "expression": "<v1>(subsystemName == 'purchases') || (subsystemName == 'signups')",
        }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/coralogix/v2/coralogix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := coralogix.NewScope(ctx, "example", &coralogix.ScopeArgs{
    			DefaultExpression: pulumi.String("<v1>true"),
    			DisplayName:       pulumi.String("ExampleScope"),
    			Filters: coralogix.ScopeFilterArray{
    				&coralogix.ScopeFilterArgs{
    					EntityType: pulumi.String("logs"),
    					Expression: pulumi.String("<v1>(subsystemName == 'purchases') || (subsystemName == 'signups')"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Coralogix = Pulumi.Coralogix;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Coralogix.Scope("example", new()
        {
            DefaultExpression = "<v1>true",
            DisplayName = "ExampleScope",
            Filters = new[]
            {
                new Coralogix.Inputs.ScopeFilterArgs
                {
                    EntityType = "logs",
                    Expression = "<v1>(subsystemName == 'purchases') || (subsystemName == 'signups')",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.coralogix.Scope;
    import com.pulumi.coralogix.ScopeArgs;
    import com.pulumi.coralogix.inputs.ScopeFilterArgs;
    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 example = new Scope("example", ScopeArgs.builder()
                .defaultExpression("<v1>true")
                .displayName("ExampleScope")
                .filters(ScopeFilterArgs.builder()
                    .entityType("logs")
                    .expression("<v1>(subsystemName == 'purchases') || (subsystemName == 'signups')")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: coralogix:Scope
        properties:
          defaultExpression: <v1>true
          displayName: ExampleScope
          filters:
            - entityType: logs
              expression: <v1>(subsystemName == 'purchases') || (subsystemName == 'signups')
    

    Create Scope Resource

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

    Constructor syntax

    new Scope(name: string, args: ScopeArgs, opts?: CustomResourceOptions);
    @overload
    def Scope(resource_name: str,
              args: ScopeArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Scope(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              default_expression: Optional[str] = None,
              display_name: Optional[str] = None,
              filters: Optional[Sequence[ScopeFilterArgs]] = None,
              description: Optional[str] = None)
    func NewScope(ctx *Context, name string, args ScopeArgs, opts ...ResourceOption) (*Scope, error)
    public Scope(string name, ScopeArgs args, CustomResourceOptions? opts = null)
    public Scope(String name, ScopeArgs args)
    public Scope(String name, ScopeArgs args, CustomResourceOptions options)
    
    type: coralogix:Scope
    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 ScopeArgs
    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 ScopeArgs
    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 ScopeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScopeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScopeArgs
    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 scopeResource = new Coralogix.Scope("scopeResource", new()
    {
        DefaultExpression = "string",
        DisplayName = "string",
        Filters = new[]
        {
            new Coralogix.Inputs.ScopeFilterArgs
            {
                EntityType = "string",
                Expression = "string",
            },
        },
        Description = "string",
    });
    
    example, err := coralogix.NewScope(ctx, "scopeResource", &coralogix.ScopeArgs{
    	DefaultExpression: pulumi.String("string"),
    	DisplayName:       pulumi.String("string"),
    	Filters: coralogix.ScopeFilterArray{
    		&coralogix.ScopeFilterArgs{
    			EntityType: pulumi.String("string"),
    			Expression: pulumi.String("string"),
    		},
    	},
    	Description: pulumi.String("string"),
    })
    
    var scopeResource = new Scope("scopeResource", ScopeArgs.builder()
        .defaultExpression("string")
        .displayName("string")
        .filters(ScopeFilterArgs.builder()
            .entityType("string")
            .expression("string")
            .build())
        .description("string")
        .build());
    
    scope_resource = coralogix.Scope("scopeResource",
        default_expression="string",
        display_name="string",
        filters=[{
            "entity_type": "string",
            "expression": "string",
        }],
        description="string")
    
    const scopeResource = new coralogix.Scope("scopeResource", {
        defaultExpression: "string",
        displayName: "string",
        filters: [{
            entityType: "string",
            expression: "string",
        }],
        description: "string",
    });
    
    type: coralogix:Scope
    properties:
        defaultExpression: string
        description: string
        displayName: string
        filters:
            - entityType: string
              expression: string
    

    Scope 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 Scope resource accepts the following input properties:

    DefaultExpression string
    Default expression to use when no filter matches the query. Until further notice, this is limited to true (everything is included) or false (nothing is included). Use a version tag (e.g <v1>true or <v1>false)
    DisplayName string
    Scope display name.
    Filters List<ScopeFilter>
    Filters applied to include data in the scope.
    Description string
    Description of the scope. Optional.
    DefaultExpression string
    Default expression to use when no filter matches the query. Until further notice, this is limited to true (everything is included) or false (nothing is included). Use a version tag (e.g <v1>true or <v1>false)
    DisplayName string
    Scope display name.
    Filters []ScopeFilterArgs
    Filters applied to include data in the scope.
    Description string
    Description of the scope. Optional.
    defaultExpression String
    Default expression to use when no filter matches the query. Until further notice, this is limited to true (everything is included) or false (nothing is included). Use a version tag (e.g <v1>true or <v1>false)
    displayName String
    Scope display name.
    filters List<ScopeFilter>
    Filters applied to include data in the scope.
    description String
    Description of the scope. Optional.
    defaultExpression string
    Default expression to use when no filter matches the query. Until further notice, this is limited to true (everything is included) or false (nothing is included). Use a version tag (e.g <v1>true or <v1>false)
    displayName string
    Scope display name.
    filters ScopeFilter[]
    Filters applied to include data in the scope.
    description string
    Description of the scope. Optional.
    default_expression str
    Default expression to use when no filter matches the query. Until further notice, this is limited to true (everything is included) or false (nothing is included). Use a version tag (e.g <v1>true or <v1>false)
    display_name str
    Scope display name.
    filters Sequence[ScopeFilterArgs]
    Filters applied to include data in the scope.
    description str
    Description of the scope. Optional.
    defaultExpression String
    Default expression to use when no filter matches the query. Until further notice, this is limited to true (everything is included) or false (nothing is included). Use a version tag (e.g <v1>true or <v1>false)
    displayName String
    Scope display name.
    filters List<Property Map>
    Filters applied to include data in the scope.
    description String
    Description of the scope. Optional.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    TeamId string
    Associated team.
    Id string
    The provider-assigned unique ID for this managed resource.
    TeamId string
    Associated team.
    id String
    The provider-assigned unique ID for this managed resource.
    teamId String
    Associated team.
    id string
    The provider-assigned unique ID for this managed resource.
    teamId string
    Associated team.
    id str
    The provider-assigned unique ID for this managed resource.
    team_id str
    Associated team.
    id String
    The provider-assigned unique ID for this managed resource.
    teamId String
    Associated team.

    Look up Existing Scope Resource

    Get an existing Scope 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?: ScopeState, opts?: CustomResourceOptions): Scope
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            default_expression: Optional[str] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            filters: Optional[Sequence[ScopeFilterArgs]] = None,
            team_id: Optional[str] = None) -> Scope
    func GetScope(ctx *Context, name string, id IDInput, state *ScopeState, opts ...ResourceOption) (*Scope, error)
    public static Scope Get(string name, Input<string> id, ScopeState? state, CustomResourceOptions? opts = null)
    public static Scope get(String name, Output<String> id, ScopeState state, CustomResourceOptions options)
    resources:  _:    type: coralogix:Scope    get:      id: ${id}
    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:
    DefaultExpression string
    Default expression to use when no filter matches the query. Until further notice, this is limited to true (everything is included) or false (nothing is included). Use a version tag (e.g <v1>true or <v1>false)
    Description string
    Description of the scope. Optional.
    DisplayName string
    Scope display name.
    Filters List<ScopeFilter>
    Filters applied to include data in the scope.
    TeamId string
    Associated team.
    DefaultExpression string
    Default expression to use when no filter matches the query. Until further notice, this is limited to true (everything is included) or false (nothing is included). Use a version tag (e.g <v1>true or <v1>false)
    Description string
    Description of the scope. Optional.
    DisplayName string
    Scope display name.
    Filters []ScopeFilterArgs
    Filters applied to include data in the scope.
    TeamId string
    Associated team.
    defaultExpression String
    Default expression to use when no filter matches the query. Until further notice, this is limited to true (everything is included) or false (nothing is included). Use a version tag (e.g <v1>true or <v1>false)
    description String
    Description of the scope. Optional.
    displayName String
    Scope display name.
    filters List<ScopeFilter>
    Filters applied to include data in the scope.
    teamId String
    Associated team.
    defaultExpression string
    Default expression to use when no filter matches the query. Until further notice, this is limited to true (everything is included) or false (nothing is included). Use a version tag (e.g <v1>true or <v1>false)
    description string
    Description of the scope. Optional.
    displayName string
    Scope display name.
    filters ScopeFilter[]
    Filters applied to include data in the scope.
    teamId string
    Associated team.
    default_expression str
    Default expression to use when no filter matches the query. Until further notice, this is limited to true (everything is included) or false (nothing is included). Use a version tag (e.g <v1>true or <v1>false)
    description str
    Description of the scope. Optional.
    display_name str
    Scope display name.
    filters Sequence[ScopeFilterArgs]
    Filters applied to include data in the scope.
    team_id str
    Associated team.
    defaultExpression String
    Default expression to use when no filter matches the query. Until further notice, this is limited to true (everything is included) or false (nothing is included). Use a version tag (e.g <v1>true or <v1>false)
    description String
    Description of the scope. Optional.
    displayName String
    Scope display name.
    filters List<Property Map>
    Filters applied to include data in the scope.
    teamId String
    Associated team.

    Supporting Types

    ScopeFilter, ScopeFilterArgs

    EntityType string
    Entity type to apply the expression on
    Expression string
    Expression to run
    EntityType string
    Entity type to apply the expression on
    Expression string
    Expression to run
    entityType String
    Entity type to apply the expression on
    expression String
    Expression to run
    entityType string
    Entity type to apply the expression on
    expression string
    Expression to run
    entity_type str
    Entity type to apply the expression on
    expression str
    Expression to run
    entityType String
    Entity type to apply the expression on
    expression String
    Expression to run

    Package Details

    Repository
    coralogix coralogix/terraform-provider-coralogix
    License
    Notes
    This Pulumi package is based on the coralogix Terraform Provider.
    coralogix logo
    coralogix 2.0.17 published on Tuesday, Apr 22, 2025 by coralogix