Servers - Create

Service:

MySQL

API Version:

2024-06-01-preview

Creates a new server or updates an existing server. The update action will overwrite the existing server.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}?api-version=2024-06-01-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
serverName	path	True	string pattern: ^[a-z0-9][-a-z0-9]*(?	The name of the server.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
identity.type		ManagedServiceIdentityType	Type of managed service identity.
identity.userAssignedIdentities		object	Metadata of user assigned identity.
properties.administratorLogin		string	The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
properties.administratorLoginPassword		string (password)	The password of the administrator login (required for server creation).
properties.availabilityZone		string	availability Zone information of the server.
properties.backup		Backup	Backup related properties of a server.
properties.createMode		CreateMode	The mode to create a new MySQL server.
properties.dataEncryption		DataEncryption	The Data Encryption for CMK.
properties.databasePort		integer (int32)	The server database port. Can only be specified when the server is being created.
properties.highAvailability		HighAvailability	High availability related properties of a server.
properties.importSourceProperties		ImportSourceProperties	Source properties for import from storage.
properties.maintenancePolicy		MaintenancePolicy	Maintenance policy of a server.
properties.maintenanceWindow		MaintenanceWindow	Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately.
properties.network		Network	Network related properties of a server.
properties.replicationRole		ReplicationRole	The replication role.
properties.restorePointInTime		string (date-time)	Restore point creation time (ISO8601 format), specifying the time to restore from.
properties.sourceServerResourceId		string	The source MySQL server id.
properties.storage		Storage	Storage related properties of a server.
properties.version		ServerVersion	Server version.
sku		MySQLServerSku	The SKU (pricing tier) of the server.
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	Server	OK
201 Created	Server	Created
202 Accepted		Accepted Headers Location: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create a new server

Create a replica server

Create a server as a point in time restore

Create a server with byok

Create a server with non-default database port

Create a new server

Sample request

HTTP

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver?api-version=2024-06-01-preview

{
  "sku": {
    "name": "Standard_D2ds_v4",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "administratorLogin": "cloudsa",
    "administratorLoginPassword": "your_password",
    "availabilityZone": "1",
    "version": "5.7",
    "createMode": "Default",
    "storage": {
      "storageSizeGB": 100,
      "iops": 600,
      "autoGrow": "Disabled",
      "storageRedundancy": "LocalRedundancy"
    },
    "backup": {
      "backupRetentionDays": 7,
      "backupIntervalHours": 24,
      "geoRedundantBackup": "Disabled"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "standbyAvailabilityZone": "3"
    }
  },
  "location": "southeastasia",
  "tags": {
    "num": "1"
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.mysqlflexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mysqlflexibleservers
# USAGE
    python server_create.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_create(
        resource_group_name="testrg",
        server_name="mysqltestserver",
        parameters={
            "location": "southeastasia",
            "properties": {
                "administratorLogin": "cloudsa",
                "administratorLoginPassword": "your_password",
                "availabilityZone": "1",
                "backup": {"backupIntervalHours": 24, "backupRetentionDays": 7, "geoRedundantBackup": "Disabled"},
                "createMode": "Default",
                "highAvailability": {"mode": "ZoneRedundant", "standbyAvailabilityZone": "3"},
                "storage": {
                    "autoGrow": "Disabled",
                    "iops": 600,
                    "storageRedundancy": "LocalRedundancy",
                    "storageSizeGB": 100,
                },
                "version": "5.7",
            },
            "sku": {"name": "Standard_D2ds_v4", "tier": "GeneralPurpose"},
            "tags": {"num": "1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-06-01-preview/examples/ServerCreate.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

Sample response

Status code:

201

{
  "sku": {
    "name": "Standard_D2ds_v4",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "administratorLogin": "cloudsa",
    "storage": {
      "storageSizeGB": 100,
      "iops": 600,
      "autoGrow": "Enabled",
      "storageSku": "Premium_LRS",
      "storageRedundancy": "LocalRedundancy"
    },
    "version": "5.7",
    "state": "Ready",
    "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com",
    "availabilityZone": "1",
    "maintenancePolicy": {
      "patchStrategy": "Regular"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "replicationRole": "None",
    "replicaCapacity": 10,
    "network": {
      "publicNetworkAccess": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "3"
    },
    "databasePort": 3306
  },
  "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:

200

{
  "sku": {
    "name": "Standard_D2ds_v4",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "administratorLogin": "cloudsa",
    "storage": {
      "storageSizeGB": 100,
      "iops": 600,
      "autoGrow": "Enabled",
      "storageSku": "Premium_LRS",
      "storageRedundancy": "LocalRedundancy"
    },
    "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,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "3"
    },
    "databasePort": 3306
  },
  "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

Create a replica server

Sample request

HTTP

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/replica-server?api-version=2024-06-01-preview

{
  "location": "SoutheastAsia",
  "properties": {
    "createMode": "Replica",
    "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/source-server"
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.mysqlflexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mysqlflexibleservers
# USAGE
    python server_create_replica.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_create(
        resource_group_name="testgr",
        server_name="replica-server",
        parameters={
            "location": "SoutheastAsia",
            "properties": {
                "createMode": "Replica",
                "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/source-server",
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-06-01-preview/examples/ServerCreateReplica.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

Sample response

Status code:

201

{
  "sku": {
    "name": "Standard_D2ds_v4",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "administratorLogin": "cloudsa",
    "storage": {
      "storageSizeGB": 20,
      "iops": 360,
      "autoGrow": "Enabled",
      "storageSku": "Premium_LRS",
      "storageRedundancy": "LocalRedundancy"
    },
    "version": "5.7",
    "state": "Ready",
    "fullyQualifiedDomainName": "replica-server.database.mysql.azure.com",
    "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/source-server",
    "availabilityZone": "3",
    "maintenancePolicy": {
      "patchStrategy": "Regular"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "replicationRole": "Replica",
    "replicaCapacity": 0,
    "network": {
      "publicNetworkAccess": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "backupIntervalHours": 24,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-06-24T08:19:18.5729164+00:00"
    },
    "highAvailability": {
      "mode": "Disabled",
      "state": "NotEnabled"
    },
    "databasePort": 3306
  },
  "location": "Southeast Asia",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/replica-server",
  "name": "replica-server",
  "type": "Microsoft.DBforMySQL/flexibleServers"
}

Status code:

200

{
  "sku": {
    "name": "Standard_D2ds_v4",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "administratorLogin": "cloudsa",
    "storage": {
      "storageSizeGB": 20,
      "iops": 360,
      "autoGrow": "Enabled",
      "storageSku": "Premium_LRS",
      "storageRedundancy": "LocalRedundancy"
    },
    "version": "5.7",
    "state": "Ready",
    "fullyQualifiedDomainName": "replica-server.database.mysql.azure.com",
    "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/source-server",
    "availabilityZone": "3",
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "replicationRole": "Replica",
    "replicaCapacity": 0,
    "network": {
      "publicNetworkAccess": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-06-24T08:19:18.5729164+00:00"
    },
    "highAvailability": {
      "mode": "Disabled",
      "state": "NotEnabled"
    },
    "databasePort": 3306
  },
  "location": "Southeast Asia",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/replica-server",
  "name": "replica-server",
  "type": "Microsoft.DBforMySQL/flexibleServers"
}

Status code:

202

Create a server as a point in time restore

Sample request

HTTP

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TargetResourceGroup/providers/Microsoft.DBforMySQL/flexibleServers/targetserver?api-version=2024-06-01-preview

{
  "location": "SoutheastAsia",
  "properties": {
    "restorePointInTime": "2021-06-24T00:00:37.467Z",
    "createMode": "PointInTimeRestore",
    "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/SourceResourceGroup/providers/Microsoft.DBforMySQL/flexibleServers/sourceserver"
  },
  "sku": {
    "name": "Standard_D14_v2",
    "tier": "GeneralPurpose"
  },
  "tags": {
    "num": "1"
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.mysqlflexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mysqlflexibleservers
# USAGE
    python server_create_with_point_in_time_restore.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_create(
        resource_group_name="TargetResourceGroup",
        server_name="targetserver",
        parameters={
            "location": "SoutheastAsia",
            "properties": {
                "createMode": "PointInTimeRestore",
                "restorePointInTime": "2021-06-24T00:00:37.467Z",
                "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/SourceResourceGroup/providers/Microsoft.DBforMySQL/flexibleServers/sourceserver",
            },
            "sku": {"name": "Standard_D14_v2", "tier": "GeneralPurpose"},
            "tags": {"num": "1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-06-01-preview/examples/ServerCreateWithPointInTimeRestore.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

Sample response

Status code:

201

{
  "sku": {
    "name": "Standard_D2ds_v4",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "administratorLogin": "adminuser",
    "storage": {
      "storageSizeGB": 20,
      "iops": 360,
      "autoGrow": "Enabled",
      "storageSku": "Premium_LRS",
      "storageRedundancy": "LocalRedundancy"
    },
    "version": "5.7",
    "state": "Ready",
    "fullyQualifiedDomainName": "targetserver.database.mysql.azure.com",
    "availabilityZone": "1",
    "maintenancePolicy": {
      "patchStrategy": "Regular"
    },
    "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-24T00:15:24.00+00:00"
    },
    "highAvailability": {
      "mode": "Disabled",
      "state": "NotEnabled"
    },
    "databasePort": 3306
  },
  "location": "Southeast Asia",
  "tags": {
    "num": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TargetResourceGroup/providers/Microsoft.DBforMySQL/flexibleServers/targetserver",
  "name": "targetserver",
  "type": "Microsoft.DBforMySQL/flexibleServers"
}

Status code:

200

{
  "sku": {
    "name": "Standard_D2ds_v4",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "administratorLogin": "adminuser",
    "storage": {
      "storageSizeGB": 20,
      "iops": 360,
      "autoGrow": "Enabled",
      "storageSku": "Premium_LRS"
    },
    "version": "5.7",
    "state": "Ready",
    "fullyQualifiedDomainName": "targetserver.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-24T00:15:24.00+00:00"
    },
    "highAvailability": {
      "mode": "Disabled",
      "state": "NotEnabled"
    },
    "databasePort": 3306
  },
  "location": "Southeast Asia",
  "tags": {
    "num": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TargetResourceGroup/providers/Microsoft.DBforMySQL/flexibleServers/targetserver",
  "name": "targetserver",
  "type": "Microsoft.DBforMySQL/flexibleServers"
}

Status code:

202

Create a server with byok

Sample request

HTTP

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver?api-version=2024-06-01-preview

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {}
    }
  },
  "sku": {
    "name": "Standard_D2ds_v4",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "administratorLogin": "cloudsa",
    "administratorLoginPassword": "your_password",
    "availabilityZone": "1",
    "version": "5.7",
    "createMode": "Default",
    "storage": {
      "storageSizeGB": 100,
      "iops": 600,
      "autoGrow": "Disabled",
      "storageRedundancy": "LocalRedundancy"
    },
    "backup": {
      "backupRetentionDays": 7,
      "backupIntervalHours": 24,
      "geoRedundantBackup": "Disabled"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "standbyAvailabilityZone": "3"
    },
    "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"
    }
  },
  "location": "southeastasia",
  "tags": {
    "num": "1"
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.mysqlflexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mysqlflexibleservers
# USAGE
    python server_create_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_create(
        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": {}
                },
            },
            "location": "southeastasia",
            "properties": {
                "administratorLogin": "cloudsa",
                "administratorLoginPassword": "your_password",
                "availabilityZone": "1",
                "backup": {"backupIntervalHours": 24, "backupRetentionDays": 7, "geoRedundantBackup": "Disabled"},
                "createMode": "Default",
                "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",
                },
                "highAvailability": {"mode": "ZoneRedundant", "standbyAvailabilityZone": "3"},
                "storage": {
                    "autoGrow": "Disabled",
                    "iops": 600,
                    "storageRedundancy": "LocalRedundancy",
                    "storageSizeGB": 100,
                },
                "version": "5.7",
            },
            "sku": {"name": "Standard_D2ds_v4", "tier": "GeneralPurpose"},
            "tags": {"num": "1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-06-01-preview/examples/ServerCreateWithBYOK.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

Sample response

Status code:

201

{
  "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",
    "maintenancePolicy": {
      "patchStrategy": "Regular"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "replicationRole": "None",
    "replicaCapacity": 10,
    "network": {
      "publicNetworkAccess": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "3"
    },
    "databasePort": 3306
  },
  "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:

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,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "3"
    },
    "databasePort": 3306
  },
  "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

Create a server with non-default database port

Sample request

HTTP

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver?api-version=2024-06-01-preview

{
  "sku": {
    "name": "Standard_D2ds_v4",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "administratorLogin": "cloudsa",
    "administratorLoginPassword": "your_password",
    "availabilityZone": "1",
    "version": "5.7",
    "createMode": "Default",
    "storage": {
      "storageSizeGB": 100,
      "iops": 600,
      "autoGrow": "Disabled",
      "storageRedundancy": "LocalRedundancy"
    },
    "backup": {
      "backupRetentionDays": 7,
      "backupIntervalHours": 24,
      "geoRedundantBackup": "Disabled"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "standbyAvailabilityZone": "3"
    },
    "databasePort": 8888
  },
  "location": "southeastasia",
  "tags": {
    "num": "1"
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.mysqlflexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mysqlflexibleservers
# USAGE
    python server_create_with_database_port.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_create(
        resource_group_name="testrg",
        server_name="mysqltestserver",
        parameters={
            "location": "southeastasia",
            "properties": {
                "administratorLogin": "cloudsa",
                "administratorLoginPassword": "your_password",
                "availabilityZone": "1",
                "backup": {"backupIntervalHours": 24, "backupRetentionDays": 7, "geoRedundantBackup": "Disabled"},
                "createMode": "Default",
                "databasePort": 8888,
                "highAvailability": {"mode": "ZoneRedundant", "standbyAvailabilityZone": "3"},
                "storage": {
                    "autoGrow": "Disabled",
                    "iops": 600,
                    "storageRedundancy": "LocalRedundancy",
                    "storageSizeGB": 100,
                },
                "version": "5.7",
            },
            "sku": {"name": "Standard_D2ds_v4", "tier": "GeneralPurpose"},
            "tags": {"num": "1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-06-01-preview/examples/ServerCreateWithDatabasePort.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

Sample response

Status code:

201

{
  "sku": {
    "name": "Standard_D2ds_v4",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "administratorLogin": "cloudsa",
    "storage": {
      "storageSizeGB": 100,
      "iops": 600,
      "autoGrow": "Enabled",
      "storageSku": "Premium_LRS",
      "storageRedundancy": "LocalRedundancy"
    },
    "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,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "3"
    },
    "databasePort": 8888
  },
  "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:

200

{
  "sku": {
    "name": "Standard_D2ds_v4",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "administratorLogin": "cloudsa",
    "storage": {
      "storageSizeGB": 100,
      "iops": 600,
      "autoGrow": "Enabled",
      "storageSku": "Premium_LRS",
      "storageRedundancy": "LocalRedundancy"
    },
    "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,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "3"
    },
    "databasePort": 8888
  },
  "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

Definitions

Name	Description
Backup	Storage Profile properties of a server
createdByType	The type of identity that created the resource.
CreateMode	The mode to create a new MySQL server.
DataEncryption	The date encryption for cmk.
DataEncryptionType	The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk.
EnableStatusEnum	Enum to indicate whether value is 'Enabled' or 'Disabled'
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
HighAvailability	High availability properties of a server
HighAvailabilityMode	High availability mode for a server.
HighAvailabilityState	The state of server high availability.
ImportSourceProperties	Import source related properties.
ImportSourceStorageType	Storage type of import source.
MaintenancePolicy	Maintenance policy of a server.
MaintenanceWindow	Maintenance window of a server.
ManagedServiceIdentityType	Type of managed service identity.
MySQLServerSku	Billing information related properties of a server.
Network	Network related properties of a server
PatchStrategy	Enum to indicate the patch strategy of a server
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnection	The private endpoint connection resource.
PrivateEndpointConnectionProvisioningState	The current provisioning state.
PrivateEndpointServiceConnectionStatus	The private endpoint connection status.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ReplicationRole	The replication role.
Server	Represents a server.
ServerSkuTier	The tier of the particular SKU, e.g. GeneralPurpose.
ServerState	The state of a server.
ServerVersion	The version of a server.
Storage	Storage Profile properties of a server
StorageRedundancyEnum	Enum to indicate whether storage sku value is 'ZoneRedundancy' or 'LocalRedundancy'
systemData	Metadata pertaining to creation and last modification of the resource.

Backup

Object

Storage Profile properties of a server

Name	Type	Default value	Description
backupIntervalHours	integer (int32)		Backup interval hours for the server.
backupRetentionDays	integer (int32)		Backup retention days for the server.
earliestRestoreDate	string (date-time)		Earliest restore point creation time (ISO8601 format)
geoRedundantBackup	EnableStatusEnum	Disabled	Whether or not geo redundant backup is enabled.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
Application
Key
ManagedIdentity
User

CreateMode

Enumeration

The mode to create a new MySQL server.

Value	Description
Default
GeoRestore
PointInTimeRestore
Replica

DataEncryption

Object

The date encryption for cmk.

Name	Type	Description
geoBackupKeyURI	string	Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup
geoBackupUserAssignedIdentityId	string	Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup
primaryKeyURI	string	Primary key uri
primaryUserAssignedIdentityId	string	Primary user identity resource id
type	DataEncryptionType	The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk.

DataEncryptionType

Enumeration

The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk.

Value	Description
AzureKeyVault
SystemManaged

EnableStatusEnum

Enumeration

Enum to indicate whether value is 'Enabled' or 'Disabled'

Value	Description
Disabled
Enabled

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

HighAvailability

Object

High availability properties of a server

Name	Type	Description
mode	HighAvailabilityMode	High availability mode for a server.
standbyAvailabilityZone	string	Availability zone of the standby server.
state	HighAvailabilityState	The state of server high availability.

HighAvailabilityMode

Enumeration

High availability mode for a server.

Value	Description
Disabled
SameZone
ZoneRedundant

HighAvailabilityState

Enumeration

The state of server high availability.

Value	Description
CreatingStandby
FailingOver
Healthy
NotEnabled
RemovingStandby

ImportSourceProperties

Object

Import source related properties.

Name	Type	Description
dataDirPath	string	Relative path of data directory in storage.
sasToken	string	Sas token for accessing source storage. Read and list permissions are required for sas token.
storageType	ImportSourceStorageType	Storage type of import source.
storageUrl	string	Uri of the import source storage.

ImportSourceStorageType

Enumeration

Storage type of import source.

Value	Description
AzureBlob

MaintenancePolicy

Object

Maintenance policy of a server.

Name	Type	Description
patchStrategy	PatchStrategy	The patch strategy of this server

MaintenanceWindow

Object

Maintenance window of a server.

Name	Type	Description
customWindow	string	indicates whether custom window is enabled or disabled
dayOfWeek	integer (int32)	day of week for maintenance window
startHour	integer (int32)	start hour for maintenance window
startMinute	integer (int32)	start minute for maintenance window

ManagedServiceIdentityType

Enumeration

Type of managed service identity.

Value	Description
UserAssigned

MySQLServerSku

Object

Billing information related properties of a server.

Name	Type	Description
name	string	The name of the sku, e.g. Standard_D32s_v3.
tier	ServerSkuTier	The tier of the particular SKU, e.g. GeneralPurpose.

Network

Object

Network related properties of a server

Name	Type	Description
delegatedSubnetResourceId	string	Delegated subnet resource id used to setup vnet for a server.
privateDnsZoneResourceId	string	Private DNS zone resource id.
publicNetworkAccess	EnableStatusEnum	Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration.

PatchStrategy

Enumeration

Enum to indicate the patch strategy of a server

Value	Description
Regular
VirtualCanary

PrivateEndpoint

Object

The private endpoint resource.

Name	Type	Description
id	string	The ARM identifier for private endpoint.

PrivateEndpointConnection

Object

The private endpoint connection resource.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.groupIds	string[]	The group ids for the private endpoint resource.
properties.privateEndpoint	PrivateEndpoint	The private endpoint resource.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	The provisioning state of the private endpoint connection resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeration

The current provisioning state.

Value	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeration

The private endpoint connection status.

Value	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

A collection of information about the state of the connection between service consumer and provider.

Name	Type	Description
actionsRequired	string	A message indicating if changes on the service provider require any updates on the consumer.
description	string	The reason for approval/rejection of the connection.
status	PrivateEndpointServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ReplicationRole

Enumeration

The replication role.

Value	Description
None
Replica
Source

Server

Object

Represents a server.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity.principalId	string	ObjectId from the KeyVault
identity.tenantId	string	TenantId from the KeyVault
identity.type	ManagedServiceIdentityType	Type of managed service identity.
identity.userAssignedIdentities	object	Metadata of user assigned identity.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.administratorLogin	string	The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
properties.administratorLoginPassword	string (password)	The password of the administrator login (required for server creation).
properties.availabilityZone	string	availability Zone information of the server.
properties.backup	Backup	Backup related properties of a server.
properties.createMode	CreateMode	The mode to create a new MySQL server.
properties.dataEncryption	DataEncryption	The Data Encryption for CMK.
properties.databasePort	integer (int32)	The server database port. Can only be specified when the server is being created.
properties.fullyQualifiedDomainName	string	The fully qualified domain name of a server.
properties.highAvailability	HighAvailability	High availability related properties of a server.
properties.importSourceProperties	ImportSourceProperties	Source properties for import from storage.
properties.maintenancePolicy	MaintenancePolicy	Maintenance policy of a server.
properties.maintenanceWindow	MaintenanceWindow	Maintenance window of a server. Known issue: cannot be set during server creation or updated with other properties during server update; must be updated separately.
properties.network	Network	Network related properties of a server.
properties.privateEndpointConnections	PrivateEndpointConnection[]	PrivateEndpointConnections related properties of a server.
properties.replicaCapacity	integer (int32) minimum: 0	The maximum number of replicas that a primary server can have.
properties.replicationRole	ReplicationRole	The replication role.
properties.restorePointInTime	string (date-time)	Restore point creation time (ISO8601 format), specifying the time to restore from.
properties.sourceServerResourceId	string	The source MySQL server id.
properties.state	ServerState	The state of a server.
properties.storage	Storage	Storage related properties of a server.
properties.version	ServerVersion	Server version.
sku	MySQLServerSku	The SKU (pricing tier) of the server.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ServerSkuTier

Enumeration

The tier of the particular SKU, e.g. GeneralPurpose.

Value	Description
Burstable
GeneralPurpose
MemoryOptimized

ServerState

Enumeration

The state of a server.

Value	Description
Disabled
Dropping
Ready
Starting
Stopped
Stopping
Updating

ServerVersion

Enumeration

The version of a server.

Value	Description
5.7
8.0.21

Storage

Object

Storage Profile properties of a server

Name	Type	Default value	Description
autoGrow	EnableStatusEnum	Disabled	Enable Storage Auto Grow or not.
autoIoScaling	EnableStatusEnum	Enabled	Enable IO Auto Scaling or not.
iops	integer (int32)		Storage IOPS for a server.
logOnDisk	EnableStatusEnum	Disabled	Enable Log On Disk or not.
storageRedundancy	StorageRedundancyEnum	LocalRedundancy	The redundant type of the server storage. The parameter is used for server creation.
storageSizeGB	integer (int32)		Max storage size allowed for a server.
storageSku	string		The sku name of the server storage.

StorageRedundancyEnum

Enumeration

Enum to indicate whether storage sku value is 'ZoneRedundancy' or 'LocalRedundancy'

Value	Description
LocalRedundancy
ZoneRedundancy

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.