Servers - Update

Servizio:

Analysis Services

Versione API:

2017-08-01

Aggiorna lo stato corrente del server Analysis Services specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Nome del gruppo di risorse di Azure di cui fa parte un determinato server Analysis Services. Questo nome deve avere una lunghezza minima di 1 carattere e non più di 90.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$	Nome del server Analysis Services. Deve contenere almeno 3 caratteri e non più di 63.
subscriptionId	path	True	string	Identificatore univoco per una sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string	Versione dell'API client.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.asAdministrators	ServerAdministrators	Raccolta di amministratori del server AS
properties.backupBlobContainerUri	string	URI del contenitore sas per il contenitore di backup.
properties.gatewayDetails	GatewayDetails	Dettagli del gateway configurati per il server AS.
properties.ipV4FirewallSettings	IPv4FirewallSettings	Impostazioni del firewall per il server AS.
properties.managedMode	ManagedMode (int32)	Modalità gestita del server (0 = non gestito, 1 = gestito).
properties.querypoolConnectionMode	ConnectionMode	Modalità di controllo della partecipazione del server di lettura/scrittura al pool di query. Può avere i valori seguenti: readOnly : indica che il server di lettura/scrittura non deve partecipare alle operazioni di query all - indica che il server di lettura/scrittura può partecipare alle operazioni di query Se si specifica readOnly quando la capacità è 1, viene generato un errore.
properties.serverMonitorMode	ServerMonitorMode (int32)	Modalità di monitoraggio del server per il server AS
sku	ResourceSku	SKU della risorsa di Analysis Services.
tags	object	Coppie chiave-valore di proprietà di provisioning aggiuntive.

Risposte

Nome	Tipo	Descrizione
200 OK	AnalysisServicesServer	OK
202 Accepted	AnalysisServicesServer	Accettato
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Update a server.

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Definizioni

Nome	Descrizione
AnalysisServicesServer	Rappresenta un'istanza di una risorsa di Analysis Services.
AnalysisServicesServerUpdateParameters	Specifica della richiesta di provisioning
ConnectionMode	Modalità di controllo della partecipazione del server di lettura/scrittura al pool di query. Può avere i valori seguenti: readOnly : indica che il server di lettura/scrittura non deve partecipare alle operazioni di query all - indica che il server di lettura/scrittura può partecipare alle operazioni di query Se si specifica readOnly quando la capacità è 1, viene generato un errore.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Descrive il formato della risposta di errore.
GatewayDetails	Dettagli del gateway.
IPv4FirewallRule	Dettaglio della regola del firewall.
IPv4FirewallSettings	Matrice di regole del firewall.
ManagedMode	Modalità gestita del server (0 = non gestito, 1 = gestito).
ProvisioningState	Stato di distribuzione corrente della risorsa di Analysis Services. ProvisioningState indica gli stati per il provisioning delle risorse.
ResourceSku	Rappresenta il nome dello SKU e il piano tariffario di Azure per la risorsa di Analysis Services.
ServerAdministrators	Matrice di identità utente dell'amministratore.
ServerMonitorMode	Modalità di monitoraggio del server per il server AS
SkuTier	Nome del piano tariffario di Azure a cui si applica lo SKU.
State	Stato corrente della risorsa di Analysis Services. Lo stato consiste nell'indicare più stati al di fuori del provisioning delle risorse.

AnalysisServicesServer

Object

Rappresenta un'istanza di una risorsa di Analysis Services.

Nome	Tipo	Valore predefinito	Descrizione
id	string		Identificatore che rappresenta la risorsa di Analysis Services.
location	string		Posizione della risorsa di Analysis Services.
name	string		Nome della risorsa di Analysis Services.
properties.asAdministrators	ServerAdministrators		Raccolta di amministratori del server AS
properties.backupBlobContainerUri	string		URI del contenitore sas per il contenitore di backup.
properties.gatewayDetails	GatewayDetails		Dettagli del gateway configurati per il server AS.
properties.ipV4FirewallSettings	IPv4FirewallSettings		Impostazioni del firewall per il server AS.
properties.managedMode	ManagedMode (int32)	1	Modalità gestita del server (0 = non gestito, 1 = gestito).
properties.provisioningState	ProvisioningState		Stato di distribuzione corrente della risorsa di Analysis Services. ProvisioningState indica gli stati per il provisioning delle risorse.
properties.querypoolConnectionMode	ConnectionMode	All	Modalità di controllo della partecipazione del server di lettura/scrittura al pool di query. Può avere i valori seguenti: readOnly : indica che il server di lettura/scrittura non deve partecipare alle operazioni di query all - indica che il server di lettura/scrittura può partecipare alle operazioni di query Se si specifica readOnly quando la capacità è 1, viene generato un errore.
properties.serverFullName	string		Nome completo della risorsa di Analysis Services.
properties.serverMonitorMode	ServerMonitorMode (int32)	1	Modalità di monitoraggio del server per il server AS
properties.sku	ResourceSku		SKU della risorsa di Analysis Services.
properties.state	State		Stato corrente della risorsa di Analysis Services. Lo stato consiste nell'indicare più stati al di fuori del provisioning delle risorse.
sku	ResourceSku		SKU della risorsa di Analysis Services.
tags	object		Coppie chiave-valore di proprietà aggiuntive per il provisioning delle risorse.
type	string		Tipo della risorsa di Analysis Services.

