dbformysql.azure.com/v1api20210501
dbformysql.azure.com/v1api20210501
Package v1api20210501 contains API Schema definitions for the dbformysql v1api20210501 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2021-05-01" |
Backup
(Appears on:FlexibleServer_Spec)
Storage Profile properties of a server
Field | Description |
---|---|
backupRetentionDays int |
BackupRetentionDays: Backup retention days for the server. |
geoRedundantBackup EnableStatusEnum |
GeoRedundantBackup: Whether or not geo redundant backup is enabled. |
Backup_STATUS
(Appears on:FlexibleServer_STATUS)
Storage Profile properties of a server
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:FlexibleServer_Spec)
The date encryption for cmk.
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 DataEncryption_Type |
Type: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. |
DataEncryption_STATUS
(Appears on:FlexibleServer_STATUS)
The date encryption for cmk.
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 DataEncryption_Type_STATUS |
Type: The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. |
DataEncryption_Type
(string
alias)
(Appears on:DataEncryption)
Value | Description |
---|---|
"AzureKeyVault" |
|
"SystemManaged" |
DataEncryption_Type_STATUS
(string
alias)
(Appears on:DataEncryption_STATUS)
Value | Description |
---|---|
"AzureKeyVault" |
|
"SystemManaged" |
EnableStatusEnum
(string
alias)
Enum to indicate whether value is ‘Enabled’ or ‘Disabled’
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
EnableStatusEnum_STATUS
(string
alias)
(Appears on:Backup_STATUS, Network_STATUS, Storage_STATUS)
Enum to indicate whether value is ‘Enabled’ or ‘Disabled’
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
FlexibleServer
Generator information: - Generated from: /mysql/resource-manager/Microsoft.DBforMySQL/legacy/stable/2021-05-01/mysql.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}p>
Field | Description | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||||
spec FlexibleServer_Spec |
|
||||||||||||||||||||||||||||||||||||||||||
status FlexibleServer_STATUS |
FlexibleServerOperatorConfigMaps
(Appears on:FlexibleServerOperatorSpec)
Field | Description |
---|---|
administratorLogin genruntime.ConfigMapDestination |
AdministratorLogin: indicates where the AdministratorLogin config map should be placed. If omitted, no config map will be created. |
fullyQualifiedDomainName genruntime.ConfigMapDestination |
FullyQualifiedDomainName: indicates where the FullyQualifiedDomainName config map should be placed. If omitted, no config map will be created. |
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:FlexibleServer_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
configMaps FlexibleServerOperatorConfigMaps |
ConfigMaps: configures where to place operator written ConfigMaps. |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
secrets FlexibleServerOperatorSecrets |
Secrets: configures where to place Azure generated secrets. |
FlexibleServer_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 ServerProperties_CreateMode_STATUS |
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 ServerProperties_State_STATUS |
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. |
FlexibleServer_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: Backup related properties of a server. |
createMode ServerProperties_CreateMode |
CreateMode: The mode to create a new MySQL server. |
dataEncryption DataEncryption |
DataEncryption: The Data Encryption for CMK. |
highAvailability HighAvailability |
HighAvailability: High availability related properties of a server. |
identity Identity |
Identity: The cmk identity for the server. |
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 ReplicationRole |
ReplicationRole: The replication role. |
restorePointInTime string |
RestorePointInTime: Restore point creation time (ISO8601 format), specifying the time to restore from. |
sku Sku |
Sku: The SKU (pricing tier) of the server. |
sourceServerResourceId string |
SourceServerResourceId: The source MySQL server id. |
storage Storage |
Storage: Storage related properties of a server. |
tags map[string]string |
Tags: Resource tags. |
version ServerVersion |
Version: Server version. |
FlexibleServersDatabase
Generator information: - Generated from: /mysql/resource-manager/Microsoft.DBforMySQL/legacy/stable/2021-05-01/mysql.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/databases/{databaseName}p>
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||
spec FlexibleServersDatabase_Spec |
|
||||||||||
status FlexibleServersDatabase_STATUS |
FlexibleServersDatabaseOperatorSpec
(Appears on:FlexibleServersDatabase_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
FlexibleServersDatabase_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” |
FlexibleServersDatabase_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. |
operatorSpec FlexibleServersDatabaseOperatorSpec |
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 dbformysql.azure.com/FlexibleServer resource |
FlexibleServersFirewallRule
Generator information: - Generated from: /mysql/resource-manager/Microsoft.DBforMySQL/legacy/stable/2021-05-01/mysql.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}p>
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||
spec FlexibleServersFirewallRule_Spec |
|
||||||||||
status FlexibleServersFirewallRule_STATUS |
FlexibleServersFirewallRuleOperatorSpec
(Appears on:FlexibleServersFirewallRule_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
FlexibleServersFirewallRule_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” |
FlexibleServersFirewallRule_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. |
operatorSpec FlexibleServersFirewallRuleOperatorSpec |
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 dbformysql.azure.com/FlexibleServer resource |
startIpAddress string |
StartIpAddress: The start IP address of the server firewall rule. Must be IPv4 format. |
HighAvailability
(Appears on:FlexibleServer_Spec)
Network related properties of a server
Field | Description |
---|---|
mode HighAvailability_Mode |
Mode: High availability mode for a server. |
standbyAvailabilityZone string |
StandbyAvailabilityZone: Availability zone of the standby server. |
HighAvailability_Mode
(string
alias)
(Appears on:HighAvailability)
Value | Description |
---|---|
"Disabled" |
|
"SameZone" |
|
"ZoneRedundant" |
HighAvailability_Mode_STATUS
(string
alias)
(Appears on:HighAvailability_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"SameZone" |
|
"ZoneRedundant" |
HighAvailability_STATUS
(Appears on:FlexibleServer_STATUS)
Network related properties of a server
Field | Description |
---|---|
mode HighAvailability_Mode_STATUS |
Mode: High availability mode for a server. |
standbyAvailabilityZone string |
StandbyAvailabilityZone: Availability zone of the standby server. |
state HighAvailability_State_STATUS |
State: The state of server high availability. |
HighAvailability_State_STATUS
(string
alias)
(Appears on:HighAvailability_STATUS)
Value | Description |
---|---|
"CreatingStandby" |
|
"FailingOver" |
|
"Healthy" |
|
"NotEnabled" |
|
"RemovingStandby" |
Identity
(Appears on:FlexibleServer_Spec)
Properties to configure Identity for Bring your Own Keys
Field | Description |
---|---|
type Identity_Type |
Type: Type of managed service identity. |
userAssignedIdentities []UserAssignedIdentityDetails |
UserAssignedIdentities: Metadata of user assigned identity. |
Identity_STATUS
(Appears on:FlexibleServer_STATUS)
Properties to configure Identity for Bring your Own Keys
Field | Description |
---|---|
principalId string |
PrincipalId: ObjectId from the KeyVault |
tenantId string |
TenantId: TenantId from the KeyVault |
type Identity_Type_STATUS |
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_Type
(string
alias)
(Appears on:Identity)
Value | Description |
---|---|
"UserAssigned" |
Identity_Type_STATUS
(string
alias)
(Appears on:Identity_STATUS)
Value | Description |
---|---|
"UserAssigned" |
MaintenanceWindow
(Appears on:FlexibleServer_Spec)
Maintenance window of a server.
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:FlexibleServer_STATUS)
Maintenance window of a server.
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:FlexibleServer_Spec)
Network related properties of a server
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. |
Network_STATUS
(Appears on:FlexibleServer_STATUS)
Network related properties of a server
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
(string
alias)
(Appears on:FlexibleServer_Spec)
The replication role.
Value | Description |
---|---|
"None" |
|
"Replica" |
|
"Source" |
ReplicationRole_STATUS
(string
alias)
(Appears on:FlexibleServer_STATUS)
The replication role.
Value | Description |
---|---|
"None" |
|
"Replica" |
|
"Source" |
ServerProperties_CreateMode
(string
alias)
(Appears on:FlexibleServer_Spec)
Value | Description |
---|---|
"Default" |
|
"GeoRestore" |
|
"PointInTimeRestore" |
|
"Replica" |
ServerProperties_CreateMode_STATUS
(string
alias)
(Appears on:FlexibleServer_STATUS)
Value | Description |
---|---|
"Default" |
|
"GeoRestore" |
|
"PointInTimeRestore" |
|
"Replica" |
ServerProperties_State_STATUS
(string
alias)
(Appears on:FlexibleServer_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Dropping" |
|
"Ready" |
|
"Starting" |
|
"Stopped" |
|
"Stopping" |
|
"Updating" |
ServerVersion
(string
alias)
(Appears on:FlexibleServer_Spec)
The version of a server.
Value | Description |
---|---|
"5.7" |
|
"8.0.21" |
ServerVersion_STATUS
(string
alias)
(Appears on:FlexibleServer_STATUS)
The version of a server.
Value | Description |
---|---|
"5.7" |
|
"8.0.21" |
Sku
(Appears on:FlexibleServer_Spec)
Billing information related properties of a server.
Field | Description |
---|---|
name string |
Name: The name of the sku, e.g. Standard_D32s_v3. |
tier Sku_Tier |
Tier: The tier of the particular SKU, e.g. GeneralPurpose. |
Sku_STATUS
(Appears on:FlexibleServer_STATUS)
Billing information related properties of a server.
Field | Description |
---|---|
name string |
Name: The name of the sku, e.g. Standard_D32s_v3. |
tier Sku_Tier_STATUS |
Tier: The tier of the particular SKU, e.g. GeneralPurpose. |
Sku_Tier
(string
alias)
(Appears on:Sku)
Value | Description |
---|---|
"Burstable" |
|
"GeneralPurpose" |
|
"MemoryOptimized" |
Sku_Tier_STATUS
(string
alias)
(Appears on:Sku_STATUS)
Value | Description |
---|---|
"Burstable" |
|
"GeneralPurpose" |
|
"MemoryOptimized" |
Storage
(Appears on:FlexibleServer_Spec)
Storage Profile properties of a server
Field | Description |
---|---|
autoGrow EnableStatusEnum |
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. |
Storage_STATUS
(Appears on:FlexibleServer_STATUS)
Storage Profile properties of a server
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. |
SystemData_CreatedByType_STATUS
(string
alias)
(Appears on:SystemData_STATUS)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_LastModifiedByType_STATUS
(string
alias)
(Appears on:SystemData_STATUS)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_STATUS
(Appears on:FlexibleServer_STATUS, FlexibleServersDatabase_STATUS, FlexibleServersFirewallRule_STATUS)
Metadata pertaining to creation and last modification of the resource.
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemData_CreatedByType_STATUS |
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 SystemData_LastModifiedByType_STATUS |
LastModifiedByType: The type of identity that last modified the resource. |
UserAssignedIdentityDetails
(Appears on:Identity)
Information about the user assigned identity for the resource
Field | Description |
---|---|
reference genruntime.ResourceReference |