Servers - Update

Ссылка

Service:: MariaDB

API Version:: 2018-06-01

Обновляет существующий сервер. Текст запроса может содержать от одного до многих свойств, присутствующих в определении обычного сервера.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
parameters	ServerUpdateParameters	Обязательные параметры для обновления сервера.

Ответы

Имя	Тип	Описание
200 OK	Server	ОК
202 Accepted		Принято
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ServerUpdate

Sample Request

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

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

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

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

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

Определения

Имя	Описание
CloudError	Ответ об ошибке от пакетной службы.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorResponse	Сообщение об ошибке
GeoRedundantBackup	Включите геоизбыточное или нет для резервного копирования сервера.
MinimalTlsVersionEnum	Примените минимальную версию TLS для сервера.
PrivateEndpointProperty	Частная конечная точка, к которой принадлежит подключение.
PrivateEndpointProvisioningState	Состояние подключения к частной конечной точке.
PrivateLinkServiceConnectionStateActionsRequire	Действия, необходимые для подключения службы приватного канала.
PrivateLinkServiceConnectionStateStatus	Состояние подключения службы приватного канала.
PublicNetworkAccessEnum	Разрешен ли доступ к общедоступной сети для этого сервера. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено".
Server	Представляет сервер.
ServerPrivateEndpointConnection	Список подключений к частной конечной точке на сервере
ServerPrivateEndpointConnectionProperties	Свойства подключения к частной конечной точке
ServerPrivateLinkServiceConnectionStateProperty	Состояние подключения к частной конечной точке.
ServerState	Состояние сервера, видимое пользователю.
ServerUpdateParameters	Обязательные параметры для обновления сервера.
ServerVersion	Версия сервера.
Sku	Номер SKU (ценовая категория) сервера.
SkuTier	Уровень конкретного номера SKU, например "Базовый".
SslEnforcementEnum	Включите принудительное применение SSL при подключении к серверу.
StorageAutogrow	Включите автоматическое увеличение хранилища.
StorageProfile	Профиль хранилища сервера.

CloudError

Ответ об ошибке от пакетной службы.

