Azure Analysis Services CLI Reference

This document provides a comprehensive reference for the Azure Analysis Services command-line interface (CLI) commands. Use these commands to manage your Azure Analysis Services resources programmatically.

The Azure CLI is a powerful tool for managing Azure resources. You can use it to create, configure, and manage resources such as Azure Analysis Services servers, databases, and security settings.

az analysiservices

Manage Azure Analysis Services.

az analysiservices [group] [--help] [--output {json, jsonc, table, tsv, yaml, yml}] [--query ] [--verbose] [--version]

Global arguments for all commands.

az analysiservices create

Create an Azure Analysis Services server.

az analysiservices create --name --resource-group [--format {default, tabular}] [--location ] [--scale-type {Classic, Premium, Standard}] [--sku {D1, S1, S2, S3, P1, P2, P3}] [--tags ] [--version {2017-06-01, 2017-07-01, 2017-07-10, 2017-08-01, 2017-08-01-preview, 2017-09-01, 2017-10-01, 2017-11-01, 2017-12-01, 2018-01-01, 2018-01-30, 2018-02-01, 2018-03-01, 2018-04-01, 2018-05-01, 2018-06-01, 2018-07-01, 2018-08-01, 2018-09-01, 2018-10-01, 2018-11-01, 2019-01-01, 2019-02-01, 2019-03-01, 2019-04-01, 2019-05-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-10-01, 2019-11-01, 2019-12-01, 2020-01-01, 2020-01-31, 2020-02-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-09-01, 2020-10-01, 2020-11-01, 2020-12-01, 2021-01-01, 2021-02-01, 2021-03-01, 2021-04-01, 2021-05-01, 2021-06-01, 2021-07-01, 2021-08-01, 2021-09-01, 2021-10-01, 2021-11-01, 2021-12-01, 2022-01-01, 2022-02-01, 2022-03-01, 2022-04-01, 2022-05-01, 2022-06-01, 2022-07-01, 2022-08-01, 2022-09-01, 2022-10-01, 2022-11-01, 2022-12-01, 2023-01-01, 2023-02-01, 2023-03-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-07-01, 2023-08-01, 2023-09-01, 2023-10-01, 2023-11-01, 2023-12-01, 2024-01-01, 2024-02-01, 2024-03-01, 2024-04-01}]

Parameters

  • --name -n The name of the Analysis Services server.
  • --resource-group -g Name of resource group.
  • --location -l Location of the resource.
  • --sku The sku name of the Analysis Services server.
  • --scale-type The scale type of the Analysis Services server.
  • --tags Space-separated tags in 'key[=value]' format.

Examples

az analysiservices create -n myASServer -g myResourceGroup -l westus2 --sku S1

Create a new Azure Analysis Services server.

az analysiservices delete

Delete an Azure Analysis Services server.

az analysiservices delete --name --resource-group [--no-wait] [--yes]

Parameters

  • --name -n The name of the Analysis Services server.
  • --resource-group -g Name of resource group.
  • --yes -y Do not prompt for confirmation.
  • --no-wait Do not wait for the long-running operation to finish.

Examples

az analysiservices delete -n myASServer -g myResourceGroup --yes

Delete an Azure Analysis Services server.

az analysiservices list

List all Azure Analysis Services servers in a subscription or resource group.

az analysiservices list [--resource-group ]

Parameters

  • --resource-group -g Name of resource group. If not specified, lists servers in the current subscription.

Examples

az analysiservices list -g myResourceGroup

List all Azure Analysis Services servers in a resource group.

az analysiservices list

List all Azure Analysis Services servers in the current subscription.

az analysiservices show

Show the details of an Azure Analysis Services server.

az analysiservices show --name --resource-group

Parameters

  • --name -n The name of the Analysis Services server.
  • --resource-group -g Name of resource group.

Examples

az analysiservices show -n myASServer -g myResourceGroup

Show the details of an Azure Analysis Services server.

az analysiservices update

Update an Azure Analysis Services server.

az analysiservices update --name --resource-group [--set ] [--tags ] [--version ]

Parameters

  • --name -n The name of the Analysis Services server.
  • --resource-group -g Name of resource group.
  • --set Space-separated list of property assignments to update.
  • --tags Space-separated tags in 'key[=value]' format.
  • --version The API version to use for the update.

Examples

az analysiservices update -n myASServer -g myResourceGroup --set sku.capacity=4

Update the capacity of an Azure Analysis Services server.

