Manage Azure Analysis Services with PowerShell

This article describes PowerShell cmdlets used to perform Azure Analysis Services server and database management tasks.

Server management tasks like creating or deleting a server, suspending or resuming server operations, or changing the service level (tier) use Azure Resource Manager (resource) cmdlets and Analysis Services (server) cmdlets. Other tasks for managing databases like adding or removing role members, processing, or partitioning use cmdlets included in the same SqlServer module as SQL Server Analysis Services.

Note

This article has been updated to use the new Azure PowerShell Az module. To learn more about the new Az module and AzureRM compatibility, see Introducing the new Azure PowerShell Az module. For installation instructions, see Install Azure PowerShell.

Permissions

Most PowerShell tasks require you have Admin privileges on the Analysis Services server you are managing. Scheduled PowerShell tasks are unattended operations. The account or service principal running the scheduler must have Admin privileges on the Analysis Services server.

For server operations using Azure PowerShell cmdlets, your account or the account running scheduler must also belong to the Owner role for the resource in Azure Role-Based Access Control (RBAC).

Resource management operations

Module - Az.AnalysisServices

Cmdlet Description
Get-AzAnalysisServicesServer Gets details of a server instance.
New-AzAnalysisServicesServer Creates a server instance.
New-AzAnalysisServicesFirewallConfig Creates a new Analysis Services firewall config.
New-AzAnalysisServicesFirewallRule Creates a new Analysis Services firewall rule.
Remove-AzAnalysisServicesServer Removes a server instance.
Resume-AzAnalysisServicesServer Resumes a server instance.
Suspend-AzAnalysisServicesServer Suspends a server instance.
Set-AzAnalysisServicesServer Modifies a server instance.
Test-AzAnalysisServicesServer Tests the existence of a server instance.

Server management operations

Module - Azure.AnalysisServices

Cmdlet Description
Add-AzAnalysisServicesAccount Adds an authenticated account to use for Azure Analysis Services server cmdlet requests.
Export-AzAnalysisServicesInstance Exports a log from an instance of Analysis Services server in the currently logged in Environment as specified in Add-AzAnalysisServicesAccount command
Restart-AzAnalysisServicesInstance Restarts an instance of Analysis Services server in the currently logged in environment; specified in Add-AzAnalysisServicesAccount command.
Sync-AzAnalysisServicesInstance Synchronizes a specified database on the specified instance of Analysis Services server to all the query scale-out instances in the currently logged in Environment as specified in Add-AzAnalysisServicesAccount command

Database operations

Azure Analysis Services database operations use the same SqlServer module as SQL Server Analysis Services. However, not all cmdlets are supported for Azure Analysis Services. To learn more, see SQL Server PowerShell.

The SqlServer module provides task-specific database management cmdlets as well as the general-purpose Invoke-ASCmd cmdlet that accepts a Tabular Model Scripting Language (TMSL) query or script. The following cmdlets in the SqlServer module are supported for Azure Analysis Services.

Cmdlet Description
Add-RoleMember Add a member to a database role.
Backup-ASDatabase Backup an Analysis Services database.
Remove-RoleMember Remove a member from a database role.
Invoke-ASCmd Execute a TMSL script.
Invoke-ProcessASDatabase Process a database.
Invoke-ProcessPartition Process a partition.
Invoke-ProcessTable Process a table.
Merge-Partition Merge a partition.
Restore-ASDatabase Restore an Analysis Services database.