1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. getDLPEDMSchema
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler

zia.getDLPEDMSchema

Explore with Pulumi AI

zia logo
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler

    Use the zia_dlp_edm_schema data source to get information about a the list of DLP Exact Data Match (EDM) templates in the Zscaler Internet Access cloud or via the API.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as zia from "@pulumi/zia";
    
    const this = zia.getDLPEDMSchema({
        projectName: "Example",
    });
    
    import pulumi
    import pulumi_zia as zia
    
    this = zia.get_dlpedm_schema(project_name="Example")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/zscaler/pulumi-zia/sdk/go/zia"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := zia.GetDLPEDMSchema(ctx, &zia.GetDLPEDMSchemaArgs{
    			ProjectName: pulumi.StringRef("Example"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zia = Pulumi.Zia;
    
    return await Deployment.RunAsync(() => 
    {
        var @this = Zia.GetDLPEDMSchema.Invoke(new()
        {
            ProjectName = "Example",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zia.ZiaFunctions;
    import com.pulumi.zia.inputs.GetDLPEDMSchemaArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var this = ZiaFunctions.getDLPEDMSchema(GetDLPEDMSchemaArgs.builder()
                .projectName("Example")
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          Function: zia:getDLPEDMSchema
          Arguments:
            projectName: Example
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zia.ZiaFunctions;
    import com.pulumi.zia.inputs.GetDLPEDMSchemaArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = ZiaFunctions.getDLPEDMSchema(GetDLPEDMSchemaArgs.builder()
                .schemaId(1234567890)
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: zia:getDLPEDMSchema
          Arguments:
            schemaId: 1.23456789e+09
    

    Using getDLPEDMSchema

    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 getDLPEDMSchema(args: GetDLPEDMSchemaArgs, opts?: InvokeOptions): Promise<GetDLPEDMSchemaResult>
    function getDLPEDMSchemaOutput(args: GetDLPEDMSchemaOutputArgs, opts?: InvokeOptions): Output<GetDLPEDMSchemaResult>
    def get_dlpedm_schema(project_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDLPEDMSchemaResult
    def get_dlpedm_schema_output(project_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetDLPEDMSchemaResult]
    func GetDLPEDMSchema(ctx *Context, args *GetDLPEDMSchemaArgs, opts ...InvokeOption) (*GetDLPEDMSchemaResult, error)
    func GetDLPEDMSchemaOutput(ctx *Context, args *GetDLPEDMSchemaOutputArgs, opts ...InvokeOption) GetDLPEDMSchemaResultOutput

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

    public static class GetDLPEDMSchema 
    {
        public static Task<GetDLPEDMSchemaResult> InvokeAsync(GetDLPEDMSchemaArgs args, InvokeOptions? opts = null)
        public static Output<GetDLPEDMSchemaResult> Invoke(GetDLPEDMSchemaInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDLPEDMSchemaResult> getDLPEDMSchema(GetDLPEDMSchemaArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: zia:index/getDLPEDMSchema:getDLPEDMSchema
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getDLPEDMSchema Result

    The following output properties are available:

    Supporting Types

    GetDLPEDMSchemaCreatedBy

    Extensions Dictionary<string, string>
    Id int
    Identifier that uniquely identifies an entity
    Name string
    The configured name of the entity
    Extensions map[string]string
    Id int
    Identifier that uniquely identifies an entity
    Name string
    The configured name of the entity
    extensions Map<String,String>
    id Integer
    Identifier that uniquely identifies an entity
    name String
    The configured name of the entity
    extensions {[key: string]: string}
    id number
    Identifier that uniquely identifies an entity
    name string
    The configured name of the entity
    extensions Mapping[str, str]
    id int
    Identifier that uniquely identifies an entity
    name str
    The configured name of the entity
    extensions Map<String>
    id Number
    Identifier that uniquely identifies an entity
    name String
    The configured name of the entity

    GetDLPEDMSchemaEdmClient

    Extensions Dictionary<string, string>
    Id int
    Identifier that uniquely identifies an entity
    Name string
    The configured name of the entity
    Extensions map[string]string
    Id int
    Identifier that uniquely identifies an entity
    Name string
    The configured name of the entity
    extensions Map<String,String>
    id Integer
    Identifier that uniquely identifies an entity
    name String
    The configured name of the entity
    extensions {[key: string]: string}
    id number
    Identifier that uniquely identifies an entity
    name string
    The configured name of the entity
    extensions Mapping[str, str]
    id int
    Identifier that uniquely identifies an entity
    name str
    The configured name of the entity
    extensions Map<String>
    id Number
    Identifier that uniquely identifies an entity
    name String
    The configured name of the entity

    GetDLPEDMSchemaLastModifiedBy

    Extensions Dictionary<string, string>
    Id int
    Identifier that uniquely identifies an entity
    Name string
    The configured name of the entity
    Extensions map[string]string
    Id int
    Identifier that uniquely identifies an entity
    Name string
    The configured name of the entity
    extensions Map<String,String>
    id Integer
    Identifier that uniquely identifies an entity
    name String
    The configured name of the entity
    extensions {[key: string]: string}
    id number
    Identifier that uniquely identifies an entity
    name string
    The configured name of the entity
    extensions Mapping[str, str]
    id int
    Identifier that uniquely identifies an entity
    name str
    The configured name of the entity
    extensions Map<String>
    id Number
    Identifier that uniquely identifies an entity
    name String
    The configured name of the entity

    GetDLPEDMSchemaSchedule

    ScheduleDayOfMonths List<string>
    The day of the month that the IDM template is scheduled for. This attribute is required by PUT and POST requests, and when scheduleType is set to MONTHLY.
    ScheduleDayOfWeeks List<string>
    The day of the week the IDM template is scheduled for. This attribute is required by PUT and POST requests, and when scheduleType is set to WEEKLY.
    ScheduleDisabled bool
    If set to true, the schedule for the IDM template is temporarily in a disabled state. This attribute is required by PUT requests in order to disable or enable a schedule.
    ScheduleTime int
    The time of the day (in minutes) that the IDM template is scheduled for. For example: at 3am= 180 mins. This attribute is required by PUT and POST requests.
    ScheduleType string
    The schedule type for the IDM template's schedule (i.e., Monthly, Weekly, Daily, or None). This attribute is required by PUT and POST requests.
    ScheduleDayOfMonths []string
    The day of the month that the IDM template is scheduled for. This attribute is required by PUT and POST requests, and when scheduleType is set to MONTHLY.
    ScheduleDayOfWeeks []string
    The day of the week the IDM template is scheduled for. This attribute is required by PUT and POST requests, and when scheduleType is set to WEEKLY.
    ScheduleDisabled bool
    If set to true, the schedule for the IDM template is temporarily in a disabled state. This attribute is required by PUT requests in order to disable or enable a schedule.
    ScheduleTime int
    The time of the day (in minutes) that the IDM template is scheduled for. For example: at 3am= 180 mins. This attribute is required by PUT and POST requests.
    ScheduleType string
    The schedule type for the IDM template's schedule (i.e., Monthly, Weekly, Daily, or None). This attribute is required by PUT and POST requests.
    scheduleDayOfMonths List<String>
    The day of the month that the IDM template is scheduled for. This attribute is required by PUT and POST requests, and when scheduleType is set to MONTHLY.
    scheduleDayOfWeeks List<String>
    The day of the week the IDM template is scheduled for. This attribute is required by PUT and POST requests, and when scheduleType is set to WEEKLY.
    scheduleDisabled Boolean
    If set to true, the schedule for the IDM template is temporarily in a disabled state. This attribute is required by PUT requests in order to disable or enable a schedule.
    scheduleTime Integer
    The time of the day (in minutes) that the IDM template is scheduled for. For example: at 3am= 180 mins. This attribute is required by PUT and POST requests.
    scheduleType String
    The schedule type for the IDM template's schedule (i.e., Monthly, Weekly, Daily, or None). This attribute is required by PUT and POST requests.
    scheduleDayOfMonths string[]
    The day of the month that the IDM template is scheduled for. This attribute is required by PUT and POST requests, and when scheduleType is set to MONTHLY.
    scheduleDayOfWeeks string[]
    The day of the week the IDM template is scheduled for. This attribute is required by PUT and POST requests, and when scheduleType is set to WEEKLY.
    scheduleDisabled boolean
    If set to true, the schedule for the IDM template is temporarily in a disabled state. This attribute is required by PUT requests in order to disable or enable a schedule.
    scheduleTime number
    The time of the day (in minutes) that the IDM template is scheduled for. For example: at 3am= 180 mins. This attribute is required by PUT and POST requests.
    scheduleType string
    The schedule type for the IDM template's schedule (i.e., Monthly, Weekly, Daily, or None). This attribute is required by PUT and POST requests.
    schedule_day_of_months Sequence[str]
    The day of the month that the IDM template is scheduled for. This attribute is required by PUT and POST requests, and when scheduleType is set to MONTHLY.
    schedule_day_of_weeks Sequence[str]
    The day of the week the IDM template is scheduled for. This attribute is required by PUT and POST requests, and when scheduleType is set to WEEKLY.
    schedule_disabled bool
    If set to true, the schedule for the IDM template is temporarily in a disabled state. This attribute is required by PUT requests in order to disable or enable a schedule.
    schedule_time int
    The time of the day (in minutes) that the IDM template is scheduled for. For example: at 3am= 180 mins. This attribute is required by PUT and POST requests.
    schedule_type str
    The schedule type for the IDM template's schedule (i.e., Monthly, Weekly, Daily, or None). This attribute is required by PUT and POST requests.
    scheduleDayOfMonths List<String>
    The day of the month that the IDM template is scheduled for. This attribute is required by PUT and POST requests, and when scheduleType is set to MONTHLY.
    scheduleDayOfWeeks List<String>
    The day of the week the IDM template is scheduled for. This attribute is required by PUT and POST requests, and when scheduleType is set to WEEKLY.
    scheduleDisabled Boolean
    If set to true, the schedule for the IDM template is temporarily in a disabled state. This attribute is required by PUT requests in order to disable or enable a schedule.
    scheduleTime Number
    The time of the day (in minutes) that the IDM template is scheduled for. For example: at 3am= 180 mins. This attribute is required by PUT and POST requests.
    scheduleType String
    The schedule type for the IDM template's schedule (i.e., Monthly, Weekly, Daily, or None). This attribute is required by PUT and POST requests.

    GetDLPEDMSchemaTokenList

    ColLengthBitmap int
    The length of the column bitmap in the hashed file.
    HashFileColumnOrder int
    The column position for the token in the hashed file, starting from 1.
    Name string
    The token (i.e., criteria) name. This attribute is required by PUT and POST requests.
    OriginalColumn int
    The column position for the token in the original CSV file uploaded to the Index Tool, starting from 1. This attribue required by PUT and POST requests.
    PrimaryKey bool
    Indicates whether the token is a primary key.
    Type string
    The token (i.e., criteria) name. This attribute is required by PUT and POST requests.
    ColLengthBitmap int
    The length of the column bitmap in the hashed file.
    HashFileColumnOrder int
    The column position for the token in the hashed file, starting from 1.
    Name string
    The token (i.e., criteria) name. This attribute is required by PUT and POST requests.
    OriginalColumn int
    The column position for the token in the original CSV file uploaded to the Index Tool, starting from 1. This attribue required by PUT and POST requests.
    PrimaryKey bool
    Indicates whether the token is a primary key.
    Type string
    The token (i.e., criteria) name. This attribute is required by PUT and POST requests.
    colLengthBitmap Integer
    The length of the column bitmap in the hashed file.
    hashFileColumnOrder Integer
    The column position for the token in the hashed file, starting from 1.
    name String
    The token (i.e., criteria) name. This attribute is required by PUT and POST requests.
    originalColumn Integer
    The column position for the token in the original CSV file uploaded to the Index Tool, starting from 1. This attribue required by PUT and POST requests.
    primaryKey Boolean
    Indicates whether the token is a primary key.
    type String
    The token (i.e., criteria) name. This attribute is required by PUT and POST requests.
    colLengthBitmap number
    The length of the column bitmap in the hashed file.
    hashFileColumnOrder number
    The column position for the token in the hashed file, starting from 1.
    name string
    The token (i.e., criteria) name. This attribute is required by PUT and POST requests.
    originalColumn number
    The column position for the token in the original CSV file uploaded to the Index Tool, starting from 1. This attribue required by PUT and POST requests.
    primaryKey boolean
    Indicates whether the token is a primary key.
    type string
    The token (i.e., criteria) name. This attribute is required by PUT and POST requests.
    col_length_bitmap int
    The length of the column bitmap in the hashed file.
    hash_file_column_order int
    The column position for the token in the hashed file, starting from 1.
    name str
    The token (i.e., criteria) name. This attribute is required by PUT and POST requests.
    original_column int
    The column position for the token in the original CSV file uploaded to the Index Tool, starting from 1. This attribue required by PUT and POST requests.
    primary_key bool
    Indicates whether the token is a primary key.
    type str
    The token (i.e., criteria) name. This attribute is required by PUT and POST requests.
    colLengthBitmap Number
    The length of the column bitmap in the hashed file.
    hashFileColumnOrder Number
    The column position for the token in the hashed file, starting from 1.
    name String
    The token (i.e., criteria) name. This attribute is required by PUT and POST requests.
    originalColumn Number
    The column position for the token in the original CSV file uploaded to the Index Tool, starting from 1. This attribue required by PUT and POST requests.
    primaryKey Boolean
    Indicates whether the token is a primary key.
    type String
    The token (i.e., criteria) name. This attribute is required by PUT and POST requests.

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    MIT
    Notes
    This Pulumi package is based on the zia Terraform Provider.
    zia logo
    Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler