Servers - Update

Service:

MariaDB

Version d'API:

2018-06-01

Met à jour un serveur existant. Le corps de la requête peut contenir une à plusieurs des propriétés présentes dans la définition de serveur normale.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
parameters	ServerUpdateParameters	Paramètres requis pour la mise à jour d’un serveur.

Réponses

Nom	Type	Description
200 OK	Server	Ok
202 Accepted		Accepté
Other Status Codes	CloudError	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

ServerUpdate

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMariaDB/servers/mariadbtestsvc4?api-version=2018-06-01

{
  "properties": {
    "administratorLoginPassword": "<administratorLoginPassword>",
    "sslEnforcement": "Disabled"
  }
}

Java

import com.azure.resourcemanager.mariadb.models.Server;
import com.azure.resourcemanager.mariadb.models.SslEnforcementEnum;

/**
 * Samples for Servers Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/examples/ServerUpdate.json
     */
    /**
     * Sample code: ServerUpdate.
     * 
     * @param manager Entry point to MariaDBManager.
     */
    public static void serverUpdate(com.azure.resourcemanager.mariadb.MariaDBManager manager) {
        Server resource = manager.servers()
            .getByResourceGroupWithResponse("testrg", "mariadbtestsvc4", com.azure.core.util.Context.NONE).getValue();
        resource.update().withAdministratorLoginPassword("<administratorLoginPassword>")
            .withSslEnforcement(SslEnforcementEnum.DISABLED).apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.rdbms.mariadb import MariaDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-rdbms
# USAGE
    python server_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MariaDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testrg",
        server_name="mariadbtestsvc4",
        parameters={
            "properties": {"administratorLoginPassword": "<administratorLoginPassword>", "sslEnforcement": "Disabled"}
        },
    ).result()
    print(response)


