Servers - Update

サービス:

MariaDB

API バージョン:

2018-06-01

既存のサーバーを更新します。 要求本文には、通常のサーバー定義に存在する 1 から多くのプロパティを含めることができます。

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	ターゲット サブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	型	説明
parameters	ServerUpdateParameters	サーバーを更新するために必要なパラメーター。

応答

名前	型	説明
200 OK	Server	OK
202 Accepted		同意
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントの借用

例

ServerUpdate

要求のサンプル

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

応答のサンプル

状態コード:

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

状態コード:

202

定義

名前	説明
CloudError	Batch サービスからのエラー応答。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	エラー応答
GeoRedundantBackup	サーバー バックアップで geo 冗長を有効にするか、有効にしないか。
MinimalTlsVersionEnum	サーバーに最小限の Tls バージョンを適用します。
PrivateEndpointProperty	接続が属するプライベート エンドポイント。
PrivateEndpointProvisioningState	プライベート エンドポイント接続の状態。
PrivateLinkServiceConnectionStateActionsRequire	プライベート リンク サービス接続に必要なアクション。
PrivateLinkServiceConnectionStateStatus	プライベート リンク サービスの接続状態。
PublicNetworkAccessEnum	このサーバーに対してパブリック ネットワーク アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 、'Enabled' または 'Disabled' である必要があります
Server	サーバーを表します。
ServerPrivateEndpointConnection	サーバー上のプライベート エンドポイント接続の一覧
ServerPrivateEndpointConnectionProperties	プライベート エンドポイント接続プロパティ
ServerPrivateLinkServiceConnectionStateProperty	プライベート エンドポイント接続の接続状態。
ServerState	ユーザーに表示されるサーバーの状態。
ServerUpdateParameters	サーバーを更新するために必要なパラメーター。
ServerVersion	サーバーのバージョン。
Sku	サーバーの SKU (価格レベル)。
SkuTier	特定の SKU のレベル (Basic など)。
SslEnforcementEnum	サーバーに接続するときに ssl 強制を有効にするか、有効にしないか。
StorageAutogrow	ストレージの自動拡張を有効にします。
StorageProfile	サーバーのストレージ プロファイル。

CloudError

Batch サービスからのエラー応答。

名前	型	説明
error	ErrorResponse	エラー応答 エラー メッセージ

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorResponse

エラー応答

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorResponse[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

GeoRedundantBackup

サーバー バックアップで geo 冗長を有効にするか、有効にしないか。

名前	型	説明
Disabled	string
Enabled	string

MinimalTlsVersionEnum

サーバーに最小限の Tls バージョンを適用します。

名前	型	説明
TLS1_0	string
TLS1_1	string
TLS1_2	string
TLSEnforcementDisabled	string

PrivateEndpointProperty

接続が属するプライベート エンドポイント。

名前	型	説明
id	string	プライベート エンドポイントのリソース ID。

PrivateEndpointProvisioningState

プライベート エンドポイント接続の状態。

名前	型	説明
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

プライベート リンク サービス接続に必要なアクション。

名前	型	説明
None	string

PrivateLinkServiceConnectionStateStatus

プライベート リンク サービスの接続状態。

名前	型	説明
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccessEnum

このサーバーに対してパブリック ネットワーク アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 、'Enabled' または 'Disabled' である必要があります

名前	型	説明
Disabled	string
Enabled	string

Server

サーバーを表します。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /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	レプリカ サーバーのマスター サーバー ID。
properties.minimalTlsVersion	MinimalTlsVersionEnum	サーバーに最小限の Tls バージョンを適用します。
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	サーバー上のプライベート エンドポイント接続の一覧
properties.publicNetworkAccess	PublicNetworkAccessEnum	このサーバーに対してパブリック ネットワーク アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 、'Enabled' または 'Disabled' である必要があります
properties.replicaCapacity	integer	マスター サーバーで使用できるレプリカの最大数。
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	プライベート エンドポイント接続のリソース ID。
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	このサーバーに対してパブリック ネットワーク アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 、'Enabled' または 'Disabled' である必要があります
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 のレベル (Basic など)。

SkuTier

特定の SKU のレベル (Basic など)。

名前	型	説明
Basic	string
GeneralPurpose	string
MemoryOptimized	string

SslEnforcementEnum

サーバーに接続するときに ssl 強制を有効にするか、有効にしないか。

名前	型	説明
Disabled	string
Enabled	string

StorageAutogrow

ストレージの自動拡張を有効にします。

名前	型	説明
Disabled	string
Enabled	string

StorageProfile

サーバーのストレージ プロファイル。

名前	型	説明
backupRetentionDays	integer	サーバーのバックアップ保有日数。
geoRedundantBackup	GeoRedundantBackup	サーバー バックアップで geo 冗長を有効にするか、有効にしないか。
storageAutogrow	StorageAutogrow	ストレージの自動拡張を有効にします。
storageMB	integer	サーバーに対して許可される最大ストレージ数。