AnalysisServicesServerUpdateParameters

Object

Specifica della richiesta di provisioning

Nome	Tipo	Valore predefinito	Descrizione
properties.asAdministrators	ServerAdministrators		Raccolta di amministratori del server AS
properties.backupBlobContainerUri	string		URI del contenitore sas per il contenitore di backup.
properties.gatewayDetails	GatewayDetails		Dettagli del gateway configurati per il server AS.
properties.ipV4FirewallSettings	IPv4FirewallSettings		Impostazioni del firewall per il server AS.
properties.managedMode	ManagedMode (int32)	1	Modalità gestita del server (0 = non gestito, 1 = gestito).
properties.querypoolConnectionMode	ConnectionMode	All	Modalità di controllo della partecipazione del server di lettura/scrittura al pool di query. Può avere i valori seguenti: readOnly : indica che il server di lettura/scrittura non deve partecipare alle operazioni di query all - indica che il server di lettura/scrittura può partecipare alle operazioni di query Se si specifica readOnly quando la capacità è 1, viene generato un errore.
properties.serverMonitorMode	ServerMonitorMode (int32)	1	Modalità di monitoraggio del server per il server AS
sku	ResourceSku		SKU della risorsa di Analysis Services.
tags	object		Coppie chiave-valore di proprietà di provisioning aggiuntive.

ConnectionMode

Enumerazione

Modalità di controllo della partecipazione del server di lettura/scrittura al pool di query.
Può avere i valori seguenti:

• readOnly : indica che il server di lettura/scrittura non deve partecipare alle operazioni di query
• all - indica che il server di lettura/scrittura può partecipare alle operazioni di query

Se si specifica readOnly quando la capacità è 1, viene generato un errore.

Valore	Descrizione
All
ReadOnly

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
httpStatusCode	integer (int32)	Codice di stato HTTP
message	string	Messaggio di errore.
subCode	integer (int32)	Codice secondario dell'errore
target	string	Destinazione dell'errore.
timeStamp	string	timestamp per l'errore.

ErrorResponse

Object

Descrive il formato della risposta di errore.

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error

GatewayDetails

Object

Dettagli del gateway.

Nome	Tipo	Descrizione
dmtsClusterUri	string	Uri del cluster DMTS.
gatewayObjectId	string	ID oggetto gateway da nel cluster DMTS per la risorsa del gateway.
gatewayResourceId	string	Risorsa gateway da associare al server.

IPv4FirewallRule

Object

Dettaglio della regola del firewall.

Nome	Tipo	Descrizione
firewallRuleName	string	Nome della regola.
rangeEnd	string	Intervallo finale di IPv4.
rangeStart	string	Intervallo iniziale di IPv4.

IPv4FirewallSettings

Object

Matrice di regole del firewall.

Nome	Tipo	Descrizione
enablePowerBIService	boolean	Indicatore dell'abilitazione del servizio PBI.
firewallRules	IPv4FirewallRule[]	Matrice di regole del firewall.

ManagedMode

Enumerazione

Modalità gestita del server (0 = non gestito, 1 = gestito).

Valore	Descrizione
0
1

ProvisioningState

Enumerazione

Stato di distribuzione corrente della risorsa di Analysis Services. ProvisioningState indica gli stati per il provisioning delle risorse.

Valore	Descrizione
Deleting
Failed
Paused
Pausing
Preparing
Provisioning
Resuming
Scaling
Succeeded
Suspended
Suspending
Updating

ResourceSku

Object

Rappresenta il nome dello SKU e il piano tariffario di Azure per la risorsa di Analysis Services.

Nome	Tipo	Valore predefinito	Descrizione
capacity	integer (int32) minimum: 1 maximum: 8	1	Numero di istanze nel pool di query di sola lettura.
name	string		Nome del livello sku.
tier	SkuTier		Nome del piano tariffario di Azure a cui si applica lo SKU.

ServerAdministrators

Object

Matrice di identità utente dell'amministratore.

Nome	Tipo	Descrizione
members	string[]	Matrice di identità utente dell'amministratore.

ServerMonitorMode

Enumerazione

Modalità di monitoraggio del server per il server AS

Valore	Descrizione
0
1

SkuTier

Enumerazione

Nome del piano tariffario di Azure a cui si applica lo SKU.

Valore	Descrizione
Basic
Development
Standard

State

Enumerazione

Stato corrente della risorsa di Analysis Services. Lo stato consiste nell'indicare più stati al di fuori del provisioning delle risorse.

Valore	Descrizione
Deleting
Failed
Paused
Pausing
Preparing
Provisioning
Resuming
Scaling
Succeeded
Suspended
Suspending
Updating