1. Packages
  2. Google Cloud Native
  3. API Docs
  4. websecurityscanner
  5. websecurityscanner/v1alpha
  6. getScanConfig

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/v1alpha.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

Gets a ScanConfig.

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.

function getScanConfig(args: GetScanConfigArgs, opts?: InvokeOptions): Promise<GetScanConfigResult>
function getScanConfigOutput(args: GetScanConfigOutputArgs, opts?: InvokeOptions): Output<GetScanConfigResult>
Copy
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]
Copy
func LookupScanConfig(ctx *Context, args *LookupScanConfigArgs, opts ...InvokeOption) (*LookupScanConfigResult, error)
func LookupScanConfigOutput(ctx *Context, args *LookupScanConfigOutputArgs, opts ...InvokeOption) LookupScanConfigResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetScanConfigResult> getScanConfig(GetScanConfigArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Copy
fn::invoke:
  function: google-native:websecurityscanner/v1alpha:getScanConfig
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ScanConfigId This property is required. string
Project string
ScanConfigId This property is required. string
Project string
scanConfigId This property is required. String
project String
scanConfigId This property is required. string
project string
scan_config_id This property is required. str
project str
scanConfigId This property is required. String
project String

getScanConfig Result

The following output properties are available:

Authentication Pulumi.GoogleNative.WebSecurityScanner.V1Alpha.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.
LatestRun Pulumi.GoogleNative.WebSecurityScanner.V1Alpha.Outputs.ScanRunResponse
Latest ScanRun if available.
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.
Schedule Pulumi.GoogleNative.WebSecurityScanner.V1Alpha.Outputs.ScheduleResponse
The schedule of the ScanConfig.
StartingUrls List<string>
The starting URLs from which the scanner finds site pages.
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.
LatestRun ScanRunResponse
Latest ScanRun if available.
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.
Schedule ScheduleResponse
The schedule of the ScanConfig.
StartingUrls []string
The starting URLs from which the scanner finds site pages.
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.
latestRun ScanRunResponse
Latest ScanRun if available.
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.
schedule ScheduleResponse
The schedule of the ScanConfig.
startingUrls List<String>
The starting URLs from which the scanner finds site pages.
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.
latestRun ScanRunResponse
Latest ScanRun if available.
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.
schedule ScheduleResponse
The schedule of the ScanConfig.
startingUrls string[]
The starting URLs from which the scanner finds site pages.
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.
latest_run ScanRunResponse
Latest ScanRun if available.
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.
schedule ScheduleResponse
The schedule of the ScanConfig.
starting_urls Sequence[str]
The starting URLs from which the scanner finds site pages.
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.
latestRun Property Map
Latest ScanRun if available.
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.
schedule Property Map
The schedule of the ScanConfig.
startingUrls List<String>
The starting URLs from which the scanner finds site pages.
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 This property is required. Pulumi.GoogleNative.WebSecurityScanner.V1Alpha.Inputs.CustomAccountResponse
Authentication using a custom account.
GoogleAccount This property is required. Pulumi.GoogleNative.WebSecurityScanner.V1Alpha.Inputs.GoogleAccountResponse
Authentication using a Google account.
CustomAccount This property is required. CustomAccountResponse
Authentication using a custom account.
GoogleAccount This property is required. GoogleAccountResponse
Authentication using a Google account.
customAccount This property is required. CustomAccountResponse
Authentication using a custom account.
googleAccount This property is required. GoogleAccountResponse
Authentication using a Google account.
customAccount This property is required. CustomAccountResponse
Authentication using a custom account.
googleAccount This property is required. GoogleAccountResponse
Authentication using a Google account.
custom_account This property is required. CustomAccountResponse
Authentication using a custom account.
google_account This property is required. GoogleAccountResponse
Authentication using a Google account.
customAccount This property is required. Property Map
Authentication using a custom account.
googleAccount This property is required. Property Map
Authentication using a Google account.

CustomAccountResponse

LoginUrl This property is required. string
The login form URL of the website.
Password This property is required. 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 This property is required. string
The user name of the custom account.
LoginUrl This property is required. string
The login form URL of the website.
Password This property is required. 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 This property is required. string
The user name of the custom account.
loginUrl This property is required. String
The login form URL of the website.
password This property is required. 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 This property is required. String
The user name of the custom account.
loginUrl This property is required. string
The login form URL of the website.
password This property is required. 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 This property is required. string
The user name of the custom account.
login_url This property is required. str
The login form URL of the website.
password This property is required. 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 This property is required. str
The user name of the custom account.
loginUrl This property is required. String
The login form URL of the website.
password This property is required. 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 This property is required. String
The user name of the custom account.

GoogleAccountResponse

Password This property is required. 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 This property is required. string
The user name of the Google account.
Password This property is required. 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 This property is required. string
The user name of the Google account.
password This property is required. 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 This property is required. String
The user name of the Google account.
password This property is required. 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 This property is required. string
The user name of the Google account.
password This property is required. 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 This property is required. str
The user name of the Google account.
password This property is required. 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 This property is required. String
The user name of the Google account.

ScanRunResponse

EndTime This property is required. string
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
ExecutionState This property is required. string
The execution state of the ScanRun.
HasVulnerabilities This property is required. bool
Whether the scan run has found any vulnerabilities.
Name This property is required. 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 This property is required. 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 This property is required. string
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
StartTime This property is required. string
The time at which the ScanRun started.
UrlsCrawledCount This property is required. 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 This property is required. 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.
EndTime This property is required. string
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
ExecutionState This property is required. string
The execution state of the ScanRun.
HasVulnerabilities This property is required. bool
Whether the scan run has found any vulnerabilities.
Name This property is required. 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 This property is required. 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 This property is required. string
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
StartTime This property is required. string
The time at which the ScanRun started.
UrlsCrawledCount This property is required. 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 This property is required. 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.
endTime This property is required. String
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
executionState This property is required. String
The execution state of the ScanRun.
hasVulnerabilities This property is required. Boolean
Whether the scan run has found any vulnerabilities.
name This property is required. 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 This property is required. 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 This property is required. String
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
startTime This property is required. String
The time at which the ScanRun started.
urlsCrawledCount This property is required. 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 This property is required. 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.
endTime This property is required. string
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
executionState This property is required. string
The execution state of the ScanRun.
hasVulnerabilities This property is required. boolean
Whether the scan run has found any vulnerabilities.
name This property is required. 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 This property is required. 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 This property is required. string
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
startTime This property is required. string
The time at which the ScanRun started.
urlsCrawledCount This property is required. 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 This property is required. 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.
end_time This property is required. str
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
execution_state This property is required. str
The execution state of the ScanRun.
has_vulnerabilities This property is required. bool
Whether the scan run has found any vulnerabilities.
name This property is required. 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 This property is required. 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 This property is required. str
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
start_time This property is required. str
The time at which the ScanRun started.
urls_crawled_count This property is required. 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 This property is required. 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.
endTime This property is required. String
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
executionState This property is required. String
The execution state of the ScanRun.
hasVulnerabilities This property is required. Boolean
Whether the scan run has found any vulnerabilities.
name This property is required. 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 This property is required. 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 This property is required. String
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
startTime This property is required. String
The time at which the ScanRun started.
urlsCrawledCount This property is required. 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 This property is required. 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.

ScheduleResponse

IntervalDurationDays This property is required. int
The duration of time between executions in days.
ScheduleTime This property is required. 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 This property is required. int
The duration of time between executions in days.
ScheduleTime This property is required. 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 This property is required. Integer
The duration of time between executions in days.
scheduleTime This property is required. 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 This property is required. number
The duration of time between executions in days.
scheduleTime This property is required. 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 This property is required. int
The duration of time between executions in days.
schedule_time This property is required. 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 This property is required. Number
The duration of time between executions in days.
scheduleTime This property is required. 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