Microsoft.AnalysisServices servers template reference

Template format

To create a Microsoft.AnalysisServices/servers resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.AnalysisServices/servers",
  "apiVersion": "2017-08-01",
  "location": "string",
  "sku": {
    "name": "string",
    "tier": "string",
    "capacity": "integer"
  },
  "tags": {},
  "properties": {
    "asAdministrators": {
      "members": [
        "string"
      ]
    },
    "backupBlobContainerUri": "string",
    "gatewayDetails": {
      "gatewayResourceId": "string"
    },
    "ipV4FirewallSettings": {
      "firewallRules": [
        {
          "firewallRuleName": "string",
          "rangeStart": "string",
          "rangeEnd": "string"
        }
      ],
      "enablePowerBIService": "boolean"
    },
    "querypoolConnectionMode": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.AnalysisServices/servers object

Name Type Required Value
name string Yes The name of the Analysis Services server. It must be a minimum of 3 characters, and a maximum of 63.
Min length: 3
Max length: 63
type enum Yes Microsoft.AnalysisServices/servers
apiVersion enum Yes 2017-08-01
location string Yes Location of the Analysis Services resource.
sku object Yes The SKU of the Analysis Services resource. - ResourceSku object
tags object No Key-value pairs of additional resource provisioning properties.
properties object Yes Properties of the provision operation request. - AnalysisServicesServerProperties object

ResourceSku object

Name Type Required Value
name string Yes Name of the SKU level.
tier enum No The name of the Azure pricing tier to which the SKU applies. - Development, Basic, Standard
capacity integer No The number of instances in the read only query pool.

AnalysisServicesServerProperties object

Name Type Required Value
asAdministrators object No A collection of AS server administrators - ServerAdministrators object
backupBlobContainerUri string No The SAS container URI to the backup container.
gatewayDetails object No The gateway details configured for the AS server. - GatewayDetails object
ipV4FirewallSettings object No The firewall settings for the AS server. - IPv4FirewallSettings object
querypoolConnectionMode enum No How the read-write server's participation in the query pool is controlled.
It can have the following values:
  • readOnly - indicates that the read-write server is intended not to participate in query operations
  • all - indicates that the read-write server can participate in query operations
Specifying readOnly when capacity is 1 results in error. - All or ReadOnly

ServerAdministrators object

Name Type Required Value
members array No An array of administrator user identities. - string

GatewayDetails object

Name Type Required Value
gatewayResourceId string No Gateway resource to be associated with the server.

IPv4FirewallSettings object

Name Type Required Value
firewallRules array No An array of firewall rules. - IPv4FirewallRule object
enablePowerBIService boolean No The indicator of enabling PBI service.

IPv4FirewallRule object

Name Type Required Value
firewallRuleName string No The rule name.
rangeStart string No The start range of IPv4.
rangeEnd string No The end range of IPv4.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an Azure Analysis Services server using a template

Deploy to Azure
This template creates an Azure Analysis Services server.