Servers - Update

Service:

MySQL

API Version:

2023-12-30

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.DBforMySQL/flexibleServers/{serverName}?api-version=2023-12-30

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. Regex pattern: ^[a-z0-9][-a-z0-9]*(?<!-)$
subscriptionId	path	True	string uuid	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
identity.type	ManagedServiceIdentityType	Typ identity spravované služby
identity.userAssignedIdentities	object	Metadata identity přiřazené uživatelem.
properties.administratorLoginPassword	string	Heslo pro přihlášení správce.
properties.backup	Backup	Vlastnosti serveru související se zálohováním.
properties.dataEncryption	DataEncryption	Šifrování dat pro CMK.
properties.highAvailability	HighAvailability	Vlastnosti serveru související s vysokou dostupností
properties.maintenanceWindow	MaintenanceWindow	Časové období údržby serveru.
properties.network	Network	Vlastnosti serveru související se sítí
properties.replicationRole	ReplicationRole	Role replikace serveru.
properties.storage	Storage	Vlastnosti serveru související s úložištěm
properties.version	ServerVersion	Verze serveru.
sku	MySQLServerSku	Skladová položka (cenová úroveň) serveru.
tags	object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

Odpovědi

Name	Typ	Description
200 OK	Server	OK
202 Accepted		Přijato Headers Location: string
Other Status Codes	ErrorResponse	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

Update a server

Update server customer maintenance window

Update server with byok

Update a server

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver?api-version=2023-12-30

{
  "properties": {
    "storage": {
      "storageSizeGB": 30,
      "iops": 200,
      "autoGrow": "Disabled",
      "autoIoScaling": "Disabled"
    },
    "network": {
      "publicNetworkAccess": "Disabled"
    }
  }
}

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.rdbms.mysql_flexibleservers import MySQLManagementClient

