Connect-GoogleSearch
SYNOPSIS
{{ Fill in the Synopsis }}
SYNTAX
Connect-GoogleSearch [-APIKey <String>] [-AuthScheme <String>] [-AutoCache] [-BrowsableSchemas <String>]
[-CacheConnection <String>] [-CacheLocation <String>] [-CacheMetadata] [-CacheProvider <String>]
[-CacheTolerance <Int32>] [-CustomSearchId <String>] [-FirewallPassword <String>] [-FirewallPort <Int32>]
[-FirewallServer <String>] [-FirewallType <String>] [-FirewallUser <String>] [-Location <String>]
[-Logfile <String>] [-LogModules <String>] [-MaxLogFileCount <Int32>] [-MaxLogFileSize <String>]
[-MaxRows <Int32>] [-Offline] [-Other <String>] [-ProxyAuthScheme <String>] [-ProxyAutoDetect <Boolean>]
[-ProxyExceptions <String>] [-ProxyPassword <String>] [-ProxyPort <Int32>] [-ProxyServer <String>]
[-ProxySSLType <String>] [-ProxyUser <String>] [-PseudoColumns <String>] [-RTK <String>]
[-SSLServerCert <String>] [-SupportEnhancedSQL <Boolean>] [-Tables <String>] [-Timeout <Int32>]
[-Verbosity <String>] [-Views <String>] [<CommonParameters>]
DESCRIPTION
{{ Fill in the Description }}
EXAMPLES
Example 1
PS C:\> {{ Add example code here }}
{{ Add example description here }}
PARAMETERS
-APIKey
Your key for the Custom Search API.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AuthScheme
The type of authentication to use when connecting to Google Search.
Type: System.String
Parameter Sets: (All)
Aliases:
Accepted values: Auto, OAuth, OAuthJWT, GCPInstanceAccount
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AutoCache
Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BrowsableSchemas
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CacheConnection
The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CacheLocation
Specifies the path to the cache when caching to a file.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CacheMetadata
This property determines whether or not to cache the table metadata to a file store.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CacheProvider
The name of the provider to be used to cache data.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CacheTolerance
The tolerance for stale data in the cache specified in seconds when using AutoCache .
Type: System.Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CustomSearchId
The Id of the Custom Search engine.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FirewallPassword
A password used to authenticate to a proxy-based firewall.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FirewallPort
The TCP port for a proxy-based firewall.
Type: System.Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FirewallServer
The name or IP address of a proxy-based firewall.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FirewallType
The protocol used by a proxy-based firewall.
Type: System.String
Parameter Sets: (All)
Aliases:
Accepted values: NONE, TUNNEL, SOCKS4, SOCKS5
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FirewallUser
The user name to use to authenticate with a proxy-based firewall.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Location
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LogModules
Core modules to be included in the log file.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Logfile
A filepath which designates the name and location of the log file.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MaxLogFileCount
A string specifying the maximum file count of log files.
Type: System.Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MaxLogFileSize
A string specifying the maximum size in bytes for a log file (for example, 10 MB).
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MaxRows
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Type: System.Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Offline
Use offline mode to get the data from the cache instead of the live source.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Other
These hidden properties are used only in specific use cases.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProxyAuthScheme
The authentication type to use to authenticate to the ProxyServer proxy.
Type: System.String
Parameter Sets: (All)
Aliases:
Accepted values: BASIC, DIGEST, NONE, NEGOTIATE, NTLM, PROPRIETARY
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProxyAutoDetect
This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
Type: System.Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProxyExceptions
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProxyPassword
A password to be used to authenticate to the ProxyServer proxy.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProxyPort
The TCP port the ProxyServer proxy is running on.
Type: System.Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProxySSLType
The SSL type to use when connecting to the ProxyServer proxy.
Type: System.String
Parameter Sets: (All)
Aliases:
Accepted values: AUTO, ALWAYS, NEVER, TUNNEL
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProxyServer
The hostname or IP address of a proxy to route HTTP traffic through.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProxyUser
A user name to be used to authenticate to the ProxyServer proxy.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PseudoColumns
This property indicates whether or not to include pseudo columns as columns to the table.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RTK
The runtime key used for licensing.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SSLServerCert
The certificate to be accepted from the server when connecting using TLS/SSL.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SupportEnhancedSQL
This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Type: System.Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tables
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Timeout
The value in seconds until the timeout error is thrown, canceling the operation.
Type: System.Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Verbosity
The verbosity level that determines the amount of detail included in the log file.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Views
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.