Servers - Update

Référence

Service:: Analysis Services

Version d'API:: 2017-08-01

Mises à jour l’état actuel du serveur Analysis Services spécifié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources Azure dont fait partie un serveur Analysis Services donné. Ce nom doit comporter au moins 1 caractère et pas plus de 90. Modèle d’expression régulière: `^[-\w\._]+$`
serverName	path	True	string	Nom du serveur Analysis Services. Il doit comporter au moins 3 caractères et pas plus de 63. Modèle d’expression régulière: `^[a-z][a-z0-9]*$`
subscriptionId	path	True	string	Identificateur unique pour un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
properties.asAdministrators	ServerAdministrators	Collection d’administrateurs de serveur AS
properties.backupBlobContainerUri	string	URI du conteneur SAS du conteneur de sauvegarde.
properties.gatewayDetails	GatewayDetails	Détails de la passerelle configurés pour le serveur AS.
properties.ipV4FirewallSettings	IPv4FirewallSettings	Paramètres de pare-feu pour le serveur AS.
properties.managedMode	ManagedMode	Mode managé du serveur (0 = non géré, 1 = managé).
properties.querypoolConnectionMode	ConnectionMode	Comment la participation du serveur en lecture-écriture dans le pool de requêtes est contrôlée. Il peut avoir les valeurs suivantes : readOnly : indique que le serveur en lecture-écriture est destiné à ne pas participer aux opérations de requête all : indique que le serveur en lecture-écriture peut participer aux opérations de requête La spécification de readOnly lorsque la capacité est 1 entraîne une erreur.
properties.serverMonitorMode	ServerMonitorMode	Mode moniteur de serveur pour le serveur AS
sku	ResourceSku	Référence SKU de la ressource Analysis Services.
tags	object	Paires clé-valeur de propriétés d’approvisionnement supplémentaires.

Réponses

Nom	Type	Description
200 OK	AnalysisServicesServer	Ok
202 Accepted	AnalysisServicesServer	Accepté
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Update a server.

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 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"
  }
}

Définitions

Nom	Description
AnalysisServicesServer	Représente une instance d’une ressource Analysis Services.
AnalysisServicesServerUpdateParameters	Spécification de demande d’approvisionnement
ConnectionMode	Comment la participation du serveur en lecture-écriture dans le pool de requêtes est contrôlée. Il peut avoir les valeurs suivantes : readOnly : indique que le serveur en lecture-écriture est destiné à ne pas participer aux opérations de requête all : indique que le serveur en lecture-écriture peut participer aux opérations de requête La spécification de readOnly lorsque la capacité est 1 entraîne une erreur.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Décrit le format de réponse d’erreur.
GatewayDetails	Détails de la passerelle.
IPv4FirewallRule	Détail de la règle de pare-feu.
IPv4FirewallSettings	Tableau de règles de pare-feu.
ManagedMode	Mode managé du serveur (0 = non géré, 1 = managé).
ProvisioningState	État de déploiement actuel de la ressource Analysis Services. ProvisioningState indique les états pour l’approvisionnement des ressources.
ResourceSku	Représente le nom de la référence SKU et le niveau tarifaire Azure pour la ressource Analysis Services.
ServerAdministrators	Tableau d’identités d’utilisateur administrateur.
ServerMonitorMode	Mode moniteur de serveur pour le serveur AS
SkuTier	Nom du niveau tarifaire Azure auquel la référence SKU s’applique.
State	État actuel de la ressource Analysis Services. L’état indique plus d’états en dehors de l’approvisionnement des ressources.

AnalysisServicesServer

Représente une instance d’une ressource Analysis Services.

Nom	Type	Valeur par défaut	Description
id	string		Identificateur qui représente la ressource Analysis Services.
location	string		Emplacement de la ressource Analysis Services.
name	string		Nom de la ressource Analysis Services.
properties.asAdministrators	ServerAdministrators		Collection d’administrateurs de serveur AS
properties.backupBlobContainerUri	string		URI du conteneur SAS du conteneur de sauvegarde.
properties.gatewayDetails	GatewayDetails		Détails de la passerelle configurés pour le serveur AS.
properties.ipV4FirewallSettings	IPv4FirewallSettings		Paramètres de pare-feu pour le serveur AS.
properties.managedMode	ManagedMode	1	Mode managé du serveur (0 = non géré, 1 = managé).
properties.provisioningState	ProvisioningState		État de déploiement actuel de la ressource Analysis Services. ProvisioningState indique les états pour l’approvisionnement des ressources.
properties.querypoolConnectionMode	ConnectionMode	All	Comment la participation du serveur en lecture-écriture dans le pool de requêtes est contrôlée. Il peut avoir les valeurs suivantes : readOnly : indique que le serveur en lecture-écriture est destiné à ne pas participer aux opérations de requête all : indique que le serveur en lecture-écriture peut participer aux opérations de requête La spécification de readOnly lorsque la capacité est 1 entraîne une erreur.
properties.serverFullName	string		Nom complet de la ressource Analysis Services.
properties.serverMonitorMode	ServerMonitorMode	1	Mode moniteur de serveur pour le serveur AS
properties.sku	ResourceSku		Référence SKU de la ressource Analysis Services.
properties.state	State		État actuel de la ressource Analysis Services. L’état indique plus d’états en dehors de l’approvisionnement des ressources.
sku	ResourceSku		Référence SKU de la ressource Analysis Services.
tags	object		Paires clé-valeur de propriétés d’approvisionnement de ressources supplémentaires.
type	string		Type de la ressource Analysis Services.

