Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Invoke-ProcessCube
- Module:
- SqlServer Module
Conducts the Process operation on a specified Cube of a specific database with a specific ProcessType value.
Syntax
ParameterSetName (Default)
Invoke-ProcessCube
[-Name] <String>
[-Database] <String>
[-ProcessType] <ProcessType>
[-Server <String>]
[-Credential <PSCredential>]
[-ServicePrincipal]
[-ApplicationId <String>]
[-TenantId <String>]
[-CertificateThumbprint <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ParameterSetInputObject
Invoke-ProcessCube
[-ProcessType] <ProcessType>
-DatabaseCube <Cube>
[-Server <String>]
[-Credential <PSCredential>]
[-ServicePrincipal]
[-ApplicationId <String>]
[-TenantId <String>]
[-CertificateThumbprint <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ParameterSetTabularName
Invoke-ProcessCube
[-Database] <String>
[-RefreshType] <RefreshType>
[-Server <String>]
[-Credential <PSCredential>]
[-ServicePrincipal]
[-ApplicationId <String>]
[-TenantId <String>]
[-CertificateThumbprint <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ParameterSetTabularInputObject
Invoke-ProcessCube
[-RefreshType] <RefreshType>
[-Server <String>]
[-Credential <PSCredential>]
[-ServicePrincipal]
[-ApplicationId <String>]
[-TenantId <String>]
[-CertificateThumbprint <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Conducts the Process operation on a specific Cube of a specific database with a specific ProcessType value depending upon the input values.
Module requirements: version 21+ on PowerShell 5.1; version 21 (recent preview) or version 22+ on PowerShell 7.x.
Examples
Process cube from pipeline
PS SQLSERVER:\SQLAS\MachineName\Instance\Databases\DB1\Cubes\Cube1> Get-Item . | Invoke-ProcessCube -ProcessType:ProcessDefault
Invoke cube using name
PS SQLSERVER:\SQLAS\MachineName\Instance\Databases\DB1\Cubes> Invoke-ProcessCube -Name "myCube" -Database "Db1" -ProcessType "ProcessDefault"
Parameters
-ApplicationId
The application Id for the service principal.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CertificateThumbprint
The certificate thumbprint for the service principal.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-Credential
If this parameter is specified, the user name and password passed will be used to connect to specified Analysis Server instance.
If no credentials are specified default windows account of the user who is running the tool will be used.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Database
Database name to which the Cube belongs to.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DatabaseCube
Microsoft.AnalysisServices.Cube object that has to be processed.
Parameter properties
| Type: | Cube |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Name of the Cube that has to be processed.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ProcessType
Analysis Services ProcessType value.
Parameter properties
| Type: | ProcessType |
| Default value: | None |
| Accepted values: | ProcessFull, ProcessAdd, ProcessUpdate, ProcessIndexes, ProcessData, ProcessDefault, ProcessClear, ProcessStructure, ProcessClearStructureOnly, ProcessScriptCache, ProcessRecalc, ProcessDefrag |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RefreshType
The type of refresh.
Parameter properties
| Type: | RefreshType |
| Default value: | None |
| Accepted values: | Full, ClearValues, Calculate, DataOnly, Automatic, Add, Defragment |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Server
Optionally specifies the server instance to connect to if not currently in the SQLAS Provider directory.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ServicePrincipal
Specifies that this connection is using service principal.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TenantId
The tenant Id for the service principal.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.AnalysisServices.Cube
Feedback
Was this page helpful?