dbformysql.azure.com/v1api20220101

dbformysql.azure.com/v1api20220101

Package v1api20220101 contains API Schema definitions for the dbformysql v1api20220101 API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2022-01-01"

    AdministratorProperties_ARM

    (Appears on:FlexibleServers_Administrator_Spec_ARM)

    The properties of an administrator.

    Field Description
    administratorType
    AdministratorProperties_AdministratorType

    AdministratorType: Type of the sever administrator.

    identityResourceId
    string
    login
    string

    Login: Login name of the server administrator.

    sid
    string

    Sid: SID (object ID) of the server administrator.

    tenantId
    string

    TenantId: Tenant ID of the administrator.

    AdministratorProperties_AdministratorType (string alias)

    (Appears on:AdministratorProperties_ARM, FlexibleServers_Administrator_Spec)

    Value Description

    "ActiveDirectory"

    AdministratorProperties_AdministratorType_STATUS (string alias)

    (Appears on:AdministratorProperties_STATUS_ARM, FlexibleServers_Administrator_STATUS)

    Value Description

    "ActiveDirectory"

    AdministratorProperties_STATUS_ARM

    (Appears on:FlexibleServers_Administrator_STATUS_ARM)

    The properties of an administrator.

    Field Description
    administratorType
    AdministratorProperties_AdministratorType_STATUS

    AdministratorType: Type of the sever administrator.

    identityResourceId
    string

    IdentityResourceId: The resource id of the identity used for AAD Authentication.

    login
    string

    Login: Login name of the server administrator.

    sid
    string

    Sid: SID (object ID) of the server administrator.

    tenantId
    string

    TenantId: Tenant ID of the administrator.

    ConfigurationProperties_ARM

    (Appears on:FlexibleServers_Configuration_Spec_ARM)

    The properties of a configuration.

    Field Description
    currentValue
    string

    CurrentValue: Current value of the configuration.

    source
    ConfigurationProperties_Source

    Source: Source of the configuration.

    value
    string

    Value: Value of the configuration.

    ConfigurationProperties_IsConfigPendingRestart_STATUS (string alias)

    (Appears on:ConfigurationProperties_STATUS_ARM, FlexibleServers_Configuration_STATUS)

    Value Description

    "False"

    "True"

    ConfigurationProperties_IsDynamicConfig_STATUS (string alias)

    (Appears on:ConfigurationProperties_STATUS_ARM, FlexibleServers_Configuration_STATUS)

    Value Description

    "False"

    "True"

    ConfigurationProperties_IsReadOnly_STATUS (string alias)

    (Appears on:ConfigurationProperties_STATUS_ARM, FlexibleServers_Configuration_STATUS)

    Value Description

    "False"

    "True"

    ConfigurationProperties_STATUS_ARM

    (Appears on:FlexibleServers_Configuration_STATUS_ARM)

    The properties of a configuration.

    Field Description
    allowedValues
    string

    AllowedValues: Allowed values of the configuration.

    currentValue
    string

    CurrentValue: Current value of the configuration.

    dataType
    string

    DataType: Data type of the configuration.

    defaultValue
    string

    DefaultValue: Default value of the configuration.

    description
    string

    Description: Description of the configuration.

    documentationLink
    string

    DocumentationLink: The link used to get the document from community or Azure site.

    isConfigPendingRestart
    ConfigurationProperties_IsConfigPendingRestart_STATUS

    IsConfigPendingRestart: If is the configuration pending restart or not.

    isDynamicConfig
    ConfigurationProperties_IsDynamicConfig_STATUS

    IsDynamicConfig: If is the configuration dynamic.

    isReadOnly
    ConfigurationProperties_IsReadOnly_STATUS

    IsReadOnly: If is the configuration read only.

    source
    ConfigurationProperties_Source_STATUS

    Source: Source of the configuration.

    value
    string

    Value: Value of the configuration.

    ConfigurationProperties_Source (string alias)

    (Appears on:ConfigurationProperties_ARM, FlexibleServers_Configuration_Spec)

    Value Description

    "system-default"

    "user-override"

    ConfigurationProperties_Source_STATUS (string alias)

    (Appears on:ConfigurationProperties_STATUS_ARM, FlexibleServers_Configuration_STATUS)

    Value Description

    "system-default"

    "user-override"

    FlexibleServersAdministrator

    Generator information: - Generated from: /mysql/resource-manager/Microsoft.DBforMySQL/AAD/stable/2022-01-01/AzureADAdministrator.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DBforMySQL/​flexibleServers/​{serverName}/​administrators/​{administratorName}

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


    administratorType
    AdministratorProperties_AdministratorType

    AdministratorType: Type of the sever administrator.

    identityResourceReference
    genruntime.ResourceReference

    IdentityResourceReference: The resource id of the identity used for AAD Authentication.

    login
    string

    Login: Login name of the server administrator.

    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

    sid
    string

    Sid: SID (object ID) of the server administrator.

    sidFromConfig
    genruntime.ConfigMapReference

    SidFromConfig: SID (object ID) of the server administrator.

    tenantId
    string

    TenantId: Tenant ID of the administrator.

    tenantIdFromConfig
    genruntime.ConfigMapReference

    TenantIdFromConfig: Tenant ID of the administrator.

    status
    FlexibleServers_Administrator_STATUS

    FlexibleServersConfiguration

    Generator information: - Generated from: /mysql/resource-manager/Microsoft.DBforMySQL/Configurations/stable/2022-01-01/Configurations.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DBforMySQL/​flexibleServers/​{serverName}/​configurations/​{configurationName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    FlexibleServers_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.

    currentValue
    string

    CurrentValue: Current value of the configuration.

    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

    source
    ConfigurationProperties_Source

    Source: Source of the configuration.

    value
    string

    Value: Value of the configuration.

    status
    FlexibleServers_Configuration_STATUS

    FlexibleServers_Administrator_STATUS

    (Appears on:FlexibleServersAdministrator)

    Field Description
    administratorType
    AdministratorProperties_AdministratorType_STATUS

    AdministratorType: Type of the sever administrator.

    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}

    identityResourceId
    string

    IdentityResourceId: The resource id of the identity used for AAD Authentication.

    login
    string

    Login: Login name of the server administrator.

    name
    string

    Name: The name of the resource

    sid
    string

    Sid: SID (object ID) of the server administrator.

    systemData
    SystemData_STATUS

    SystemData: The system metadata relating to this resource.

    tenantId
    string

    TenantId: Tenant ID of the administrator.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    FlexibleServers_Administrator_STATUS_ARM

    Field Description
    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

    properties
    AdministratorProperties_STATUS_ARM

    Properties: The properties of an administrator.

    systemData
    SystemData_STATUS_ARM

    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”

    FlexibleServers_Administrator_Spec

    (Appears on:FlexibleServersAdministrator)

    Field Description
    administratorType
    AdministratorProperties_AdministratorType

    AdministratorType: Type of the sever administrator.

    identityResourceReference
    genruntime.ResourceReference

    IdentityResourceReference: The resource id of the identity used for AAD Authentication.

    login
    string

    Login: Login name of the server administrator.

    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

    sid
    string

    Sid: SID (object ID) of the server administrator.

    sidFromConfig
    genruntime.ConfigMapReference

    SidFromConfig: SID (object ID) of the server administrator.

    tenantId
    string

    TenantId: Tenant ID of the administrator.

    tenantIdFromConfig
    genruntime.ConfigMapReference

    TenantIdFromConfig: Tenant ID of the administrator.

    FlexibleServers_Administrator_Spec_ARM

    Field Description
    name
    string
    properties
    AdministratorProperties_ARM

    Properties: The properties of an administrator.

    FlexibleServers_Configuration_STATUS

    (Appears on:FlexibleServersConfiguration)

    Field Description
    allowedValues
    string

    AllowedValues: Allowed values of the configuration.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    currentValue
    string

    CurrentValue: Current value of the configuration.

    dataType
    string

    DataType: Data type of the configuration.

    defaultValue
    string

    DefaultValue: Default value of the configuration.

    description
    string

    Description: Description of the configuration.

    documentationLink
    string

    DocumentationLink: The link used to get the document from community or Azure site.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    isConfigPendingRestart
    ConfigurationProperties_IsConfigPendingRestart_STATUS

    IsConfigPendingRestart: If is the configuration pending restart or not.

    isDynamicConfig
    ConfigurationProperties_IsDynamicConfig_STATUS

    IsDynamicConfig: If is the configuration dynamic.

    isReadOnly
    ConfigurationProperties_IsReadOnly_STATUS

    IsReadOnly: If is the configuration read only.

    name
    string

    Name: The name of the resource

    source
    ConfigurationProperties_Source_STATUS

    Source: Source of the configuration.

    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”

    value
    string

    Value: Value of the configuration.

    FlexibleServers_Configuration_STATUS_ARM

    Field Description
    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

    properties
    ConfigurationProperties_STATUS_ARM

    Properties: The properties of a configuration.

    systemData
    SystemData_STATUS_ARM

    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”

    FlexibleServers_Configuration_Spec

    (Appears on:FlexibleServersConfiguration)

    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.

    currentValue
    string

    CurrentValue: Current value of the configuration.

    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

    source
    ConfigurationProperties_Source

    Source: Source of the configuration.

    value
    string

    Value: Value of the configuration.

    FlexibleServers_Configuration_Spec_ARM

    Field Description
    name
    string
    properties
    ConfigurationProperties_ARM

    Properties: The properties of a configuration.

    SystemData_CreatedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS, SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS, SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_STATUS

    (Appears on:FlexibleServers_Administrator_STATUS, FlexibleServers_Configuration_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.

    SystemData_STATUS_ARM

    (Appears on:FlexibleServers_Administrator_STATUS_ARM, FlexibleServers_Configuration_STATUS_ARM)

    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.