dbformysql.azure.com/v1

dbformysql.azure.com/v1

Package v1 contains hand-crafted API Schema definitions for the dbformysql v1 API group

Resource Types:

    AADUserSpec

    (Appears on:UserSpec)

    Field Description
    alias
    string

    Alias is the short name associated with the user. This is required if the AzureName is longer than 32 characters. Note that Alias denotes the name used to manage the SQL user in MySQL, NOT the name used to log in to the SQL server. When logging in to the SQL server and prompted to provider the username, supply the AzureName.

    serverAdminUsername
    string

    ServerAdminUsername is the username of the Server administrator. If your server admin was configured with Azure Service Operator, this should match the value of the Administrator’s $.spec.login field. If the administrator is a group, the ServerAdminUsername should be the group name, not the actual username of the identity to log in with. For example if the administrator group is “admin-group” and identity “my-identity” is a member of that group, the ServerAdminUsername should be “admin-group”

    LocalUserSpec

    (Appears on:UserSpec)

    Field Description
    serverAdminUsername
    string

    ServerAdminUsername is the username of the Server administrator. If the administrator is a group, the ServerAdminUsername should be the group name, not the actual username of the identity to log in with. For example if the administrator group is “admin-group” and identity “my-identity” is a member of that group, the ServerAdminUsername should be “admin-group”.

    serverAdminPassword
    genruntime.SecretReference

    ServerAdminPassword is a reference to a secret containing the servers administrator password. If specified, the operator uses the ServerAdminUsername and ServerAdminPassword to log into the server as a local administrator. If NOT specified, the operator uses its identity to log into the server. The operator can only successfully log into the server if its identity is the administrator of the server or if its identity is a member of a group which is the administrator of the server. If the administrator is a group, the ServerAdminUsername should be the group name, not the actual username of the identity to log in with. For example if the administrator group is “admin-group” and identity “my-identity” is a member of that group, the ServerAdminUsername should be “admin-group”

    password
    genruntime.SecretReference

    Password is the password to use for the user

    User

    User is a MySQL user

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


    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. If not specified, the default is the name of the Kubernetes object. When creating a local user, this will be the name of the user created. When creating an AAD user, this must have a specific format depending on the type of AAD user being created. For managed identity: “my-managed-identity-name” For standard AAD user: “myuser@mydomain.onmicrosoft.com” For AAD group: “my-group”

    owner
    genruntime.KubernetesOwnerReference

    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

    hostname
    string

    Hostname is the host the user will connect from. If omitted, the default is to allow connection from any hostname.

    privileges
    []string

    The server-level roles assigned to the user. Privileges include the following: RELOAD, PROCESS, SHOW DATABASES, REPLICATION SLAVE, REPLICATION CLIENT, CREATE USER

    databasePrivileges
    map[string][]string

    The database-level roles assigned to the user (keyed by database name). Privileges include the following: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER

    localUser
    LocalUserSpec

    LocalUser contains details for creating a standard (non-aad) MySQL User

    aadUser
    AADUserSpec

    AADUser contains details for creating an AAD user.

    status
    UserStatus

    UserSpec

    (Appears on:User)

    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. If not specified, the default is the name of the Kubernetes object. When creating a local user, this will be the name of the user created. When creating an AAD user, this must have a specific format depending on the type of AAD user being created. For managed identity: “my-managed-identity-name” For standard AAD user: “myuser@mydomain.onmicrosoft.com” For AAD group: “my-group”

    owner
    genruntime.KubernetesOwnerReference

    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

    hostname
    string

    Hostname is the host the user will connect from. If omitted, the default is to allow connection from any hostname.

    privileges
    []string

    The server-level roles assigned to the user. Privileges include the following: RELOAD, PROCESS, SHOW DATABASES, REPLICATION SLAVE, REPLICATION CLIENT, CREATE USER

    databasePrivileges
    map[string][]string

    The database-level roles assigned to the user (keyed by database name). Privileges include the following: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER

    localUser
    LocalUserSpec

    LocalUser contains details for creating a standard (non-aad) MySQL User

    aadUser
    AADUserSpec

    AADUser contains details for creating an AAD user.

    UserStatus

    (Appears on:User)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource