Servers - Update

Service:

MariaDB

API Version:

2018-06-01

Aktualizace existující server. Text požadavku může obsahovat jednu až mnoho vlastností, které jsou přítomné v normální definici serveru.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
parameters	ServerUpdateParameters	Požadované parametry pro aktualizaci serveru.

Odpovědi

Name	Typ	Description
200 OK	Server	OK
202 Accepted		Přijato
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ServerUpdate

Sample Request

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

Sample Response

Status code:

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

Status code:

202

Definice

Name	Description
CloudError	Chybová odpověď ze služby Batch.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorResponse	Odpověď na chybu
GeoRedundantBackup	Pro zálohování serveru povolte geograficky redundantní nebo ne.
MinimalTlsVersionEnum	Vynucujte minimální verzi protokolu TLS pro server.
PrivateEndpointProperty	Privátní koncový bod, ke kterému připojení patří.
PrivateEndpointProvisioningState	Stav připojení privátního koncového bodu.
PrivateLinkServiceConnectionStateActionsRequire	Akce vyžadované pro připojení služby private link.
PrivateLinkServiceConnectionStateStatus	Stav připojení služby private link.
PublicNetworkAccessEnum	Určuje, jestli je pro tento server povolený veřejný síťový přístup. Hodnota je volitelná, ale pokud je předána, musí být Povolená nebo Zakázaná.
Server	Představuje server.
ServerPrivateEndpointConnection	Seznam připojení privátních koncových bodů na serveru
ServerPrivateEndpointConnectionProperties	Vlastnosti připojení privátního koncového bodu
ServerPrivateLinkServiceConnectionStateProperty	Stav připojení privátního koncového bodu.
ServerState	Stav serveru, který je viditelný pro uživatele.
ServerUpdateParameters	Požadované parametry pro aktualizaci serveru.
ServerVersion	Verze serveru.
Sku	Skladová položka (cenová úroveň) serveru.
SkuTier	Úroveň konkrétní skladové položky, například Basic.
SslEnforcementEnum	Při připojení k serveru povolte vynucování ssl nebo ne.
StorageAutogrow	Povolte automatické zvětšování úložiště.
StorageProfile	Profil úložiště serveru.

CloudError

Chybová odpověď ze služby Batch.

Name	Typ	Description
error	ErrorResponse	Odpověď na chybu Chybová zpráva

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě
code	string	Kód chyby
details	ErrorResponse[]	Podrobnosti o chybě
message	string	Chybová zpráva
target	string	Cíl chyby.

GeoRedundantBackup

Pro zálohování serveru povolte geograficky redundantní nebo ne.

Name	Typ	Description
Disabled	string
Enabled	string

MinimalTlsVersionEnum

Vynucujte minimální verzi protokolu TLS pro server.

Name	Typ	Description
TLS1_0	string
TLS1_1	string
TLS1_2	string
TLSEnforcementDisabled	string

PrivateEndpointProperty

Privátní koncový bod, ke kterému připojení patří.

Name	Typ	Description
id	string	ID prostředku privátního koncového bodu

PrivateEndpointProvisioningState

Stav připojení privátního koncového bodu.

Name	Typ	Description
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

Akce vyžadované pro připojení služby private link.

Name	Typ	Description
None	string

PrivateLinkServiceConnectionStateStatus

Stav připojení služby private link.

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccessEnum

Určuje, jestli je pro tento server povolený veřejný síťový přístup. Hodnota je volitelná, ale pokud je předána, musí být Povolená nebo Zakázaná.

Name	Typ	Description
Disabled	string
Enabled	string

Server

