Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler
zia.getSandboxReport
Explore with Pulumi AI
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<zscaler.
Pulumi Package. Zia. Inputs. Get Sandbox Report Exploit> - Networkings
List<zscaler.
Pulumi Package. Zia. Inputs. Get Sandbox Report Networking> - Persistences
List<zscaler.
Pulumi Package. Zia. Inputs. Get Sandbox Report Persistence> - Security
Bypasses List<zscaler.Pulumi Package. Zia. Inputs. Get Sandbox Report Security Bypass> - Spywares
List<zscaler.
Pulumi Package. Zia. Inputs. Get Sandbox Report Spyware> - Stealths
List<zscaler.
Pulumi Package. Zia. Inputs. Get Sandbox Report Stealth>
- Md5Hash string
- (Required) MD5 hash of the file that was analyzed by Sandbox.
- Details string
- (Required) Type of report, full or summary.
- Exploits
[]Get
Sandbox Report Exploit - Networkings
[]Get
Sandbox Report Networking - Persistences
[]Get
Sandbox Report Persistence - Security
Bypasses []GetSandbox Report Security Bypass - Spywares
[]Get
Sandbox Report Spyware - Stealths
[]Get
Sandbox Report Stealth
- md5Hash String
- (Required) MD5 hash of the file that was analyzed by Sandbox.
- details String
- (Required) Type of report, full or summary.
- exploits
List<Get
Sandbox Report Exploit> - networkings
List<Get
Sandbox Report Networking> - persistences
List<Get
Sandbox Report Persistence> - security
Bypasses List<GetSandbox Report Security Bypass> - spywares
List<Get
Sandbox Report Spyware> - stealths
List<Get
Sandbox Report Stealth>
- md5Hash string
- (Required) MD5 hash of the file that was analyzed by Sandbox.
- details string
- (Required) Type of report, full or summary.
- exploits
Get
Sandbox Report Exploit[] - networkings
Get
Sandbox Report Networking[] - persistences
Get
Sandbox Report Persistence[] - security
Bypasses GetSandbox Report Security Bypass[] - spywares
Get
Sandbox Report Spyware[] - stealths
Get
Sandbox Report Stealth[]
- md5_
hash str - (Required) MD5 hash of the file that was analyzed by Sandbox.
- details str
- (Required) Type of report, full or summary.
- exploits
Sequence[Get
Sandbox Report Exploit] - networkings
Sequence[Get
Sandbox Report Networking] - persistences
Sequence[Get
Sandbox Report Persistence] - security_
bypasses Sequence[GetSandbox Report Security Bypass] - spywares
Sequence[Get
Sandbox Report Spyware] - stealths
Sequence[Get
Sandbox Report Stealth]
- 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>
- security
Bypasses List<Property Map> - spywares List<Property Map>
- stealths List<Property Map>
getSandboxReport Result
The following output properties are available:
- Classifications
List<zscaler.
Pulumi Package. Zia. Outputs. Get Sandbox Report Classification> - Exploits
List<zscaler.
Pulumi Package. Zia. Outputs. Get Sandbox Report Exploit> - File
Properties List<zscaler.Pulumi Package. Zia. Outputs. Get Sandbox Report File Property> - 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.
Pulumi Package. Zia. Outputs. Get Sandbox Report Networking> - Origins
List<zscaler.
Pulumi Package. Zia. Outputs. Get Sandbox Report Origin> - Persistences
List<zscaler.
Pulumi Package. Zia. Outputs. Get Sandbox Report Persistence> - Security
Bypasses List<zscaler.Pulumi Package. Zia. Outputs. Get Sandbox Report Security Bypass> - Spywares
List<zscaler.
Pulumi Package. Zia. Outputs. Get Sandbox Report Spyware> - Stealths
List<zscaler.
Pulumi Package. Zia. Outputs. Get Sandbox Report Stealth> - Summaries
List<zscaler.
Pulumi Package. Zia. Outputs. Get Sandbox Report Summary> - Summary detail report for an MD5 hash of a file that was analyzed by Sandbox
- System
Summaries List<zscaler.Pulumi Package. Zia. Outputs. Get Sandbox Report System Summary> - Details string
- (Required) Type of report, full or summary.
- Classifications
[]Get
Sandbox Report Classification - Exploits
[]Get
Sandbox Report Exploit - File
Properties []GetSandbox Report File Property - 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
[]Get
Sandbox Report Networking - Origins
[]Get
Sandbox Report Origin - Persistences
[]Get
Sandbox Report Persistence - Security
Bypasses []GetSandbox Report Security Bypass - Spywares
[]Get
Sandbox Report Spyware - Stealths
[]Get
Sandbox Report Stealth - Summaries
[]Get
Sandbox Report Summary - Summary detail report for an MD5 hash of a file that was analyzed by Sandbox
- System
Summaries []GetSandbox Report System Summary - Details string
- (Required) Type of report, full or summary.
- classifications
List<Get
Sandbox Report Classification> - exploits
List<Get
Sandbox Report Exploit> - file
Properties List<GetSandbox Report File Property> - 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<Get
Sandbox Report Networking> - origins
List<Get
Sandbox Report Origin> - persistences
List<Get
Sandbox Report Persistence> - security
Bypasses List<GetSandbox Report Security Bypass> - spywares
List<Get
Sandbox Report Spyware> - stealths
List<Get
Sandbox Report Stealth> - summaries
List<Get
Sandbox Report Summary> - Summary detail report for an MD5 hash of a file that was analyzed by Sandbox
- system
Summaries List<GetSandbox Report System Summary> - details String
- (Required) Type of report, full or summary.
- classifications
Get
Sandbox Report Classification[] - exploits
Get
Sandbox Report Exploit[] - file
Properties GetSandbox Report File Property[] - 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
Get
Sandbox Report Networking[] - origins
Get
Sandbox Report Origin[] - persistences
Get
Sandbox Report Persistence[] - security
Bypasses GetSandbox Report Security Bypass[] - spywares
Get
Sandbox Report Spyware[] - stealths
Get
Sandbox Report Stealth[] - summaries
Get
Sandbox Report Summary[] - Summary detail report for an MD5 hash of a file that was analyzed by Sandbox
- system
Summaries GetSandbox Report System Summary[] - details string
- (Required) Type of report, full or summary.
- classifications
Sequence[Get
Sandbox Report Classification] - exploits
Sequence[Get
Sandbox Report Exploit] - file_
properties Sequence[GetSandbox Report File Property] - id str
- The provider-assigned unique ID for this managed resource.
- md5_
hash str - (Required) MD5 hash of the file that was analyzed by Sandbox.
- networkings
Sequence[Get
Sandbox Report Networking] - origins
Sequence[Get
Sandbox Report Origin] - persistences
Sequence[Get
Sandbox Report Persistence] - security_
bypasses Sequence[GetSandbox Report Security Bypass] - spywares
Sequence[Get
Sandbox Report Spyware] - stealths
Sequence[Get
Sandbox Report Stealth] - summaries
Sequence[Get
Sandbox Report Summary] - Summary detail report for an MD5 hash of a file that was analyzed by Sandbox
- system_
summaries Sequence[GetSandbox Report System Summary] - details str
- (Required) Type of report, full or summary.
- classifications List<Property Map>
- exploits List<Property Map>
- file
Properties 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>
- security
Bypasses 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
- system
Summaries List<Property Map> - details String
- (Required) Type of report, full or summary.
Supporting Types
GetSandboxReportClassification
- Category string
- Detected
Malware string - Score int
- Type string
- Category string
- Detected
Malware string - Score int
- Type string
- category String
- detected
Malware String - score Integer
- type String
- category string
- detected
Malware string - score number
- type string
- category str
- detected_
malware str - score int
- type str
- category String
- detected
Malware String - score Number
- type String
GetSandboxReportExploit
- Risk string
- Signature string
- Signature
Sources List<string>
- Risk string
- Signature string
- Signature
Sources []string
- risk String
- signature String
- signature
Sources List<String>
- risk string
- signature string
- signature
Sources string[]
- risk str
- signature str
- signature_
sources Sequence[str]
- risk String
- signature String
- signature
Sources List<String>
GetSandboxReportFileProperty
GetSandboxReportNetworking
- Risk string
- Signature string
- Signature
Sources List<string>
- Risk string
- Signature string
- Signature
Sources []string
- risk String
- signature String
- signature
Sources List<String>
- risk string
- signature string
- signature
Sources string[]
- risk str
- signature str
- signature_
sources Sequence[str]
- risk String
- signature String
- signature
Sources List<String>
GetSandboxReportOrigin
GetSandboxReportPersistence
- Risk string
- Signature string
- Signature
Sources List<string>
- Risk string
- Signature string
- Signature
Sources []string
- risk String
- signature String
- signature
Sources List<String>
- risk string
- signature string
- signature
Sources string[]
- risk str
- signature str
- signature_
sources Sequence[str]
- risk String
- signature String
- signature
Sources List<String>
GetSandboxReportSecurityBypass
- Risk string
- Signature string
- Signature
Sources List<string>
- Risk string
- Signature string
- Signature
Sources []string
- risk String
- signature String
- signature
Sources List<String>
- risk string
- signature string
- signature
Sources string[]
- risk str
- signature str
- signature_
sources Sequence[str]
- risk String
- signature String
- signature
Sources List<String>
GetSandboxReportSpyware
- Risk string
- Signature string
- Signature
Sources List<string>
- Risk string
- Signature string
- Signature
Sources []string
- risk String
- signature String
- signature
Sources List<String>
- risk string
- signature string
- signature
Sources string[]
- risk str
- signature str
- signature_
sources Sequence[str]
- risk String
- signature String
- signature
Sources List<String>
GetSandboxReportStealth
- Risk string
- Signature string
- Signature
Sources List<string>
- Risk string
- Signature string
- Signature
Sources []string
- risk String
- signature String
- signature
Sources List<String>
- risk string
- signature string
- signature
Sources string[]
- risk str
- signature str
- signature_
sources Sequence[str]
- risk String
- signature String
- signature
Sources List<String>
GetSandboxReportSummary
- category str
- duration int
- file_
type str - start_
time int - status str
GetSandboxReportSystemSummary
- Risk string
- Signature string
- Signature
Sources List<string>
- Risk string
- Signature string
- Signature
Sources []string
- risk String
- signature String
- signature
Sources List<String>
- risk string
- signature string
- signature
Sources string[]
- risk str
- signature str
- signature_
sources Sequence[str]
- risk String
- signature String
- signature
Sources List<String>
Package Details
- Repository
- zia zscaler/pulumi-zia
- License
- MIT
- Notes
- This Pulumi package is based on the
zia
Terraform Provider.