Share via

Microsoft.AnalysisServices servers

  • Article
  • 02/13/2025
Choose a deployment language

Bicep resource definition

The servers resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AnalysisServices/servers resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AnalysisServices/servers@2017-08-01' = {
  location: 'string'
  name: 'string'
  properties: {
    asAdministrators: {
      members: [
        'string'
      ]
    }
    backupBlobContainerUri: 'string'
    gatewayDetails: {
      gatewayResourceId: 'string'
    }
    ipV4FirewallSettings: {
      enablePowerBIService: bool
      firewallRules: [
        {
          firewallRuleName: 'string'
          rangeEnd: 'string'
          rangeStart: 'string'
        }
      ]
    }
    managedMode: int
    querypoolConnectionMode: 'string'
    serverMonitorMode: int
    sku: {
      capacity: int
      name: 'string'
      tier: 'string'
    }
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

AnalysisServicesServerProperties

Name Description Value
asAdministrators A collection of AS server administrators ServerAdministrators
backupBlobContainerUri The SAS container URI to the backup container. string
gatewayDetails The gateway details configured for the AS server. GatewayDetails
ipV4FirewallSettings The firewall settings for the AS server. IPv4FirewallSettings
managedMode The managed mode of the server (0 = not managed, 1 = managed). int
querypoolConnectionMode How the read-write server's participation in the query pool is controlled.
It can have the following values: <ul><li>readOnly - indicates that the read-write server is intended not to participate in query operations</li><li>all - indicates that the read-write server can participate in query operations</li></ul>Specifying readOnly when capacity is 1 results in error.		 'All'
'ReadOnly'
serverMonitorMode The server monitor mode for AS server int
sku The SKU of the Analysis Services resource. ResourceSku

GatewayDetails

Name Description Value
gatewayResourceId Gateway resource to be associated with the server. string

IPv4FirewallRule

Name Description Value
firewallRuleName The rule name. string
rangeEnd The end range of IPv4. string
rangeStart The start range of IPv4. string

IPv4FirewallSettings

Name Description Value
enablePowerBIService The indicator of enabling PBI service. bool
firewallRules An array of firewall rules. IPv4FirewallRule[]

Microsoft.AnalysisServices/servers

Name Description Value
location Location of the Analysis Services resource. string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[a-z][a-z0-9]*$ (required)
properties Properties of the provision operation request. AnalysisServicesServerProperties
sku The SKU of the Analysis Services resource. ResourceSku (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

ResourceSku

Name Description Value
capacity The number of instances in the read only query pool. int

Constraints:
Min value = 1
Max value = 8
name Name of the SKU level. string (required)
tier The name of the Azure pricing tier to which the SKU applies. 'Basic'
'Development'
'Standard'

ResourceTags

Name Description Value

ServerAdministrators

Name Description Value
members An array of administrator user identities. string[]

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Analysis Services Server AVM Resource Module for Analysis Services Server

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Create an Azure Analysis Services server using a template This template creates an Azure Analysis Services server.

ARM template resource definition

The servers resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

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

Property Values

AnalysisServicesServerProperties

Name Description Value
asAdministrators A collection of AS server administrators ServerAdministrators
backupBlobContainerUri The SAS container URI to the backup container. string
gatewayDetails The gateway details configured for the AS server. GatewayDetails
ipV4FirewallSettings The firewall settings for the AS server. IPv4FirewallSettings
managedMode The managed mode of the server (0 = not managed, 1 = managed). int
querypoolConnectionMode How the read-write server's participation in the query pool is controlled.
It can have the following values: <ul><li>readOnly - indicates that the read-write server is intended not to participate in query operations</li><li>all - indicates that the read-write server can participate in query operations</li></ul>Specifying readOnly when capacity is 1 results in error.		 'All'
'ReadOnly'
serverMonitorMode The server monitor mode for AS server int
sku The SKU of the Analysis Services resource. ResourceSku

GatewayDetails

Name Description Value
gatewayResourceId Gateway resource to be associated with the server. string

IPv4FirewallRule

Name Description Value
firewallRuleName The rule name. string
rangeEnd The end range of IPv4. string
rangeStart The start range of IPv4. string

IPv4FirewallSettings

Name Description Value
enablePowerBIService The indicator of enabling PBI service. bool
firewallRules An array of firewall rules. IPv4FirewallRule[]

Microsoft.AnalysisServices/servers

Name Description Value
apiVersion The api version '2017-08-01'
location Location of the Analysis Services resource. string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[a-z][a-z0-9]*$ (required)
properties Properties of the provision operation request. AnalysisServicesServerProperties
sku The SKU of the Analysis Services resource. ResourceSku (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.AnalysisServices/servers'

ResourceSku

Name Description Value
capacity The number of instances in the read only query pool. int

Constraints:
Min value = 1
Max value = 8
name Name of the SKU level. string (required)
tier The name of the Azure pricing tier to which the SKU applies. 'Basic'
'Development'
'Standard'

ResourceTags

Name Description Value

ServerAdministrators

Name Description Value
members An array of administrator user identities. string[]

Usage Examples

Azure Quickstart Templates

The following Azure 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.

Terraform (AzAPI provider) resource definition

The servers resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AnalysisServices/servers resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AnalysisServices/servers@2017-08-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      asAdministrators = {
        members = [
          "string"
        ]
      }
      backupBlobContainerUri = "string"
      gatewayDetails = {
        gatewayResourceId = "string"
      }
      ipV4FirewallSettings = {
        enablePowerBIService = bool
        firewallRules = [
          {
            firewallRuleName = "string"
            rangeEnd = "string"
            rangeStart = "string"
          }
        ]
      }
      managedMode = int
      querypoolConnectionMode = "string"
      serverMonitorMode = int
      sku = {
        capacity = int
        name = "string"
        tier = "string"
      }
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  }
}

Property Values

AnalysisServicesServerProperties

Name Description Value
asAdministrators A collection of AS server administrators ServerAdministrators
backupBlobContainerUri The SAS container URI to the backup container. string
gatewayDetails The gateway details configured for the AS server. GatewayDetails
ipV4FirewallSettings The firewall settings for the AS server. IPv4FirewallSettings
managedMode The managed mode of the server (0 = not managed, 1 = managed). int
querypoolConnectionMode How the read-write server's participation in the query pool is controlled.
It can have the following values: <ul><li>readOnly - indicates that the read-write server is intended not to participate in query operations</li><li>all - indicates that the read-write server can participate in query operations</li></ul>Specifying readOnly when capacity is 1 results in error.		 'All'
'ReadOnly'
serverMonitorMode The server monitor mode for AS server int
sku The SKU of the Analysis Services resource. ResourceSku

GatewayDetails

Name Description Value
gatewayResourceId Gateway resource to be associated with the server. string

IPv4FirewallRule

Name Description Value
firewallRuleName The rule name. string
rangeEnd The end range of IPv4. string
rangeStart The start range of IPv4. string

IPv4FirewallSettings

Name Description Value
enablePowerBIService The indicator of enabling PBI service. bool
firewallRules An array of firewall rules. IPv4FirewallRule[]

Microsoft.AnalysisServices/servers

Name Description Value
location Location of the Analysis Services resource. string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[a-z][a-z0-9]*$ (required)
properties Properties of the provision operation request. AnalysisServicesServerProperties
sku The SKU of the Analysis Services resource. ResourceSku (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.AnalysisServices/servers@2017-08-01"

ResourceSku

Name Description Value
capacity The number of instances in the read only query pool. int

Constraints:
Min value = 1
Max value = 8
name Name of the SKU level. string (required)
tier The name of the Azure pricing tier to which the SKU applies. 'Basic'
'Development'
'Standard'

ResourceTags

Name Description Value

ServerAdministrators

Name Description Value
members An array of administrator user identities. string[]