Servers - Update

Usługa:

MariaDB

Wersja interfejsu API:

2018-06-01

Aktualizacje istniejącego serwera. Treść żądania może zawierać od jednej do wielu właściwości znajdujących się w normalnej definicji serwera.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
parameters	ServerUpdateParameters	Wymagane parametry aktualizacji serwera.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Server	OK
202 Accepted		Zaakceptowano
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ServerUpdate

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

202

Definicje

Nazwa	Opis
CloudError	Odpowiedź na błąd z usługi Batch.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorResponse	Odpowiedź na błąd
GeoRedundantBackup	Włącz geograficznie nadmiarowe lub nie dla kopii zapasowej serwera.
MinimalTlsVersionEnum	Wymuszaj minimalną wersję protokołu Tls dla serwera.
PrivateEndpointProperty	Prywatny punkt końcowy, do którego należy połączenie.
PrivateEndpointProvisioningState	Stan połączenia prywatnego punktu końcowego.
PrivateLinkServiceConnectionStateActionsRequire	Akcje wymagane do połączenia usługi private link.
PrivateLinkServiceConnectionStateStatus	Stan połączenia usługi private link.
PublicNetworkAccessEnum	Niezależnie od tego, czy dostęp do sieci publicznej jest dozwolony dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone"
Server	Reprezentuje serwer.
ServerPrivateEndpointConnection	Lista połączeń prywatnego punktu końcowego na serwerze
ServerPrivateEndpointConnectionProperties	Właściwości połączenia prywatnego punktu końcowego
ServerPrivateLinkServiceConnectionStateProperty	Stan połączenia prywatnego punktu końcowego.
ServerState	Stan serwera, który jest widoczny dla użytkownika.
ServerUpdateParameters	Wymagane parametry aktualizacji serwera.
ServerVersion	Wersja serwera.
Sku	Jednostka SKU (warstwa cenowa) serwera.
SkuTier	Warstwa określonej jednostki SKU, np. Podstawowa.
SslEnforcementEnum	Włącz wymuszanie ssl lub nie podczas nawiązywania połączenia z serwerem.
StorageAutogrow	Włącz automatyczne zwiększanie magazynu.
StorageProfile	Profil magazynu serwera.

CloudError

Odpowiedź na błąd z usługi Batch.

