dbformariadb.azure.com/v1api20180601

Package v1api20180601 contains API Schema definitions for the dbformariadb v1api20180601 API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2018-06-01"

Configuration

Generator information: - Generated from: /mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/configurations/{configurationName}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Configuration_Spec

`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.
`operatorSpec` ConfigurationOperatorSpec	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 dbformariadb.azure.com/Server resource
`source` string	Source: Source of the configuration.
`value` string	Value: Value of the configuration.

status
Configuration_STATUS

ConfigurationOperatorSpec

(Appears on:Configuration_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).

Configuration_STATUS

(Appears on:Configuration)

Field	Description
`allowedValues` string	AllowedValues: Allowed values of the configuration.
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`dataType` string	DataType: Data type of the configuration.
`defaultValue` string	DefaultValue: Default value of the configuration.
`description` string	Description: Description of the configuration.
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`name` string	Name: The name of the resource
`source` string	Source: Source of the configuration.
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
`value` string	Value: Value of the configuration.

Configuration_Spec

(Appears on:Configuration)

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.
`operatorSpec` ConfigurationOperatorSpec	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 dbformariadb.azure.com/Server resource
`source` string	Source: Source of the configuration.
`value` string	Value: Value of the configuration.

Database

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Database_Spec

`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` DatabaseOperatorSpec	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 dbformariadb.azure.com/Server resource

status
Database_STATUS

DatabaseOperatorSpec

(Appears on:Database_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).

Database_STATUS

(Appears on:Database)

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}
`name` string	Name: The name of the resource
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

Database_Spec

(Appears on:Database)

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` DatabaseOperatorSpec	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 dbformariadb.azure.com/Server resource

MinimalTlsVersion (`string` alias)

(Appears on:ServerPropertiesForDefaultCreate, ServerPropertiesForGeoRestore, ServerPropertiesForReplica, ServerPropertiesForRestore)

Enforce a minimal Tls version for the server.

Value	Description
"TLS1_0"
"TLS1_1"
"TLS1_2"
"TLSEnforcementDisabled"

MinimalTlsVersion_STATUS (`string` alias)

(Appears on:Server_STATUS)

Enforce a minimal Tls version for the server.

Value	Description
"TLS1_0"
"TLS1_1"
"TLS1_2"
"TLSEnforcementDisabled"

PrivateEndpointProperty_STATUS

(Appears on:ServerPrivateEndpointConnectionProperties_STATUS)

Field	Description
`id` string	Id: Resource id of the private endpoint.

PublicNetworkAccess (`string` alias)

(Appears on:ServerPropertiesForDefaultCreate, ServerPropertiesForGeoRestore, ServerPropertiesForReplica, ServerPropertiesForRestore)

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’

Value	Description
"Disabled"
"Enabled"

PublicNetworkAccess_STATUS (`string` alias)

(Appears on:Server_STATUS)

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’

Value	Description
"Disabled"
"Enabled"

Server

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Server_Spec

