Google Cloud Native v0.32.0, Nov 29 23

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.websecurityscanner/v1beta.getScanConfig

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Using getScanConfig

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.

TypeScript
Python
Go
C#
Java
YAML

function getScanConfig(args: GetScanConfigArgs, opts?: InvokeOptions): Promise<GetScanConfigResult>
function getScanConfigOutput(args: GetScanConfigOutputArgs, opts?: InvokeOptions): Output<GetScanConfigResult>

def get_scan_config(project: Optional[str] = None,
                    scan_config_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetScanConfigResult
def get_scan_config_output(project: Optional[pulumi.Input[str]] = None,
                    scan_config_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetScanConfigResult]

func LookupScanConfig(ctx *Context, args *LookupScanConfigArgs, opts ...InvokeOption) (*LookupScanConfigResult, error)
func LookupScanConfigOutput(ctx *Context, args *LookupScanConfigOutputArgs, opts ...InvokeOption) LookupScanConfigResultOutput

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

public static class GetScanConfig 
{
    public static Task<GetScanConfigResult> InvokeAsync(GetScanConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetScanConfigResult> Invoke(GetScanConfigInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetScanConfigResult> getScanConfig(GetScanConfigArgs args, InvokeOptions options)
public static Output<GetScanConfigResult> getScanConfig(GetScanConfigArgs args, InvokeOptions options)

fn::invoke:
  function: google-native:websecurityscanner/v1beta:getScanConfig
  arguments:
    # arguments dictionary

The following arguments are supported:

ScanConfigId string
Project string

ScanConfigId string
Project string

scanConfigId String
project String

scanConfigId string
project string

scan_config_id str
project str

scanConfigId String
project String

getScanConfig Result

The following output properties are available:

Authentication Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Outputs.AuthenticationResponse: The authentication configuration. If specified, service will use the authentication configuration during scanning.
BlacklistPatterns List<string>: The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
DisplayName string: The user provided display name of the ScanConfig.
ExportToSecurityCommandCenter string: Controls export of scan configurations and results to Security Command Center.
IgnoreHttpStatusErrors bool: Whether to keep scanning even if most requests return HTTP error codes.
LatestRun Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Outputs.ScanRunResponse: Latest ScanRun if available.
ManagedScan bool: Whether the scan config is managed by Web Security Scanner, output only.
MaxQps int: The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
Name string: The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
RiskLevel string: The risk level selected for the scan
Schedule Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Outputs.ScheduleResponse: The schedule of the ScanConfig.
StartingUrls List<string>: The starting URLs from which the scanner finds site pages.
StaticIpScan bool: Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
TargetPlatforms List<string>: Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
UserAgent string: The user agent used during scanning.

Authentication AuthenticationResponse: The authentication configuration. If specified, service will use the authentication configuration during scanning.
BlacklistPatterns []string: The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
DisplayName string: The user provided display name of the ScanConfig.
ExportToSecurityCommandCenter string: Controls export of scan configurations and results to Security Command Center.
IgnoreHttpStatusErrors bool: Whether to keep scanning even if most requests return HTTP error codes.
LatestRun ScanRunResponse: Latest ScanRun if available.
ManagedScan bool: Whether the scan config is managed by Web Security Scanner, output only.
MaxQps int: The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
Name string: The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
RiskLevel string: The risk level selected for the scan
Schedule ScheduleResponse: The schedule of the ScanConfig.
StartingUrls []string: The starting URLs from which the scanner finds site pages.
StaticIpScan bool: Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
TargetPlatforms []string: Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
UserAgent string: The user agent used during scanning.

authentication AuthenticationResponse: The authentication configuration. If specified, service will use the authentication configuration during scanning.
blacklistPatterns List<String>: The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
displayName String: The user provided display name of the ScanConfig.
exportToSecurityCommandCenter String: Controls export of scan configurations and results to Security Command Center.
ignoreHttpStatusErrors Boolean: Whether to keep scanning even if most requests return HTTP error codes.
latestRun ScanRunResponse: Latest ScanRun if available.
managedScan Boolean: Whether the scan config is managed by Web Security Scanner, output only.
maxQps Integer: The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
name String: The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
riskLevel String: The risk level selected for the scan
schedule ScheduleResponse: The schedule of the ScanConfig.
startingUrls List<String>: The starting URLs from which the scanner finds site pages.
staticIpScan Boolean: Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
targetPlatforms List<String>: Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
userAgent String: The user agent used during scanning.

authentication AuthenticationResponse: The authentication configuration. If specified, service will use the authentication configuration during scanning.
blacklistPatterns string[]: The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
displayName string: The user provided display name of the ScanConfig.
exportToSecurityCommandCenter string: Controls export of scan configurations and results to Security Command Center.
ignoreHttpStatusErrors boolean: Whether to keep scanning even if most requests return HTTP error codes.
latestRun ScanRunResponse: Latest ScanRun if available.
managedScan boolean: Whether the scan config is managed by Web Security Scanner, output only.
maxQps number: The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
name string: The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
riskLevel string: The risk level selected for the scan
schedule ScheduleResponse: The schedule of the ScanConfig.
startingUrls string[]: The starting URLs from which the scanner finds site pages.
staticIpScan boolean: Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
targetPlatforms string[]: Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
userAgent string: The user agent used during scanning.

authentication AuthenticationResponse: The authentication configuration. If specified, service will use the authentication configuration during scanning.
blacklist_patterns Sequence[str]: The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
display_name str: The user provided display name of the ScanConfig.
export_to_security_command_center str: Controls export of scan configurations and results to Security Command Center.
ignore_http_status_errors bool: Whether to keep scanning even if most requests return HTTP error codes.
latest_run ScanRunResponse: Latest ScanRun if available.
managed_scan bool: Whether the scan config is managed by Web Security Scanner, output only.
max_qps int: The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
name str: The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
risk_level str: The risk level selected for the scan
schedule ScheduleResponse: The schedule of the ScanConfig.
starting_urls Sequence[str]: The starting URLs from which the scanner finds site pages.
static_ip_scan bool: Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
target_platforms Sequence[str]: Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
user_agent str: The user agent used during scanning.

authentication Property Map: The authentication configuration. If specified, service will use the authentication configuration during scanning.
blacklistPatterns List<String>: The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
displayName String: The user provided display name of the ScanConfig.
exportToSecurityCommandCenter String: Controls export of scan configurations and results to Security Command Center.
ignoreHttpStatusErrors Boolean: Whether to keep scanning even if most requests return HTTP error codes.
latestRun Property Map: Latest ScanRun if available.
managedScan Boolean: Whether the scan config is managed by Web Security Scanner, output only.
maxQps Number: The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
name String: The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
riskLevel String: The risk level selected for the scan
schedule Property Map: The schedule of the ScanConfig.
startingUrls List<String>: The starting URLs from which the scanner finds site pages.
staticIpScan Boolean: Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
targetPlatforms List<String>: Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
userAgent String: The user agent used during scanning.

Supporting Types

AuthenticationResponse

CustomAccount Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.CustomAccountResponse: Authentication using a custom account.
GoogleAccount Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.GoogleAccountResponse: Authentication using a Google account.
IapCredential Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.IapCredentialResponse: Authentication using Identity-Aware-Proxy (IAP).

CustomAccount CustomAccountResponse: Authentication using a custom account.
GoogleAccount GoogleAccountResponse: Authentication using a Google account.
IapCredential IapCredentialResponse: Authentication using Identity-Aware-Proxy (IAP).

customAccount CustomAccountResponse: Authentication using a custom account.
googleAccount GoogleAccountResponse: Authentication using a Google account.
iapCredential IapCredentialResponse: Authentication using Identity-Aware-Proxy (IAP).

customAccount CustomAccountResponse: Authentication using a custom account.
googleAccount GoogleAccountResponse: Authentication using a Google account.
iapCredential IapCredentialResponse: Authentication using Identity-Aware-Proxy (IAP).

custom_account CustomAccountResponse: Authentication using a custom account.
google_account GoogleAccountResponse: Authentication using a Google account.
iap_credential IapCredentialResponse: Authentication using Identity-Aware-Proxy (IAP).

customAccount Property Map: Authentication using a custom account.
googleAccount Property Map: Authentication using a Google account.
iapCredential Property Map: Authentication using Identity-Aware-Proxy (IAP).

CustomAccountResponse

LoginUrl string: The login form URL of the website.
Password string: Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
Username string: The user name of the custom account.

LoginUrl string: The login form URL of the website.
Password string: Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
Username string: The user name of the custom account.

loginUrl String: The login form URL of the website.
password String: Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username String: The user name of the custom account.

loginUrl string: The login form URL of the website.
password string: Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username string: The user name of the custom account.

login_url str: The login form URL of the website.
password str: Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username str: The user name of the custom account.

loginUrl String: The login form URL of the website.
password String: Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username String: The user name of the custom account.

GoogleAccountResponse

Password string: Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
Username string: The user name of the Google account.

Password string: Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
Username string: The user name of the Google account.

password String: Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username String: The user name of the Google account.

password string: Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username string: The user name of the Google account.

password str: Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username str: The user name of the Google account.

password String: Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
username String: The user name of the Google account.

IapCredentialResponse

IapTestServiceAccountInfo Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.IapTestServiceAccountInfoResponse: Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

IapTestServiceAccountInfo IapTestServiceAccountInfoResponse: Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

iapTestServiceAccountInfo IapTestServiceAccountInfoResponse: Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

iapTestServiceAccountInfo IapTestServiceAccountInfoResponse: Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

iap_test_service_account_info IapTestServiceAccountInfoResponse: Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

iapTestServiceAccountInfo Property Map: Authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

IapTestServiceAccountInfoResponse

TargetAudienceClientId string: Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

TargetAudienceClientId string: Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

targetAudienceClientId String: Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

targetAudienceClientId string: Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

target_audience_client_id str: Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

targetAudienceClientId String: Describes OAuth2 Client ID of resources protected by Identity-Aware-Proxy(IAP).

ScanConfigErrorResponse

Code string: Indicates the reason code for a configuration failure.
FieldName string: Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.

Code string: Indicates the reason code for a configuration failure.
FieldName string: Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.

code String: Indicates the reason code for a configuration failure.
fieldName String: Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.

code string: Indicates the reason code for a configuration failure.
fieldName string: Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.

code str: Indicates the reason code for a configuration failure.
field_name str: Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.

code String: Indicates the reason code for a configuration failure.
fieldName String: Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.

ScanRunErrorTraceResponse

Code string: Indicates the error reason code.
MostCommonHttpErrorCode int: If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
ScanConfigError Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.ScanConfigErrorResponse: If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.

Code string: Indicates the error reason code.
MostCommonHttpErrorCode int: If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
ScanConfigError ScanConfigErrorResponse: If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.

code String: Indicates the error reason code.
mostCommonHttpErrorCode Integer: If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
scanConfigError ScanConfigErrorResponse: If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.

code string: Indicates the error reason code.
mostCommonHttpErrorCode number: If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
scanConfigError ScanConfigErrorResponse: If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.

code str: Indicates the error reason code.
most_common_http_error_code int: If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
scan_config_error ScanConfigErrorResponse: If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.

code String: Indicates the error reason code.
mostCommonHttpErrorCode Number: If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
scanConfigError Property Map: If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.

ScanRunResponse

EndTime string: The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
ErrorTrace Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.ScanRunErrorTraceResponse: If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
ExecutionState string: The execution state of the ScanRun.
HasVulnerabilities bool: Whether the scan run has found any vulnerabilities.
Name string: The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
ProgressPercent int: The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
ResultState string: The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
StartTime string: The time at which the ScanRun started.
UrlsCrawledCount string: The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
UrlsTestedCount string: The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
WarningTraces List<Pulumi.GoogleNative.WebSecurityScanner.V1Beta.Inputs.ScanRunWarningTraceResponse>: A list of warnings, if such are encountered during this scan run.

EndTime string: The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
ErrorTrace ScanRunErrorTraceResponse: If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
ExecutionState string: The execution state of the ScanRun.
HasVulnerabilities bool: Whether the scan run has found any vulnerabilities.
Name string: The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
ProgressPercent int: The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
ResultState string: The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
StartTime string: The time at which the ScanRun started.
UrlsCrawledCount string: The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
UrlsTestedCount string: The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
WarningTraces []ScanRunWarningTraceResponse: A list of warnings, if such are encountered during this scan run.

endTime String: The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
errorTrace ScanRunErrorTraceResponse: If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
executionState String: The execution state of the ScanRun.
hasVulnerabilities Boolean: Whether the scan run has found any vulnerabilities.
name String: The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
progressPercent Integer: The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
resultState String: The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
startTime String: The time at which the ScanRun started.
urlsCrawledCount String: The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
urlsTestedCount String: The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
warningTraces List<ScanRunWarningTraceResponse>: A list of warnings, if such are encountered during this scan run.

endTime string: The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
errorTrace ScanRunErrorTraceResponse: If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
executionState string: The execution state of the ScanRun.
hasVulnerabilities boolean: Whether the scan run has found any vulnerabilities.
name string: The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
progressPercent number: The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
resultState string: The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
startTime string: The time at which the ScanRun started.
urlsCrawledCount string: The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
urlsTestedCount string: The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
warningTraces ScanRunWarningTraceResponse[]: A list of warnings, if such are encountered during this scan run.

end_time str: The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
error_trace ScanRunErrorTraceResponse: If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
execution_state str: The execution state of the ScanRun.
has_vulnerabilities bool: Whether the scan run has found any vulnerabilities.
name str: The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
progress_percent int: The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
result_state str: The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
start_time str: The time at which the ScanRun started.
urls_crawled_count str: The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
urls_tested_count str: The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
warning_traces Sequence[ScanRunWarningTraceResponse]: A list of warnings, if such are encountered during this scan run.

endTime String: The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
errorTrace Property Map: If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
executionState String: The execution state of the ScanRun.
hasVulnerabilities Boolean: Whether the scan run has found any vulnerabilities.
name String: The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
progressPercent Number: The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
resultState String: The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
startTime String: The time at which the ScanRun started.
urlsCrawledCount String: The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
urlsTestedCount String: The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
warningTraces List<Property Map>: A list of warnings, if such are encountered during this scan run.

ScanRunWarningTraceResponse

Code string: Indicates the warning code.

Code string: Indicates the warning code.

code String: Indicates the warning code.

code string: Indicates the warning code.

code str: Indicates the warning code.

code String: Indicates the warning code.

ScheduleResponse

IntervalDurationDays int: The duration of time between executions in days.
ScheduleTime string: A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.

IntervalDurationDays int: The duration of time between executions in days.
ScheduleTime string: A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.

intervalDurationDays Integer: The duration of time between executions in days.
scheduleTime String: A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.

intervalDurationDays number: The duration of time between executions in days.
scheduleTime string: A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.

interval_duration_days int: The duration of time between executions in days.
schedule_time str: A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.

intervalDurationDays Number: The duration of time between executions in days.
scheduleTime String: A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.websecurityscanner/v1beta.getScanConfig

On this page

On this page

Using getScanConfig

getScanConfig Result

Supporting Types

AuthenticationResponse

CustomAccountResponse

GoogleAccountResponse

IapCredentialResponse

IapTestServiceAccountInfoResponse

ScanConfigErrorResponse

ScanRunErrorTraceResponse

ScanRunResponse

ScanRunWarningTraceResponse

ScheduleResponse

Package Details

On this page

On this page