AnalysisServicesServerUpdateParameters

Spécification de demande d’approvisionnement

Nom	Type	Valeur par défaut	Description
properties.asAdministrators	ServerAdministrators		Collection d’administrateurs de serveur AS
properties.backupBlobContainerUri	string		URI du conteneur SAS du conteneur de sauvegarde.
properties.gatewayDetails	GatewayDetails		Détails de la passerelle configurés pour le serveur AS.
properties.ipV4FirewallSettings	IPv4FirewallSettings		Paramètres de pare-feu pour le serveur AS.
properties.managedMode	ManagedMode	1	Mode managé du serveur (0 = non géré, 1 = managé).
properties.querypoolConnectionMode	ConnectionMode	All	Comment la participation du serveur en lecture-écriture dans le pool de requêtes est contrôlée. Il peut avoir les valeurs suivantes : readOnly : indique que le serveur en lecture-écriture est destiné à ne pas participer aux opérations de requête all : indique que le serveur en lecture-écriture peut participer aux opérations de requête La spécification de readOnly lorsque la capacité est 1 entraîne une erreur.
properties.serverMonitorMode	ServerMonitorMode	1	Mode moniteur de serveur pour le serveur AS
sku	ResourceSku		Référence SKU de la ressource Analysis Services.
tags	object		Paires clé-valeur de propriétés d’approvisionnement supplémentaires.

ConnectionMode

Comment la participation du serveur en lecture-écriture dans le pool de requêtes est contrôlée.
Il peut avoir les valeurs suivantes :

readOnly : indique que le serveur en lecture-écriture est destiné à ne pas participer aux opérations de requête
all : indique que le serveur en lecture-écriture peut participer aux opérations de requête

La spécification de readOnly lorsque la capacité est 1 entraîne une erreur.

Nom	Type	Description
All	string
ReadOnly	string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
httpStatusCode	integer	Code status http
message	string	Message d’erreur.
subCode	integer	Sous-code d’erreur
target	string	Cible d’erreur.
timeStamp	string	horodatage de l’erreur.

ErrorResponse

Décrit le format de réponse d’erreur.

Nom	Type	Description
error	ErrorDetail	Objet error

GatewayDetails

Détails de la passerelle.

Nom	Type	Description
dmtsClusterUri	string	URI du cluster DMTS.
gatewayObjectId	string	ID d’objet de passerelle à partir du cluster DMTS pour la ressource de passerelle.
gatewayResourceId	string	Ressource de passerelle à associer au serveur.

IPv4FirewallRule

Détail de la règle de pare-feu.

Nom	Type	Description
firewallRuleName	string	Nom de la règle.
rangeEnd	string	Plage de fin d’IPv4.
rangeStart	string	Plage de début d’IPv4.

IPv4FirewallSettings

Tableau de règles de pare-feu.

Nom	Type	Description
enablePowerBIService	boolean	Indicateur d’activation du service PBI.
firewallRules	IPv4FirewallRule[]	Tableau de règles de pare-feu.

ManagedMode

Mode managé du serveur (0 = non géré, 1 = managé).

Nom	Type	Description
0	Integer
1	Integer

ProvisioningState

État de déploiement actuel de la ressource Analysis Services. ProvisioningState indique les états pour l’approvisionnement des ressources.

Nom	Type	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

Représente le nom de la référence SKU et le niveau tarifaire Azure pour la ressource Analysis Services.

Nom	Type	Valeur par défaut	Description
capacity	integer	1	Nombre d’instances dans le pool de requêtes en lecture seule.
name	string		Nom du niveau de référence SKU.
tier	SkuTier		Nom du niveau tarifaire Azure auquel la référence SKU s’applique.

ServerAdministrators

Tableau d’identités d’utilisateur administrateur.

Nom	Type	Description
members	string[]	Tableau d’identités d’utilisateur administrateur.

ServerMonitorMode

Mode moniteur de serveur pour le serveur AS

Nom	Type	Description
0	Integer
1	Integer

SkuTier

Nom du niveau tarifaire Azure auquel la référence SKU s’applique.

Nom	Type	Description
Basic	string
Development	string
Standard	string

State

État actuel de la ressource Analysis Services. L’état indique plus d’états en dehors de l’approvisionnement des ressources.

Nom	Type	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

Partager via

Servers - Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Update a server.

Exemple de requête

Exemple de réponse

Définitions

AnalysisServicesServer

AnalysisServicesServerUpdateParameters

ConnectionMode

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GatewayDetails

IPv4FirewallRule

IPv4FirewallSettings

ManagedMode

ProvisioningState

ResourceSku

ServerAdministrators

ServerMonitorMode

SkuTier

State

Ressources supplémentaires