Cmdlets for OData

Build 20.0.7654

Parameters (Connect-OData Cmdlet)

The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.

Parameter Required Description
AuthKey    The authentication secret used to request and obtain the OAuth Access Token. 
AuthScheme  True  The scheme used for authentication. Accepted entries are NTLM, BASIC, DIGEST, NONE, NEGOTIATE, or SHAREPOINTONLINE. 
AuthToken    The authentication token used to request and obtain the OAuth Access Token. 
AutoCache    Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . 
AzureADTenant    The Azure Active Directory tenant to authenticate against (only used with Azure AD OAuth). 
AzureResource  True  The Azure Active resource to authenticate to (used during Azure OAuth exchange). 
AzureTenant  True  The Microsoft Online tenant being used to access data. If not specified, your default tentant will be used. 
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. 
CacheLocation    Specifies the path to the cache when caching to a file. 
CacheMetadata    This property determines whether or not to cache the table metadata to a file store. 
CacheProvider    The name of the provider to be used to cache data. 
CacheTolerance    The tolerance for stale data in the cache specified in seconds when using AutoCache . 
CallbackURL    The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. 
ContinueOnError    Whether or not to continue after encountering an error on a batch request. 
Cookies    Allows cookies to be manually specified in name=value pairs separated by a semicolon. 
CustomHeaders    Other headers as determined by the user (optional). 
CustomUrlParams    The custom query string to be included in the request. 
DataFormat    The data format to retrieve data in. Select either ATOM or JSON. 
FirewallPassword    A password used to authenticate to a proxy-based firewall. 
FirewallPort    The TCP port for a proxy-based firewall. 
FirewallServer    The name or IP address of a proxy-based firewall. 
FirewallType    The protocol used by a proxy-based firewall. 
FirewallUser    The user name to use to authenticate with a proxy-based firewall. 
IncludeNavigationParentColumns    Indicates if navigation parent columns should be included on navigation views. 
InitiateOAuth    Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. 
KerberosKDC    The Kerberos Key Distribution Center (KDC) service used to authenticate the user. 
KerberosKeytabFile    The Keytab file containing your pairs of Kerberos principals and encrypted keys. 
KerberosRealm    The Kerberos Realm used to authenticate the user with. 
KerberosServiceKDC    The Kerberos KDC of the service. 
KerberosServiceRealm    The Kerberos realm of the service. 
KerberosSPN    The service principal name (SPN) for the Kerberos Domain Controller. 
KerberosTicketCache    The full file path to an MIT Kerberos credential cache file. 
Location    A path to the directory that contains the schema files defining tables, views, and stored procedures. 
Logfile    A filepath which designates the name and location of the log file. 
LogModules    Core modules to be included in the log file. 
MaxLogFileCount    A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. 
MaxLogFileSize    A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. 
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. 
NavigationPropertiesAsViews    A boolean indicating navigation properties should be promoted to full views. 
OAuthAccessToken    The access token for connecting using OAuth. 
OAuthAccessTokenSecret    The OAuth access token secret for connecting using OAuth. 
OAuthAccessTokenURL    The URL to retrieve the OAuth access token from. 
OAuthAuthorizationURL    The authorization URL for the OAuth service. 
OAuthClientId    The client ID assigned when you register your application with an OAuth authorization server. 
OAuthClientSecret    The client secret assigned when you register your application with an OAuth authorization server. 
OAuthGrantType    The grant type for the OAuth flow. 
OAuthParams    A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value. 
OAuthRefreshToken    The OAuth refresh token for the corresponding OAuth access token. 
OAuthRefreshTokenURL    The URL to refresh the OAuth token from. 
OAuthRequestTokenURL    The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0. 
OAuthSettingsLocation    The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://. 
OAuthVerifier    The verifier code returned from the OAuth authorization URL. 
OAuthVersion    The version of OAuth being used. 
ODataVersion    The version of OData to use. By default the provider will attempt to autodetect the version. 
Offline    Use offline mode to get the data from the cache instead of the live source. 
Other    These hidden properties are used only in specific use cases. 
Pagesize    The maximum number of results to return per page from OData. 
Password  True  The password used to authenticate the user. 
ProxyAuthScheme    The authentication type to use to authenticate to the ProxyServer proxy. 
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. 
ProxyExceptions    A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . 
ProxyPassword    A password to be used to authenticate to the ProxyServer proxy. 
ProxyPort    The TCP port the ProxyServer proxy is running on. 
ProxyServer    The hostname or IP address of a proxy to route HTTP traffic through. 
ProxySSLType    The SSL type to use when connecting to the ProxyServer proxy. 
ProxyUser    A user name to be used to authenticate to the ProxyServer proxy. 
PseudoColumns    This property indicates whether or not to include pseudo columns as columns to the table. 
Readonly    You can use this property to enforce read-only access to OData from the provider. 
RTK    The runtime key used for licensing. 
ServerTimeZone    The timezone by which the server's Edm.DateTime values are represented. The value of this property will affect how Edm.DateTime filters and results are converted between the server and the client machine. 
SharePointSSODomain    The domain of the user when using single sign-on (SSO). 
SharePointUseSSO    Whether or not to use single sign-on (SSO) to authenticate to SharePoint Online. 
SSLClientCert    The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). 
SSLClientCertPassword    The password for the TLS/SSL client certificate. 
SSLClientCertSubject    The subject of the TLS/SSL client certificate. 
SSLClientCertType    The type of key store containing the TLS/SSL client certificate. 
SSLServerCert    The certificate to be accepted from the server when connecting using TLS/SSL. 
StoredProceduresAsViews    A boolean indicating if we should list stored procedures which return a collection of entities as views. 
SupportEnhancedSQL    This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. 
SupportsExpand    Whether you need to specify the base entity's key to query navigation property views. 
SupportsFormulas    A boolean indicating if the odata service supports server side formulas. 
Tables    This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. 
Timeout    The value in seconds until the timeout error is thrown, canceling the operation. 
URL  True  URL to the Organization root or the OData services file. For example, http://MySite/MyOrganization. 
UseClientSidePaging    Whether or not the CData ADO.NET Provider for OData should use client side paging. 
UseEtags    Whether or not the OData source uses Etags. 
User  True  The OData user account used to authenticate. 
UseSimpleNames    Boolean determining if simple names should be used for tables and columns. 
Verbosity    The verbosity level that determines the amount of detail included in the log file. 
Views    Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. 

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7654