dbformysql.azure.com/v1beta20210501
dbformysql.azure.com/v1beta20210501
Package v1beta20210501 contains API Schema definitions for the dbformysql v1beta20210501 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2021-05-01" |
Backup
(Appears on:FlexibleServers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/Backup
Field | Description |
---|---|
backupRetentionDays int |
BackupRetentionDays: Backup retention days for the server. |
geoRedundantBackup BackupGeoRedundantBackup |
GeoRedundantBackup: Whether or not geo redundant backup is enabled. |
BackupARM
(Appears on:ServerPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/Backup
Field | Description |
---|---|
backupRetentionDays int |
BackupRetentionDays: Backup retention days for the server. |
geoRedundantBackup BackupGeoRedundantBackup |
GeoRedundantBackup: Whether or not geo redundant backup is enabled. |
BackupGeoRedundantBackup
(string
alias)
(Appears on:Backup, BackupARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
Backup_Status
(Appears on:Server_Status)
Field | Description |
---|---|
backupRetentionDays int |
BackupRetentionDays: Backup retention days for the server. |
earliestRestoreDate string |
EarliestRestoreDate: Earliest restore point creation time (ISO8601 format) |
geoRedundantBackup EnableStatusEnum_Status |
GeoRedundantBackup: Whether or not geo redundant backup is enabled. |
Backup_StatusARM
(Appears on:ServerProperties_StatusARM)
Field | Description |
---|---|
backupRetentionDays int |
BackupRetentionDays: Backup retention days for the server. |
earliestRestoreDate string |
EarliestRestoreDate: Earliest restore point creation time (ISO8601 format) |
geoRedundantBackup EnableStatusEnum_Status |
GeoRedundantBackup: Whether or not geo redundant backup is enabled. |
DataEncryption
(Appears on:FlexibleServers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/DataEncryption
Field | Description |
---|---|
geoBackupKeyUri string |
GeoBackupKeyUri: Geo backup key uri as key vault can’t cross region, need cmk in same region as geo backup |
geoBackupUserAssignedIdentityReference genruntime.ResourceReference |
GeoBackupUserAssignedIdentityReference: Geo backup user identity resource id as identity can’t cross region, need identity in same region as geo backup |
primaryKeyUri string |
PrimaryKeyUri: Primary key uri |
primaryUserAssignedIdentityReference genruntime.ResourceReference |
PrimaryUserAssignedIdentityReference: Primary user identity resource id |
type DataEncryptionType |
Type: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. |
DataEncryptionARM
(Appears on:ServerPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/DataEncryption
Field | Description |
---|---|
geoBackupKeyUri string |
GeoBackupKeyUri: Geo backup key uri as key vault can’t cross region, need cmk in same region as geo backup |
geoBackupUserAssignedIdentityId string |
|
primaryKeyUri string |
PrimaryKeyUri: Primary key uri |
primaryUserAssignedIdentityId string |
|
type DataEncryptionType |
Type: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. |
DataEncryptionStatusType
(string
alias)
(Appears on:DataEncryption_Status, DataEncryption_StatusARM)
Value | Description |
---|---|
"AzureKeyVault" |
|
"SystemManaged" |
DataEncryptionType
(string
alias)
(Appears on:DataEncryption, DataEncryptionARM)
Value | Description |
---|---|
"AzureKeyVault" |
|
"SystemManaged" |
DataEncryption_Status
(Appears on:Server_Status)
Field | Description |
---|---|
geoBackupKeyUri string |
GeoBackupKeyUri: Geo backup key uri as key vault can’t cross region, need cmk in same region as geo backup |
geoBackupUserAssignedIdentityId string |
GeoBackupUserAssignedIdentityId: Geo backup user identity resource id as identity can’t cross region, need identity in same region as geo backup |
primaryKeyUri string |
PrimaryKeyUri: Primary key uri |
primaryUserAssignedIdentityId string |
PrimaryUserAssignedIdentityId: Primary user identity resource id |
type DataEncryptionStatusType |
Type: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. |
DataEncryption_StatusARM
(Appears on:ServerProperties_StatusARM)
Field | Description |
---|---|
geoBackupKeyUri string |
GeoBackupKeyUri: Geo backup key uri as key vault can’t cross region, need cmk in same region as geo backup |
geoBackupUserAssignedIdentityId string |
GeoBackupUserAssignedIdentityId: Geo backup user identity resource id as identity can’t cross region, need identity in same region as geo backup |
primaryKeyUri string |
PrimaryKeyUri: Primary key uri |
primaryUserAssignedIdentityId string |
PrimaryUserAssignedIdentityId: Primary user identity resource id |
type DataEncryptionStatusType |
Type: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. |
DatabasePropertiesARM
(Appears on:FlexibleServersDatabases_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/DatabaseProperties
Field | Description |
---|---|
charset string |
Charset: The charset of the database. |
collation string |
Collation: The collation of the database. |
DatabaseProperties_StatusARM
(Appears on:Database_StatusARM)
Field | Description |
---|---|
charset string |
Charset: The charset of the database. |
collation string |
Collation: The collation of the database. |
Database_Status
(Appears on:FlexibleServersDatabase)
Field | Description |
---|---|
charset string |
Charset: The charset of the database. |
collation string |
Collation: The collation of the database. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
systemData SystemData_Status |
SystemData: The system metadata relating to this resource. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
Database_StatusARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
properties DatabaseProperties_StatusARM |
Properties: The properties of a database. |
systemData SystemData_StatusARM |
SystemData: The system metadata relating to this resource. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
EnableStatusEnum_Status
(string
alias)
(Appears on:Backup_Status, Backup_StatusARM, Network_Status, Network_StatusARM, Storage_Status, Storage_StatusARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
FirewallRulePropertiesARM
(Appears on:FlexibleServersFirewallRules_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/FirewallRuleProperties
Field | Description |
---|---|
endIpAddress string |
EndIpAddress: The end IP address of the server firewall rule. Must be IPv4 format. |
startIpAddress string |
StartIpAddress: The start IP address of the server firewall rule. Must be IPv4 format. |
FirewallRuleProperties_StatusARM
(Appears on:FirewallRule_StatusARM)
Field | Description |
---|---|
endIpAddress string |
EndIpAddress: The end IP address of the server firewall rule. Must be IPv4 format. |
startIpAddress string |
StartIpAddress: The start IP address of the server firewall rule. Must be IPv4 format. |
FirewallRule_Status
(Appears on:FlexibleServersFirewallRule)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
endIpAddress string |
EndIpAddress: The end IP address of the server firewall rule. Must be IPv4 format. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
startIpAddress string |
StartIpAddress: The start IP address of the server firewall rule. Must be IPv4 format. |
systemData SystemData_Status |
SystemData: The system metadata relating to this resource. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
FirewallRule_StatusARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
properties FirewallRuleProperties_StatusARM |
Properties: The properties of a firewall rule. |
systemData SystemData_StatusARM |
SystemData: The system metadata relating to this resource. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
FlexibleServer
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/resourceDefinitions/flexibleServers
Field | Description | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||||
spec FlexibleServers_Spec |
|
||||||||||||||||||||||||||||||||||||||||||
status Server_Status |
FlexibleServerOperatorSecrets
(Appears on:FlexibleServerOperatorSpec)
Field | Description |
---|---|
fullyQualifiedDomainName genruntime.SecretDestination |
FullyQualifiedDomainName: indicates where the FullyQualifiedDomainName secret should be placed. If omitted, the secret will not be retrieved from Azure. |
FlexibleServerOperatorSpec
(Appears on:FlexibleServers_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
secrets FlexibleServerOperatorSecrets |
Secrets: configures where to place Azure generated secrets. |
FlexibleServersDatabase
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/resourceDefinitions/flexibleServers_databases
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec FlexibleServersDatabases_Spec |
|
||||||||||||
status Database_Status |
FlexibleServersDatabases_Spec
(Appears on:FlexibleServersDatabase)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
charset string |
Charset: The charset of the database. |
collation string |
Collation: The collation of the database. |
location string |
Location: Location to deploy resource to |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a dbformysql.azure.com/FlexibleServer resource |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
FlexibleServersDatabases_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: The name of the database. |
properties DatabasePropertiesARM |
Properties: The properties of a database. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
FlexibleServersFirewallRule
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/resourceDefinitions/flexibleServers_firewallRules
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec FlexibleServersFirewallRules_Spec |
|
||||||||||||
status FirewallRule_Status |
FlexibleServersFirewallRules_Spec
(Appears on:FlexibleServersFirewallRule)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
endIpAddress string |
EndIpAddress: The end IP address of the server firewall rule. Must be IPv4 format. |
location string |
Location: Location to deploy resource to |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a dbformysql.azure.com/FlexibleServer resource |
startIpAddress string |
StartIpAddress: The start IP address of the server firewall rule. Must be IPv4 format. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
FlexibleServersFirewallRules_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: The name of the server firewall rule. |
properties FirewallRulePropertiesARM |
Properties: The properties of a server firewall rule. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
FlexibleServers_Spec
(Appears on:FlexibleServer)
Field | Description |
---|---|
administratorLogin string |
AdministratorLogin: The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation). |
administratorLoginPassword genruntime.SecretReference |
AdministratorLoginPassword: The password of the administrator login (required for server creation). |
availabilityZone string |
AvailabilityZone: availability Zone information of the server. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
backup Backup |
Backup: Storage Profile properties of a server |
createMode ServerPropertiesCreateMode |
CreateMode: The mode to create a new MySQL server. |
dataEncryption DataEncryption |
DataEncryption: The date encryption for cmk. |
highAvailability HighAvailability |
HighAvailability: Network related properties of a server |
identity Identity |
Identity: Properties to configure Identity for Bring your Own Keys |
location string |
Location: The geo-location where the resource lives |
maintenanceWindow MaintenanceWindow |
MaintenanceWindow: Maintenance window of a server. |
network Network |
Network: Network related properties of a server |
operatorSpec FlexibleServerOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
replicationRole ServerPropertiesReplicationRole |
ReplicationRole: The replication role. |
restorePointInTime string |
RestorePointInTime: Restore point creation time (ISO8601 format), specifying the time to restore from. |
sku Sku |
Sku: Billing information related properties of a server. |
sourceServerResourceId string |
SourceServerResourceId: The source MySQL server id. |
storage Storage |
Storage: Storage Profile properties of a server |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
version ServerPropertiesVersion |
Version: Server version. |
FlexibleServers_SpecARM
Field | Description |
---|---|
identity IdentityARM |
Identity: Properties to configure Identity for Bring your Own Keys |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the server. |
properties ServerPropertiesARM |
Properties: The properties of a server. |
sku SkuARM |
Sku: Billing information related properties of a server. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
HighAvailability
(Appears on:FlexibleServers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/HighAvailability
Field | Description |
---|---|
mode HighAvailabilityMode |
Mode: High availability mode for a server. |
standbyAvailabilityZone string |
StandbyAvailabilityZone: Availability zone of the standby server. |
HighAvailabilityARM
(Appears on:ServerPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/HighAvailability
Field | Description |
---|---|
mode HighAvailabilityMode |
Mode: High availability mode for a server. |
standbyAvailabilityZone string |
StandbyAvailabilityZone: Availability zone of the standby server. |
HighAvailabilityMode
(string
alias)
(Appears on:HighAvailability, HighAvailabilityARM)
Value | Description |
---|---|
"Disabled" |
|
"SameZone" |
|
"ZoneRedundant" |
HighAvailabilityStatusMode
(string
alias)
(Appears on:HighAvailability_Status, HighAvailability_StatusARM)
Value | Description |
---|---|
"Disabled" |
|
"SameZone" |
|
"ZoneRedundant" |
HighAvailabilityStatusState
(string
alias)
(Appears on:HighAvailability_Status, HighAvailability_StatusARM)
Value | Description |
---|---|
"CreatingStandby" |
|
"FailingOver" |
|
"Healthy" |
|
"NotEnabled" |
|
"RemovingStandby" |
HighAvailability_Status
(Appears on:Server_Status)
Field | Description |
---|---|
mode HighAvailabilityStatusMode |
Mode: High availability mode for a server. |
standbyAvailabilityZone string |
StandbyAvailabilityZone: Availability zone of the standby server. |
state HighAvailabilityStatusState |
State: The state of server high availability. |
HighAvailability_StatusARM
(Appears on:ServerProperties_StatusARM)
Field | Description |
---|---|
mode HighAvailabilityStatusMode |
Mode: High availability mode for a server. |
standbyAvailabilityZone string |
StandbyAvailabilityZone: Availability zone of the standby server. |
state HighAvailabilityStatusState |
State: The state of server high availability. |
Identity
(Appears on:FlexibleServers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/Identity
Field | Description |
---|---|
type IdentityType |
Type: Type of managed service identity. |
IdentityARM
(Appears on:FlexibleServers_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/Identity
Field | Description |
---|---|
type IdentityType |
Type: Type of managed service identity. |
IdentityStatusType
(string
alias)
(Appears on:Identity_Status, Identity_StatusARM)
Value | Description |
---|---|
"UserAssigned" |
IdentityType
(string
alias)
(Appears on:Identity, IdentityARM)
Value | Description |
---|---|
"UserAssigned" |
Identity_Status
(Appears on:Server_Status)
Field | Description |
---|---|
principalId string |
PrincipalId: ObjectId from the KeyVault |
tenantId string |
TenantId: TenantId from the KeyVault |
type IdentityStatusType |
Type: Type of managed service identity. |
userAssignedIdentities map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
UserAssignedIdentities: Metadata of user assigned identity. |
Identity_StatusARM
(Appears on:Server_StatusARM)
Field | Description |
---|---|
principalId string |
PrincipalId: ObjectId from the KeyVault |
tenantId string |
TenantId: TenantId from the KeyVault |
type IdentityStatusType |
Type: Type of managed service identity. |
userAssignedIdentities map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
UserAssignedIdentities: Metadata of user assigned identity. |
MaintenanceWindow
(Appears on:FlexibleServers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/MaintenanceWindow
Field | Description |
---|---|
customWindow string |
CustomWindow: indicates whether custom window is enabled or disabled |
dayOfWeek int |
DayOfWeek: day of week for maintenance window |
startHour int |
StartHour: start hour for maintenance window |
startMinute int |
StartMinute: start minute for maintenance window |
MaintenanceWindowARM
(Appears on:ServerPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/MaintenanceWindow
Field | Description |
---|---|
customWindow string |
CustomWindow: indicates whether custom window is enabled or disabled |
dayOfWeek int |
DayOfWeek: day of week for maintenance window |
startHour int |
StartHour: start hour for maintenance window |
startMinute int |
StartMinute: start minute for maintenance window |
MaintenanceWindow_Status
(Appears on:Server_Status)
Field | Description |
---|---|
customWindow string |
CustomWindow: indicates whether custom window is enabled or disabled |
dayOfWeek int |
DayOfWeek: day of week for maintenance window |
startHour int |
StartHour: start hour for maintenance window |
startMinute int |
StartMinute: start minute for maintenance window |
MaintenanceWindow_StatusARM
(Appears on:ServerProperties_StatusARM)
Field | Description |
---|---|
customWindow string |
CustomWindow: indicates whether custom window is enabled or disabled |
dayOfWeek int |
DayOfWeek: day of week for maintenance window |
startHour int |
StartHour: start hour for maintenance window |
startMinute int |
StartMinute: start minute for maintenance window |
Network
(Appears on:FlexibleServers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/Network
Field | Description |
---|---|
delegatedSubnetResourceReference genruntime.ResourceReference |
DelegatedSubnetResourceReference: Delegated subnet resource id used to setup vnet for a server. |
privateDnsZoneResourceReference genruntime.ResourceReference |
PrivateDnsZoneResourceReference: Private DNS zone resource id. |
NetworkARM
(Appears on:ServerPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/Network
Field | Description |
---|---|
delegatedSubnetResourceId string |
|
privateDnsZoneResourceId string |
Network_Status
(Appears on:Server_Status)
Field | Description |
---|---|
delegatedSubnetResourceId string |
DelegatedSubnetResourceId: Delegated subnet resource id used to setup vnet for a server. |
privateDnsZoneResourceId string |
PrivateDnsZoneResourceId: Private DNS zone resource id. |
publicNetworkAccess EnableStatusEnum_Status |
PublicNetworkAccess: Whether or not public network access is allowed for this server. Value is ‘Disabled’ when server has VNet integration. |
Network_StatusARM
(Appears on:ServerProperties_StatusARM)
Field | Description |
---|---|
delegatedSubnetResourceId string |
DelegatedSubnetResourceId: Delegated subnet resource id used to setup vnet for a server. |
privateDnsZoneResourceId string |
PrivateDnsZoneResourceId: Private DNS zone resource id. |
publicNetworkAccess EnableStatusEnum_Status |
PublicNetworkAccess: Whether or not public network access is allowed for this server. Value is ‘Disabled’ when server has VNet integration. |
ReplicationRole_Status
(string
alias)
(Appears on:ServerProperties_StatusARM, Server_Status)
Value | Description |
---|---|
"None" |
|
"Replica" |
|
"Source" |
ServerPropertiesARM
(Appears on:FlexibleServers_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/ServerProperties
Field | Description |
---|---|
administratorLogin string |
AdministratorLogin: The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation). |
administratorLoginPassword string |
AdministratorLoginPassword: The password of the administrator login (required for server creation). |
availabilityZone string |
AvailabilityZone: availability Zone information of the server. |
backup BackupARM |
Backup: Storage Profile properties of a server |
createMode ServerPropertiesCreateMode |
CreateMode: The mode to create a new MySQL server. |
dataEncryption DataEncryptionARM |
DataEncryption: The date encryption for cmk. |
highAvailability HighAvailabilityARM |
HighAvailability: Network related properties of a server |
maintenanceWindow MaintenanceWindowARM |
MaintenanceWindow: Maintenance window of a server. |
network NetworkARM |
Network: Network related properties of a server |
replicationRole ServerPropertiesReplicationRole |
ReplicationRole: The replication role. |
restorePointInTime string |
RestorePointInTime: Restore point creation time (ISO8601 format), specifying the time to restore from. |
sourceServerResourceId string |
SourceServerResourceId: The source MySQL server id. |
storage StorageARM |
Storage: Storage Profile properties of a server |
version ServerPropertiesVersion |
Version: Server version. |
ServerPropertiesCreateMode
(string
alias)
(Appears on:FlexibleServers_Spec, ServerPropertiesARM)
Value | Description |
---|---|
"Default" |
|
"GeoRestore" |
|
"PointInTimeRestore" |
|
"Replica" |
ServerPropertiesReplicationRole
(string
alias)
(Appears on:FlexibleServers_Spec, ServerPropertiesARM)
Value | Description |
---|---|
"None" |
|
"Replica" |
|
"Source" |
ServerPropertiesStatusCreateMode
(string
alias)
(Appears on:ServerProperties_StatusARM, Server_Status)
Value | Description |
---|---|
"Default" |
|
"GeoRestore" |
|
"PointInTimeRestore" |
|
"Replica" |
ServerPropertiesStatusState
(string
alias)
(Appears on:ServerProperties_StatusARM, Server_Status)
Value | Description |
---|---|
"Disabled" |
|
"Dropping" |
|
"Ready" |
|
"Starting" |
|
"Stopped" |
|
"Stopping" |
|
"Updating" |
ServerPropertiesVersion
(string
alias)
(Appears on:FlexibleServers_Spec, ServerPropertiesARM)
Value | Description |
---|---|
"5.7" |
|
"8.0.21" |
ServerProperties_StatusARM
(Appears on:Server_StatusARM)
Field | Description |
---|---|
administratorLogin string |
AdministratorLogin: The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation). |
availabilityZone string |
AvailabilityZone: availability Zone information of the server. |
backup Backup_StatusARM |
Backup: Backup related properties of a server. |
createMode ServerPropertiesStatusCreateMode |
CreateMode: The mode to create a new MySQL server. |
dataEncryption DataEncryption_StatusARM |
DataEncryption: The Data Encryption for CMK. |
fullyQualifiedDomainName string |
FullyQualifiedDomainName: The fully qualified domain name of a server. |
highAvailability HighAvailability_StatusARM |
HighAvailability: High availability related properties of a server. |
maintenanceWindow MaintenanceWindow_StatusARM |
MaintenanceWindow: Maintenance window of a server. |
network Network_StatusARM |
Network: Network related properties of a server. |
replicaCapacity int |
ReplicaCapacity: The maximum number of replicas that a primary server can have. |
replicationRole ReplicationRole_Status |
ReplicationRole: The replication role. |
restorePointInTime string |
RestorePointInTime: Restore point creation time (ISO8601 format), specifying the time to restore from. |
sourceServerResourceId string |
SourceServerResourceId: The source MySQL server id. |
state ServerPropertiesStatusState |
State: The state of a server. |
storage Storage_StatusARM |
Storage: Storage related properties of a server. |
version ServerVersion_Status |
Version: Server version. |
ServerVersion_Status
(string
alias)
(Appears on:ServerProperties_StatusARM, Server_Status)
Value | Description |
---|---|
"5.7" |
|
"8.0.21" |
Server_Status
(Appears on:FlexibleServer)
Field | Description |
---|---|
administratorLogin string |
AdministratorLogin: The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation). |
availabilityZone string |
AvailabilityZone: availability Zone information of the server. |
backup Backup_Status |
Backup: Backup related properties of a server. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
createMode ServerPropertiesStatusCreateMode |
CreateMode: The mode to create a new MySQL server. |
dataEncryption DataEncryption_Status |
DataEncryption: The Data Encryption for CMK. |
fullyQualifiedDomainName string |
FullyQualifiedDomainName: The fully qualified domain name of a server. |
highAvailability HighAvailability_Status |
HighAvailability: High availability related properties of a server. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
identity Identity_Status |
Identity: The cmk identity for the server. |
location string |
Location: The geo-location where the resource lives |
maintenanceWindow MaintenanceWindow_Status |
MaintenanceWindow: Maintenance window of a server. |
name string |
Name: The name of the resource |
network Network_Status |
Network: Network related properties of a server. |
replicaCapacity int |
ReplicaCapacity: The maximum number of replicas that a primary server can have. |
replicationRole ReplicationRole_Status |
ReplicationRole: The replication role. |
restorePointInTime string |
RestorePointInTime: Restore point creation time (ISO8601 format), specifying the time to restore from. |
sku Sku_Status |
Sku: The SKU (pricing tier) of the server. |
sourceServerResourceId string |
SourceServerResourceId: The source MySQL server id. |
state ServerPropertiesStatusState |
State: The state of a server. |
storage Storage_Status |
Storage: Storage related properties of a server. |
systemData SystemData_Status |
SystemData: The system metadata relating to this resource. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
version ServerVersion_Status |
Version: Server version. |
Server_StatusARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
identity Identity_StatusARM |
Identity: The cmk identity for the server. |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the resource |
properties ServerProperties_StatusARM |
Properties: Properties of the server. |
sku Sku_StatusARM |
Sku: The SKU (pricing tier) of the server. |
systemData SystemData_StatusARM |
SystemData: The system metadata relating to this resource. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
Sku
(Appears on:FlexibleServers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/Sku
Field | Description |
---|---|
name string |
Name: The name of the sku, e.g. Standard_D32s_v3. |
tier SkuTier |
Tier: The tier of the particular SKU, e.g. GeneralPurpose. |
SkuARM
(Appears on:FlexibleServers_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/Sku
Field | Description |
---|---|
name string |
Name: The name of the sku, e.g. Standard_D32s_v3. |
tier SkuTier |
Tier: The tier of the particular SKU, e.g. GeneralPurpose. |
SkuStatusTier
(string
alias)
(Appears on:Sku_Status, Sku_StatusARM)
Value | Description |
---|---|
"Burstable" |
|
"GeneralPurpose" |
|
"MemoryOptimized" |
SkuTier
(string
alias)
Value | Description |
---|---|
"Burstable" |
|
"GeneralPurpose" |
|
"MemoryOptimized" |
Sku_Status
(Appears on:Server_Status)
Field | Description |
---|---|
name string |
Name: The name of the sku, e.g. Standard_D32s_v3. |
tier SkuStatusTier |
Tier: The tier of the particular SKU, e.g. GeneralPurpose. |
Sku_StatusARM
(Appears on:Server_StatusARM)
Field | Description |
---|---|
name string |
Name: The name of the sku, e.g. Standard_D32s_v3. |
tier SkuStatusTier |
Tier: The tier of the particular SKU, e.g. GeneralPurpose. |
Storage
(Appears on:FlexibleServers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/Storage
Field | Description |
---|---|
autoGrow StorageAutoGrow |
AutoGrow: Enable Storage Auto Grow or not. |
iops int |
Iops: Storage IOPS for a server. |
storageSizeGB int |
StorageSizeGB: Max storage size allowed for a server. |
StorageARM
(Appears on:ServerPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-01/Microsoft.DBforMySQL.json#/definitions/Storage
Field | Description |
---|---|
autoGrow StorageAutoGrow |
AutoGrow: Enable Storage Auto Grow or not. |
iops int |
Iops: Storage IOPS for a server. |
storageSizeGB int |
StorageSizeGB: Max storage size allowed for a server. |
StorageAutoGrow
(string
alias)
(Appears on:Storage, StorageARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
Storage_Status
(Appears on:Server_Status)
Field | Description |
---|---|
autoGrow EnableStatusEnum_Status |
AutoGrow: Enable Storage Auto Grow or not. |
iops int |
Iops: Storage IOPS for a server. |
storageSizeGB int |
StorageSizeGB: Max storage size allowed for a server. |
storageSku string |
StorageSku: The sku name of the server storage. |
Storage_StatusARM
(Appears on:ServerProperties_StatusARM)
Field | Description |
---|---|
autoGrow EnableStatusEnum_Status |
AutoGrow: Enable Storage Auto Grow or not. |
iops int |
Iops: Storage IOPS for a server. |
storageSizeGB int |
StorageSizeGB: Max storage size allowed for a server. |
storageSku string |
StorageSku: The sku name of the server storage. |
SystemDataStatusCreatedByType
(string
alias)
(Appears on:SystemData_Status, SystemData_StatusARM)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemDataStatusLastModifiedByType
(string
alias)
(Appears on:SystemData_Status, SystemData_StatusARM)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_Status
(Appears on:Database_Status, FirewallRule_Status, Server_Status)
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemDataStatusCreatedByType |
CreatedByType: The type of identity that created the resource. |
lastModifiedAt string |
LastModifiedAt: The timestamp of resource last modification (UTC) |
lastModifiedBy string |
LastModifiedBy: The identity that last modified the resource. |
lastModifiedByType SystemDataStatusLastModifiedByType |
LastModifiedByType: The type of identity that last modified the resource. |
SystemData_StatusARM
(Appears on:Database_StatusARM, FirewallRule_StatusARM, Server_StatusARM)
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemDataStatusCreatedByType |
CreatedByType: The type of identity that created the resource. |
lastModifiedAt string |
LastModifiedAt: The timestamp of resource last modification (UTC) |
lastModifiedBy string |
LastModifiedBy: The identity that last modified the resource. |
lastModifiedByType SystemDataStatusLastModifiedByType |
LastModifiedByType: The type of identity that last modified the resource. |