Servers - Update

Referência

Serviço:: Analysis Services

Versão da API:: 2017-08-01

Atualizações o estado atual do servidor do Analysis Services especificado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos do Azure do qual um determinado servidor do Analysis Services faz parte. Esse nome deve ter pelo menos 1 caractere de comprimento e não mais do que 90. Padrão Regex: `^[-\w\._]+$`
serverName	path	True	string	O nome do servidor do Analysis Services. Ele deve ter pelo menos três caracteres de comprimento e não mais do que 63. Padrão Regex: `^[a-z][a-z0-9]*$`
subscriptionId	path	True	string	Um identificador exclusivo para uma assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	A versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
properties.asAdministrators	ServerAdministrators	Uma coleção de administradores do servidor AS
properties.backupBlobContainerUri	string	O URI do contêiner SAS para o contêiner de backup.
properties.gatewayDetails	GatewayDetails	Os detalhes do gateway configurados para o servidor AS.
properties.ipV4FirewallSettings	IPv4FirewallSettings	As configurações de firewall para o servidor AS.
properties.managedMode	ManagedMode	O modo gerenciado do servidor (0 = não gerenciado, 1 = gerenciado).
properties.querypoolConnectionMode	ConnectionMode	Como a participação do servidor de leitura/gravação no pool de consultas é controlada. Pode ter um dos valores a seguir: readOnly – indica que o servidor de leitura/gravação se destina a não participar de operações de consulta all – indica que o servidor de leitura/gravação pode participar de operações de consulta Especificar readOnly quando a capacidade é 1 resulta em erro.
properties.serverMonitorMode	ServerMonitorMode	O modo de monitor do servidor para o servidor AS
sku	ResourceSku	O SKU do recurso analysis services.
tags	object	Pares chave-valor de propriedades de provisionamento adicionais.

Respostas

Nome	Tipo	Description
200 OK	AnalysisServicesServer	OK
202 Accepted	AnalysisServicesServer	Aceito
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Update a server.

Solicitação de exemplo

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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
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

Resposta de exemplo

Código de status:: 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"
  }
}

Código de status:: 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"
  }
}

Definições

Nome	Description
AnalysisServicesServer	Representa uma instância de um recurso do Analysis Services.
AnalysisServicesServerUpdateParameters	Especificação de solicitação de provisionamento
ConnectionMode	Como a participação do servidor de leitura/gravação no pool de consultas é controlada. Pode ter um dos valores a seguir: readOnly – indica que o servidor de leitura/gravação se destina a não participar de operações de consulta all – indica que o servidor de leitura/gravação pode participar de operações de consulta Especificar readOnly quando a capacidade é 1 resulta em erro.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Descreve o formato da resposta de erro.
GatewayDetails	Os detalhes do gateway.
IPv4FirewallRule	O detalhe da regra de firewall.
IPv4FirewallSettings	Uma matriz de regras de firewall.
ManagedMode	O modo gerenciado do servidor (0 = não gerenciado, 1 = gerenciado).
ProvisioningState	O estado de implantação atual do recurso do Analysis Services. O provisioningState é para indicar estados para provisionamento de recursos.
ResourceSku	Representa o nome do SKU e o tipo de preço do Azure para o recurso do Analysis Services.
ServerAdministrators	Uma matriz de identidades de usuário de administrador.
ServerMonitorMode	O modo de monitor do servidor para o servidor AS
SkuTier	O nome do tipo de preço do Azure ao qual o SKU se aplica.
State	O estado atual do recurso do Analysis Services. O estado é para indicar mais estados fora do provisionamento de recursos.

AnalysisServicesServer

Representa uma instância de um recurso do Analysis Services.

Nome	Tipo	Valor padrão	Description
id	string		Um identificador que representa o recurso do Analysis Services.
location	string		Local do recurso do Analysis Services.
name	string		O nome do recurso do Analysis Services.
properties.asAdministrators	ServerAdministrators		Uma coleção de administradores do servidor AS
properties.backupBlobContainerUri	string		O URI do contêiner SAS para o contêiner de backup.
properties.gatewayDetails	GatewayDetails		Os detalhes do gateway configurados para o servidor AS.
properties.ipV4FirewallSettings	IPv4FirewallSettings		As configurações de firewall para o servidor AS.
properties.managedMode	ManagedMode	1	O modo gerenciado do servidor (0 = não gerenciado, 1 = gerenciado).
properties.provisioningState	ProvisioningState		O estado de implantação atual do recurso do Analysis Services. O provisioningState é para indicar estados para provisionamento de recursos.
properties.querypoolConnectionMode	ConnectionMode	All	Como a participação do servidor de leitura/gravação no pool de consultas é controlada. Pode ter um dos valores a seguir: readOnly – indica que o servidor de leitura/gravação se destina a não participar de operações de consulta all – indica que o servidor de leitura/gravação pode participar de operações de consulta Especificar readOnly quando a capacidade é 1 resulta em erro.
properties.serverFullName	string		O nome completo do recurso do Analysis Services.
properties.serverMonitorMode	ServerMonitorMode	1	O modo de monitor do servidor para o servidor AS
properties.sku	ResourceSku		O SKU do recurso analysis services.
properties.state	State		O estado atual do recurso do Analysis Services. O estado é para indicar mais estados fora do provisionamento de recursos.
sku	ResourceSku		O SKU do recurso analysis services.
tags	object		Pares chave-valor de propriedades de provisionamento de recursos adicionais.
type	string		O tipo do recurso do Analysis Services.

