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>
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:websecurityscanner/v1alpha:getScanConfig
arguments:
# arguments dictionary
The following arguments are supported:
- Scan
Config Id This property is required. string - Project string
- Scan
Config Id This property is required. string - Project string
- scan
Config Id This property is required. String - project String
- scan
Config Id This property is required. string - project string
- scan_
config_ id This property is required. str - project str
- scan
Config Id This property is required. String - project String
getScanConfig Result
The following output properties are available:
- Authentication
Pulumi.
Google Native. Web Security Scanner. V1Alpha. Outputs. Authentication Response - The authentication configuration. If specified, service will use the authentication configuration during scanning.
- Blacklist
Patterns 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
- Display
Name string - The user provided display name of the ScanConfig.
- Latest
Run Pulumi.Google Native. Web Security Scanner. V1Alpha. Outputs. Scan Run Response - 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 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.
Google Native. Web Security Scanner. V1Alpha. Outputs. Schedule Response - The schedule of the ScanConfig.
- Starting
Urls List<string> - The starting URLs from which the scanner finds site pages.
- Target
Platforms List<string> - Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- User
Agent string - The user agent used during scanning.
- Authentication
Authentication
Response - The authentication configuration. If specified, service will use the authentication configuration during scanning.
- Blacklist
Patterns []string - 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 string - The user provided display name of the ScanConfig.
- Latest
Run ScanRun Response - 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 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
Schedule
Response - The schedule of the ScanConfig.
- Starting
Urls []string - The starting URLs from which the scanner finds site pages.
- Target
Platforms []string - Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- User
Agent string - The user agent used during scanning.
- authentication
Authentication
Response - The authentication configuration. If specified, service will use the authentication configuration during scanning.
- blacklist
Patterns 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
- display
Name String - The user provided display name of the ScanConfig.
- latest
Run ScanRun Response - Latest ScanRun if available.
- max
Qps 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
Schedule
Response - The schedule of the ScanConfig.
- starting
Urls List<String> - The starting URLs from which the scanner finds site pages.
- target
Platforms List<String> - Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- user
Agent String - The user agent used during scanning.
- authentication
Authentication
Response - The authentication configuration. If specified, service will use the authentication configuration during scanning.
- blacklist
Patterns string[] - 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 string - The user provided display name of the ScanConfig.
- latest
Run ScanRun Response - Latest ScanRun if available.
- max
Qps 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
Schedule
Response - The schedule of the ScanConfig.
- starting
Urls string[] - The starting URLs from which the scanner finds site pages.
- target
Platforms string[] - Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- user
Agent string - The user agent used during scanning.
- authentication
Authentication
Response - 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 ScanRun Response - 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
Schedule
Response - 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.
- blacklist
Patterns 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
- display
Name String - The user provided display name of the ScanConfig.
- latest
Run Property Map - Latest ScanRun if available.
- max
Qps 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.
- starting
Urls List<String> - The starting URLs from which the scanner finds site pages.
- target
Platforms List<String> - Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- user
Agent String - The user agent used during scanning.
Supporting Types
AuthenticationResponse
- Custom
Account This property is required. Pulumi.Google Native. Web Security Scanner. V1Alpha. Inputs. Custom Account Response - Authentication using a custom account.
- Google
Account This property is required. Pulumi.Google Native. Web Security Scanner. V1Alpha. Inputs. Google Account Response - Authentication using a Google account.
- Custom
Account This property is required. CustomAccount Response - Authentication using a custom account.
- Google
Account This property is required. GoogleAccount Response - Authentication using a Google account.
- custom
Account This property is required. CustomAccount Response - Authentication using a custom account.
- google
Account This property is required. GoogleAccount Response - Authentication using a Google account.
- custom
Account This property is required. CustomAccount Response - Authentication using a custom account.
- google
Account This property is required. GoogleAccount Response - Authentication using a Google account.
- custom_
account This property is required. CustomAccount Response - Authentication using a custom account.
- google_
account This property is required. GoogleAccount Response - Authentication using a Google account.
- custom
Account This property is required. Property Map - Authentication using a custom account.
- google
Account This property is required. Property Map - Authentication using a Google account.
CustomAccountResponse
- Login
Url 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. 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. 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. 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.
- login
Url 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
ScanRunResponse
- End
Time This property is required. string - 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. string - 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. 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.
- 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. string - The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- Start
Time This property is required. string - The time at which the ScanRun started.
- Urls
Crawled Count 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.
- Urls
Tested Count 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. string - 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. string - 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. 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.
- 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. string - The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- Start
Time This property is required. string - The time at which the ScanRun started.
- Urls
Crawled Count 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.
- Urls
Tested Count 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. String - 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. String - The execution state of the ScanRun.
- has
Vulnerabilities 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.
- progress
Percent 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.
- result
State This property is required. String - The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- start
Time This property is required. String - The time at which the ScanRun started.
- urls
Crawled Count 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.
- urls
Tested Count 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. string - 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. string - The execution state of the ScanRun.
- has
Vulnerabilities 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.
- progress
Percent 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.
- result
State This property is required. string - The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- start
Time This property is required. string - The time at which the ScanRun started.
- urls
Crawled Count 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.
- urls
Tested Count 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.
- end
Time This property is required. String - 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. String - The execution state of the ScanRun.
- has
Vulnerabilities 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.
- progress
Percent 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.
- result
State This property is required. String - The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- start
Time This property is required. String - The time at which the ScanRun started.
- urls
Crawled Count 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.
- urls
Tested Count 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
- Interval
Duration Days This property is required. int - The duration of time between executions in days.
- Schedule
Time 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. 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. Integer - The duration of time between executions in days.
- schedule
Time 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. number - The duration of time between executions in days.
- schedule
Time 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.
- interval
Duration Days This property is required. Number - The duration of time between executions in days.
- schedule
Time 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