Parameters (Connect-MicrosoftProject Cmdlet)
The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.
| Property | Description |
| AuthScheme | The scheme used for authentication. Accepted entries are SharePointOnlineCookies,OAuth,OKTA,ADFS,AzureAD and OneLogin. |
| URL | URL to the MS Project Web App. For example, https://MyOrganization.sharepoint.com/sites/pwa/. |
| User | The Microsoft Project user account used to authenticate. |
| Password | The password used to authenticate the user. |
| Property | Description |
| ProjectId | The Id of the default project. This Id will be used by default for all the operations which require the project Id. Can be overridden by providing a query specific ProjectId filter. |
| AuthCookie | The cookie to use for authenticating to the online SharePoint server. |
| Property | Description |
| AzureTenant | The Microsoft Online tenant being used to access data. If not specified, your default tenant is used. |
| AzureEnvironment | The Azure Environment to use when establishing a connection. |
| Property | Description |
| SSOLoginURL | The identity provider's login URL. |
| SSODomain | The domain of the user when using single sign-on (SSO). |
| SSOProperties | Additional properties required to connect to the identity provider, formatted as a semicolon-separated list. |
| Property | Description |
| InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
| 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. |
| OAuthAccessToken | The access token for connecting using OAuth. |
| OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'. |
| CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
| Scope | The scopes used for the OAuth or AzureAD flow. Should be separated with a whitespace. For the OAuth flow, it defaults to the following: ProjectAdmin.Manage Projects.Write ProjectResources.Write ProjectReporting.Read. A list of the available scopes and their aliases can be found here: https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/authorization-code-oauth-flow-for-sharepoint-add-ins?redirectedfrom=MSDN#permission-scope-aliases-and-the-oauthauthorizeaspx-page. For the AzureAD flow, it deafults to the following: offline_access https://MyOrganization.sharepoint.com/ProjectWebApp.FullControl https://MyOrganization.sharepoint.com/AllSites.FullControl. A list of the available Azure scopes can be found under API Permissions > SharePoint when customizing any app in the Azure Portal > App Registrations page. |
| State | Optional value for representing extra OAuth state information. |
| OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
| OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
| OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
| OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port that the proxy server (specified in the ProxyServer connection property) is running on. |
| ProxyAuthScheme | The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connnection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| Schema | The type of schema to use: ODataV1 or ODataV2. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| Property | Description |
| MaxProjectionLength | Set this to override the maximum length of characters supported in the $select system query option by the Microsoft Project API service. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Other | These hidden properties are used only in specific use cases. |
| Pagesize | The maximum number of results to return per page from Microsoft Project. |
| PseudoColumns | Specify a set of pseudocolumns to expose as columns. |
| Readonly | You can use this property to enforce read-only access to Microsoft Project from the provider. |
| RTK | The runtime key used for licensing. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
| UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |