Servers - Update

Updates the current state of the specified Analysis Services server.

PATCH 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 at least 3 characters in length, and no more than 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 Type Description
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.managedMode

The managed mode of the server (0 = not managed, 1 = managed).

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.serverMonitorMode

The server monitor mode for AS server

sku

The SKU of the Analysis Services resource.

tags
  • object

Key-value pairs of additional provisioning properties.

Responses

Name Type Description
200 OK

OK

202 Accepted

Accepted

Other Status Codes

Error response describing why the operation failed.

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

Update a server.

Sample Request

PATCH 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"
  },
  "properties": {
    "asAdministrators": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    }
  }
}

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.

AnalysisServicesServerUpdateParameters

Provision request specification

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.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Describes the format of Error response.

GatewayDetails

The gateway details.

IPv4FirewallRule

The detail of firewall rule.

IPv4FirewallSettings

An array of firewall rules.

ManagedMode

The managed mode of the server (0 = not managed, 1 = managed).

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.

ServerMonitorMode

The server monitor mode for AS server

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 Default Value 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.managedMode 1

The managed mode of the server (0 = not managed, 1 = managed).

properties.provisioningState

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

properties.querypoolConnectionMode All

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.serverMonitorMode 1

The server monitor mode for AS server

properties.sku

The SKU 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.

AnalysisServicesServerUpdateParameters

Provision request specification

Name Type Default Value Description
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.managedMode 1

The managed mode of the server (0 = not managed, 1 = managed).

properties.querypoolConnectionMode All

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.serverMonitorMode 1

The server monitor mode for AS server

sku

The SKU of the Analysis Services resource.

tags
  • object

Key-value pairs of additional provisioning properties.

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

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

httpStatusCode
  • integer

The http status code

message
  • string

The error message.

subCode
  • integer

The error sub code

target
  • string

The error target.

timeStamp
  • string

the timestamp for the error.

ErrorResponse

Describes the format of Error response.

Name Type Description
error

The error object

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.

ManagedMode

The managed mode of the server (0 = not managed, 1 = managed).

Name Type Description
0
  • Integer
1
  • Integer

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 Default Value Description
capacity
  • integer
1

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.

ServerMonitorMode

The server monitor mode for AS server

Name Type Description
0
  • Integer
1
  • Integer

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