Invoke-ProcessDimension
Conducts the Process operation on a specified Cube of a specific database with a specific ProcessType value.
Syntax
ParameterSetName (Default)
Invoke-ProcessDimension
[-Name] <String>
[-Database] <String>
[-ProcessType] <ProcessType>
[-Server <String>]
[-Credential <PSCredential>]
[-ServicePrincipal]
[-ApplicationId <String>]
[-TenantId <String>]
[-CertificateThumbprint <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-ProcessDimension
[-ProcessType] <ProcessType>
-DatabaseDimension <Dimension>
[-Server <String>]
[-Credential <PSCredential>]
[-ServicePrincipal]
[-ApplicationId <String>]
[-TenantId <String>]
[-CertificateThumbprint <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ParameterSetTabularName
Invoke-ProcessDimension
[-Database] <String>
[-RefreshType] <RefreshType>
[-Server <String>]
[-Credential <PSCredential>]
[-ServicePrincipal]
[-ApplicationId <String>]
[-TenantId <String>]
[-CertificateThumbprint <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-ProcessDimension
[-RefreshType] <RefreshType>
[-Server <String>]
[-Credential <PSCredential>]
[-ServicePrincipal]
[-ApplicationId <String>]
[-TenantId <String>]
[-CertificateThumbprint <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Conducts the Process operation on a specific Dimension 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
Example 1
PS SQL SERVER:\sqlas\locahost\default\Databases\AWTEST\Dimensions\Account> Get-Item . | Invoke-ProcessDimension -ProcessType ProcessDefault
This command retrieves the specified dimension object via the pipeline and processes it.
Example 2
PS SQL SERVER:\sqlas\locahost\default\Databases\AWTEST\Dimensions > Invoke-ProcessDimension -Name Customer -Database AWTEST -ProcessType ProcessDefault
This command identifies a specific dimension that will be processed.
Parameters
-ApplicationId
The application Id for the service principal.
Parameter properties
| Type: | String
|
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CertificateThumbprint
The certificate thumbprint for the service principal.
Parameter properties
| Type: | String
|
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Database
The database name to which the Dimension belongs to.
Parameter properties
| Type: | String
|
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ParameterSetName
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
ParameterSetTabularName
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabaseDimension
The Microsoft.AnalysisServices.Dimension object that has to be processed.
Parameter properties
| Type: | Dimension
|
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ParameterSetInputObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Name of the Dimension that has to be processed.
Parameter properties
| Type: | String
|
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ParameterSetName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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
ParameterSetName
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
ParameterSetInputObject
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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
ParameterSetTabularName
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
ParameterSetTabularInputObject
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ServicePrincipal
Specifies that this connection is using service principal.
Parameter properties
| Type: | SwitchParameter
|
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TenantId
The tenant Id for the service principal.
Parameter properties
| Type: | String
|
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets