Servers - Update

Ссылка

Служба:: Analysis Services

Версия API:: 2017-08-01

Обновляет текущее состояние указанного сервера Служб Analysis Services.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Имя группы ресурсов Azure, в которую входит заданный сервер Служб Analysis Services. Это имя должно быть не менее 1 символа длиной, а не более 90.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$	Имя сервера служб Analysis Services. Длина не менее 3 символов и не более 63.
subscriptionId	path	True	string	Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия клиентского API.

Текст запроса

Имя	Тип	Описание
properties.asAdministrators	ServerAdministrators	Коллекция администраторов серверов AS
properties.backupBlobContainerUri	string	URI контейнера SAS для контейнера резервного копирования.
properties.gatewayDetails	GatewayDetails	Сведения о шлюзе, настроенные для сервера AS.
properties.ipV4FirewallSettings	IPv4FirewallSettings	Параметры брандмауэра для сервера AS.
properties.managedMode	ManagedMode (int32)	Управляемый режим сервера (0 = не управляемый, 1 = управляемый).
properties.querypoolConnectionMode	ConnectionMode	Как управляется участие сервера чтения и записи в пуле запросов. Он может иметь следующие значения: readOnly — указывает, что сервер чтения и записи предназначен не для участия в операциях запроса. all — указывает, что сервер чтения и записи может участвовать в операциях запроса Указание readOnly, если емкость составляет 1, приводит к ошибке.
properties.serverMonitorMode	ServerMonitorMode (int32)	Режим монитора сервера для сервера AS
sku	ResourceSku	Номер SKU ресурса служб Analysis Services.
tags	object	Пары "ключ-значение" дополнительных свойств подготовки.

Ответы

Имя	Тип	Описание
200 OK	AnalysisServicesServer	ХОРОШО
202 Accepted	AnalysisServicesServer	Принятый
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Update a server.

Образец запроса

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

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

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

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

Пример ответа

Код состояния:: 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"
  }
}

Код состояния:: 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"
  }
}

Определения

Имя	Описание
AnalysisServicesServer	Представляет экземпляр ресурса Служб Analysis Services.
AnalysisServicesServerUpdateParameters	Спецификация запроса подготовки
ConnectionMode	Как управляется участие сервера чтения и записи в пуле запросов. Он может иметь следующие значения: readOnly — указывает, что сервер чтения и записи предназначен не для участия в операциях запроса. all — указывает, что сервер чтения и записи может участвовать в операциях запроса Указание readOnly, если емкость составляет 1, приводит к ошибке.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Описывает формат ответа на ошибку.
GatewayDetails	Сведения о шлюзе.
IPv4FirewallRule	Подробные сведения о правиле брандмауэра.
IPv4FirewallSettings	Массив правил брандмауэра.
ManagedMode	Управляемый режим сервера (0 = не управляемый, 1 = управляемый).
ProvisioningState	Текущее состояние развертывания ресурса Служб Analysis Services. Параметр provisioningState — это указание состояний для подготовки ресурсов.
ResourceSku	Представляет имя SKU и ценовую категорию Azure для ресурса Служб Analysis Services.
ServerAdministrators	Массив удостоверений пользователей администратора.
ServerMonitorMode	Режим монитора сервера для сервера AS
SkuTier	Имя ценовой категории Azure, к которой применяется номер SKU.
State	Текущее состояние ресурса служб Analysis Services. Состояние заключается в том, чтобы указать больше состояний за пределами подготовки ресурсов.

AnalysisServicesServer

Object

Представляет экземпляр ресурса Служб Analysis Services.

Имя	Тип	Default value	Описание
id	string		Идентификатор, представляющий ресурс служб Analysis Services.
location	string		Расположение ресурса служб Analysis Services.
name	string		Имя ресурса служб Analysis Services.
properties.asAdministrators	ServerAdministrators		Коллекция администраторов серверов AS
properties.backupBlobContainerUri	string		URI контейнера SAS для контейнера резервного копирования.
properties.gatewayDetails	GatewayDetails		Сведения о шлюзе, настроенные для сервера AS.
properties.ipV4FirewallSettings	IPv4FirewallSettings		Параметры брандмауэра для сервера AS.
properties.managedMode	ManagedMode (int32)	1	Управляемый режим сервера (0 = не управляемый, 1 = управляемый).
properties.provisioningState	ProvisioningState		Текущее состояние развертывания ресурса Служб Analysis Services. Параметр provisioningState — это указание состояний для подготовки ресурсов.
properties.querypoolConnectionMode	ConnectionMode	All	Как управляется участие сервера чтения и записи в пуле запросов. Он может иметь следующие значения: readOnly — указывает, что сервер чтения и записи предназначен не для участия в операциях запроса. all — указывает, что сервер чтения и записи может участвовать в операциях запроса Указание readOnly, если емкость составляет 1, приводит к ошибке.
properties.serverFullName	string		Полное имя ресурса служб Analysis Services.
properties.serverMonitorMode	ServerMonitorMode (int32)	1	Режим монитора сервера для сервера AS
properties.sku	ResourceSku		Номер SKU ресурса служб Analysis Services.
properties.state	State		Текущее состояние ресурса служб Analysis Services. Состояние заключается в том, чтобы указать больше состояний за пределами подготовки ресурсов.
sku	ResourceSku		Номер SKU ресурса служб Analysis Services.
tags	object		Пары "ключ-значение" дополнительных свойств подготовки ресурсов.
type	string		Тип ресурса служб Analysis Services.

