getAssessment

dome9 1.40.4, Oct 30 25

dome9 1.40.4 published on Thursday, Oct 30, 2025 by dome9

Schema (JSON)

dome9/terraform-provider-dome9

dome9 1.40.4 published on Thursday, Oct 30, 2025 by dome9

Schema (JSON)

dome9/terraform-provider-dome9

Example Usage

Basic usage:

import * as pulumi from "@pulumi/pulumi";
import * as dome9 from "@pulumi/dome9";

const test = dome9.getAssessment({
    id: ASSESSMENT_ID,
});

import pulumi
import pulumi_dome9 as dome9

test = dome9.get_assessment(id=assessmen_t__id)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/dome9/dome9"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dome9.LookupAssessment(ctx, &dome9.LookupAssessmentArgs{
			Id: ASSESSMENT_ID,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Dome9 = Pulumi.Dome9;

return await Deployment.RunAsync(() => 
{
    var test = Dome9.GetAssessment.Invoke(new()
    {
        Id = ASSESSMENT_ID,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dome9.Dome9Functions;
import com.pulumi.dome9.inputs.GetAssessmentArgs;
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 test = Dome9Functions.getAssessment(GetAssessmentArgs.builder()
            .id(ASSESSMENT_ID)
            .build());

    }
}

variables:
  test:
    fn::invoke:
      function: dome9:getAssessment
      arguments:
        id: ${ASSESSMENT_ID}

Using getAssessment

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 getAssessment(args: GetAssessmentArgs, opts?: InvokeOptions): Promise<GetAssessmentResult>
function getAssessmentOutput(args: GetAssessmentOutputArgs, opts?: InvokeOptions): Output<GetAssessmentResult>

def get_assessment(id: Optional[float] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAssessmentResult
def get_assessment_output(id: Optional[pulumi.Input[float]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetAssessmentResult]

func LookupAssessment(ctx *Context, args *LookupAssessmentArgs, opts ...InvokeOption) (*LookupAssessmentResult, error)
func LookupAssessmentOutput(ctx *Context, args *LookupAssessmentOutputArgs, opts ...InvokeOption) LookupAssessmentResultOutput

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

public static class GetAssessment 
{
    public static Task<GetAssessmentResult> InvokeAsync(GetAssessmentArgs args, InvokeOptions? opts = null)
    public static Output<GetAssessmentResult> Invoke(GetAssessmentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAssessmentResult> getAssessment(GetAssessmentArgs args, InvokeOptions options)
public static Output<GetAssessmentResult> getAssessment(GetAssessmentArgs args, InvokeOptions options)

fn::invoke:
  function: dome9:index/getAssessment:getAssessment
  arguments:
    # arguments dictionary

The following arguments are supported:

Id double: Assessment id.

Id float64: Assessment id.

id Double: Assessment id.

id number: Assessment id.

id float: Assessment id.

id Number: Assessment id.

getAssessment Result

The following output properties are available:

AdditionalFields Dictionary<string, string>: Additional fields.
AssessmentId string: Assessment id.
AssessmentPassed bool: Is assessment_passed. True/False.
BundleId double
CloudAccountId string: Cloud account id to run the ruleset on.
CloudAccountType string
ComparisonCustomId string: Comparison custom id.
CreatedTime string: Date of assessment.
DataSyncStatuses List<GetAssessmentDataSyncStatus>: Data sync status - list of entities.
Description string: Rule description.
Dome9CloudAccountId string: dome9 cloud account id to run the ruleset on.
Exclusions List<GetAssessmentExclusion>: List of exclusions associated with this assessment.
ExternalCloudAccountId string: External cloud account id.
HasDataSyncStatusIssues bool: Is has data sync status issues. True/False.
HasErrors bool: Is assessment has errors. True/False.
Id double: Rule ID.
LocationMetadatas List<GetAssessmentLocationMetadata>
Name string: Entity name.
Remediations List<GetAssessmentRemediation>: List of remediations associated with this assessment.
RequestId string: Request id.
Requests List<GetAssessmentRequest>: Request content.
ShouldMinimizeResult bool: Should minimize result size.
Stats List<GetAssessmentStat>: Summary statistics for assessment.
Tests List<GetAssessmentTest>: List of all the tests that have been run.
TriggeredBy string: Reason for assessment.

AdditionalFields map[string]string: Additional fields.
AssessmentId string: Assessment id.
AssessmentPassed bool: Is assessment_passed. True/False.
BundleId float64
CloudAccountId string: Cloud account id to run the ruleset on.
CloudAccountType string
ComparisonCustomId string: Comparison custom id.
CreatedTime string: Date of assessment.
DataSyncStatuses []GetAssessmentDataSyncStatus: Data sync status - list of entities.
Description string: Rule description.
Dome9CloudAccountId string: dome9 cloud account id to run the ruleset on.
Exclusions []GetAssessmentExclusion: List of exclusions associated with this assessment.
ExternalCloudAccountId string: External cloud account id.
HasDataSyncStatusIssues bool: Is has data sync status issues. True/False.
HasErrors bool: Is assessment has errors. True/False.
Id float64: Rule ID.
LocationMetadatas []GetAssessmentLocationMetadata
Name string: Entity name.
Remediations []GetAssessmentRemediation: List of remediations associated with this assessment.
RequestId string: Request id.
Requests []GetAssessmentRequest: Request content.
ShouldMinimizeResult bool: Should minimize result size.
Stats []GetAssessmentStat: Summary statistics for assessment.
Tests []GetAssessmentTest: List of all the tests that have been run.
TriggeredBy string: Reason for assessment.

additionalFields Map<String,String>: Additional fields.
assessmentId String: Assessment id.
assessmentPassed Boolean: Is assessment_passed. True/False.
bundleId Double
cloudAccountId String: Cloud account id to run the ruleset on.
cloudAccountType String
comparisonCustomId String: Comparison custom id.
createdTime String: Date of assessment.
dataSyncStatuses List<GetAssessmentDataSyncStatus>: Data sync status - list of entities.
description String: Rule description.
dome9CloudAccountId String: dome9 cloud account id to run the ruleset on.
exclusions List<GetAssessmentExclusion>: List of exclusions associated with this assessment.
externalCloudAccountId String: External cloud account id.
hasDataSyncStatusIssues Boolean: Is has data sync status issues. True/False.
hasErrors Boolean: Is assessment has errors. True/False.
id Double: Rule ID.
locationMetadatas List<GetAssessmentLocationMetadata>
name String: Entity name.
remediations List<GetAssessmentRemediation>: List of remediations associated with this assessment.
requestId String: Request id.
requests List<GetAssessmentRequest>: Request content.
shouldMinimizeResult Boolean: Should minimize result size.
stats List<GetAssessmentStat>: Summary statistics for assessment.
tests List<GetAssessmentTest>: List of all the tests that have been run.
triggeredBy String: Reason for assessment.

additionalFields {[key: string]: string}: Additional fields.
assessmentId string: Assessment id.
assessmentPassed boolean: Is assessment_passed. True/False.
bundleId number
cloudAccountId string: Cloud account id to run the ruleset on.
cloudAccountType string
comparisonCustomId string: Comparison custom id.
createdTime string: Date of assessment.
dataSyncStatuses GetAssessmentDataSyncStatus[]: Data sync status - list of entities.
description string: Rule description.
dome9CloudAccountId string: dome9 cloud account id to run the ruleset on.
exclusions GetAssessmentExclusion[]: List of exclusions associated with this assessment.
externalCloudAccountId string: External cloud account id.
hasDataSyncStatusIssues boolean: Is has data sync status issues. True/False.
hasErrors boolean: Is assessment has errors. True/False.
id number: Rule ID.
locationMetadatas GetAssessmentLocationMetadata[]
name string: Entity name.
remediations GetAssessmentRemediation[]: List of remediations associated with this assessment.
requestId string: Request id.
requests GetAssessmentRequest[]: Request content.
shouldMinimizeResult boolean: Should minimize result size.
stats GetAssessmentStat[]: Summary statistics for assessment.
tests GetAssessmentTest[]: List of all the tests that have been run.
triggeredBy string: Reason for assessment.

additional_fields Mapping[str, str]: Additional fields.
assessment_id str: Assessment id.
assessment_passed bool: Is assessment_passed. True/False.
bundle_id float
cloud_account_id str: Cloud account id to run the ruleset on.
cloud_account_type str
comparison_custom_id str: Comparison custom id.
created_time str: Date of assessment.
data_sync_statuses Sequence[GetAssessmentDataSyncStatus]: Data sync status - list of entities.
description str: Rule description.
dome9_cloud_account_id str: dome9 cloud account id to run the ruleset on.
exclusions Sequence[GetAssessmentExclusion]: List of exclusions associated with this assessment.
external_cloud_account_id str: External cloud account id.
has_data_sync_status_issues bool: Is has data sync status issues. True/False.
has_errors bool: Is assessment has errors. True/False.
id float: Rule ID.
location_metadatas Sequence[GetAssessmentLocationMetadata]
name str: Entity name.
remediations Sequence[GetAssessmentRemediation]: List of remediations associated with this assessment.
request_id str: Request id.
requests Sequence[GetAssessmentRequest]: Request content.
should_minimize_result bool: Should minimize result size.
stats Sequence[GetAssessmentStat]: Summary statistics for assessment.
tests Sequence[GetAssessmentTest]: List of all the tests that have been run.
triggered_by str: Reason for assessment.

additionalFields Map<String>: Additional fields.
assessmentId String: Assessment id.
assessmentPassed Boolean: Is assessment_passed. True/False.
bundleId Number
cloudAccountId String: Cloud account id to run the ruleset on.
cloudAccountType String
comparisonCustomId String: Comparison custom id.
createdTime String: Date of assessment.
dataSyncStatuses List<Property Map>: Data sync status - list of entities.
description String: Rule description.
dome9CloudAccountId String: dome9 cloud account id to run the ruleset on.
exclusions List<Property Map>: List of exclusions associated with this assessment.
externalCloudAccountId String: External cloud account id.
hasDataSyncStatusIssues Boolean: Is has data sync status issues. True/False.
hasErrors Boolean: Is assessment has errors. True/False.
id Number: Rule ID.
locationMetadatas List<Property Map>
name String: Entity name.
remediations List<Property Map>: List of remediations associated with this assessment.
requestId String: Request id.
requests List<Property Map>: Request content.
shouldMinimizeResult Boolean: Should minimize result size.
stats List<Property Map>: Summary statistics for assessment.
tests List<Property Map>: List of all the tests that have been run.
triggeredBy String: Reason for assessment.

Supporting Types

GetAssessmentDataSyncStatus

EntitiesWithPermissionIssues List<GetAssessmentDataSyncStatusEntitiesWithPermissionIssue>: List entities with permission issues.
EntityType string: Entity type.
GeneralFetchPermissionIssues bool: Is general fetch permission issues. True/False.
RecentlySuccessfulSync bool: Is recently successful sync. True/False.

EntitiesWithPermissionIssues []GetAssessmentDataSyncStatusEntitiesWithPermissionIssue: List entities with permission issues.
EntityType string: Entity type.
GeneralFetchPermissionIssues bool: Is general fetch permission issues. True/False.
RecentlySuccessfulSync bool: Is recently successful sync. True/False.

entitiesWithPermissionIssues List<GetAssessmentDataSyncStatusEntitiesWithPermissionIssue>: List entities with permission issues.
entityType String: Entity type.
generalFetchPermissionIssues Boolean: Is general fetch permission issues. True/False.
recentlySuccessfulSync Boolean: Is recently successful sync. True/False.

entitiesWithPermissionIssues GetAssessmentDataSyncStatusEntitiesWithPermissionIssue[]: List entities with permission issues.
entityType string: Entity type.
generalFetchPermissionIssues boolean: Is general fetch permission issues. True/False.
recentlySuccessfulSync boolean: Is recently successful sync. True/False.

entities_with_permission_issues Sequence[GetAssessmentDataSyncStatusEntitiesWithPermissionIssue]: List entities with permission issues.
entity_type str: Entity type.
general_fetch_permission_issues bool: Is general fetch permission issues. True/False.
recently_successful_sync bool: Is recently successful sync. True/False.

entitiesWithPermissionIssues List<Property Map>: List entities with permission issues.
entityType String: Entity type.
generalFetchPermissionIssues Boolean: Is general fetch permission issues. True/False.
recentlySuccessfulSync Boolean: Is recently successful sync. True/False.

GetAssessmentDataSyncStatusEntitiesWithPermissionIssue

CloudVendorIdentifier string: Entity cloud vendor identifier.
ExternalId string: Entity external id.
Name string: Entity name.

CloudVendorIdentifier string: Entity cloud vendor identifier.
ExternalId string: Entity external id.
Name string: Entity name.

cloudVendorIdentifier String: Entity cloud vendor identifier.
externalId String: Entity external id.
name String: Entity name.

cloudVendorIdentifier string: Entity cloud vendor identifier.
externalId string: Entity external id.
name string: Entity name.

cloud_vendor_identifier str: Entity cloud vendor identifier.
external_id str: Entity external id.
name str: Entity name.

cloudVendorIdentifier String: Entity cloud vendor identifier.
externalId String: Entity external id.
name String: Entity name.

GetAssessmentExclusion

CloudAccountIds List<string>: List of cloud account IDs to apply exclusion on.
Comment string: Comment text (free text).
DateRanges List<GetAssessmentExclusionDateRange>: Effective date range for the exclusion.
Id double: Assessment id.
LogicExpressions List<string>: The GSL logic expressions of the exclusion.
OrganizationalUnitIds List<string>: List of organizational unit IDs to apply exclusion on.
Platform string
Rules List<GetAssessmentExclusionRule>: List of rules to apply the exclusion on.
RulesetId double: Ruleset ID to apply exclusion on.

CloudAccountIds []string: List of cloud account IDs to apply exclusion on.
Comment string: Comment text (free text).
DateRanges []GetAssessmentExclusionDateRange: Effective date range for the exclusion.
Id float64: Assessment id.
LogicExpressions []string: The GSL logic expressions of the exclusion.
OrganizationalUnitIds []string: List of organizational unit IDs to apply exclusion on.
Platform string
Rules []GetAssessmentExclusionRule: List of rules to apply the exclusion on.
RulesetId float64: Ruleset ID to apply exclusion on.

cloudAccountIds List<String>: List of cloud account IDs to apply exclusion on.
comment String: Comment text (free text).
dateRanges List<GetAssessmentExclusionDateRange>: Effective date range for the exclusion.
id Double: Assessment id.
logicExpressions List<String>: The GSL logic expressions of the exclusion.
organizationalUnitIds List<String>: List of organizational unit IDs to apply exclusion on.
platform String
rules List<GetAssessmentExclusionRule>: List of rules to apply the exclusion on.
rulesetId Double: Ruleset ID to apply exclusion on.

cloudAccountIds string[]: List of cloud account IDs to apply exclusion on.
comment string: Comment text (free text).
dateRanges GetAssessmentExclusionDateRange[]: Effective date range for the exclusion.
id number: Assessment id.
logicExpressions string[]: The GSL logic expressions of the exclusion.
organizationalUnitIds string[]: List of organizational unit IDs to apply exclusion on.
platform string
rules GetAssessmentExclusionRule[]: List of rules to apply the exclusion on.
rulesetId number: Ruleset ID to apply exclusion on.

cloud_account_ids Sequence[str]: List of cloud account IDs to apply exclusion on.
comment str: Comment text (free text).
date_ranges Sequence[GetAssessmentExclusionDateRange]: Effective date range for the exclusion.
id float: Assessment id.
logic_expressions Sequence[str]: The GSL logic expressions of the exclusion.
organizational_unit_ids Sequence[str]: List of organizational unit IDs to apply exclusion on.
platform str
rules Sequence[GetAssessmentExclusionRule]: List of rules to apply the exclusion on.
ruleset_id float: Ruleset ID to apply exclusion on.

cloudAccountIds List<String>: List of cloud account IDs to apply exclusion on.
comment String: Comment text (free text).
dateRanges List<Property Map>: Effective date range for the exclusion.
id Number: Assessment id.
logicExpressions List<String>: The GSL logic expressions of the exclusion.
organizationalUnitIds List<String>: List of organizational unit IDs to apply exclusion on.
platform String
rules List<Property Map>: List of rules to apply the exclusion on.
rulesetId Number: Ruleset ID to apply exclusion on.

GetAssessmentExclusionDateRange

From string: From date time.
To string: To date time.

From string: From date time.
To string: To date time.

from String: From date time.
to String: To date time.

from string: From date time.
to string: To date time.

from_ str: From date time.
to str: To date time.

from String: From date time.
to String: To date time.

GetAssessmentExclusionRule

Id double: Assessment id.
LogicHash string: Rule logic hash.
Name string: Entity name.

Id float64: Assessment id.
LogicHash string: Rule logic hash.
Name string: Entity name.

id Double: Assessment id.
logicHash String: Rule logic hash.
name String: Entity name.

id number: Assessment id.
logicHash string: Rule logic hash.
name string: Entity name.

id float: Assessment id.
logic_hash str: Rule logic hash.
name str: Entity name.

id Number: Assessment id.
logicHash String: Rule logic hash.
name String: Entity name.

GetAssessmentLocationMetadata

Accounts List<GetAssessmentLocationMetadataAccount>

Accounts []GetAssessmentLocationMetadataAccount

accounts List<GetAssessmentLocationMetadataAccount>

accounts GetAssessmentLocationMetadataAccount[]

accounts Sequence[GetAssessmentLocationMetadataAccount]

accounts List<Property Map>

GetAssessmentLocationMetadataAccount

ExternalId string: Entity external id.
Id string: Assessment id.
Name string: Entity name.
Srl string

ExternalId string: Entity external id.
Id string: Assessment id.
Name string: Entity name.
Srl string

externalId String: Entity external id.
id String: Assessment id.
name String: Entity name.
srl String

externalId string: Entity external id.
id string: Assessment id.
name string: Entity name.
srl string

external_id str: Entity external id.
id str: Assessment id.
name str: Entity name.
srl str

externalId String: Entity external id.
id String: Assessment id.
name String: Entity name.
srl String

GetAssessmentRemediation

CloudAccountIds List<string>: List of cloud account IDs to apply exclusion on.
CloudBots List<string>: Cloud bots execution expressions.
Comment string: Comment text (free text).
DateRanges List<GetAssessmentRemediationDateRange>: Effective date range for the exclusion.
Id double: Assessment id.
LogicExpressions List<string>: The GSL logic expressions of the exclusion.
OrganizationalUnitIds List<string>: List of organizational unit IDs to apply exclusion on.
Platform string
Rules List<GetAssessmentRemediationRule>: List of rules to apply the exclusion on.
RulesetId double: Ruleset ID to apply exclusion on.

CloudAccountIds []string: List of cloud account IDs to apply exclusion on.
CloudBots []string: Cloud bots execution expressions.
Comment string: Comment text (free text).
DateRanges []GetAssessmentRemediationDateRange: Effective date range for the exclusion.
Id float64: Assessment id.
LogicExpressions []string: The GSL logic expressions of the exclusion.
OrganizationalUnitIds []string: List of organizational unit IDs to apply exclusion on.
Platform string
Rules []GetAssessmentRemediationRule: List of rules to apply the exclusion on.
RulesetId float64: Ruleset ID to apply exclusion on.

cloudAccountIds List<String>: List of cloud account IDs to apply exclusion on.
cloudBots List<String>: Cloud bots execution expressions.
comment String: Comment text (free text).
dateRanges List<GetAssessmentRemediationDateRange>: Effective date range for the exclusion.
id Double: Assessment id.
logicExpressions List<String>: The GSL logic expressions of the exclusion.
organizationalUnitIds List<String>: List of organizational unit IDs to apply exclusion on.
platform String
rules List<GetAssessmentRemediationRule>: List of rules to apply the exclusion on.
rulesetId Double: Ruleset ID to apply exclusion on.

cloudAccountIds string[]: List of cloud account IDs to apply exclusion on.
cloudBots string[]: Cloud bots execution expressions.
comment string: Comment text (free text).
dateRanges GetAssessmentRemediationDateRange[]: Effective date range for the exclusion.
id number: Assessment id.
logicExpressions string[]: The GSL logic expressions of the exclusion.
organizationalUnitIds string[]: List of organizational unit IDs to apply exclusion on.
platform string
rules GetAssessmentRemediationRule[]: List of rules to apply the exclusion on.
rulesetId number: Ruleset ID to apply exclusion on.

cloud_account_ids Sequence[str]: List of cloud account IDs to apply exclusion on.
cloud_bots Sequence[str]: Cloud bots execution expressions.
comment str: Comment text (free text).
date_ranges Sequence[GetAssessmentRemediationDateRange]: Effective date range for the exclusion.
id float: Assessment id.
logic_expressions Sequence[str]: The GSL logic expressions of the exclusion.
organizational_unit_ids Sequence[str]: List of organizational unit IDs to apply exclusion on.
platform str
rules Sequence[GetAssessmentRemediationRule]: List of rules to apply the exclusion on.
ruleset_id float: Ruleset ID to apply exclusion on.

cloudAccountIds List<String>: List of cloud account IDs to apply exclusion on.
cloudBots List<String>: Cloud bots execution expressions.
comment String: Comment text (free text).
dateRanges List<Property Map>: Effective date range for the exclusion.
id Number: Assessment id.
logicExpressions List<String>: The GSL logic expressions of the exclusion.
organizationalUnitIds List<String>: List of organizational unit IDs to apply exclusion on.
platform String
rules List<Property Map>: List of rules to apply the exclusion on.
rulesetId Number: Ruleset ID to apply exclusion on.

GetAssessmentRemediationDateRange

From string: From date time.
To string: To date time.

From string: From date time.
To string: To date time.

from String: From date time.
to String: To date time.

from string: From date time.
to string: To date time.

from_ str: From date time.
to str: To date time.

from String: From date time.
to String: To date time.

GetAssessmentRemediationRule

Id double: Assessment id.
LogicHash string: Rule logic hash.
Name string: Entity name.

Id float64: Assessment id.
LogicHash string: Rule logic hash.
Name string: Entity name.

id Double: Assessment id.
logicHash String: Rule logic hash.
name String: Entity name.

id number: Assessment id.
logicHash string: Rule logic hash.
name string: Entity name.

id float: Assessment id.
logic_hash str: Rule logic hash.
name str: Entity name.

id Number: Assessment id.
logicHash String: Rule logic hash.
name String: Entity name.

GetAssessmentRequest

CloudAccountId string: Cloud account id to run the ruleset on.
CloudAccountType string
Description string: Rule description.
Dome9CloudAccountId string: dome9 cloud account id to run the ruleset on.
ExternalCloudAccountId string: External cloud account id.
Id double: Assessment id.
IsTemplate bool: Is CloudGuard template ruleset.
Name string: Entity name.
RequestId string: Request id.
ShouldMinimizeResult bool: Should minimize result size.

CloudAccountId string: Cloud account id to run the ruleset on.
CloudAccountType string
Description string: Rule description.
Dome9CloudAccountId string: dome9 cloud account id to run the ruleset on.
ExternalCloudAccountId string: External cloud account id.
Id float64: Assessment id.
IsTemplate bool: Is CloudGuard template ruleset.
Name string: Entity name.
RequestId string: Request id.
ShouldMinimizeResult bool: Should minimize result size.

cloudAccountId String: Cloud account id to run the ruleset on.
cloudAccountType String
description String: Rule description.
dome9CloudAccountId String: dome9 cloud account id to run the ruleset on.
externalCloudAccountId String: External cloud account id.
id Double: Assessment id.
isTemplate Boolean: Is CloudGuard template ruleset.
name String: Entity name.
requestId String: Request id.
shouldMinimizeResult Boolean: Should minimize result size.

cloudAccountId string: Cloud account id to run the ruleset on.
cloudAccountType string
description string: Rule description.
dome9CloudAccountId string: dome9 cloud account id to run the ruleset on.
externalCloudAccountId string: External cloud account id.
id number: Assessment id.
isTemplate boolean: Is CloudGuard template ruleset.
name string: Entity name.
requestId string: Request id.
shouldMinimizeResult boolean: Should minimize result size.

cloud_account_id str: Cloud account id to run the ruleset on.
cloud_account_type str
description str: Rule description.
dome9_cloud_account_id str: dome9 cloud account id to run the ruleset on.
external_cloud_account_id str: External cloud account id.
id float: Assessment id.
is_template bool: Is CloudGuard template ruleset.
name str: Entity name.
request_id str: Request id.
should_minimize_result bool: Should minimize result size.

cloudAccountId String: Cloud account id to run the ruleset on.
cloudAccountType String
description String: Rule description.
dome9CloudAccountId String: dome9 cloud account id to run the ruleset on.
externalCloudAccountId String: External cloud account id.
id Number: Assessment id.
isTemplate Boolean: Is CloudGuard template ruleset.
name String: Entity name.
requestId String: Request id.
shouldMinimizeResult Boolean: Should minimize result size.

GetAssessmentStat

Error double: Number of errors
ExcludedFailedTests double: Number of excluded tests that also failed.
ExcludedRules double: Number of rules that contains only excluded tests.
ExcludedRulesBySeverities List<GetAssessmentStatExcludedRulesBySeverity>: Excluded rules divided by severity.
ExcludedTests double: Number of excluded tests.
Failed double: Number of failed rules.
FailedEntities double: Number of failed entities.
FailedRulesBySeverities List<GetAssessmentStatFailedRulesBySeverity>: Failed rules divided by severity.
FailedTests double: Number of failed tests.
LogicallyTested double: Total number of tests performed.
Passed double: Number of passed rules.
PassedRulesBySeverities List<GetAssessmentStatPassedRulesBySeverity>: Passed rules divided by severity.

Error float64: Number of errors
ExcludedFailedTests float64: Number of excluded tests that also failed.
ExcludedRules float64: Number of rules that contains only excluded tests.
ExcludedRulesBySeverities []GetAssessmentStatExcludedRulesBySeverity: Excluded rules divided by severity.
ExcludedTests float64: Number of excluded tests.
Failed float64: Number of failed rules.
FailedEntities float64: Number of failed entities.
FailedRulesBySeverities []GetAssessmentStatFailedRulesBySeverity: Failed rules divided by severity.
FailedTests float64: Number of failed tests.
LogicallyTested float64: Total number of tests performed.
Passed float64: Number of passed rules.
PassedRulesBySeverities []GetAssessmentStatPassedRulesBySeverity: Passed rules divided by severity.

error Double: Number of errors
excludedFailedTests Double: Number of excluded tests that also failed.
excludedRules Double: Number of rules that contains only excluded tests.
excludedRulesBySeverities List<GetAssessmentStatExcludedRulesBySeverity>: Excluded rules divided by severity.
excludedTests Double: Number of excluded tests.
failed Double: Number of failed rules.
failedEntities Double: Number of failed entities.
failedRulesBySeverities List<GetAssessmentStatFailedRulesBySeverity>: Failed rules divided by severity.
failedTests Double: Number of failed tests.
logicallyTested Double: Total number of tests performed.
passed Double: Number of passed rules.
passedRulesBySeverities List<GetAssessmentStatPassedRulesBySeverity>: Passed rules divided by severity.

error number: Number of errors
excludedFailedTests number: Number of excluded tests that also failed.
excludedRules number: Number of rules that contains only excluded tests.
excludedRulesBySeverities GetAssessmentStatExcludedRulesBySeverity[]: Excluded rules divided by severity.
excludedTests number: Number of excluded tests.
failed number: Number of failed rules.
failedEntities number: Number of failed entities.
failedRulesBySeverities GetAssessmentStatFailedRulesBySeverity[]: Failed rules divided by severity.
failedTests number: Number of failed tests.
logicallyTested number: Total number of tests performed.
passed number: Number of passed rules.
passedRulesBySeverities GetAssessmentStatPassedRulesBySeverity[]: Passed rules divided by severity.

error float: Number of errors
excluded_failed_tests float: Number of excluded tests that also failed.
excluded_rules float: Number of rules that contains only excluded tests.
excluded_rules_by_severities Sequence[GetAssessmentStatExcludedRulesBySeverity]: Excluded rules divided by severity.
excluded_tests float: Number of excluded tests.
failed float: Number of failed rules.
failed_entities float: Number of failed entities.
failed_rules_by_severities Sequence[GetAssessmentStatFailedRulesBySeverity]: Failed rules divided by severity.
failed_tests float: Number of failed tests.
logically_tested float: Total number of tests performed.
passed float: Number of passed rules.
passed_rules_by_severities Sequence[GetAssessmentStatPassedRulesBySeverity]: Passed rules divided by severity.

error Number: Number of errors
excludedFailedTests Number: Number of excluded tests that also failed.
excludedRules Number: Number of rules that contains only excluded tests.
excludedRulesBySeverities List<Property Map>: Excluded rules divided by severity.
excludedTests Number: Number of excluded tests.
failed Number: Number of failed rules.
failedEntities Number: Number of failed entities.
failedRulesBySeverities List<Property Map>: Failed rules divided by severity.
failedTests Number: Number of failed tests.
logicallyTested Number: Total number of tests performed.
passed Number: Number of passed rules.
passedRulesBySeverities List<Property Map>: Passed rules divided by severity.

GetAssessmentStatExcludedRulesBySeverity

Critical double: Critical.
High double: High.
Informational double: Informational.
Low double: Low.
Medium double: Medium.

Critical float64: Critical.
High float64: High.
Informational float64: Informational.
Low float64: Low.
Medium float64: Medium.

critical Double: Critical.
high Double: High.
informational Double: Informational.
low Double: Low.
medium Double: Medium.

critical number: Critical.
high number: High.
informational number: Informational.
low number: Low.
medium number: Medium.

critical float: Critical.
high float: High.
informational float: Informational.
low float: Low.
medium float: Medium.

critical Number: Critical.
high Number: High.
informational Number: Informational.
low Number: Low.
medium Number: Medium.

GetAssessmentStatFailedRulesBySeverity

Critical double: Critical.
High double: High.
Informational double: Informational.
Low double: Low.
Medium double: Medium.

Critical float64: Critical.
High float64: High.
Informational float64: Informational.
Low float64: Low.
Medium float64: Medium.

critical Double: Critical.
high Double: High.
informational Double: Informational.
low Double: Low.
medium Double: Medium.

critical number: Critical.
high number: High.
informational number: Informational.
low number: Low.
medium number: Medium.

critical float: Critical.
high float: High.
informational float: Informational.
low float: Low.
medium float: Medium.

critical Number: Critical.
high Number: High.
informational Number: Informational.
low Number: Low.
medium Number: Medium.

GetAssessmentStatPassedRulesBySeverity

Critical double: Critical.
High double: High.
Informational double: Informational.
Low double: Low.
Medium double: Medium.

Critical float64: Critical.
High float64: High.
Informational float64: Informational.
Low float64: Low.
Medium float64: Medium.

critical Double: Critical.
high Double: High.
informational Double: Informational.
low Double: Low.
medium Double: Medium.

critical number: Critical.
high number: High.
informational number: Informational.
low number: Low.
medium number: Medium.

critical float: Critical.
high float: High.
informational float: Informational.
low float: Low.
medium float: Medium.

critical Number: Critical.
high Number: High.
informational Number: Informational.
low Number: Low.
medium Number: Medium.

GetAssessmentTest

EntityResults List<GetAssessmentTestEntityResult>: Entity results.
Error string: Number of errors
ExclusionStats List<GetAssessmentTestExclusionStat>: Exclusion stats.
NonComplyingCount double: Number of assets that has been non-complying to the test.
RelevantCount double: Number of assets that has been relevant to the test.
Rules List<GetAssessmentTestRule>: Rule.
TestPassed bool: Is test passed: true/false.
TestedCount double: Number of assets that has been excluded from the test.

EntityResults []GetAssessmentTestEntityResult: Entity results.
Error string: Number of errors
ExclusionStats []GetAssessmentTestExclusionStat: Exclusion stats.
NonComplyingCount float64: Number of assets that has been non-complying to the test.
RelevantCount float64: Number of assets that has been relevant to the test.
Rules []GetAssessmentTestRule: Rule.
TestPassed bool: Is test passed: true/false.
TestedCount float64: Number of assets that has been excluded from the test.

entityResults List<GetAssessmentTestEntityResult>: Entity results.
error String: Number of errors
exclusionStats List<GetAssessmentTestExclusionStat>: Exclusion stats.
nonComplyingCount Double: Number of assets that has been non-complying to the test.
relevantCount Double: Number of assets that has been relevant to the test.
rules List<GetAssessmentTestRule>: Rule.
testPassed Boolean: Is test passed: true/false.
testedCount Double: Number of assets that has been excluded from the test.

entityResults GetAssessmentTestEntityResult[]: Entity results.
error string: Number of errors
exclusionStats GetAssessmentTestExclusionStat[]: Exclusion stats.
nonComplyingCount number: Number of assets that has been non-complying to the test.
relevantCount number: Number of assets that has been relevant to the test.
rules GetAssessmentTestRule[]: Rule.
testPassed boolean: Is test passed: true/false.
testedCount number: Number of assets that has been excluded from the test.

entity_results Sequence[GetAssessmentTestEntityResult]: Entity results.
error str: Number of errors
exclusion_stats Sequence[GetAssessmentTestExclusionStat]: Exclusion stats.
non_complying_count float: Number of assets that has been non-complying to the test.
relevant_count float: Number of assets that has been relevant to the test.
rules Sequence[GetAssessmentTestRule]: Rule.
test_passed bool: Is test passed: true/false.
tested_count float: Number of assets that has been excluded from the test.

entityResults List<Property Map>: Entity results.
error String: Number of errors
exclusionStats List<Property Map>: Exclusion stats.
nonComplyingCount Number: Number of assets that has been non-complying to the test.
relevantCount Number: Number of assets that has been relevant to the test.
rules List<Property Map>: Rule.
testPassed Boolean: Is test passed: true/false.
testedCount Number: Number of assets that has been excluded from the test.

GetAssessmentTestEntityResult

Error string: Number of errors
ExclusionId string: Guid, can be Null.
IsExcluded bool: Means if entity is excluded. for example for rule="Instance should have vpc exclude name='test'", return true if instance name is test, and false if not.
IsRelevant bool: Means if entity is relevant for this rule. for example rule = "Instance where name like '%db%' should have...", returns false in instance name = 'scheduler1'.
IsValid bool: Means if entity is compliant. for example for rule="Instance should have vpc", return true if instance i-123 is under vpc-234, and false if not.
RemediationId string: Guid, can be Null.
TestObjs List<GetAssessmentTestEntityResultTestObj>: The object that has been tested.
ValidationStatus string: Can be: Relevant, Valid, Excluded.

Error string: Number of errors
ExclusionId string: Guid, can be Null.
IsExcluded bool: Means if entity is excluded. for example for rule="Instance should have vpc exclude name='test'", return true if instance name is test, and false if not.
IsRelevant bool: Means if entity is relevant for this rule. for example rule = "Instance where name like '%db%' should have...", returns false in instance name = 'scheduler1'.
IsValid bool: Means if entity is compliant. for example for rule="Instance should have vpc", return true if instance i-123 is under vpc-234, and false if not.
RemediationId string: Guid, can be Null.
TestObjs []GetAssessmentTestEntityResultTestObj: The object that has been tested.
ValidationStatus string: Can be: Relevant, Valid, Excluded.

error String: Number of errors
exclusionId String: Guid, can be Null.
isExcluded Boolean: Means if entity is excluded. for example for rule="Instance should have vpc exclude name='test'", return true if instance name is test, and false if not.
isRelevant Boolean: Means if entity is relevant for this rule. for example rule = "Instance where name like '%db%' should have...", returns false in instance name = 'scheduler1'.
isValid Boolean: Means if entity is compliant. for example for rule="Instance should have vpc", return true if instance i-123 is under vpc-234, and false if not.
remediationId String: Guid, can be Null.
testObjs List<GetAssessmentTestEntityResultTestObj>: The object that has been tested.
validationStatus String: Can be: Relevant, Valid, Excluded.

error string: Number of errors
exclusionId string: Guid, can be Null.
isExcluded boolean: Means if entity is excluded. for example for rule="Instance should have vpc exclude name='test'", return true if instance name is test, and false if not.
isRelevant boolean: Means if entity is relevant for this rule. for example rule = "Instance where name like '%db%' should have...", returns false in instance name = 'scheduler1'.
isValid boolean: Means if entity is compliant. for example for rule="Instance should have vpc", return true if instance i-123 is under vpc-234, and false if not.
remediationId string: Guid, can be Null.
testObjs GetAssessmentTestEntityResultTestObj[]: The object that has been tested.
validationStatus string: Can be: Relevant, Valid, Excluded.

error str: Number of errors
exclusion_id str: Guid, can be Null.
is_excluded bool: Means if entity is excluded. for example for rule="Instance should have vpc exclude name='test'", return true if instance name is test, and false if not.
is_relevant bool: Means if entity is relevant for this rule. for example rule = "Instance where name like '%db%' should have...", returns false in instance name = 'scheduler1'.
is_valid bool: Means if entity is compliant. for example for rule="Instance should have vpc", return true if instance i-123 is under vpc-234, and false if not.
remediation_id str: Guid, can be Null.
test_objs Sequence[GetAssessmentTestEntityResultTestObj]: The object that has been tested.
validation_status str: Can be: Relevant, Valid, Excluded.

error String: Number of errors
exclusionId String: Guid, can be Null.
isExcluded Boolean: Means if entity is excluded. for example for rule="Instance should have vpc exclude name='test'", return true if instance name is test, and false if not.
isRelevant Boolean: Means if entity is relevant for this rule. for example rule = "Instance where name like '%db%' should have...", returns false in instance name = 'scheduler1'.
isValid Boolean: Means if entity is compliant. for example for rule="Instance should have vpc", return true if instance i-123 is under vpc-234, and false if not.
remediationId String: Guid, can be Null.
testObjs List<Property Map>: The object that has been tested.
validationStatus String: Can be: Relevant, Valid, Excluded.

GetAssessmentTestEntityResultTestObj

CustomEntityComparisonHash string: Custom entity comparison hash of the object.
Dome9Id string: Dome9 id of the object.
EntityIndex double: Entity index of the object.
EntityType string: Entity type.
Id string: Assessment id.

CustomEntityComparisonHash string: Custom entity comparison hash of the object.
Dome9Id string: Dome9 id of the object.
EntityIndex float64: Entity index of the object.
EntityType string: Entity type.
Id string: Assessment id.

customEntityComparisonHash String: Custom entity comparison hash of the object.
dome9Id String: Dome9 id of the object.
entityIndex Double: Entity index of the object.
entityType String: Entity type.
id String: Assessment id.

customEntityComparisonHash string: Custom entity comparison hash of the object.
dome9Id string: Dome9 id of the object.
entityIndex number: Entity index of the object.
entityType string: Entity type.
id string: Assessment id.

custom_entity_comparison_hash str: Custom entity comparison hash of the object.
dome9_id str: Dome9 id of the object.
entity_index float: Entity index of the object.
entity_type str: Entity type.
id str: Assessment id.

customEntityComparisonHash String: Custom entity comparison hash of the object.
dome9Id String: Dome9 id of the object.
entityIndex Number: Entity index of the object.
entityType String: Entity type.
id String: Assessment id.

GetAssessmentTestExclusionStat

NonComplyingCount double: Number of assets that has been non-complying to the test.
RelevantCount double: Number of assets that has been relevant to the test.
TestedCount double: Number of assets that has been excluded from the test.

NonComplyingCount float64: Number of assets that has been non-complying to the test.
RelevantCount float64: Number of assets that has been relevant to the test.
TestedCount float64: Number of assets that has been excluded from the test.

nonComplyingCount Double: Number of assets that has been non-complying to the test.
relevantCount Double: Number of assets that has been relevant to the test.
testedCount Double: Number of assets that has been excluded from the test.

nonComplyingCount number: Number of assets that has been non-complying to the test.
relevantCount number: Number of assets that has been relevant to the test.
testedCount number: Number of assets that has been excluded from the test.

non_complying_count float: Number of assets that has been non-complying to the test.
relevant_count float: Number of assets that has been relevant to the test.
tested_count float: Number of assets that has been excluded from the test.

nonComplyingCount Number: Number of assets that has been non-complying to the test.
relevantCount Number: Number of assets that has been relevant to the test.
testedCount Number: Number of assets that has been excluded from the test.

GetAssessmentTestRule

Category string: Rule category.
Cloudbots string: Rule cloudbots.
ComplianceTag string: Compliance tag.
ControlTitle string: Control title.
Description string: Rule description.
Domain string: Rule domain.
IsDefault bool: Is default rule.
Labels List<string>: Rule labels.
Logic string: Rule logic.
LogicHash string: Rule logic hash.
Name string: Entity name.
Priority string: Rule priority.
Remediation string: Rule remediation.
RuleId string: Rule id.
Severity string: Rule severity.

Category string: Rule category.
Cloudbots string: Rule cloudbots.
ComplianceTag string: Compliance tag.
ControlTitle string: Control title.
Description string: Rule description.
Domain string: Rule domain.
IsDefault bool: Is default rule.
Labels []string: Rule labels.
Logic string: Rule logic.
LogicHash string: Rule logic hash.
Name string: Entity name.
Priority string: Rule priority.
Remediation string: Rule remediation.
RuleId string: Rule id.
Severity string: Rule severity.

category String: Rule category.
cloudbots String: Rule cloudbots.
complianceTag String: Compliance tag.
controlTitle String: Control title.
description String: Rule description.
domain String: Rule domain.
isDefault Boolean: Is default rule.
labels List<String>: Rule labels.
logic String: Rule logic.
logicHash String: Rule logic hash.
name String: Entity name.
priority String: Rule priority.
remediation String: Rule remediation.
ruleId String: Rule id.
severity String: Rule severity.

category string: Rule category.
cloudbots string: Rule cloudbots.
complianceTag string: Compliance tag.
controlTitle string: Control title.
description string: Rule description.
domain string: Rule domain.
isDefault boolean: Is default rule.
labels string[]: Rule labels.
logic string: Rule logic.
logicHash string: Rule logic hash.
name string: Entity name.
priority string: Rule priority.
remediation string: Rule remediation.
ruleId string: Rule id.
severity string: Rule severity.

category str: Rule category.
cloudbots str: Rule cloudbots.
compliance_tag str: Compliance tag.
control_title str: Control title.
description str: Rule description.
domain str: Rule domain.
is_default bool: Is default rule.
labels Sequence[str]: Rule labels.
logic str: Rule logic.
logic_hash str: Rule logic hash.
name str: Entity name.
priority str: Rule priority.
remediation str: Rule remediation.
rule_id str: Rule id.
severity str: Rule severity.

category String: Rule category.
cloudbots String: Rule cloudbots.
complianceTag String: Compliance tag.
controlTitle String: Control title.
description String: Rule description.
domain String: Rule domain.
isDefault Boolean: Is default rule.
labels List<String>: Rule labels.
logic String: Rule logic.
logicHash String: Rule logic hash.
name String: Entity name.
priority String: Rule priority.
remediation String: Rule remediation.
ruleId String: Rule id.
severity String: Rule severity.

Package Details

Repository: dome9 dome9/terraform-provider-dome9
License
Notes: This Pulumi package is based on the dome9 Terraform Provider.

dome9 1.40.4 published on Thursday, Oct 30, 2025 by dome9

Schema (JSON)

dome9/terraform-provider-dome9

dome9.getAssessment

On this page

On this page

Example Usage

Using getAssessment

getAssessment Result

Supporting Types

GetAssessmentDataSyncStatus

GetAssessmentDataSyncStatusEntitiesWithPermissionIssue

GetAssessmentExclusion

GetAssessmentExclusionDateRange

GetAssessmentExclusionRule

GetAssessmentLocationMetadata

GetAssessmentLocationMetadataAccount

GetAssessmentRemediation

GetAssessmentRemediationDateRange

GetAssessmentRemediationRule

GetAssessmentRequest

GetAssessmentStat

GetAssessmentStatExcludedRulesBySeverity

GetAssessmentStatFailedRulesBySeverity

GetAssessmentStatPassedRulesBySeverity

GetAssessmentTest

GetAssessmentTestEntityResult

GetAssessmentTestEntityResultTestObj

GetAssessmentTestExclusionStat

GetAssessmentTestRule

Package Details

On this page

On this page