# x-ms-original-file: specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/examples/ServerUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armmariadb_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/mariadb/armmariadb"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/examples/ServerUpdate.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 := armmariadb.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewServersClient().BeginUpdate(ctx, "testrg", "mariadbtestsvc4", armmariadb.ServerUpdateParameters{
		Properties: &armmariadb.ServerUpdateParametersProperties{
			AdministratorLoginPassword: to.Ptr("<administratorLoginPassword>"),
			SSLEnforcement:             to.Ptr(armmariadb.SSLEnforcementEnumDisabled),
		},
	}, 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 = armmariadb.Server{
	// 	Name: to.Ptr("mariadbtestsvc4"),
	// 	Type: to.Ptr("Microsoft.DBforMariaDB/servers"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMariaDB/servers/mariadbtestsvc4"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"ElasticServer": to.Ptr("1"),
	// 	},
	// 	Properties: &armmariadb.ServerProperties{
	// 		AdministratorLogin: to.Ptr("cloudsa"),
	// 		EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-14T18:02:41.577Z"); return t}()),
	// 		FullyQualifiedDomainName: to.Ptr("mariadbtestsvc4.mariadb.database.azure.com"),
	// 		SSLEnforcement: to.Ptr(armmariadb.SSLEnforcementEnumDisabled),
	// 		StorageProfile: &armmariadb.StorageProfile{
	// 			BackupRetentionDays: to.Ptr[int32](7),
	// 			GeoRedundantBackup: to.Ptr(armmariadb.GeoRedundantBackupEnabled),
	// 			StorageMB: to.Ptr[int32](128000),
	// 		},
	// 		UserVisibleState: to.Ptr(armmariadb.ServerStateReady),
	// 		Version: to.Ptr(armmariadb.ServerVersionTen3),
	// 	},
	// 	SKU: &armmariadb.SKU{
	// 		Name: to.Ptr("GP_Gen4_2"),
	// 		Capacity: to.Ptr[int32](2),
	// 		Family: to.Ptr("Gen4"),
	// 		Tier: to.Ptr(armmariadb.SKUTierGeneralPurpose),
	// 	},
	// }
}

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 { MariaDBManagementClient } = require("@azure/arm-mariadb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
 *
 * @summary Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
 * x-ms-original-file: specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/examples/ServerUpdate.json
 */
async function serverUpdate() {
  const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = "testrg";
  const serverName = "mariadbtestsvc4";
  const parameters = {
    administratorLoginPassword: "<administratorLoginPassword>",
    sslEnforcement: "Disabled",
  };
  const credential = new DefaultAzureCredential();
  const client = new MariaDBManagementClient(credential, subscriptionId);
  const result = await client.servers.beginUpdateAndWait(resourceGroupName, serverName, parameters);
  console.log(result);
}

serverUpdate().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

Exemple de réponse

Code d’état:

200

{
  "sku": {
    "name": "GP_Gen4_2",
    "tier": "GeneralPurpose",
    "family": "Gen4",
    "capacity": 2
  },
  "properties": {
    "administratorLogin": "cloudsa",
    "storageProfile": {
      "storageMB": 128000,
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Enabled"
    },
    "version": "10.3",
    "sslEnforcement": "Disabled",
    "userVisibleState": "Ready",
    "fullyQualifiedDomainName": "mariadbtestsvc4.mariadb.database.azure.com",
    "earliestRestoreDate": "2018-03-14T18:02:41.577+00:00"
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMariaDB/servers/mariadbtestsvc4",
  "name": "mariadbtestsvc4",
  "type": "Microsoft.DBforMariaDB/servers"
}

Code d’état:

202

Définitions

Nom	Description
CloudError	Réponse d’erreur du service Batch.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorResponse	Réponse d’erreur
GeoRedundantBackup	Activez la géoredondant ou non pour la sauvegarde du serveur.
MinimalTlsVersionEnum	Appliquez une version minimale de Tls pour le serveur.
PrivateEndpointProperty	Point de terminaison privé auquel la connexion appartient.
PrivateEndpointProvisioningState	État de la connexion de point de terminaison privé.
PrivateLinkServiceConnectionStateActionsRequire	Actions requises pour la connexion au service de liaison privée.
PrivateLinkServiceConnectionStateStatus	La connexion au service de liaison privée status.
PublicNetworkAccessEnum	Indique si l’accès au réseau public est autorisé ou non pour ce serveur. La valeur est facultative, mais si elle est transmise, doit être « Enabled » ou « Disabled »
Server	Représente un serveur.
ServerPrivateEndpointConnection	Liste des connexions de point de terminaison privé sur un serveur
ServerPrivateEndpointConnectionProperties	Propriétés de connexion de point de terminaison privé
ServerPrivateLinkServiceConnectionStateProperty	État de la connexion du point de terminaison privé.
ServerState	État d’un serveur visible par l’utilisateur.
ServerUpdateParameters	Paramètres requis pour la mise à jour d’un serveur.
ServerVersion	Version du serveur.
Sku	Référence SKU (niveau tarifaire) du serveur.
SkuTier	Niveau de la référence SKU particulière, par exemple De base.
SslEnforcementEnum	Activez ou non l’application ssl lors de la connexion au serveur.
StorageAutogrow	Activez la croissance automatique du stockage.
StorageProfile	Profil de stockage d’un serveur.

CloudError

Réponse d’erreur du service Batch.

Nom	Type	Description
error	ErrorResponse	Réponse d’erreur Message d’erreur

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.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

GeoRedundantBackup

Activez la géoredondant ou non pour la sauvegarde du serveur.

Nom	Type	Description
Disabled	string
Enabled	string

MinimalTlsVersionEnum

Appliquez une version minimale de Tls pour le serveur.

Nom	Type	Description
TLS1_0	string
TLS1_1	string
TLS1_2	string
TLSEnforcementDisabled	string

PrivateEndpointProperty

Point de terminaison privé auquel la connexion appartient.

Nom	Type	Description
id	string	ID de ressource du point de terminaison privé.

PrivateEndpointProvisioningState

État de la connexion de point de terminaison privé.

Nom	Type	Description
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

Actions requises pour la connexion au service de liaison privée.

Nom	Type	Description
None	string

PrivateLinkServiceConnectionStateStatus

La connexion au service de liaison privée status.

Nom	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccessEnum

Indique si l’accès au réseau public est autorisé ou non pour ce serveur. La valeur est facultative, mais si elle est transmise, doit être « Enabled » ou « Disabled »

Nom	Type	Description
Disabled	string
Enabled	string

Server

Représente un serveur.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Emplacement géographique où réside la ressource
name	string	nom de la ressource.
properties.administratorLogin	string	Nom de connexion de l’administrateur d’un serveur. Ne peut être spécifié que lorsque le serveur est en cours de création (et est requis pour la création).
properties.earliestRestoreDate	string	Heure de création du point de restauration la plus ancienne (format ISO8601)
properties.fullyQualifiedDomainName	string	Nom de domaine complet d’un serveur.
properties.masterServerId	string	ID de serveur master d’un serveur réplica.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Appliquez une version minimale de Tls pour le serveur.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Liste des connexions de point de terminaison privé sur un serveur
properties.publicNetworkAccess	PublicNetworkAccessEnum	Indique si l’accès au réseau public est autorisé ou non pour ce serveur. La valeur est facultative, mais si elle est transmise, doit être « Enabled » ou « Disabled »
properties.replicaCapacity	integer	Nombre maximal de réplicas qu’un serveur master peut avoir.
properties.replicationRole	string	Rôle de réplication du serveur.
properties.sslEnforcement	SslEnforcementEnum	Activez ou non l’application ssl lors de la connexion au serveur.
properties.storageProfile	StorageProfile	Profil de stockage d’un serveur.
properties.userVisibleState	ServerState	État d’un serveur visible par l’utilisateur.
properties.version	ServerVersion	Version du serveur.
sku	Sku	Référence SKU (niveau tarifaire) du serveur.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ServerPrivateEndpointConnection

Liste des connexions de point de terminaison privé sur un serveur

Nom	Type	Description
id	string	ID de ressource de la connexion de point de terminaison privé.
properties	ServerPrivateEndpointConnectionProperties	Propriétés de connexion de point de terminaison privé

ServerPrivateEndpointConnectionProperties

Propriétés de connexion de point de terminaison privé

Nom	Type	Description
privateEndpoint	PrivateEndpointProperty	Point de terminaison privé auquel la connexion appartient.
privateLinkServiceConnectionState	ServerPrivateLinkServiceConnectionStateProperty	État de la connexion du point de terminaison privé.
provisioningState	PrivateEndpointProvisioningState	État de la connexion de point de terminaison privé.

ServerPrivateLinkServiceConnectionStateProperty

État de la connexion du point de terminaison privé.

Nom	Type	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Actions requises pour la connexion au service de liaison privée.
description	string	Description de la connexion au service de liaison privée.
status	PrivateLinkServiceConnectionStateStatus	La connexion au service de liaison privée status.

ServerState

État d’un serveur visible par l’utilisateur.

Nom	Type	Description
Disabled	string
Dropping	string
Ready	string

ServerUpdateParameters

Paramètres requis pour la mise à jour d’un serveur.

Nom	Type	Description
properties.administratorLoginPassword	string	Mot de passe de la connexion administrateur.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Appliquez une version minimale de Tls pour le serveur.
properties.publicNetworkAccess	PublicNetworkAccessEnum	Indique si l’accès au réseau public est autorisé ou non pour ce serveur. La valeur est facultative, mais si elle est transmise, doit être « Enabled » ou « Disabled »
properties.replicationRole	string	Rôle de réplication du serveur.
properties.sslEnforcement	SslEnforcementEnum	Activez ou non l’application ssl lors de la connexion au serveur.
properties.storageProfile	StorageProfile	Profil de stockage d’un serveur.
properties.version	ServerVersion	Version d’un serveur.
sku	Sku	Référence SKU (niveau tarifaire) du serveur.
tags	object	Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

ServerVersion

Version du serveur.

Nom	Type	Description
10.2	string
10.3	string

Sku

Référence SKU (niveau tarifaire) du serveur.

Nom	Type	Description
capacity	integer	Capacité de montée en puissance/sortie, représentant les unités de calcul du serveur.
family	string	Famille de matériel.
name	string	Nom de la référence sku, généralement niveau + famille + cœurs, par exemple B_Gen4_1, GP_Gen5_8.
size	string	Code de taille, à interpréter par la ressource comme il convient.
tier	SkuTier	Niveau de la référence SKU particulière, par exemple De base.

SkuTier

Niveau de la référence SKU particulière, par exemple De base.

Nom	Type	Description
Basic	string
GeneralPurpose	string
MemoryOptimized	string

SslEnforcementEnum

Activez ou non l’application ssl lors de la connexion au serveur.

Nom	Type	Description
Disabled	string
Enabled	string

StorageAutogrow

Activez la croissance automatique du stockage.

Nom	Type	Description
Disabled	string
Enabled	string

StorageProfile

Profil de stockage d’un serveur.

Nom	Type	Description
backupRetentionDays	integer	Jours de rétention de sauvegarde pour le serveur.
geoRedundantBackup	GeoRedundantBackup	Activez la géoredondant ou non pour la sauvegarde du serveur.
storageAutogrow	StorageAutogrow	Activez la croissance automatique du stockage.
storageMB	integer	Stockage maximal autorisé pour un serveur.