Představuje server.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Geografické umístění, ve kterém se nachází prostředek
name	string	Název prostředku
properties.administratorLogin	string	Přihlašovací jméno správce serveru. Lze zadat pouze v případě, že se server vytváří (a vyžaduje se k vytvoření).
properties.earliestRestoreDate	string	Nejstarší čas vytvoření bodu obnovení (formát ISO8601)
properties.fullyQualifiedDomainName	string	Plně kvalifikovaný název domény serveru.
properties.masterServerId	string	ID hlavního serveru serveru repliky.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Vynucujte minimální verzi protokolu TLS pro server.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Seznam připojení privátních koncových bodů na serveru
properties.publicNetworkAccess	PublicNetworkAccessEnum	Určuje, jestli je pro tento server povolený veřejný síťový přístup. Hodnota je volitelná, ale pokud je předána, musí být Povolená nebo Zakázaná.
properties.replicaCapacity	integer	Maximální počet replik, které může mít hlavní server.
properties.replicationRole	string	Role replikace serveru.
properties.sslEnforcement	SslEnforcementEnum	Při připojení k serveru povolte vynucování ssl nebo ne.
properties.storageProfile	StorageProfile	Profil úložiště serveru.
properties.userVisibleState	ServerState	Stav serveru, který je viditelný pro uživatele.
properties.version	ServerVersion	Verze serveru.
sku	Sku	Skladová položka (cenová úroveň) serveru.
tags	object	Značky prostředků.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ServerPrivateEndpointConnection

Seznam připojení privátních koncových bodů na serveru

Name	Typ	Description
id	string	ID prostředku připojení privátního koncového bodu.
properties	ServerPrivateEndpointConnectionProperties	Vlastnosti připojení privátního koncového bodu

ServerPrivateEndpointConnectionProperties

Vlastnosti připojení privátního koncového bodu

Name	Typ	Description
privateEndpoint	PrivateEndpointProperty	Privátní koncový bod, ke kterému připojení patří.
privateLinkServiceConnectionState	ServerPrivateLinkServiceConnectionStateProperty	Stav připojení privátního koncového bodu.
provisioningState	PrivateEndpointProvisioningState	Stav připojení privátního koncového bodu.

ServerPrivateLinkServiceConnectionStateProperty

Stav připojení privátního koncového bodu.

Name	Typ	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Akce vyžadované pro připojení služby private link.
description	string	Popis připojení služby private link.
status	PrivateLinkServiceConnectionStateStatus	Stav připojení služby private link.

ServerState

Stav serveru, který je viditelný pro uživatele.

Name	Typ	Description
Disabled	string
Dropping	string
Ready	string

ServerUpdateParameters

Požadované parametry pro aktualizaci serveru.

Name	Typ	Description
properties.administratorLoginPassword	string	Heslo pro přihlášení správce.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Vynucujte minimální verzi protokolu TLS pro server.
properties.publicNetworkAccess	PublicNetworkAccessEnum	Určuje, jestli je pro tento server povolený veřejný síťový přístup. Hodnota je volitelná, ale pokud je předána, musí být Povolená nebo Zakázaná.
properties.replicationRole	string	Role replikace serveru.
properties.sslEnforcement	SslEnforcementEnum	Při připojení k serveru povolte vynucování ssl nebo ne.
properties.storageProfile	StorageProfile	Profil úložiště serveru.
properties.version	ServerVersion	Verze serveru.
sku	Sku	Skladová položka (cenová úroveň) serveru.
tags	object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

ServerVersion

Verze serveru.

Name	Typ	Description
10.2	string
10.3	string

Sku

Skladová položka (cenová úroveň) serveru.

Name	Typ	Description
capacity	integer	Kapacita vertikálního navýšení/snížení kapacity představující výpočetní jednotky serveru.
family	string	Rodina hardwaru.
name	string	Název skladové položky, obvykle vrstva + rodina + jádra, například B_Gen4_1, GP_Gen5_8.
size	string	Kód velikosti, který má být odpovídajícím způsobem interpretován prostředkem.
tier	SkuTier	Úroveň konkrétní skladové položky, například Basic.

SkuTier

Úroveň konkrétní skladové položky, například Basic.

Name	Typ	Description
Basic	string
GeneralPurpose	string
MemoryOptimized	string

SslEnforcementEnum

Při připojení k serveru povolte vynucování ssl nebo ne.

Name	Typ	Description
Disabled	string
Enabled	string

StorageAutogrow

Povolte automatické zvětšování úložiště.

Name	Typ	Description
Disabled	string
Enabled	string

StorageProfile

Profil úložiště serveru.

Name	Typ	Description
backupRetentionDays	integer	Dny uchovávání záloh pro server.
geoRedundantBackup	GeoRedundantBackup	Pro zálohování serveru povolte geograficky redundantní nebo ne.
storageAutogrow	StorageAutogrow	Povolte automatické zvětšování úložiště.
storageMB	integer	Maximální povolené úložiště pro server