Servers - Create

Provisions the specified Analysis Services server based on the configuration specified in the request.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}?api-version=2017-08-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True
  • string

The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90.

Regex pattern: ^[-\w\._\(\)]+$

serverName
path True
  • string

The name of the Analysis Services server. It must be a minimum of 3 characters, and a maximum of 63.

Regex pattern: ^[a-z][a-z0-9]*$

subscriptionId
path True
  • string

A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

The client API version.

Request Body

Name Required Type Description
location True
  • string

Location of the Analysis Services resource.

properties.asAdministrators

A collection of AS server administrators

properties.backupBlobContainerUri
  • string

The SAS container URI to the backup container.

properties.gatewayDetails

The gateway details configured for the AS server.

properties.ipV4FirewallSettings

The firewall settings for the AS server.

properties.querypoolConnectionMode

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.

sku True

The SKU of the Analysis Services resource.

tags
  • object

Key-value pairs of additional resource provisioning properties.

Responses

Name Type Description
200 OK

OK. The operation completed successfully.

201 Created

InProgress. The operation is still completing.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Create a server.

Sample Request

PUT https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.AnalysisServices/servers/azsdktest?api-version=2017-08-01
{
  "sku": {
    "capacity": 1,
    "name": "S1",
    "tier": "Standard"
  },
  "tags": {
    "testKey": "testValue"
  },
  "location": "West US",
  "properties": {
    "asAdministrators": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    },
    "provisioningState": "Preparing",
    "serverFullName": "asazure://nightly1.asazure-int.windows.net/azsdktest",
    "state": "Preparing"
  }
}

Sample Response

{
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.AnalysisServices/servers/azsdktest",
  "location": "West US",
  "name": "azsdktest",
  "properties": {
    "asAdministrators": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    },
    "provisioningState": "Provisioning",
    "serverFullName": "asazure://nightly1.asazure-int.windows.net/azsdktest",
    "state": "Provisioning"
  },
  "sku": {
    "capacity": 1,
    "name": "S1",
    "tier": "Standard"
  },
  "tags": {
    "testKey": "testValue"
  }
}
{
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.AnalysisServices/servers/azsdktest",
  "location": "West US",
  "name": "azsdktest",
  "properties": {
    "asAdministrators": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    },
    "provisioningState": "Provisioning",
    "serverFullName": "asazure://nightly1.asazure-int.windows.net/azsdktest",
    "state": "Provisioning"
  },
  "sku": {
    "capacity": 1,
    "name": "S1",
    "tier": "Standard"
  },
  "tags": {
    "testKey": "testValue"
  }
}

Definitions

AnalysisServicesServer

Represents an instance of an Analysis Services resource.

ConnectionMode

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.

GatewayDetails

The gateway details.

IPv4FirewallRule

The detail of firewall rule.

IPv4FirewallSettings

An array of firewall rules.

ProvisioningState

The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning.

ResourceSku

Represents the SKU name and Azure pricing tier for Analysis Services resource.

ServerAdministrators

An array of administrator user identities.

SkuTier

The name of the Azure pricing tier to which the SKU applies.

State

The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning.

AnalysisServicesServer

Represents an instance of an Analysis Services resource.

Name Type Description
id
  • string

An identifier that represents the Analysis Services resource.

location
  • string

Location of the Analysis Services resource.

name
  • string

The name of the Analysis Services resource.

properties.asAdministrators

A collection of AS server administrators

properties.backupBlobContainerUri
  • string

The SAS container URI to the backup container.

properties.gatewayDetails

The gateway details configured for the AS server.

properties.ipV4FirewallSettings

The firewall settings for the AS server.

properties.provisioningState

The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning.

properties.querypoolConnectionMode

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.

properties.serverFullName
  • string

The full name of the Analysis Services resource.

properties.state

The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning.

sku

The SKU of the Analysis Services resource.

tags
  • object

Key-value pairs of additional resource provisioning properties.

type
  • string

The type of the Analysis Services resource.

ConnectionMode

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.

Name Type Description
All
  • string
ReadOnly
  • string

GatewayDetails

The gateway details.

Name Type Description
dmtsClusterUri
  • string

Uri of the DMTS cluster.

gatewayObjectId
  • string

Gateway object id from in the DMTS cluster for the gateway resource.

gatewayResourceId
  • string

Gateway resource to be associated with the server.

IPv4FirewallRule

The detail of firewall rule.

Name Type Description
firewallRuleName
  • string

The rule name.

rangeEnd
  • string

The end range of IPv4.

rangeStart
  • string

The start range of IPv4.

IPv4FirewallSettings

An array of firewall rules.

Name Type Description
enablePowerBIService
  • boolean

The indicator of enabling PBI service.

firewallRules

An array of firewall rules.

ProvisioningState

The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning.

Name Type Description
Deleting
  • string
Failed
  • string
Paused
  • string
Pausing
  • string
Preparing
  • string
Provisioning
  • string
Resuming
  • string
Scaling
  • string
Succeeded
  • string
Suspended
  • string
Suspending
  • string
Updating
  • string

ResourceSku

Represents the SKU name and Azure pricing tier for Analysis Services resource.

Name Type Description
capacity
  • integer

The number of instances in the read only query pool.

name
  • string

Name of the SKU level.

tier

The name of the Azure pricing tier to which the SKU applies.

ServerAdministrators

An array of administrator user identities.

Name Type Description
members
  • string[]

An array of administrator user identities.

SkuTier

The name of the Azure pricing tier to which the SKU applies.

Name Type Description
Basic
  • string
Development
  • string
Standard
  • string

State

The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning.

Name Type Description
Deleting
  • string
Failed
  • string
Paused
  • string
Pausing
  • string
Preparing
  • string
Provisioning
  • string
Resuming
  • string
Scaling
  • string
Succeeded
  • string
Suspended
  • string
Suspending
  • string
Updating
  • string