Docs Packages
  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
pulumi/pulumi-google-native

google-native.websecurityscanner/v1alpha.getScanConfig

Explore with Pulumi AI

google-native logo

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

    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:

    ScanConfigId string
    Project string
    ScanConfigId string
    Project string
    scanConfigId String
    project String
    scanConfigId string
    project string
    scanConfigId 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 CustomAccountResponse
    Authentication using a custom account.
    GoogleAccount GoogleAccountResponse
    Authentication using a Google account.
    customAccount CustomAccountResponse
    Authentication using a custom account.
    googleAccount GoogleAccountResponse
    Authentication using a Google account.
    customAccount CustomAccountResponse
    Authentication using a custom account.
    googleAccount GoogleAccountResponse
    Authentication using a Google account.
    custom_account CustomAccountResponse
    Authentication using a custom account.
    google_account GoogleAccountResponse
    Authentication using a Google account.
    customAccount Property Map
    Authentication using a custom account.
    googleAccount Property Map
    Authentication using a Google account.

    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.

    ScanRunResponse

    EndTime string
    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
    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.
    EndTime string
    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
    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.
    endTime String
    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
    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.
    endTime string
    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
    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.
    end_time str
    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
    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.
    endTime String
    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
    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.

    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-native logo

    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