`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.
`location` string	Location: The location the resource resides in.
`operatorSpec` ServerOperatorSpec	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
`properties` ServerPropertiesForCreate	Properties: Properties of the server.
`sku` Sku	Sku: The SKU (pricing tier) of the server.
`tags` map[string]string	Tags: Application-specific metadata in the form of key-value pairs.

status
Server_STATUS

ServerOperatorSecrets

(Appears on:ServerOperatorSpec)

Field	Description
`fullyQualifiedDomainName` genruntime.SecretDestination	FullyQualifiedDomainName: indicates where the FullyQualifiedDomainName secret should be placed. If omitted, the secret will not be retrieved from Azure.

ServerOperatorSpec

(Appears on:Server_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).
`secrets` ServerOperatorSecrets	Secrets: configures where to place Azure generated secrets.

ServerPrivateEndpointConnectionProperties_ProvisioningState_STATUS (`string` alias)

(Appears on:ServerPrivateEndpointConnectionProperties_STATUS)

Value	Description
"Approving"
"Dropping"
"Failed"
"Ready"
"Rejecting"

ServerPrivateEndpointConnectionProperties_STATUS

(Appears on:ServerPrivateEndpointConnection_STATUS)

Properties of a private endpoint connection.

Field	Description
`privateEndpoint` PrivateEndpointProperty_STATUS	PrivateEndpoint: Private endpoint which the connection belongs to.
`privateLinkServiceConnectionState` ServerPrivateLinkServiceConnectionStateProperty_STATUS	PrivateLinkServiceConnectionState: Connection state of the private endpoint connection.
`provisioningState` ServerPrivateEndpointConnectionProperties_ProvisioningState_STATUS	ProvisioningState: State of the private endpoint connection.

ServerPrivateEndpointConnection_STATUS

(Appears on:Server_STATUS)

A private endpoint connection under a server

Field	Description
`id` string	Id: Resource Id of the private endpoint connection.
`properties` ServerPrivateEndpointConnectionProperties_STATUS	Properties: Private endpoint connection properties

ServerPrivateLinkServiceConnectionStateProperty_ActionsRequired_STATUS (`string` alias)

(Appears on:ServerPrivateLinkServiceConnectionStateProperty_STATUS)

Value	Description
"None"

ServerPrivateLinkServiceConnectionStateProperty_STATUS

(Appears on:ServerPrivateEndpointConnectionProperties_STATUS)

Field	Description
`actionsRequired` ServerPrivateLinkServiceConnectionStateProperty_ActionsRequired_STATUS	ActionsRequired: The actions required for private link service connection.
`description` string	Description: The private link service connection description.
`status` ServerPrivateLinkServiceConnectionStateProperty_Status_STATUS	Status: The private link service connection status.

ServerPrivateLinkServiceConnectionStateProperty_Status_STATUS (`string` alias)

(Appears on:ServerPrivateLinkServiceConnectionStateProperty_STATUS)

Value	Description
"Approved"
"Disconnected"
"Pending"
"Rejected"

ServerPropertiesForCreate

(Appears on:Server_Spec)

Field	Description
`default` ServerPropertiesForDefaultCreate	Default: Mutually exclusive with all other properties
`geoRestore` ServerPropertiesForGeoRestore	GeoRestore: Mutually exclusive with all other properties
`pointInTimeRestore` ServerPropertiesForRestore	PointInTimeRestore: Mutually exclusive with all other properties
`replica` ServerPropertiesForReplica	Replica: Mutually exclusive with all other properties

ServerPropertiesForDefaultCreate

(Appears on:ServerPropertiesForCreate)

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.
`createMode` ServerPropertiesForDefaultCreate_CreateMode	CreateMode: The mode to create a new server.
`minimalTlsVersion` MinimalTlsVersion	MinimalTlsVersion: Enforce a minimal Tls version for the server.
`publicNetworkAccess` PublicNetworkAccess	PublicNetworkAccess: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’
`sslEnforcement` SslEnforcement	SslEnforcement: Enable ssl enforcement or not when connect to server.
`storageProfile` StorageProfile	StorageProfile: Storage profile of a server.
`version` ServerVersion	Version: Server version.

ServerPropertiesForDefaultCreate_CreateMode (`string` alias)

(Appears on:ServerPropertiesForDefaultCreate)

Value	Description
"Default"

ServerPropertiesForGeoRestore

(Appears on:ServerPropertiesForCreate)

Field	Description
`createMode` ServerPropertiesForGeoRestore_CreateMode	CreateMode: The mode to create a new server.
`minimalTlsVersion` MinimalTlsVersion	MinimalTlsVersion: Enforce a minimal Tls version for the server.
`publicNetworkAccess` PublicNetworkAccess	PublicNetworkAccess: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’
`sourceServerId` string	SourceServerId: The source server id to restore from.
`sslEnforcement` SslEnforcement	SslEnforcement: Enable ssl enforcement or not when connect to server.
`storageProfile` StorageProfile	StorageProfile: Storage profile of a server.
`version` ServerVersion	Version: Server version.

ServerPropertiesForGeoRestore_CreateMode (`string` alias)

(Appears on:ServerPropertiesForGeoRestore)

Value	Description
"GeoRestore"

ServerPropertiesForReplica

(Appears on:ServerPropertiesForCreate)

Field	Description
`createMode` ServerPropertiesForReplica_CreateMode	CreateMode: The mode to create a new server.
`minimalTlsVersion` MinimalTlsVersion	MinimalTlsVersion: Enforce a minimal Tls version for the server.
`publicNetworkAccess` PublicNetworkAccess	PublicNetworkAccess: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’
`sourceServerId` string	SourceServerId: The master server id to create replica from.
`sslEnforcement` SslEnforcement	SslEnforcement: Enable ssl enforcement or not when connect to server.
`storageProfile` StorageProfile	StorageProfile: Storage profile of a server.
`version` ServerVersion	Version: Server version.

ServerPropertiesForReplica_CreateMode (`string` alias)

(Appears on:ServerPropertiesForReplica)

Value	Description
"Replica"

ServerPropertiesForRestore

(Appears on:ServerPropertiesForCreate)

Field	Description
`createMode` ServerPropertiesForRestore_CreateMode	CreateMode: The mode to create a new server.
`minimalTlsVersion` MinimalTlsVersion	MinimalTlsVersion: Enforce a minimal Tls version for the server.
`publicNetworkAccess` PublicNetworkAccess	PublicNetworkAccess: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’
`restorePointInTime` string	RestorePointInTime: Restore point creation time (ISO8601 format), specifying the time to restore from.
`sourceServerId` string	SourceServerId: The source server id to restore from.
`sslEnforcement` SslEnforcement	SslEnforcement: Enable ssl enforcement or not when connect to server.
`storageProfile` StorageProfile	StorageProfile: Storage profile of a server.
`version` ServerVersion	Version: Server version.

ServerPropertiesForRestore_CreateMode (`string` alias)

(Appears on:ServerPropertiesForRestore)

Value	Description
"PointInTimeRestore"

ServerProperties_UserVisibleState_STATUS (`string` alias)

(Appears on:Server_STATUS)

Value	Description
"Disabled"
"Dropping"
"Ready"

ServerVersion (`string` alias)

(Appears on:ServerPropertiesForDefaultCreate, ServerPropertiesForGeoRestore, ServerPropertiesForReplica, ServerPropertiesForRestore)

The version of a server.

Value	Description
"10.2"
"10.3"

ServerVersion_STATUS (`string` alias)

(Appears on:Server_STATUS)

The version of a server.

Value	Description
"10.2"
"10.3"

Server_STATUS

(Appears on:Server)

Represents a server.

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).
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`earliestRestoreDate` string	EarliestRestoreDate: Earliest restore point creation time (ISO8601 format)
`fullyQualifiedDomainName` string	FullyQualifiedDomainName: The fully qualified domain name of a server.
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`location` string	Location: The geo-location where the resource lives
`masterServerId` string	MasterServerId: The master server id of a replica server.
`minimalTlsVersion` MinimalTlsVersion_STATUS	MinimalTlsVersion: Enforce a minimal Tls version for the server.
`name` string	Name: The name of the resource
`privateEndpointConnections` []ServerPrivateEndpointConnection_STATUS	PrivateEndpointConnections: List of private endpoint connections on a server
`publicNetworkAccess` PublicNetworkAccess_STATUS	PublicNetworkAccess: Whether or not public network access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’
`replicaCapacity` int	ReplicaCapacity: The maximum number of replicas that a master server can have.
`replicationRole` string	ReplicationRole: The replication role of the server.
`sku` Sku_STATUS	Sku: The SKU (pricing tier) of the server.
`sslEnforcement` SslEnforcement_STATUS	SslEnforcement: Enable ssl enforcement or not when connect to server.
`storageProfile` StorageProfile_STATUS	StorageProfile: Storage profile of a server.
`tags` map[string]string	Tags: Resource tags.
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
`userVisibleState` ServerProperties_UserVisibleState_STATUS	UserVisibleState: A state of a server that is visible to user.
`version` ServerVersion_STATUS	Version: Server version.

Server_Spec

(Appears on:Server)

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.
`location` string	Location: The location the resource resides in.
`operatorSpec` ServerOperatorSpec	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
`properties` ServerPropertiesForCreate	Properties: Properties of the server.
`sku` Sku	Sku: The SKU (pricing tier) of the server.
`tags` map[string]string	Tags: Application-specific metadata in the form of key-value pairs.

Sku

(Appears on:Server_Spec)

Billing information related properties of a server.

Field	Description
`capacity` int	Capacity: The scale up/out capacity, representing server’s compute units.
`family` string	Family: The family of hardware.
`name` string	Name: The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.
`size` string	Size: The size code, to be interpreted by resource as appropriate.
`tier` Sku_Tier	Tier: The tier of the particular SKU, e.g. Basic.

Sku_STATUS

(Appears on:Server_STATUS)

Billing information related properties of a server.

Field	Description
`capacity` int	Capacity: The scale up/out capacity, representing server’s compute units.
`family` string	Family: The family of hardware.
`name` string	Name: The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.
`size` string	Size: The size code, to be interpreted by resource as appropriate.
`tier` Sku_Tier_STATUS	Tier: The tier of the particular SKU, e.g. Basic.

Sku_Tier (`string` alias)

(Appears on:Sku)

Value	Description
"Basic"
"GeneralPurpose"
"MemoryOptimized"

Sku_Tier_STATUS (`string` alias)

(Appears on:Sku_STATUS)

Value	Description
"Basic"
"GeneralPurpose"
"MemoryOptimized"

SslEnforcement (`string` alias)

(Appears on:ServerPropertiesForDefaultCreate, ServerPropertiesForGeoRestore, ServerPropertiesForReplica, ServerPropertiesForRestore)

Enable ssl enforcement or not when connect to server.

Value	Description
"Disabled"
"Enabled"

SslEnforcement_STATUS (`string` alias)

(Appears on:Server_STATUS)

Enable ssl enforcement or not when connect to server.

Value	Description
"Disabled"
"Enabled"

StorageProfile

(Appears on:ServerPropertiesForDefaultCreate, ServerPropertiesForGeoRestore, ServerPropertiesForReplica, ServerPropertiesForRestore)

Storage Profile properties of a server

Field	Description
`backupRetentionDays` int	BackupRetentionDays: Backup retention days for the server.
`geoRedundantBackup` StorageProfile_GeoRedundantBackup	GeoRedundantBackup: Enable Geo-redundant or not for server backup.
`storageAutogrow` StorageProfile_StorageAutogrow	StorageAutogrow: Enable Storage Auto Grow.
`storageMB` int	StorageMB: Max storage allowed for a server.

StorageProfile_GeoRedundantBackup (`string` alias)

(Appears on:StorageProfile)

Value	Description
"Disabled"
"Enabled"

StorageProfile_GeoRedundantBackup_STATUS (`string` alias)

(Appears on:StorageProfile_STATUS)

Value	Description
"Disabled"
"Enabled"

StorageProfile_STATUS

(Appears on:Server_STATUS)

Storage Profile properties of a server

Field	Description
`backupRetentionDays` int	BackupRetentionDays: Backup retention days for the server.
`geoRedundantBackup` StorageProfile_GeoRedundantBackup_STATUS	GeoRedundantBackup: Enable Geo-redundant or not for server backup.
`storageAutogrow` StorageProfile_StorageAutogrow_STATUS	StorageAutogrow: Enable Storage Auto Grow.
`storageMB` int	StorageMB: Max storage allowed for a server.

StorageProfile_StorageAutogrow (`string` alias)

(Appears on:StorageProfile)

Value	Description
"Disabled"
"Enabled"

StorageProfile_StorageAutogrow_STATUS (`string` alias)

(Appears on:StorageProfile_STATUS)

Value	Description
"Disabled"
"Enabled"

dbformariadb.azure.com/v1api20180601