AnalysisServicesServerUpdateParameters

Object

Спецификация запроса подготовки

Имя	Тип	Default value	Описание
properties.asAdministrators	ServerAdministrators		Коллекция администраторов серверов AS
properties.backupBlobContainerUri	string		URI контейнера SAS для контейнера резервного копирования.
properties.gatewayDetails	GatewayDetails		Сведения о шлюзе, настроенные для сервера AS.
properties.ipV4FirewallSettings	IPv4FirewallSettings		Параметры брандмауэра для сервера AS.
properties.managedMode	ManagedMode (int32)	1	Управляемый режим сервера (0 = не управляемый, 1 = управляемый).
properties.querypoolConnectionMode	ConnectionMode	All	Как управляется участие сервера чтения и записи в пуле запросов. Он может иметь следующие значения: readOnly — указывает, что сервер чтения и записи предназначен не для участия в операциях запроса. all — указывает, что сервер чтения и записи может участвовать в операциях запроса Указание readOnly, если емкость составляет 1, приводит к ошибке.
properties.serverMonitorMode	ServerMonitorMode (int32)	1	Режим монитора сервера для сервера AS
sku	ResourceSku		Номер SKU ресурса служб Analysis Services.
tags	object		Пары "ключ-значение" дополнительных свойств подготовки.

ConnectionMode

Перечисление

Как управляется участие сервера чтения и записи в пуле запросов.
Он может иметь следующие значения:

readOnly — указывает, что сервер чтения и записи предназначен не для участия в операциях запроса.
all — указывает, что сервер чтения и записи может участвовать в операциях запроса

Указание readOnly, если емкость составляет 1, приводит к ошибке.

Значение	Описание
All
ReadOnly

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
httpStatusCode	integer (int32)	Код состояния HTTP
message	string	Сообщение об ошибке.
subCode	integer (int32)	Вложенный код ошибки
target	string	Целевой объект ошибки.
timeStamp	string	метка времени ошибки.

ErrorResponse

Object

Описывает формат ответа на ошибку.

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки

GatewayDetails

Object

Сведения о шлюзе.

Имя	Тип	Описание
dmtsClusterUri	string	Универсальный код ресурса (URI) кластера DMTS.
gatewayObjectId	string	Идентификатор объекта шлюза из кластера DMTS для ресурса шлюза.
gatewayResourceId	string	Ресурс шлюза, связанный с сервером.

IPv4FirewallRule

Object

Подробные сведения о правиле брандмауэра.

Имя	Тип	Описание
firewallRuleName	string	Имя правила.
rangeEnd	string	Конечный диапазон IPv4.
rangeStart	string	Начальный диапазон IPv4.

IPv4FirewallSettings

Object

Массив правил брандмауэра.

Имя	Тип	Описание
enablePowerBIService	boolean	Индикатор включения службы PBI.
firewallRules	IPv4FirewallRule[]	Массив правил брандмауэра.

ManagedMode

Перечисление

Управляемый режим сервера (0 = не управляемый, 1 = управляемый).

Значение	Описание
0
1

ProvisioningState

Перечисление

Текущее состояние развертывания ресурса Служб Analysis Services. Параметр provisioningState — это указание состояний для подготовки ресурсов.

Значение	Описание
Deleting
Failed
Paused
Pausing
Preparing
Provisioning
Resuming
Scaling
Succeeded
Suspended
Suspending
Updating

ResourceSku

Object

Представляет имя SKU и ценовую категорию Azure для ресурса Служб Analysis Services.

Имя	Тип	Default value	Описание
capacity	integer (int32) minimum: 1 maximum: 8	1	Количество экземпляров в пуле запросов только для чтения.
name	string		Имя уровня SKU.
tier	SkuTier		Имя ценовой категории Azure, к которой применяется номер SKU.

ServerAdministrators

Object

Массив удостоверений пользователей администратора.

Имя	Тип	Описание
members	string[]	Массив удостоверений пользователей администратора.

ServerMonitorMode

Перечисление

Режим монитора сервера для сервера AS

Значение	Описание
0
1

SkuTier

Перечисление

Имя ценовой категории Azure, к которой применяется номер SKU.

Значение	Описание
Basic
Development
Standard

State

Перечисление

Текущее состояние ресурса служб Analysis Services. Состояние заключается в том, чтобы указать больше состояний за пределами подготовки ресурсов.

Значение	Описание
Deleting
Failed
Paused
Pausing
Preparing
Provisioning
Resuming
Scaling
Succeeded
Suspended
Suspending
Updating

Поделиться через

Servers - Update

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

Update a server.

Образец запроса

Пример ответа

Определения

AnalysisServicesServer

AnalysisServicesServerUpdateParameters

ConnectionMode

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GatewayDetails

IPv4FirewallRule

IPv4FirewallSettings

ManagedMode

ProvisioningState

ResourceSku

ServerAdministrators

ServerMonitorMode

SkuTier

State

Дополнительные ресурсы