Имя	Тип	Описание
error	ErrorResponse	Сообщение об ошибке Сообщение об ошибке

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorResponse[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

GeoRedundantBackup

Включите геоизбыточное или нет для резервного копирования сервера.

Имя	Тип	Описание
Disabled	string
Enabled	string

MinimalTlsVersionEnum

Примените минимальную версию TLS для сервера.

Имя	Тип	Описание
TLS1_0	string
TLS1_1	string
TLS1_2	string
TLSEnforcementDisabled	string

PrivateEndpointProperty

Частная конечная точка, к которой принадлежит подключение.

Имя	Тип	Описание
id	string	Идентификатор ресурса частной конечной точки.

PrivateEndpointProvisioningState

Состояние подключения к частной конечной точке.

Имя	Тип	Описание
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

Действия, необходимые для подключения службы приватного канала.

Имя	Тип	Описание
None	string

PrivateLinkServiceConnectionStateStatus

Состояние подключения службы приватного канала.

Имя	Тип	Описание
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccessEnum

Разрешен ли доступ к общедоступной сети для этого сервера. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено".

Имя	Тип	Описание
Disabled	string
Enabled	string

Server

Представляет сервер.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса.
properties.administratorLogin	string	Имя входа администратора сервера. Может указываться только при создании сервера (и требуется для создания).
properties.earliestRestoreDate	string	Самое раннее время создания точки восстановления (ISO8601 формате)
properties.fullyQualifiedDomainName	string	Полное доменное имя сервера.
properties.masterServerId	string	Идентификатор сервера master сервера реплика.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Примените минимальную версию TLS для сервера.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Список подключений к частной конечной точке на сервере
properties.publicNetworkAccess	PublicNetworkAccessEnum	Разрешен ли доступ к общедоступной сети для этого сервера. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено".
properties.replicaCapacity	integer	Максимальное количество реплик, которое может иметь сервер master.
properties.replicationRole	string	Роль репликации сервера.
properties.sslEnforcement	SslEnforcementEnum	Включите принудительное применение SSL при подключении к серверу.
properties.storageProfile	StorageProfile	Профиль хранилища сервера.
properties.userVisibleState	ServerState	Состояние сервера, видимое пользователю.
properties.version	ServerVersion	Версия сервера.
sku	Sku	Номер SKU (ценовая категория) сервера.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ServerPrivateEndpointConnection

Список подключений к частной конечной точке на сервере

Имя	Тип	Описание
id	string	Идентификатор ресурса подключения к частной конечной точке.
properties	ServerPrivateEndpointConnectionProperties	Свойства подключения к частной конечной точке

ServerPrivateEndpointConnectionProperties

Свойства подключения к частной конечной точке

Имя	Тип	Описание
privateEndpoint	PrivateEndpointProperty	Частная конечная точка, к которой принадлежит подключение.
privateLinkServiceConnectionState	ServerPrivateLinkServiceConnectionStateProperty	Состояние подключения к частной конечной точке.
provisioningState	PrivateEndpointProvisioningState	Состояние подключения к частной конечной точке.

ServerPrivateLinkServiceConnectionStateProperty

Состояние подключения к частной конечной точке.

Имя	Тип	Описание
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Действия, необходимые для подключения службы приватного канала.
description	string	Описание подключения службы приватного канала.
status	PrivateLinkServiceConnectionStateStatus	Состояние подключения службы приватного канала.

ServerState

Состояние сервера, видимое пользователю.

Имя	Тип	Описание
Disabled	string
Dropping	string
Ready	string

ServerUpdateParameters

Обязательные параметры для обновления сервера.

Имя	Тип	Описание
properties.administratorLoginPassword	string	Пароль для входа администратора.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Примените минимальную версию TLS для сервера.
properties.publicNetworkAccess	PublicNetworkAccessEnum	Разрешен ли доступ к общедоступной сети для этого сервера. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено".
properties.replicationRole	string	Роль репликации сервера.
properties.sslEnforcement	SslEnforcementEnum	Включите принудительное применение SSL при подключении к серверу.
properties.storageProfile	StorageProfile	Профиль хранилища сервера.
properties.version	ServerVersion	Версия сервера.
sku	Sku	Номер SKU (ценовая категория) сервера.
tags	object	Метаданные конкретного приложения в формате пар "ключ — значение".

ServerVersion

Версия сервера.

Имя	Тип	Описание
10.2	string
10.3	string

Sku

Номер SKU (ценовая категория) сервера.

Имя	Тип	Описание
capacity	integer	Емкость увеличения и уменьшения масштаба, представляющая единицы вычислений сервера.
family	string	Семейство оборудования.
name	string	Имя SKU, как правило, уровень + семейство + ядра, например B_Gen4_1, GP_Gen5_8.
size	string	Код размера, интерпретируемый ресурсом соответствующим образом.
tier	SkuTier	Уровень конкретного номера SKU, например "Базовый".

SkuTier

Уровень конкретного номера SKU, например "Базовый".

Имя	Тип	Описание
Basic	string
GeneralPurpose	string
MemoryOptimized	string

SslEnforcementEnum

Включите принудительное применение SSL при подключении к серверу.

Имя	Тип	Описание
Disabled	string
Enabled	string

StorageAutogrow

Включите автоматическое увеличение хранилища.

Имя	Тип	Описание
Disabled	string
Enabled	string

StorageProfile

Профиль хранилища сервера.

Имя	Тип	Описание
backupRetentionDays	integer	Дни хранения резервных копий для сервера.
geoRedundantBackup	GeoRedundantBackup	Включите геоизбыточное или нет для резервного копирования сервера.
storageAutogrow	StorageAutogrow	Включите автоматическое увеличение хранилища.
storageMB	integer	Максимальный объем хранилища, разрешенный для сервера.

Share via

Servers - Update

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Scopes

Примеры

ServerUpdate

Sample Request

Sample Response

Определения

CloudError

ErrorAdditionalInfo

ErrorResponse

GeoRedundantBackup

MinimalTlsVersionEnum

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateStatus

PublicNetworkAccessEnum

Server

ServerPrivateEndpointConnection

ServerPrivateEndpointConnectionProperties

ServerPrivateLinkServiceConnectionStateProperty

ServerState

ServerUpdateParameters

ServerVersion

Sku

SkuTier

SslEnforcementEnum

StorageAutogrow

StorageProfile

Дополнительные ресурсы