AnalysisServicesServerUpdateParameters

Especificação de solicitação de provisionamento

Nome	Tipo	Valor padrão	Description
properties.asAdministrators	ServerAdministrators		Uma coleção de administradores do servidor AS
properties.backupBlobContainerUri	string		O URI do contêiner SAS para o contêiner de backup.
properties.gatewayDetails	GatewayDetails		Os detalhes do gateway configurados para o servidor AS.
properties.ipV4FirewallSettings	IPv4FirewallSettings		As configurações de firewall para o servidor AS.
properties.managedMode	ManagedMode	1	O modo gerenciado do servidor (0 = não gerenciado, 1 = gerenciado).
properties.querypoolConnectionMode	ConnectionMode	All	Como a participação do servidor de leitura/gravação no pool de consultas é controlada. Pode ter um dos valores a seguir: readOnly – indica que o servidor de leitura/gravação se destina a não participar de operações de consulta all – indica que o servidor de leitura/gravação pode participar de operações de consulta Especificar readOnly quando a capacidade é 1 resulta em erro.
properties.serverMonitorMode	ServerMonitorMode	1	O modo de monitor do servidor para o servidor AS
sku	ResourceSku		O SKU do recurso analysis services.
tags	object		Pares chave-valor de propriedades de provisionamento adicionais.

ConnectionMode

Como a participação do servidor de leitura/gravação no pool de consultas é controlada.
Pode ter um dos valores a seguir:

readOnly – indica que o servidor de leitura/gravação se destina a não participar de operações de consulta
all – indica que o servidor de leitura/gravação pode participar de operações de consulta

Especificar readOnly quando a capacidade é 1 resulta em erro.

Nome	Tipo	Description
All	string
ReadOnly	string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
httpStatusCode	integer	O código http status
message	string	A mensagem de erro.
subCode	integer	O subcódigo de erro
target	string	O destino do erro.
timeStamp	string	o carimbo de data/hora do erro.

ErrorResponse

Descreve o formato da resposta de erro.

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro

GatewayDetails

Os detalhes do gateway.

Nome	Tipo	Description
dmtsClusterUri	string	Uri do cluster DMTS.
gatewayObjectId	string	ID de objeto do gateway no cluster DMTS para o recurso de gateway.
gatewayResourceId	string	Recurso de gateway a ser associado ao servidor.

IPv4FirewallRule

O detalhe da regra de firewall.

Nome	Tipo	Description
firewallRuleName	string	O nome da regra.
rangeEnd	string	O intervalo final de IPv4.
rangeStart	string	O intervalo inicial de IPv4.

IPv4FirewallSettings

Uma matriz de regras de firewall.

Nome	Tipo	Description
enablePowerBIService	boolean	O indicador de habilitação do serviço PBI.
firewallRules	IPv4FirewallRule[]	Uma matriz de regras de firewall.

ManagedMode

O modo gerenciado do servidor (0 = não gerenciado, 1 = gerenciado).

Nome	Tipo	Description
0	Integer
1	Integer

ProvisioningState

O estado de implantação atual do recurso do Analysis Services. O provisioningState é para indicar estados para provisionamento de recursos.

Nome	Tipo	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

Representa o nome do SKU e o tipo de preço do Azure para o recurso do Analysis Services.

Nome	Tipo	Valor padrão	Description
capacity	integer	1	O número de instâncias no pool de consultas somente leitura.
name	string		Nome do nível de SKU.
tier	SkuTier		O nome do tipo de preço do Azure ao qual o SKU se aplica.

ServerAdministrators

Uma matriz de identidades de usuário de administrador.

Nome	Tipo	Description
members	string[]	Uma matriz de identidades de usuário de administrador.

ServerMonitorMode

O modo de monitor do servidor para o servidor AS

Nome	Tipo	Description
0	Integer
1	Integer

SkuTier

O nome do tipo de preço do Azure ao qual o SKU se aplica.

Nome	Tipo	Description
Basic	string
Development	string
Standard	string

State

O estado atual do recurso do Analysis Services. O estado é para indicar mais estados fora do provisionamento de recursos.

Nome	Tipo	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

Compartilhar via

Servers - Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

Update a server.

Solicitação de exemplo

Resposta de exemplo

Definições

AnalysisServicesServer

AnalysisServicesServerUpdateParameters

ConnectionMode

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GatewayDetails

IPv4FirewallRule

IPv4FirewallSettings

ManagedMode

ProvisioningState

ResourceSku

ServerAdministrators

ServerMonitorMode

SkuTier

State

Recursos adicionais