Servers - Update

Referencia

Service:: Analysis Services

API Version:: 2017-08-01

Novedades el estado actual del servidor de 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 identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos de Azure del que forma parte un servidor de Analysis Services determinado. Este nombre debe tener al menos 1 carácter de longitud y no más de 90. Regex pattern: `^[-\w\._]+$`
serverName	path	True	string	Nombre del servidor de Analysis Services. Debe tener al menos 3 caracteres de longitud y no más de 63. Regex pattern: `^[a-z][a-z0-9]*$`
subscriptionId	path	True	string	Identificador único de una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	La versión de la API de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.asAdministrators	ServerAdministrators	Una colección de administradores de servidores as
properties.backupBlobContainerUri	string	Identificador URI del contenedor de SAS en el contenedor de copia de seguridad.
properties.gatewayDetails	GatewayDetails	Los detalles de la puerta de enlace configurados para el servidor AS.
properties.ipV4FirewallSettings	IPv4FirewallSettings	Configuración del firewall para el servidor AS.
properties.managedMode	ManagedMode	Modo administrado del servidor (0 = no administrado, 1 = administrado).
properties.querypoolConnectionMode	ConnectionMode	Cómo se controla la participación del servidor de lectura y escritura en el grupo de consultas. Puede presentar los siguientes valores: readOnly: indica que el servidor de lectura y escritura está pensado para no participar en las operaciones de consulta. all: indica que el servidor de lectura y escritura puede participar en las operaciones de consulta. Si se especifica readOnly cuando la capacidad es 1, se produce un error.
properties.serverMonitorMode	ServerMonitorMode	Modo de supervisión del servidor para el servidor AS
sku	ResourceSku	SKU del recurso de Analysis Services.
tags	object	Pares clave-valor de propiedades de aprovisionamiento adicionales.

Respuestas

Nombre	Tipo	Description
200 OK	AnalysisServicesServer	Aceptar
202 Accepted	AnalysisServicesServer	Aceptado
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

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

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

Definiciones

Nombre	Description
AnalysisServicesServer	Representa una instancia de un recurso de Analysis Services.
AnalysisServicesServerUpdateParameters	Especificación de solicitud de aprovisionamiento
ConnectionMode	Cómo se controla la participación del servidor de lectura y escritura en el grupo de consultas. Puede presentar los siguientes valores: readOnly: indica que el servidor de lectura y escritura está pensado para no participar en las operaciones de consulta. all: indica que el servidor de lectura y escritura puede participar en las operaciones de consulta. Si se especifica readOnly cuando la capacidad es 1, se produce un error.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Describe el formato de respuesta de error.
GatewayDetails	Detalles de la puerta de enlace.
IPv4FirewallRule	Detalles de la regla de firewall.
IPv4FirewallSettings	Matriz de reglas de firewall.
ManagedMode	Modo administrado del servidor (0 = no administrado, 1 = administrado).
ProvisioningState	Estado de implementación actual del recurso de Analysis Services. ProvisioningState es indicar los estados para el aprovisionamiento de recursos.
ResourceSku	Representa el nombre de la SKU y el plan de tarifa de Azure para el recurso de Analysis Services.
ServerAdministrators	Matriz de identidades de usuario de administrador.
ServerMonitorMode	Modo de supervisión del servidor para el servidor AS
SkuTier	Nombre del plan de tarifa de Azure al que se aplica la SKU.
State	Estado actual del recurso de Analysis Services. El estado es indicar más estados fuera del aprovisionamiento de recursos.

AnalysisServicesServer

Representa una instancia de un recurso de Analysis Services.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador que representa el recurso de Analysis Services.
location	string		Ubicación del recurso de Analysis Services.
name	string		Nombre del recurso de Analysis Services.
properties.asAdministrators	ServerAdministrators		Una colección de administradores de servidores as
properties.backupBlobContainerUri	string		Identificador URI del contenedor de SAS en el contenedor de copia de seguridad.
properties.gatewayDetails	GatewayDetails		Los detalles de la puerta de enlace configurados para el servidor AS.
properties.ipV4FirewallSettings	IPv4FirewallSettings		Configuración del firewall para el servidor AS.
properties.managedMode	ManagedMode	1	Modo administrado del servidor (0 = no administrado, 1 = administrado).
properties.provisioningState	ProvisioningState		Estado de implementación actual del recurso de Analysis Services. ProvisioningState es indicar los estados para el aprovisionamiento de recursos.
properties.querypoolConnectionMode	ConnectionMode	All	Cómo se controla la participación del servidor de lectura y escritura en el grupo de consultas. Puede presentar los siguientes valores: readOnly: indica que el servidor de lectura y escritura está pensado para no participar en las operaciones de consulta. all: indica que el servidor de lectura y escritura puede participar en las operaciones de consulta. Si se especifica readOnly cuando la capacidad es 1, se produce un error.
properties.serverFullName	string		Nombre completo del recurso de Analysis Services.
properties.serverMonitorMode	ServerMonitorMode	1	Modo de supervisión del servidor para el servidor AS
properties.sku	ResourceSku		SKU del recurso de Analysis Services.
properties.state	State		Estado actual del recurso de Analysis Services. El estado es indicar más estados fuera del aprovisionamiento de recursos.
sku	ResourceSku		SKU del recurso de Analysis Services.
tags	object		Pares clave-valor de propiedades de aprovisionamiento de recursos adicionales.
type	string		Tipo del recurso de Analysis Services.

