API Endpoints

GET /servers/{serverName}/aas/v1.0/models

Retrieves a list of all Analysis Services models within the specified server.

Parameters

Name Type Description Required
serverName string The name of the Azure Analysis Services server. Yes

Responses

Code Description Schema
200 OK Successfully retrieved the list of models. Array of Model Objects
404 Not Found The specified server or resource was not found. Error Object
500 Internal Server Error An internal server error occurred. Error Object

Example Response (JSON)


[
  {
    "name": "AdventureWorks",
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "state": "Online",
    "creationDate": "2023-10-27T10:00:00Z",
    "lastUpdate": "2023-10-27T11:30:00Z"
  },
  {
    "name": "ContosoRetail",
    "id": "f0e9d8c7-b6a5-4321-0987-654321fedcba",
    "state": "Offline",
    "creationDate": "2023-09-15T09:00:00Z",
    "lastUpdate": "2023-10-26T15:00:00Z"
  }
]
GET /servers/{serverName}/aas/v1.0/models/{modelId}/datasets

Retrieves a list of all datasets within a specified Analysis Services model.

Parameters

Name Type Description Required
serverName string The name of the Azure Analysis Services server. Yes
modelId string The unique identifier of the Analysis Services model. Yes

Responses

Code Description Schema
200 OK Successfully retrieved the list of datasets. Array of Dataset Objects
404 Not Found The specified server, model, or resource was not found. Error Object
500 Internal Server Error An internal server error occurred. Error Object
POST /servers/{serverName}/aas/v1.0/models/{modelId}/datasets/{datasetName}/partitions/{partitionId}/refresh

Triggers a data refresh for a specific partition within a dataset.

Parameters

Name Type Description Required
serverName string The name of the Azure Analysis Services server. Yes
modelId string The unique identifier of the Analysis Services model. Yes
datasetName string The name of the dataset containing the partition. Yes
partitionId string The unique identifier of the partition to refresh. Yes

Responses

Code Description Schema
202 Accepted The refresh request has been accepted and is being processed. Refresh Status Object
404 Not Found The specified server, model, dataset, or partition was not found. Error Object
500 Internal Server Error An internal server error occurred. Error Object

Authentication

Requests to the Azure Analysis Services REST API must be authenticated. Supported authentication methods include:

  • Azure Active Directory (Azure AD) OAuth 2.0: This is the recommended method. You can obtain access tokens using service principals or managed identities.
  • Service Principal: Authenticate as an application identity with specific permissions.
  • Managed Identity: If your application is running within Azure, you can use its managed identity for authentication.

Ensure that your application has the necessary permissions (e.g., Contributor, Data Reader) assigned to the Azure Analysis Services resource.

All API requests should include an Authorization header in the format:

Authorization: Bearer <access_token>

Glossary

  • Model: An Azure Analysis Services database representing your data models.
  • Dataset: A logical grouping of tables within a model.
  • Table: A collection of related data within a dataset.
  • Column: An attribute within a table.
  • Partition: A subset of data within a table, used for managing refreshes and optimizing performance.
  • Refresh: The process of updating data in a partition or table from its source.