Nazwa	Typ	Opis
error	ErrorResponse	Odpowiedź na błąd Komunikat o błędzie

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorResponse[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

GeoRedundantBackup

Włącz geograficznie nadmiarowe lub nie dla kopii zapasowej serwera.

Nazwa	Typ	Opis
Disabled	string
Enabled	string

MinimalTlsVersionEnum

Wymuszaj minimalną wersję protokołu Tls dla serwera.

Nazwa	Typ	Opis
TLS1_0	string
TLS1_1	string
TLS1_2	string
TLSEnforcementDisabled	string

PrivateEndpointProperty

Prywatny punkt końcowy, do którego należy połączenie.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu prywatnego punktu końcowego.

PrivateEndpointProvisioningState

Stan połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

Akcje wymagane do połączenia usługi private link.

Nazwa	Typ	Opis
None	string

PrivateLinkServiceConnectionStateStatus

Stan połączenia usługi private link.

Nazwa	Typ	Opis
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccessEnum

Niezależnie od tego, czy dostęp do sieci publicznej jest dozwolony dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone"

Nazwa	Typ	Opis
Disabled	string
Enabled	string

Server

Reprezentuje serwer.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.administratorLogin	string	Nazwa logowania administratora serwera. Można określić tylko wtedy, gdy serwer jest tworzony (i jest wymagany do utworzenia).
properties.earliestRestoreDate	string	Najwcześniejszy czas tworzenia punktu przywracania (format ISO8601)
properties.fullyQualifiedDomainName	string	W pełni kwalifikowana nazwa domeny serwera.
properties.masterServerId	string	Identyfikator serwera głównego serwera repliki.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Wymuszaj minimalną wersję protokołu Tls dla serwera.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Lista połączeń prywatnego punktu końcowego na serwerze
properties.publicNetworkAccess	PublicNetworkAccessEnum	Niezależnie od tego, czy dostęp do sieci publicznej jest dozwolony dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone"
properties.replicaCapacity	integer	Maksymalna liczba replik, które może mieć serwer główny.
properties.replicationRole	string	Rola replikacji serwera.
properties.sslEnforcement	SslEnforcementEnum	Włącz wymuszanie ssl lub nie podczas nawiązywania połączenia z serwerem.
properties.storageProfile	StorageProfile	Profil magazynu serwera.
properties.userVisibleState	ServerState	Stan serwera, który jest widoczny dla użytkownika.
properties.version	ServerVersion	Wersja serwera.
sku	Sku	Jednostka SKU (warstwa cenowa) serwera.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ServerPrivateEndpointConnection

Lista połączeń prywatnego punktu końcowego na serwerze

Nazwa	Typ	Opis
id	string	Identyfikator zasobu połączenia prywatnego punktu końcowego.
properties	ServerPrivateEndpointConnectionProperties	Właściwości połączenia prywatnego punktu końcowego

ServerPrivateEndpointConnectionProperties

Właściwości połączenia prywatnego punktu końcowego

Nazwa	Typ	Opis
privateEndpoint	PrivateEndpointProperty	Prywatny punkt końcowy, do którego należy połączenie.
privateLinkServiceConnectionState	ServerPrivateLinkServiceConnectionStateProperty	Stan połączenia prywatnego punktu końcowego.
provisioningState	PrivateEndpointProvisioningState	Stan połączenia prywatnego punktu końcowego.

ServerPrivateLinkServiceConnectionStateProperty

Stan połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Akcje wymagane do połączenia usługi private link.
description	string	Opis połączenia usługi private link.
status	PrivateLinkServiceConnectionStateStatus	Stan połączenia usługi private link.

ServerState

Stan serwera, który jest widoczny dla użytkownika.

Nazwa	Typ	Opis
Disabled	string
Dropping	string
Ready	string

ServerUpdateParameters

Wymagane parametry aktualizacji serwera.

Nazwa	Typ	Opis
properties.administratorLoginPassword	string	Hasło logowania administratora.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Wymuszaj minimalną wersję protokołu Tls dla serwera.
properties.publicNetworkAccess	PublicNetworkAccessEnum	Niezależnie od tego, czy dostęp do sieci publicznej jest dozwolony dla tego serwera. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone"
properties.replicationRole	string	Rola replikacji serwera.
properties.sslEnforcement	SslEnforcementEnum	Włącz wymuszanie ssl lub nie podczas nawiązywania połączenia z serwerem.
properties.storageProfile	StorageProfile	Profil magazynu serwera.
properties.version	ServerVersion	Wersja serwera.
sku	Sku	Jednostka SKU (warstwa cenowa) serwera.
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

ServerVersion

Wersja serwera.

Nazwa	Typ	Opis
10.2	string
10.3	string

Sku

Jednostka SKU (warstwa cenowa) serwera.

Nazwa	Typ	Opis
capacity	integer	Pojemność skalowania w górę/w poziomie reprezentująca jednostki obliczeniowe serwera.
family	string	Rodzina sprzętu.
name	string	Nazwa jednostki SKU, zazwyczaj warstwa + rodzina i rdzenie, np. B_Gen4_1, GP_Gen5_8.
size	string	Kod rozmiaru, który ma być interpretowany przez zasób zgodnie z potrzebami.
tier	SkuTier	Warstwa określonej jednostki SKU, np. Podstawowa.

SkuTier

Warstwa określonej jednostki SKU, np. Podstawowa.

Nazwa	Typ	Opis
Basic	string
GeneralPurpose	string
MemoryOptimized	string

SslEnforcementEnum

Włącz wymuszanie ssl lub nie podczas nawiązywania połączenia z serwerem.

Nazwa	Typ	Opis
Disabled	string
Enabled	string

StorageAutogrow

Włącz automatyczne zwiększanie magazynu.

Nazwa	Typ	Opis
Disabled	string
Enabled	string

StorageProfile

Profil magazynu serwera.

Nazwa	Typ	Opis
backupRetentionDays	integer	Dni przechowywania kopii zapasowych serwera.
geoRedundantBackup	GeoRedundantBackup	Włącz geograficznie nadmiarowe lub nie dla kopii zapasowej serwera.
storageAutogrow	StorageAutogrow	Włącz automatyczne zwiększanie magazynu.
storageMB	integer	Maksymalna dozwolona ilość miejsca do magazynowania dla serwera.