1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. getSandboxReport
Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler

zia.getSandboxReport

Explore with Pulumi AI

zia logo
Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler

    Use the zia_sandbox_report data source gets a full (i.e., complete) or summary detail report for an MD5 hash of a file that was analyzed by Sandbox.

    Example Usage

    Obtain Full Sandbox Report

    import * as pulumi from "@pulumi/pulumi";
    import * as zia from "@pulumi/zia";
    
    const this = zia.getSandboxReport({
        details: "full",
        md5Hash: "F69CA01D65E6C8F9E3540029E5F6AB92",
    });
    
    import pulumi
    import pulumi_zia as zia
    
    this = zia.get_sandbox_report(details="full",
        md5_hash="F69CA01D65E6C8F9E3540029E5F6AB92")
    
    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.GetSandboxReport(ctx, &zia.GetSandboxReportArgs{
    			Details: pulumi.StringRef("full"),
    			Md5Hash: "F69CA01D65E6C8F9E3540029E5F6AB92",
    		}, 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.GetSandboxReport.Invoke(new()
        {
            Details = "full",
            Md5Hash = "F69CA01D65E6C8F9E3540029E5F6AB92",
        });
    
    });
    
    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.GetSandboxReportArgs;
    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.getSandboxReport(GetSandboxReportArgs.builder()
                .details("full")
                .md5Hash("F69CA01D65E6C8F9E3540029E5F6AB92")
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          Function: zia:getSandboxReport
          Arguments:
            details: full
            md5Hash: F69CA01D65E6C8F9E3540029E5F6AB92
    

    Obtain Summarized Sandbox Report

    import * as pulumi from "@pulumi/pulumi";
    import * as zia from "@pulumi/zia";
    
    const this = zia.getSandboxReport({
        details: "summary",
        md5Hash: "F69CA01D65E6C8F9E3540029E5F6AB92",
    });
    
    import pulumi
    import pulumi_zia as zia
    
    this = zia.get_sandbox_report(details="summary",
        md5_hash="F69CA01D65E6C8F9E3540029E5F6AB92")
    
    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.GetSandboxReport(ctx, &zia.GetSandboxReportArgs{
    			Details: pulumi.StringRef("summary"),
    			Md5Hash: "F69CA01D65E6C8F9E3540029E5F6AB92",
    		}, 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.GetSandboxReport.Invoke(new()
        {
            Details = "summary",
            Md5Hash = "F69CA01D65E6C8F9E3540029E5F6AB92",
        });
    
    });
    
    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.GetSandboxReportArgs;
    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.getSandboxReport(GetSandboxReportArgs.builder()
                .details("summary")
                .md5Hash("F69CA01D65E6C8F9E3540029E5F6AB92")
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          Function: zia:getSandboxReport
          Arguments:
            details: summary
            md5Hash: F69CA01D65E6C8F9E3540029E5F6AB92
    

    Using getSandboxReport

    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 getSandboxReport(args: GetSandboxReportArgs, opts?: InvokeOptions): Promise<GetSandboxReportResult>
    function getSandboxReportOutput(args: GetSandboxReportOutputArgs, opts?: InvokeOptions): Output<GetSandboxReportResult>
    def get_sandbox_report(details: Optional[str] = None,
                           exploits: Optional[Sequence[GetSandboxReportExploit]] = None,
                           md5_hash: Optional[str] = None,
                           networkings: Optional[Sequence[GetSandboxReportNetworking]] = None,
                           persistences: Optional[Sequence[GetSandboxReportPersistence]] = None,
                           security_bypasses: Optional[Sequence[GetSandboxReportSecurityBypass]] = None,
                           spywares: Optional[Sequence[GetSandboxReportSpyware]] = None,
                           stealths: Optional[Sequence[GetSandboxReportStealth]] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSandboxReportResult
    def get_sandbox_report_output(details: Optional[pulumi.Input[str]] = None,
                           exploits: Optional[pulumi.Input[Sequence[pulumi.Input[GetSandboxReportExploitArgs]]]] = None,
                           md5_hash: Optional[pulumi.Input[str]] = None,
                           networkings: Optional[pulumi.Input[Sequence[pulumi.Input[GetSandboxReportNetworkingArgs]]]] = None,
                           persistences: Optional[pulumi.Input[Sequence[pulumi.Input[GetSandboxReportPersistenceArgs]]]] = None,
                           security_bypasses: Optional[pulumi.Input[Sequence[pulumi.Input[GetSandboxReportSecurityBypassArgs]]]] = None,
                           spywares: Optional[pulumi.Input[Sequence[pulumi.Input[GetSandboxReportSpywareArgs]]]] = None,
                           stealths: Optional[pulumi.Input[Sequence[pulumi.Input[GetSandboxReportStealthArgs]]]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSandboxReportResult]
    func GetSandboxReport(ctx *Context, args *GetSandboxReportArgs, opts ...InvokeOption) (*GetSandboxReportResult, error)
    func GetSandboxReportOutput(ctx *Context, args *GetSandboxReportOutputArgs, opts ...InvokeOption) GetSandboxReportResultOutput

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

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

    The following arguments are supported:

    md5Hash String
    (Required) MD5 hash of the file that was analyzed by Sandbox.
    details String
    (Required) Type of report, full or summary.
    exploits List<Property Map>
    networkings List<Property Map>
    persistences List<Property Map>
    securityBypasses List<Property Map>
    spywares List<Property Map>
    stealths List<Property Map>

    getSandboxReport Result

    The following output properties are available:

    Classifications List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxReportClassification>
    Exploits List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxReportExploit>
    FileProperties List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxReportFileProperty>
    Id string
    The provider-assigned unique ID for this managed resource.
    Md5Hash string
    (Required) MD5 hash of the file that was analyzed by Sandbox.
    Networkings List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxReportNetworking>
    Origins List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxReportOrigin>
    Persistences List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxReportPersistence>
    SecurityBypasses List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxReportSecurityBypass>
    Spywares List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxReportSpyware>
    Stealths List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxReportStealth>
    Summaries List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxReportSummary>
    Summary detail report for an MD5 hash of a file that was analyzed by Sandbox
    SystemSummaries List<zscaler.PulumiPackage.Zia.Outputs.GetSandboxReportSystemSummary>
    Details string
    (Required) Type of report, full or summary.
    classifications List<Property Map>
    exploits List<Property Map>
    fileProperties List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    md5Hash String
    (Required) MD5 hash of the file that was analyzed by Sandbox.
    networkings List<Property Map>
    origins List<Property Map>
    persistences List<Property Map>
    securityBypasses List<Property Map>
    spywares List<Property Map>
    stealths List<Property Map>
    summaries List<Property Map>
    Summary detail report for an MD5 hash of a file that was analyzed by Sandbox
    systemSummaries List<Property Map>
    details String
    (Required) Type of report, full or summary.

    Supporting Types

    GetSandboxReportClassification

    Category string
    DetectedMalware string
    Score int
    Type string
    Category string
    DetectedMalware string
    Score int
    Type string
    category String
    detectedMalware String
    score Integer
    type String
    category string
    detectedMalware string
    score number
    type string
    category String
    detectedMalware String
    score Number
    type String

    GetSandboxReportExploit

    Risk string
    Signature string
    SignatureSources List<string>
    Risk string
    Signature string
    SignatureSources []string
    risk String
    signature String
    signatureSources List<String>
    risk string
    signature string
    signatureSources string[]
    risk str
    signature str
    signature_sources Sequence[str]
    risk String
    signature String
    signatureSources List<String>

    GetSandboxReportFileProperty

    DigitalCerificate string
    FileSize int
    FileType string
    Issuer string
    Md5 string
    RootCa string
    Sha1 string
    Sha256 string
    Ssdeep string
    DigitalCerificate string
    FileSize int
    FileType string
    Issuer string
    Md5 string
    RootCa string
    Sha1 string
    Sha256 string
    Ssdeep string
    digitalCerificate String
    fileSize Integer
    fileType String
    issuer String
    md5 String
    rootCa String
    sha1 String
    sha256 String
    ssdeep String
    digitalCerificate string
    fileSize number
    fileType string
    issuer string
    md5 string
    rootCa string
    sha1 string
    sha256 string
    ssdeep string
    digitalCerificate String
    fileSize Number
    fileType String
    issuer String
    md5 String
    rootCa String
    sha1 String
    sha256 String
    ssdeep String

    GetSandboxReportNetworking

    Risk string
    Signature string
    SignatureSources List<string>
    Risk string
    Signature string
    SignatureSources []string
    risk String
    signature String
    signatureSources List<String>
    risk string
    signature string
    signatureSources string[]
    risk str
    signature str
    signature_sources Sequence[str]
    risk String
    signature String
    signatureSources List<String>

    GetSandboxReportOrigin

    Country string
    Language string
    Risk string
    Country string
    Language string
    Risk string
    country String
    language String
    risk String
    country string
    language string
    risk string
    country String
    language String
    risk String

    GetSandboxReportPersistence

    Risk string
    Signature string
    SignatureSources List<string>
    Risk string
    Signature string
    SignatureSources []string
    risk String
    signature String
    signatureSources List<String>
    risk string
    signature string
    signatureSources string[]
    risk str
    signature str
    signature_sources Sequence[str]
    risk String
    signature String
    signatureSources List<String>

    GetSandboxReportSecurityBypass

    Risk string
    Signature string
    SignatureSources List<string>
    Risk string
    Signature string
    SignatureSources []string
    risk String
    signature String
    signatureSources List<String>
    risk string
    signature string
    signatureSources string[]
    risk str
    signature str
    signature_sources Sequence[str]
    risk String
    signature String
    signatureSources List<String>

    GetSandboxReportSpyware

    Risk string
    Signature string
    SignatureSources List<string>
    Risk string
    Signature string
    SignatureSources []string
    risk String
    signature String
    signatureSources List<String>
    risk string
    signature string
    signatureSources string[]
    risk str
    signature str
    signature_sources Sequence[str]
    risk String
    signature String
    signatureSources List<String>

    GetSandboxReportStealth

    Risk string
    Signature string
    SignatureSources List<string>
    Risk string
    Signature string
    SignatureSources []string
    risk String
    signature String
    signatureSources List<String>
    risk string
    signature string
    signatureSources string[]
    risk str
    signature str
    signature_sources Sequence[str]
    risk String
    signature String
    signatureSources List<String>

    GetSandboxReportSummary

    Category string
    Duration int
    FileType string
    StartTime int
    Status string
    Category string
    Duration int
    FileType string
    StartTime int
    Status string
    category String
    duration Integer
    fileType String
    startTime Integer
    status String
    category string
    duration number
    fileType string
    startTime number
    status string
    category String
    duration Number
    fileType String
    startTime Number
    status String

    GetSandboxReportSystemSummary

    Risk string
    Signature string
    SignatureSources List<string>
    Risk string
    Signature string
    SignatureSources []string
    risk String
    signature String
    signatureSources List<String>
    risk string
    signature string
    signatureSources string[]
    risk str
    signature str
    signature_sources Sequence[str]
    risk String
    signature String
    signatureSources List<String>

    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.6 published on Wednesday, Apr 10, 2024 by Zscaler