AnalysisServicesServerUpdateParameters

Especificación de solicitud de aprovisionamiento

Nombre	Tipo	Valor predeterminado	Description
properties.asAdministrators	ServerAdministrators		Una colección de administradores de servidores as
properties.backupBlobContainerUri	string		Identificador URI del contenedor de SAS en el contenedor de copia de seguridad.
properties.gatewayDetails	GatewayDetails		Los detalles de la puerta de enlace configurados para el servidor AS.
properties.ipV4FirewallSettings	IPv4FirewallSettings		Configuración del firewall para el servidor AS.
properties.managedMode	ManagedMode	1	Modo administrado del servidor (0 = no administrado, 1 = administrado).
properties.querypoolConnectionMode	ConnectionMode	All	Cómo se controla la participación del servidor de lectura y escritura en el grupo de consultas. Puede presentar los siguientes valores: readOnly: indica que el servidor de lectura y escritura está pensado para no participar en las operaciones de consulta. all: indica que el servidor de lectura y escritura puede participar en las operaciones de consulta. Si se especifica readOnly cuando la capacidad es 1, se produce un error.
properties.serverMonitorMode	ServerMonitorMode	1	Modo de supervisión del servidor para el servidor AS
sku	ResourceSku		SKU del recurso de Analysis Services.
tags	object		Pares clave-valor de propiedades de aprovisionamiento adicionales.

ConnectionMode

Cómo se controla la participación del servidor de lectura y escritura en el grupo de consultas.
Puede presentar los siguientes valores:

readOnly: indica que el servidor de lectura y escritura está pensado para no participar en las operaciones de consulta.
all: indica que el servidor de lectura y escritura puede participar en las operaciones de consulta.

Si se especifica readOnly cuando la capacidad es 1, se produce un error.

Nombre	Tipo	Description
All	string
ReadOnly	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
httpStatusCode	integer	El código de estado HTTP
message	string	El mensaje de error.
subCode	integer	Sub code de error
target	string	Destino del error.
timeStamp	string	marca de tiempo del error.

ErrorResponse

Describe el formato de respuesta de error.

Nombre	Tipo	Description
error	ErrorDetail	El objeto error

GatewayDetails

Detalles de la puerta de enlace.

Nombre	Tipo	Description
dmtsClusterUri	string	URI del clúster DMTS.
gatewayObjectId	string	Identificador de objeto de puerta de enlace desde en el clúster DMTS para el recurso de puerta de enlace.
gatewayResourceId	string	Recurso de puerta de enlace que se va a asociar al servidor.

IPv4FirewallRule

Detalles de la regla de firewall.

Nombre	Tipo	Description
firewallRuleName	string	Nombre de la regla.
rangeEnd	string	Intervalo final de IPv4.
rangeStart	string	Intervalo inicial de IPv4.

IPv4FirewallSettings

Matriz de reglas de firewall.

Nombre	Tipo	Description
enablePowerBIService	boolean	Indicador de habilitación del servicio PBI.
firewallRules	IPv4FirewallRule[]	Matriz de reglas de firewall.

ManagedMode

Modo administrado del servidor (0 = no administrado, 1 = administrado).

Nombre	Tipo	Description
0	Integer
1	Integer

ProvisioningState

Estado de implementación actual del recurso de Analysis Services. ProvisioningState es indicar los estados para el aprovisionamiento de recursos.

Nombre	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 el nombre de la SKU y el plan de tarifa de Azure para el recurso de Analysis Services.

Nombre	Tipo	Valor predeterminado	Description
capacity	integer	1	Número de instancias del grupo de consultas de solo lectura.
name	string		Nombre del nivel de SKU.
tier	SkuTier		Nombre del plan de tarifa de Azure al que se aplica la SKU.

ServerAdministrators

Matriz de identidades de usuario de administrador.

Nombre	Tipo	Description
members	string[]	Matriz de identidades de usuario de administrador.

ServerMonitorMode

Modo de supervisión del servidor para el servidor AS

Nombre	Tipo	Description
0	Integer
1	Integer

SkuTier

Nombre del plan de tarifa de Azure al que se aplica la SKU.

Nombre	Tipo	Description
Basic	string
Development	string
Standard	string

State

Estado actual del recurso de Analysis Services. El estado es indicar más estados fuera del aprovisionamiento de recursos.

Nombre	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

Servers - Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

Update a server.

Sample Request

Sample Response

Definiciones

AnalysisServicesServer

AnalysisServicesServerUpdateParameters

ConnectionMode

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GatewayDetails

IPv4FirewallRule

IPv4FirewallSettings

ManagedMode

ProvisioningState

ResourceSku

ServerAdministrators

ServerMonitorMode

SkuTier

State

Recursos adicionales