"""
# 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 = MySQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testrg",
        server_name="mysqltestserver",
        parameters={
            "properties": {
                "network": {"publicNetworkAccess": "Disabled"},
                "storage": {"autoGrow": "Disabled", "autoIoScaling": "Disabled", "iops": 200, "storageSizeGB": 30},
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/stable/2023-12-30/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 armmysqlflexibleservers_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/mysql/armmysqlflexibleservers/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b8691fbfca8fcdc5a241a0b501c32fd4a76bb0cd/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/stable/2023-12-30/examples/ServerUpdate.json
func ExampleServersClient_BeginUpdate_updateAServer() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmysqlflexibleservers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewServersClient().BeginUpdate(ctx, "testrg", "mysqltestserver", armmysqlflexibleservers.ServerForUpdate{
		Properties: &armmysqlflexibleservers.ServerPropertiesForUpdate{
			Network: &armmysqlflexibleservers.Network{
				PublicNetworkAccess: to.Ptr(armmysqlflexibleservers.EnableStatusEnumDisabled),
			},
			Storage: &armmysqlflexibleservers.Storage{
				AutoGrow:      to.Ptr(armmysqlflexibleservers.EnableStatusEnumDisabled),
				AutoIoScaling: to.Ptr(armmysqlflexibleservers.EnableStatusEnumDisabled),
				Iops:          to.Ptr[int32](200),
				StorageSizeGB: to.Ptr[int32](30),
			},
		},
	}, 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 = armmysqlflexibleservers.Server{
	// 	Name: to.Ptr("mysqltestserver"),
	// 	Type: to.Ptr("Microsoft.DBforMySQL/flexibleServers"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver"),
	// 	Location: to.Ptr("Southeast Asia"),
	// 	Tags: map[string]*string{
	// 		"num": to.Ptr("1"),
	// 	},
	// 	Properties: &armmysqlflexibleservers.ServerProperties{
	// 		AdministratorLogin: to.Ptr("cloudsa"),
	// 		AvailabilityZone: to.Ptr("3"),
	// 		Backup: &armmysqlflexibleservers.Backup{
	// 			BackupIntervalHours: to.Ptr[int32](24),
	// 			BackupRetentionDays: to.Ptr[int32](7),
	// 			EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-17T06:11:38.415Z"); return t}()),
	// 			GeoRedundantBackup: to.Ptr(armmysqlflexibleservers.EnableStatusEnumDisabled),
	// 		},
	// 		FullyQualifiedDomainName: to.Ptr("mysqltestserver.database.mysql.azure.com"),
	// 		HighAvailability: &armmysqlflexibleservers.HighAvailability{
	// 			Mode: to.Ptr(armmysqlflexibleservers.HighAvailabilityModeDisabled),
	// 			State: to.Ptr(armmysqlflexibleservers.HighAvailabilityStateNotEnabled),
	// 		},
	// 		MaintenanceWindow: &armmysqlflexibleservers.MaintenanceWindow{
	// 			CustomWindow: to.Ptr("Enabled"),
	// 			DayOfWeek: to.Ptr[int32](1),
	// 			StartHour: to.Ptr[int32](1),
	// 			StartMinute: to.Ptr[int32](0),
	// 		},
	// 		Network: &armmysqlflexibleservers.Network{
	// 			PublicNetworkAccess: to.Ptr(armmysqlflexibleservers.EnableStatusEnumDisabled),
	// 		},
	// 		ReplicaCapacity: to.Ptr[int32](10),
	// 		ReplicationRole: to.Ptr(armmysqlflexibleservers.ReplicationRoleNone),
	// 		State: to.Ptr(armmysqlflexibleservers.ServerStateReady),
	// 		Storage: &armmysqlflexibleservers.Storage{
	// 			AutoGrow: to.Ptr(armmysqlflexibleservers.EnableStatusEnumDisabled),
	// 			AutoIoScaling: to.Ptr(armmysqlflexibleservers.EnableStatusEnumDisabled),
	// 			Iops: to.Ptr[int32](200),
	// 			StorageSizeGB: to.Ptr[int32](30),
	// 			StorageSKU: to.Ptr("Premium_LRS"),
	// 		},
	// 		Version: to.Ptr(armmysqlflexibleservers.ServerVersionFive7),
	// 	},
	// 	SKU: &armmysqlflexibleservers.MySQLServerSKU{
	// 		Name: to.Ptr("Standard_D2ds_v4"),
	// 		Tier: to.Ptr(armmysqlflexibleservers.ServerSKUTierGeneralPurpose),
	// 	},
	// }
}

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": "Standard_D2ds_v4",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "administratorLogin": "cloudsa",
    "storage": {
      "storageSizeGB": 30,
      "iops": 200,
      "autoGrow": "Disabled",
      "storageSku": "Premium_LRS",
      "autoIoScaling": "Disabled"
    },
    "version": "5.7",
    "state": "Ready",
    "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com",
    "availabilityZone": "3",
    "maintenanceWindow": {
      "customWindow": "Enabled",
      "dayOfWeek": 1,
      "startHour": 1,
      "startMinute": 0
    },
    "replicationRole": "None",
    "replicaCapacity": 10,
    "network": {
      "publicNetworkAccess": "Disabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "backupIntervalHours": 24,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00"
    },
    "highAvailability": {
      "mode": "Disabled",
      "state": "NotEnabled"
    }
  },
  "location": "Southeast Asia",
  "tags": {
    "num": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver",
  "name": "mysqltestserver",
  "type": "Microsoft.DBforMySQL/flexibleServers"
}

Status code:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30

Update server customer maintenance window

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver?api-version=2023-12-30

{
  "properties": {
    "maintenanceWindow": {
      "customWindow": "Enabled",
      "dayOfWeek": 1,
      "startHour": 8,
      "startMinute": 0
    }
  }
}

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.rdbms.mysql_flexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-rdbms
# USAGE
    python server_update_with_customer_maintenance_window.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 = MySQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testrg",
        server_name="mysqltestserver",
        parameters={
            "properties": {
                "maintenanceWindow": {"customWindow": "Enabled", "dayOfWeek": 1, "startHour": 8, "startMinute": 0}
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/stable/2023-12-30/examples/ServerUpdateWithCustomerMaintenanceWindow.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 armmysqlflexibleservers_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/mysql/armmysqlflexibleservers/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b8691fbfca8fcdc5a241a0b501c32fd4a76bb0cd/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/stable/2023-12-30/examples/ServerUpdateWithCustomerMaintenanceWindow.json
func ExampleServersClient_BeginUpdate_updateServerCustomerMaintenanceWindow() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmysqlflexibleservers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewServersClient().BeginUpdate(ctx, "testrg", "mysqltestserver", armmysqlflexibleservers.ServerForUpdate{
		Properties: &armmysqlflexibleservers.ServerPropertiesForUpdate{
			MaintenanceWindow: &armmysqlflexibleservers.MaintenanceWindow{
				CustomWindow: to.Ptr("Enabled"),
				DayOfWeek:    to.Ptr[int32](1),
				StartHour:    to.Ptr[int32](8),
				StartMinute:  to.Ptr[int32](0),
			},
		},
	}, 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 = armmysqlflexibleservers.Server{
	// 	Name: to.Ptr("mysqltestserver"),
	// 	Type: to.Ptr("Microsoft.DBforMySQL/flexibleServers"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver"),
	// 	Location: to.Ptr("Southeast Asia"),
	// 	Tags: map[string]*string{
	// 		"num": to.Ptr("1"),
	// 	},
	// 	Properties: &armmysqlflexibleservers.ServerProperties{
	// 		AdministratorLogin: to.Ptr("cloudsa"),
	// 		AvailabilityZone: to.Ptr("3"),
	// 		Backup: &armmysqlflexibleservers.Backup{
	// 			BackupIntervalHours: to.Ptr[int32](24),
	// 			BackupRetentionDays: to.Ptr[int32](7),
	// 			EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-17T06:11:38.415Z"); return t}()),
	// 			GeoRedundantBackup: to.Ptr(armmysqlflexibleservers.EnableStatusEnumDisabled),
	// 		},
	// 		FullyQualifiedDomainName: to.Ptr("mysqltestserver.database.mysql.azure.com"),
	// 		HighAvailability: &armmysqlflexibleservers.HighAvailability{
	// 			Mode: to.Ptr(armmysqlflexibleservers.HighAvailabilityModeDisabled),
	// 			State: to.Ptr(armmysqlflexibleservers.HighAvailabilityStateNotEnabled),
	// 		},
	// 		MaintenanceWindow: &armmysqlflexibleservers.MaintenanceWindow{
	// 			CustomWindow: to.Ptr("Enabled"),
	// 			DayOfWeek: to.Ptr[int32](1),
	// 			StartHour: to.Ptr[int32](8),
	// 			StartMinute: to.Ptr[int32](0),
	// 		},
	// 		Network: &armmysqlflexibleservers.Network{
	// 			PublicNetworkAccess: to.Ptr(armmysqlflexibleservers.EnableStatusEnumEnabled),
	// 		},
	// 		ReplicaCapacity: to.Ptr[int32](10),
	// 		ReplicationRole: to.Ptr(armmysqlflexibleservers.ReplicationRoleNone),
	// 		State: to.Ptr(armmysqlflexibleservers.ServerStateReady),
	// 		Storage: &armmysqlflexibleservers.Storage{
	// 			AutoGrow: to.Ptr(armmysqlflexibleservers.EnableStatusEnumEnabled),
	// 			Iops: to.Ptr[int32](600),
	// 			StorageSizeGB: to.Ptr[int32](100),
	// 			StorageSKU: to.Ptr("Premium_LRS"),
	// 		},
	// 		Version: to.Ptr(armmysqlflexibleservers.ServerVersionFive7),
	// 	},
	// 	SKU: &armmysqlflexibleservers.MySQLServerSKU{
	// 		Name: to.Ptr("Standard_D2ds_v4"),
	// 		Tier: to.Ptr(armmysqlflexibleservers.ServerSKUTierGeneralPurpose),
	// 	},
	// }
}

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": "Standard_D2ds_v4",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "administratorLogin": "cloudsa",
    "storage": {
      "storageSizeGB": 100,
      "iops": 600,
      "autoGrow": "Enabled",
      "storageSku": "Premium_LRS"
    },
    "version": "5.7",
    "state": "Ready",
    "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com",
    "availabilityZone": "3",
    "maintenanceWindow": {
      "customWindow": "Enabled",
      "dayOfWeek": 1,
      "startHour": 8,
      "startMinute": 0
    },
    "replicationRole": "None",
    "replicaCapacity": 10,
    "network": {
      "publicNetworkAccess": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "backupIntervalHours": 24,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00"
    },
    "highAvailability": {
      "mode": "Disabled",
      "state": "NotEnabled"
    }
  },
  "location": "Southeast Asia",
  "tags": {
    "num": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver",
  "name": "mysqltestserver",
  "type": "Microsoft.DBforMySQL/flexibleServers"
}

Status code:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30

Update server with byok

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver?api-version=2023-12-30

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {}
    }
  },
  "properties": {
    "dataEncryption": {
      "type": "AzureKeyVault",
      "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity",
      "primaryKeyURI": "https://test.vault.azure.net/keys/key/c8a92236622244c0a4fdb892666f671a",
      "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-identity",
      "geoBackupKeyURI": "https://test-geo.vault.azure.net/keys/key/c8a92236622244c0a4fdb892666f671a"
    }
  }
}

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.rdbms.mysql_flexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-rdbms
# USAGE
    python server_update_with_byok.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 = MySQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testrg",
        server_name="mysqltestserver",
        parameters={
            "identity": {
                "type": "UserAssigned",
                "userAssignedIdentities": {
                    "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {}
                },
            },
            "properties": {
                "dataEncryption": {
                    "geoBackupKeyURI": "https://test-geo.vault.azure.net/keys/key/c8a92236622244c0a4fdb892666f671a",
                    "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-identity",
                    "primaryKeyURI": "https://test.vault.azure.net/keys/key/c8a92236622244c0a4fdb892666f671a",
                    "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity",
                    "type": "AzureKeyVault",
                }
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/stable/2023-12-30/examples/ServerUpdateWithBYOK.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 armmysqlflexibleservers_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/mysql/armmysqlflexibleservers/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b8691fbfca8fcdc5a241a0b501c32fd4a76bb0cd/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/stable/2023-12-30/examples/ServerUpdateWithBYOK.json
func ExampleServersClient_BeginUpdate_updateServerWithByok() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmysqlflexibleservers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewServersClient().BeginUpdate(ctx, "testrg", "mysqltestserver", armmysqlflexibleservers.ServerForUpdate{
		Identity: &armmysqlflexibleservers.MySQLServerIdentity{
			Type: to.Ptr(armmysqlflexibleservers.ManagedServiceIdentityTypeUserAssigned),
			UserAssignedIdentities: map[string]any{
				"/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": map[string]any{},
			},
		},
		Properties: &armmysqlflexibleservers.ServerPropertiesForUpdate{
			DataEncryption: &armmysqlflexibleservers.DataEncryption{
				Type:                            to.Ptr(armmysqlflexibleservers.DataEncryptionTypeAzureKeyVault),
				GeoBackupKeyURI:                 to.Ptr("https://test-geo.vault.azure.net/keys/key/c8a92236622244c0a4fdb892666f671a"),
				GeoBackupUserAssignedIdentityID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-identity"),
				PrimaryKeyURI:                   to.Ptr("https://test.vault.azure.net/keys/key/c8a92236622244c0a4fdb892666f671a"),
				PrimaryUserAssignedIdentityID:   to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity"),
			},
		},
	}, 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 = armmysqlflexibleservers.Server{
	// 	Name: to.Ptr("mysqltestserver"),
	// 	Type: to.Ptr("Microsoft.DBforMySQL/flexibleServers"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver"),
	// 	Location: to.Ptr("Southeast Asia"),
	// 	Tags: map[string]*string{
	// 		"num": to.Ptr("1"),
	// 	},
	// 	Properties: &armmysqlflexibleservers.ServerProperties{
	// 		AdministratorLogin: to.Ptr("cloudsa"),
	// 		AvailabilityZone: to.Ptr("1"),
	// 		Backup: &armmysqlflexibleservers.Backup{
	// 			BackupIntervalHours: to.Ptr[int32](24),
	// 			BackupRetentionDays: to.Ptr[int32](7),
	// 			EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-17T06:11:38.415Z"); return t}()),
	// 			GeoRedundantBackup: to.Ptr(armmysqlflexibleservers.EnableStatusEnumDisabled),
	// 		},
	// 		FullyQualifiedDomainName: to.Ptr("mysqltestserver.database.mysql.azure.com"),
	// 		HighAvailability: &armmysqlflexibleservers.HighAvailability{
	// 			Mode: to.Ptr(armmysqlflexibleservers.HighAvailabilityModeZoneRedundant),
	// 			StandbyAvailabilityZone: to.Ptr("3"),
	// 			State: to.Ptr(armmysqlflexibleservers.HighAvailabilityStateHealthy),
	// 		},
	// 		MaintenanceWindow: &armmysqlflexibleservers.MaintenanceWindow{
	// 			CustomWindow: to.Ptr("Disabled"),
	// 			DayOfWeek: to.Ptr[int32](0),
	// 			StartHour: to.Ptr[int32](0),
	// 			StartMinute: to.Ptr[int32](0),
	// 		},
	// 		Network: &armmysqlflexibleservers.Network{
	// 			PublicNetworkAccess: to.Ptr(armmysqlflexibleservers.EnableStatusEnumEnabled),
	// 		},
	// 		ReplicaCapacity: to.Ptr[int32](10),
	// 		ReplicationRole: to.Ptr(armmysqlflexibleservers.ReplicationRoleNone),
	// 		State: to.Ptr(armmysqlflexibleservers.ServerStateReady),
	// 		Storage: &armmysqlflexibleservers.Storage{
	// 			AutoGrow: to.Ptr(armmysqlflexibleservers.EnableStatusEnumEnabled),
	// 			Iops: to.Ptr[int32](600),
	// 			StorageSizeGB: to.Ptr[int32](100),
	// 			StorageSKU: to.Ptr("Premium_LRS"),
	// 		},
	// 		Version: to.Ptr(armmysqlflexibleservers.ServerVersionFive7),
	// 	},
	// 	SKU: &armmysqlflexibleservers.MySQLServerSKU{
	// 		Name: to.Ptr("Standard_D2ds_v4"),
	// 		Tier: to.Ptr(armmysqlflexibleservers.ServerSKUTierGeneralPurpose),
	// 	},
	// }
}

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": "Standard_D2ds_v4",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "administratorLogin": "cloudsa",
    "storage": {
      "storageSizeGB": 100,
      "iops": 600,
      "autoGrow": "Enabled",
      "storageSku": "Premium_LRS"
    },
    "version": "5.7",
    "state": "Ready",
    "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com",
    "availabilityZone": "1",
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "replicationRole": "None",
    "replicaCapacity": 10,
    "network": {
      "publicNetworkAccess": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "backupIntervalHours": 24,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "3"
    }
  },
  "location": "Southeast Asia",
  "tags": {
    "num": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver",
  "name": "mysqltestserver",
  "type": "Microsoft.DBforMySQL/flexibleServers"
}

Status code:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-12-30

Definice

Name	Description
Backup	Vlastnosti profilu úložiště serveru
createdByType	Typ identity, která vytvořila prostředek.
CreateMode	Režim pro vytvoření nového serveru MySQL
DataEncryption	Šifrování data pro cmk.
DataEncryptionType	Typ klíče, AzureKeyVault pro povolení cmk, SystemManaged pro zakázání cmk.
EnableStatusEnum	Výčet označující, jestli je hodnota "Povoleno" nebo "Zakázáno"
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
HighAvailability	Vlastnosti vysoké dostupnosti serveru
HighAvailabilityMode	Režim vysoké dostupnosti pro server
HighAvailabilityState	Stav vysoké dostupnosti serveru.
ImportSourceProperties	Importuje vlastnosti související se zdrojem.
ImportSourceStorageType	Typ úložiště zdroje importu.
MaintenanceWindow	Časové období údržby serveru.
ManagedServiceIdentityType	Typ identity spravované služby
MySQLServerSku	Vlastnosti serveru související s fakturačními údaji.
Network	Vlastnosti serveru související se sítí
PrivateEndpoint	Prostředek privátního koncového bodu.
PrivateEndpointConnection	Prostředek připojení privátního koncového bodu.
PrivateEndpointConnectionProvisioningState	Aktuální stav zřizování.
PrivateEndpointServiceConnectionStatus	Stav připojení privátního koncového bodu.
PrivateLinkServiceConnectionState	Kolekce informací o stavu připojení mezi příjemcem služby a poskytovatelem.
ReplicationRole	Role replikace.
Server	Představuje server.
ServerForUpdate	Parametry serveru se můžou aktualizovat.
ServerSkuTier	Úroveň konkrétní skladové položky, například GeneralPurpose.
ServerState	Stav serveru.
ServerVersion	Verze serveru.
Storage	Vlastnosti profilu úložiště serveru
systemData	Metadata týkající se vytvoření a poslední změny prostředku

Backup

Vlastnosti profilu úložiště serveru

Name	Typ	Výchozí hodnota	Description
backupIntervalHours	integer		Hodiny intervalu zálohování pro server.
backupRetentionDays	integer		Dny uchovávání záloh pro server.
earliestRestoreDate	string		Nejstarší čas vytvoření bodu obnovení (formát ISO8601)
geoRedundantBackup	EnableStatusEnum	Disabled	Určuje, jestli je povolené geograficky redundantní zálohování.

createdByType

Typ identity, která vytvořila prostředek.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Režim pro vytvoření nového serveru MySQL

Name	Typ	Description
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string

DataEncryption

Šifrování data pro cmk.

Name	Typ	Description
geoBackupKeyURI	string	Identifikátor URI klíče geografické zálohy jako trezor klíčů nemůže překračovat oblast, je potřeba klíč cmk ve stejné oblasti jako geografické zálohování.
geoBackupUserAssignedIdentityId	string	ID prostředku identity uživatele geografické zálohy, protože identita nemůže překračovat oblast, je potřeba identita ve stejné oblasti jako geografické zálohování
primaryKeyURI	string	Identifikátor URI primárního klíče
primaryUserAssignedIdentityId	string	ID prostředku identity primárního uživatele
type	DataEncryptionType	Typ klíče, AzureKeyVault pro povolení cmk, SystemManaged pro zakázání cmk.

DataEncryptionType

Typ klíče, AzureKeyVault pro povolení cmk, SystemManaged pro zakázání cmk.

Name	Typ	Description
AzureKeyVault	string
SystemManaged	string

EnableStatusEnum

Výčet označující, jestli je hodnota "Povoleno" nebo "Zakázáno"

Name	Typ	Description
Disabled	string
Enabled	string

ErrorAdditionalInfo

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

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

ErrorDetail

Podrobnosti o chybě.

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

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

HighAvailability

Vlastnosti vysoké dostupnosti serveru

Name	Typ	Description
mode	HighAvailabilityMode	Režim vysoké dostupnosti pro server
standbyAvailabilityZone	string	Zóna dostupnosti pohotovostního serveru.
state	HighAvailabilityState	Stav vysoké dostupnosti serveru.

HighAvailabilityMode

Režim vysoké dostupnosti pro server

Name	Typ	Description
Disabled	string
SameZone	string
ZoneRedundant	string

HighAvailabilityState

Stav vysoké dostupnosti serveru.

Name	Typ	Description
CreatingStandby	string
FailingOver	string
Healthy	string
NotEnabled	string
RemovingStandby	string

ImportSourceProperties

Importuje vlastnosti související se zdrojem.

Name	Typ	Description
dataDirPath	string	Relativní cesta k adresáři dat v úložišti.
sasToken	string	Token SAS pro přístup ke zdrojovému úložišti. Pro token SAS se vyžadují oprávnění ke čtení a výpisu.
storageType	ImportSourceStorageType	Typ úložiště zdroje importu.
storageUrl	string	Identifikátor URI zdrojového úložiště importu

ImportSourceStorageType

Typ úložiště zdroje importu.

Name	Typ	Description
AzureBlob	string

MaintenanceWindow

Časové období údržby serveru.

Name	Typ	Description
customWindow	string	označuje, jestli je vlastní okno povolené nebo zakázané.
dayOfWeek	integer	den v týdnu pro časové období údržby
startHour	integer	počáteční hodina pro časové období údržby
startMinute	integer	počáteční minuta pro časové období údržby

ManagedServiceIdentityType

Typ identity spravované služby

Name	Typ	Description
UserAssigned	string

MySQLServerSku

Vlastnosti serveru související s fakturačními údaji.

Name	Typ	Description
name	string	Název skladové položky, například Standard_D32s_v3.
tier	ServerSkuTier	Úroveň konkrétní skladové položky, například GeneralPurpose.

Network

Vlastnosti serveru související se sítí

Name	Typ	Description
delegatedSubnetResourceId	string	ID prostředku delegovaného podsítě použitého k nastavení virtuální sítě pro server
privateDnsZoneResourceId	string	Privátní DNS ID prostředku zóny.
publicNetworkAccess	EnableStatusEnum	Určuje, jestli je pro tento server povolený veřejný síťový přístup. Hodnota je Zakázaná, pokud má server integraci virtuální sítě.

PrivateEndpoint

Prostředek privátního koncového bodu.

Name	Typ	Description
id	string	Identifikátor ARM pro privátní koncový bod.

PrivateEndpointConnection

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

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.groupIds	string[]	ID skupiny pro prostředek privátního koncového bodu.
properties.privateEndpoint	PrivateEndpoint	Prostředek privátního koncového bodu.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Kolekce informací o stavu připojení mezi příjemcem služby a poskytovatelem.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stav zřizování prostředku připojení privátního koncového bodu
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

PrivateEndpointConnectionProvisioningState

Aktuální stav zřizování.

Name	Typ	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

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

Name	Typ	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Kolekce informací o stavu připojení mezi příjemcem služby a poskytovatelem.

Name	Typ	Description
actionsRequired	string	Zpráva s informací, že změny poskytovatele služeb vyžadují aktualizace příjemce.
description	string	Důvod schválení nebo odmítnutí připojení.
status	PrivateEndpointServiceConnectionStatus	Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby.

ReplicationRole

Role replikace.

Name	Typ	Description
None	string
Replica	string
Source	string

Server

Představuje server.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Například /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{název_poskytovatele_prostředku}/{typ_prostředku}/{název_prostředku}.
identity.principalId	string	ObjectId ze služby Key Vault
identity.tenantId	string	Id tenanta ze služby Key Vault
identity.type	ManagedServiceIdentityType	Typ identity spravované služby
identity.userAssignedIdentities	object	Metadata identity přiřazené uživatelem
location	string	Geografické umístění, kde se prostředek nachází
name	string	Název prostředku
properties.administratorLogin	string	Přihlašovací jméno správce serveru. Lze zadat pouze při vytváření serveru (a vyžaduje se k vytvoření).
properties.administratorLoginPassword	string	Heslo pro přihlášení správce (vyžadované pro vytvoření serveru)
properties.availabilityZone	string	dostupnost Informace o zóně serveru.
properties.backup	Backup	Vlastnosti serveru související se zálohováním
properties.createMode	CreateMode	Režim pro vytvoření nového serveru MySQL
properties.dataEncryption	DataEncryption	Šifrování dat pro CMK.
properties.fullyQualifiedDomainName	string	Plně kvalifikovaný název domény serveru.
properties.highAvailability	HighAvailability	Vlastnosti serveru související s vysokou dostupností
properties.importSourceProperties	ImportSourceProperties	Vlastnosti zdroje pro import z úložiště
properties.maintenanceWindow	MaintenanceWindow	Časové období údržby serveru.
properties.network	Network	Vlastnosti serveru související se sítí.
properties.privateEndpointConnections	PrivateEndpointConnection[]	PrivateEndpointConnections související vlastnosti serveru.
properties.replicaCapacity	integer	Maximální počet replik, které může mít primární server.
properties.replicationRole	ReplicationRole	Role replikace.
properties.restorePointInTime	string	Čas vytvoření bodu obnovení (ISO8601 formát) a určení času, ze které se má provést obnovení.
properties.sourceServerResourceId	string	ID zdrojového serveru MySQL.
properties.state	ServerState	Stav serveru.
properties.storage	Storage	Vlastnosti serveru související s úložištěm
properties.version	ServerVersion	Verze serveru.
sku	MySQLServerSku	Skladová položka (cenová úroveň) serveru.
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
tags	object	Značky prostředků.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ServerForUpdate

Parametry serveru se můžou aktualizovat.

Name	Typ	Description
identity.principalId	string	ObjectId ze služby Key Vault
identity.tenantId	string	Id tenanta ze služby Key Vault
identity.type	ManagedServiceIdentityType	Typ identity spravované služby
identity.userAssignedIdentities	object	Metadata identity přiřazené uživatelem
properties.administratorLoginPassword	string	Heslo přihlášení správce.
properties.backup	Backup	Vlastnosti serveru související se zálohováním
properties.dataEncryption	DataEncryption	Šifrování dat pro CMK.
properties.highAvailability	HighAvailability	Vlastnosti serveru související s vysokou dostupností
properties.maintenanceWindow	MaintenanceWindow	Časové období údržby serveru.
properties.network	Network	Vlastnosti serveru související se sítí
properties.replicationRole	ReplicationRole	Role replikace serveru.
properties.storage	Storage	Vlastnosti serveru související s úložištěm
properties.version	ServerVersion	Verze serveru.
sku	MySQLServerSku	Skladová položka (cenová úroveň) serveru.
tags	object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

ServerSkuTier

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

Name	Typ	Description
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

ServerState

Stav serveru.

Name	Typ	Description
Disabled	string
Dropping	string
Ready	string
Starting	string
Stopped	string
Stopping	string
Updating	string

ServerVersion

Verze serveru.

Name	Typ	Description
5.7	string
8.0.21	string

Storage

Vlastnosti profilu úložiště serveru

Name	Typ	Výchozí hodnota	Description
autoGrow	EnableStatusEnum	Disabled	Povolte automatické zvětšování úložiště nebo ne.
autoIoScaling	EnableStatusEnum	Enabled	Povolte automatické škálování vstupně-výstupních operací.
iops	integer		IOPS úložiště pro server.
logOnDisk	EnableStatusEnum	Disabled	Povolte přihlášení na disku nebo ne.
storageSizeGB	integer		Maximální velikost úložiště povolená pro server
storageSku	string		Název skladové položky úložiště serveru.

systemData

Metadata týkající se vytvoření a poslední změny prostředku

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která vytvořila prostředek.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.