Microsoft.AnalysisServices servers

Article
04/10/2023

Bicep resource definition

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

Resource groups - See resource group deployment commands

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' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: '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'
    }
  }
}

Property values

servers

Name	Description	Value
name	The resource name	string (required) Character limit: 3-63 Valid characters: Lowercase letters and numbers. Start with lowercase letter.
location	Location of the Analysis Services resource.	string (required)
tags	Key-value pairs of additional resource provisioning properties.	Dictionary of tag names and values. See Tags in templates
sku	The SKU of the Analysis Services resource.	ResourceSku (required)
properties	Properties of the provision operation request.	AnalysisServicesServerProperties

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

ServerAdministrators

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

GatewayDetails

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

IPv4FirewallSettings

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

IPv4FirewallRule

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

ResourceSku

Name	Description	Value
capacity	The number of instances in the read only query pool.	int
name	Name of the SKU level.	string (required)
tier	The name of the Azure pricing tier to which the SKU applies.	'Basic' 'Development' 'Standard'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	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:

Resource groups - See resource group deployment commands

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",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "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"
    }
  }
}

Property values

servers

Name	Description	Value
type	The resource type	'Microsoft.AnalysisServices/servers'
apiVersion	The resource api version	'2017-08-01'
name	The resource name	string (required) Character limit: 3-63 Valid characters: Lowercase letters and numbers. Start with lowercase letter.
location	Location of the Analysis Services resource.	string (required)
tags	Key-value pairs of additional resource provisioning properties.	Dictionary of tag names and values. See Tags in templates
sku	The SKU of the Analysis Services resource.	ResourceSku (required)
properties	Properties of the provision operation request.	AnalysisServicesServerProperties

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

ServerAdministrators

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

GatewayDetails

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

IPv4FirewallSettings

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

IPv4FirewallRule

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

ResourceSku

Name	Description	Value
capacity	The number of instances in the read only query pool.	int
name	Name of the SKU level.	string (required)
tier	The name of the Azure pricing tier to which the SKU applies.	'Basic' 'Development' 'Standard'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create an Azure Analysis Services server using a template	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"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    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

servers

Name	Description	Value
type	The resource type	"Microsoft.AnalysisServices/servers@2017-08-01"
name	The resource name	string (required) Character limit: 3-63 Valid characters: Lowercase letters and numbers. Start with lowercase letter.
location	Location of the Analysis Services resource.	string (required)
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Key-value pairs of additional resource provisioning properties.	Dictionary of tag names and values.
sku	The SKU of the Analysis Services resource.	ResourceSku (required)
properties	Properties of the provision operation request.	AnalysisServicesServerProperties

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

ServerAdministrators

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

GatewayDetails

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

IPv4FirewallSettings

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

IPv4FirewallRule

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

ResourceSku

Name	Description	Value
capacity	The number of instances in the read only query pool.	int
name	Name of the SKU level.	string (required)
tier	The name of the Azure pricing tier to which the SKU applies.	"Basic" "Development" "Standard"

Microsoft.AnalysisServices servers

Bicep resource definition

Resource format

Property values

servers

AnalysisServicesServerProperties

ServerAdministrators

GatewayDetails

IPv4FirewallSettings

IPv4FirewallRule

ResourceSku

Quickstart templates

ARM template resource definition

Resource format

Property values

servers

AnalysisServicesServerProperties

ServerAdministrators

GatewayDetails

IPv4FirewallSettings

IPv4FirewallRule

ResourceSku

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

servers

AnalysisServicesServerProperties

ServerAdministrators

GatewayDetails

IPv4FirewallSettings

IPv4FirewallRule

ResourceSku

Additional resources

Additional resources