Microsoft.MySQLDiscovery MySQLSites/MySQLServers

Bicep resource definition

The MySQLSites/MySQLServers resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MySQLDiscovery/MySQLSites/MySQLServers resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.MySQLDiscovery/MySQLSites/MySQLServers@2024-09-30-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    edition: 'string'
    errors: [
      {
        code: 'string'
        id: 'string'
        message: 'string'
        possibleCause: 'string'
        recommendedAction: 'string'
        runAsAccountId: 'string'
        severity: 'string'
        summaryMessage: 'string'
        updatedTimeStamp: 'string'
      }
    ]
    hostIp: [
      'string'
    ]
    hostName: 'string'
    labels: {
      {customized property}: 'string'
    }
    machineId: 'string'
    mysqlVersion: 'string'
    numberOfDatabase: int
    portNumber: 'string'
    provisioningState: 'string'
    supportEndIn: 'string'
    supportStatus: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.MySQLDiscovery/MySQLSites/MySQLServers

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[a-zA-Z0-9-]*$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: MySQLSites
properties Resource properties. MySQLServerProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

Error

Name Description Value
code The error code. string
id The error ID. string
message The detailed error message. string
possibleCause The error possible cause. string
recommendedAction Gets description of the checkpoint. string
runAsAccountId The account ID used to login. string
severity Gets description of the severity. string
summaryMessage The summarized error message. string
updatedTimeStamp Time when this error was last updated. string

MySQLServerProperties

Name Description Value
edition mysql server edition. 'Community'
'Enterprise'
errors The list of errors. Error[]
hostIp The Server IP/host name. string[]
hostName The Server IP/host name. string (required)
labels Resource labels. MySQLServerPropertiesLabels
machineId discovery Machine Id string
mysqlVersion The mysql server version. string
numberOfDatabase The number of database. int
portNumber MySQL Server port number string (required)
provisioningState Gets or sets the provisioning state. 'Canceled'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Unknown'
'Updating'
supportEndIn Time when mysql version support end. string
supportStatus mysql version support status. 'Extended'
'Mainstream'
'OutOfSupport'

MySQLServerPropertiesLabels

Name Description Value

MySQLServerTags

Name Description Value

ARM template resource definition

The MySQLSites/MySQLServers resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MySQLDiscovery/MySQLSites/MySQLServers resource, add the following JSON to your template.

{
  "type": "Microsoft.MySQLDiscovery/MySQLSites/MySQLServers",
  "apiVersion": "2024-09-30-preview",
  "name": "string",
  "properties": {
    "edition": "string",
    "errors": [
      {
        "code": "string",
        "id": "string",
        "message": "string",
        "possibleCause": "string",
        "recommendedAction": "string",
        "runAsAccountId": "string",
        "severity": "string",
        "summaryMessage": "string",
        "updatedTimeStamp": "string"
      }
    ],
    "hostIp": [ "string" ],
    "hostName": "string",
    "labels": {
      "{customized property}": "string"
    },
    "machineId": "string",
    "mysqlVersion": "string",
    "numberOfDatabase": "int",
    "portNumber": "string",
    "provisioningState": "string",
    "supportEndIn": "string",
    "supportStatus": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.MySQLDiscovery/MySQLSites/MySQLServers

Name Description Value
apiVersion The api version '2024-09-30-preview'
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[a-zA-Z0-9-]*$ (required)
properties Resource properties. MySQLServerProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.MySQLDiscovery/MySQLSites/MySQLServers'

Error

Name Description Value
code The error code. string
id The error ID. string
message The detailed error message. string
possibleCause The error possible cause. string
recommendedAction Gets description of the checkpoint. string
runAsAccountId The account ID used to login. string
severity Gets description of the severity. string
summaryMessage The summarized error message. string
updatedTimeStamp Time when this error was last updated. string

MySQLServerProperties

Name Description Value
edition mysql server edition. 'Community'
'Enterprise'
errors The list of errors. Error[]
hostIp The Server IP/host name. string[]
hostName The Server IP/host name. string (required)
labels Resource labels. MySQLServerPropertiesLabels
machineId discovery Machine Id string
mysqlVersion The mysql server version. string
numberOfDatabase The number of database. int
portNumber MySQL Server port number string (required)
provisioningState Gets or sets the provisioning state. 'Canceled'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Unknown'
'Updating'
supportEndIn Time when mysql version support end. string
supportStatus mysql version support status. 'Extended'
'Mainstream'
'OutOfSupport'

MySQLServerPropertiesLabels

Name Description Value

MySQLServerTags

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

The MySQLSites/MySQLServers resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MySQLDiscovery/MySQLSites/MySQLServers resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MySQLDiscovery/MySQLSites/MySQLServers@2024-09-30-preview"
  name = "string"
  parent_id = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      edition = "string"
      errors = [
        {
          code = "string"
          id = "string"
          message = "string"
          possibleCause = "string"
          recommendedAction = "string"
          runAsAccountId = "string"
          severity = "string"
          summaryMessage = "string"
          updatedTimeStamp = "string"
        }
      ]
      hostIp = [
        "string"
      ]
      hostName = "string"
      labels = {
        {customized property} = "string"
      }
      machineId = "string"
      mysqlVersion = "string"
      numberOfDatabase = int
      portNumber = "string"
      provisioningState = "string"
      supportEndIn = "string"
      supportStatus = "string"
    }
  }
}

Property Values

Microsoft.MySQLDiscovery/MySQLSites/MySQLServers

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[a-zA-Z0-9-]*$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: MySQLSites
properties Resource properties. MySQLServerProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.MySQLDiscovery/MySQLSites/MySQLServers@2024-09-30-preview"

Error

Name Description Value
code The error code. string
id The error ID. string
message The detailed error message. string
possibleCause The error possible cause. string
recommendedAction Gets description of the checkpoint. string
runAsAccountId The account ID used to login. string
severity Gets description of the severity. string
summaryMessage The summarized error message. string
updatedTimeStamp Time when this error was last updated. string

MySQLServerProperties

Name Description Value
edition mysql server edition. 'Community'
'Enterprise'
errors The list of errors. Error[]
hostIp The Server IP/host name. string[]
hostName The Server IP/host name. string (required)
labels Resource labels. MySQLServerPropertiesLabels
machineId discovery Machine Id string
mysqlVersion The mysql server version. string
numberOfDatabase The number of database. int
portNumber MySQL Server port number string (required)
provisioningState Gets or sets the provisioning state. 'Canceled'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Unknown'
'Updating'
supportEndIn Time when mysql version support end. string
supportStatus mysql version support status. 'Extended'
'Mainstream'
'OutOfSupport'

MySQLServerPropertiesLabels

Name Description Value

MySQLServerTags

Name Description Value
  • Last updated on