Servers - Update

Service:

Analysis Services

API Version:

2017-08-01

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 minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	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.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$	The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63.
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	ServerAdministrators	A collection of AS server administrators
properties.backupBlobContainerUri	string	The SAS container URI to the backup container.
properties.gatewayDetails	GatewayDetails	The gateway details configured for the AS server.
properties.ipV4FirewallSettings	IPv4FirewallSettings	The firewall settings for the AS server.
properties.managedMode	ManagedMode (int32)	The managed mode of the server (0 = not managed, 1 = managed).
properties.querypoolConnectionMode	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.
properties.serverMonitorMode	ServerMonitorMode (int32)	The server monitor mode for AS server
sku	ResourceSku	The SKU of the Analysis Services resource.
tags	object	Key-value pairs of additional provisioning properties.

Responses

Name	Type	Description
200 OK	AnalysisServicesServer	OK
202 Accepted	AnalysisServicesServer	Accepted
Other Status Codes	ErrorResponse	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

HTTP

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"
      ]
    }
  }
}

Go

package armanalysisservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/analysisservices/armanalysisservices"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/updateServer.json
func ExampleServersClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armanalysisservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewServersClient().BeginUpdate(ctx, "TestRG", "azsdktest", armanalysisservices.ServerUpdateParameters{
		Properties: &armanalysisservices.ServerMutableProperties{
			AsAdministrators: &armanalysisservices.ServerAdministrators{
				Members: []*string{
					to.Ptr("azsdktest@microsoft.com"),
					to.Ptr("azsdktest2@microsoft.com")},
			},
		},
		SKU: &armanalysisservices.ResourceSKU{
			Name:     to.Ptr("S1"),
			Capacity: to.Ptr[int32](1),
			Tier:     to.Ptr(armanalysisservices.SKUTierStandard),
		},
		Tags: map[string]*string{
			"testKey": to.Ptr("testValue"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Server = armanalysisservices.Server{
	// 	Name: to.Ptr("azsdktest"),
	// 	ID: to.Ptr("/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.AnalysisServices/servers/azsdktest"),
	// 	Location: to.Ptr("West US"),
	// 	SKU: &armanalysisservices.ResourceSKU{
	// 		Name: to.Ptr("S1"),
	// 		Capacity: to.Ptr[int32](1),
	// 		Tier: to.Ptr(armanalysisservices.SKUTierStandard),
	// 	},
	// 	Tags: map[string]*string{
	// 		"testKey": to.Ptr("testValue"),
	// 	},
	// 	Properties: &armanalysisservices.ServerProperties{
	// 		AsAdministrators: &armanalysisservices.ServerAdministrators{
	// 			Members: []*string{
	// 				to.Ptr("azsdktest@microsoft.com"),
	// 				to.Ptr("azsdktest2@microsoft.com")},
	// 			},
	// 			ProvisioningState: to.Ptr(armanalysisservices.ProvisioningStateSucceeded),
	// 			ServerFullName: to.Ptr("asazure://nightly1.asazure-int.windows.net/azsdktest"),
	// 			State: to.Ptr(armanalysisservices.StateProvisioning),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AzureAnalysisServices } = require("@azure/arm-analysisservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates the current state of the specified Analysis Services server.
 *
 * @summary Updates the current state of the specified Analysis Services server.
 * x-ms-original-file: specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/updateServer.json
 */
async function updateAServer() {
  const subscriptionId = "613192d7-503f-477a-9cfe-4efc3ee2bd60";
  const resourceGroupName = "TestRG";
  const serverName = "azsdktest";
  const serverUpdateParameters = {
    asAdministrators: {
      members: ["azsdktest@microsoft.com", "azsdktest2@microsoft.com"],
    },
    sku: { name: "S1", capacity: 1, tier: "Standard" },
    tags: { testKey: "testValue" },
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureAnalysisServices(credential, subscriptionId);
  const result = await client.servers.beginUpdateAndWait(
    resourceGroupName,
    serverName,
    serverUpdateParameters
  );
  console.log(result);
}

updateAServer().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Analysis;
using Azure.ResourceManager.Analysis.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/examples/updateServer.json
// this example is just showing the usage of "Servers_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AnalysisServerResource created on azure
// for more information of creating AnalysisServerResource, please refer to the document of AnalysisServerResource
string subscriptionId = "613192d7-503f-477a-9cfe-4efc3ee2bd60";
string resourceGroupName = "TestRG";
string serverName = "azsdktest";
ResourceIdentifier analysisServerResourceId = AnalysisServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
AnalysisServerResource analysisServer = client.GetAnalysisServerResource(analysisServerResourceId);

// invoke the operation
AnalysisServerPatch patch = new AnalysisServerPatch()
{
    Sku = new AnalysisResourceSku("S1")
    {
        Tier = AnalysisSkuTier.Standard,
        Capacity = 1,
    },
    Tags =
    {
    ["testKey"] = "testValue",
    },
    AsAdministratorIdentities =
    {
    "azsdktest@microsoft.com","azsdktest2@microsoft.com"
    },
};
ArmOperation<AnalysisServerResource> lro = await analysisServer.UpdateAsync(WaitUntil.Completed, patch);
AnalysisServerResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AnalysisServerData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "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"
  }
}

Status code:

202

{
  "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

Name	Description
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

Object

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	ServerAdministrators		A collection of AS server administrators
properties.backupBlobContainerUri	string		The SAS container URI to the backup container.
properties.gatewayDetails	GatewayDetails		The gateway details configured for the AS server.
properties.ipV4FirewallSettings	IPv4FirewallSettings		The firewall settings for the AS server.
properties.managedMode	ManagedMode (int32)	1	The managed mode of the server (0 = not managed, 1 = managed).
properties.provisioningState	ProvisioningState		The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning.
properties.querypoolConnectionMode	ConnectionMode	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	ServerMonitorMode (int32)	1	The server monitor mode for AS server
properties.sku	ResourceSku		The SKU of the Analysis Services resource.
properties.state	State		The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning.
sku	ResourceSku		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

Object

Provision request specification

Name	Type	Default value	Description
properties.asAdministrators	ServerAdministrators		A collection of AS server administrators
properties.backupBlobContainerUri	string		The SAS container URI to the backup container.
properties.gatewayDetails	GatewayDetails		The gateway details configured for the AS server.
properties.ipV4FirewallSettings	IPv4FirewallSettings		The firewall settings for the AS server.
properties.managedMode	ManagedMode (int32)	1	The managed mode of the server (0 = not managed, 1 = managed).
properties.querypoolConnectionMode	ConnectionMode	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	ServerMonitorMode (int32)	1	The server monitor mode for AS server
sku	ResourceSku		The SKU of the Analysis Services resource.
tags	object		Key-value pairs of additional provisioning properties.

ConnectionMode

Enumeration

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.

Value	Description
All
ReadOnly

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
httpStatusCode	integer (int32)	The http status code
message	string	The error message.
subCode	integer (int32)	The error sub code
target	string	The error target.
timeStamp	string	the timestamp for the error.

ErrorResponse

Object

Describes the format of Error response.

Name	Type	Description
error	ErrorDetail	The error object

GatewayDetails

Object

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

Object

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

Object

An array of firewall rules.

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

ManagedMode

Enumeration

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

Value	Description
0
1

ProvisioningState

Enumeration

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

Value	Description
Deleting
Failed
Paused
Pausing
Preparing
Provisioning
Resuming
Scaling
Succeeded
Suspended
Suspending
Updating

ResourceSku

Object

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

Name	Type	Default value	Description
capacity	integer (int32) minimum: 1 maximum: 8	1	The number of instances in the read only query pool.
name	string		Name of the SKU level.
tier	SkuTier		The name of the Azure pricing tier to which the SKU applies.

ServerAdministrators

Object

An array of administrator user identities.

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

ServerMonitorMode

Enumeration

The server monitor mode for AS server

Value	Description
0
1

SkuTier

Enumeration

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

Value	Description
Basic
Development
Standard

State

Enumeration

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

Value	Description
Deleting
Failed
Paused
Pausing
Preparing
Provisioning
Resuming
Scaling
Succeeded
Suspended
Suspending
Updating