az analysiservices update -n myASServer -g myResourceGroup --tags environment=production

Update the tags of an Azure Analysis Services server.

az analysiservices server

Manage Analysis Services servers.

az analysiservices server [group] [--help] [--output {json, jsonc, table, tsv, yaml, yml}] [--query ] [--verbose] [--version]

az analysiservices server add-to-resource-group

Add an existing Analysis Services server to the specified resource group.

az analysiservices server add-to-resource-group --resource-group --server

Parameters

  • --resource-group -g Name of resource group.
  • --server -s Name of the Analysis Services server.

az analysiservices server delete

Delete an Analysis Services server.

az analysiservices server delete --name --resource-group [--no-wait] [--yes]

Parameters

  • --name -n The name of the Analysis Services server.
  • --resource-group -g Name of resource group.
  • --yes -y Do not prompt for confirmation.
  • --no-wait Do not wait for the long-running operation to finish.

az analysiservices server list

List Analysis Services servers.

az analysiservices server list [--resource-group ]

Parameters

  • --resource-group -g Name of resource group.

az analysiservices server restart

Restart an Analysis Services server.

az analysiservices server restart --name --resource-group [--no-wait]

Parameters

  • --name -n The name of the Analysis Services server.
  • --resource-group -g Name of resource group.
  • --no-wait Do not wait for the long-running operation to finish.

az analysiservices server show

Show an Analysis Services server.

az analysiservices server show --name --resource-group

Parameters

  • --name -n The name of the Analysis Services server.
  • --resource-group -g Name of resource group.

az analysiservices server start

Start an Analysis Services server.

az analysiservices server start --name --resource-group [--no-wait]

Parameters

  • --name -n The name of the Analysis Services server.
  • --resource-group -g Name of resource group.
  • --no-wait Do not wait for the long-running operation to finish.

az analysiservices server stop

Stop an Analysis Services server.

az analysiservices server stop --name --resource-group [--no-wait]

Parameters

  • --name -n The name of the Analysis Services server.
  • --resource-group -g Name of resource group.
  • --no-wait Do not wait for the long-running operation to finish.

az analysiservices server update

Update an Analysis Services server.

az analysiservices server update --name --resource-group [--scale-type {Classic, Premium, Standard}] [--sku {D1, S1, S2, S3, P1, P2, P3}] [--tags ]

Parameters

  • --name -n The name of the Analysis Services server.
  • --resource-group -g Name of resource group.
  • --sku The sku name of the Analysis Services server.
  • --scale-type The scale type of the Analysis Services server.
  • --tags Space-separated tags in 'key[=value]' format.

az analysiservices dm dm-schema

Manage data modeling schemas.

az analysiservices dm dm-schema [group] [--help] [--output {json, jsonc, table, tsv, yaml, yml}] [--query ] [--verbose] [--version]

az analysiservices dm dm-schema create

Create a data modeling schema.

az analysiservices dm dm-schema create --data-model --database --name --resource-group --server [--file ]

Parameters

  • --data-model The name of the data model.
  • --database -d The name of the database.
  • --name -n The name of the schema.
  • --resource-group -g Name of resource group.
  • --server -s Name of the Analysis Services server.
  • --file -f Path to the schema file.

az analysiservices dm dm-schema delete

Delete a data modeling schema.

az analysiservices dm dm-schema delete --database --name --resource-group --server [--yes]

Parameters

  • --database -d The name of the database.
  • --name -n The name of the schema.
  • --resource-group -g Name of resource group.
  • --server -s Name of the Analysis Services server.
  • --yes -y Do not prompt for confirmation.

az analysiservices dm dm-schema list

List data modeling schemas.

az analysiservices dm dm-schema list --database --resource-group --server

Parameters

  • --database -d The name of the database.
  • --resource-group -g Name of resource group.
  • --server -s Name of the Analysis Services server.

az analysiservices dm dm-schema show

Show a data modeling schema.

az analysiservices dm dm-schema show --database --name --resource-group --server

Parameters

  • --database -d The name of the database.
  • --name -n The name of the schema.
  • --resource-group -g Name of resource group.
  • --server -s Name of the Analysis Services server.

az analysiservices dm dm-schema update

Update a data modeling schema.

az analysiservices dm dm-schema update --database --name --resource-group --server [--file ]

Parameters

  • --database -d The name of the database.
  • --name -n The name of the schema.
  • --resource-group -g Name of resource group.
  • --server -s Name of the Analysis Services server.
  • --file -f Path to the schema file.