dbforpostgresql.azure.com/v1api20230601preview


APIVersion

Value Description
“2023-06-01-preview”

FlexibleServer

Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/FlexibleServers.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DBforPostgreSQL/flexibleServers/{serverName}

Used by: FlexibleServerList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec FlexibleServer_Spec
Optional
status FlexibleServer_STATUS
Optional

FlexibleServer_Spec

Property Description Type
administratorLogin The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation). string
Optional
administratorLoginPassword The administrator login password (required for server creation). genruntime.SecretReference
Optional
authConfig AuthConfig properties of a server. AuthConfig
Optional
availabilityZone availability zone information of the server. string
Optional
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. string
Optional
backup Backup properties of a server. Backup
Optional
createMode The mode to create a new PostgreSQL server. ServerProperties_CreateMode
Optional
dataEncryption Data encryption properties of a server. DataEncryption
Optional
highAvailability High availability properties of a server. HighAvailability
Optional
identity Describes the identity of the application. UserAssignedIdentity
Optional
location The geo-location where the resource lives string
Required
maintenanceWindow Maintenance window properties of a server. MaintenanceWindow
Optional
network Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server. Network
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure FlexibleServerOperatorSpec
Optional
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 genruntime.KnownResourceReference
Required
pointInTimeUTC Restore point creation time (ISO8601 format), specifying the time to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’ or ‘GeoRestore’ or ‘ReviveDropped’. string
Optional
replica Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server. Replica
Optional
replicationRole Replication role of the server ReplicationRole
Optional
sku The SKU (pricing tier) of the server. Sku
Optional
sourceServerResourceReference The source server resource ID to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’ or ‘GeoRestore’ or ‘Replica’ or ‘ReviveDropped’. This property is returned only for Replica server genruntime.ResourceReference
Optional
storage Storage properties of a server. Storage
Optional
tags Resource tags. map[string]string
Optional
version PostgreSQL Server version. ServerVersion
Optional

FlexibleServer_STATUS

Property Description Type
administratorLogin The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation). string
Optional
authConfig AuthConfig properties of a server. AuthConfig_STATUS
Optional
availabilityZone availability zone information of the server. string
Optional
backup Backup properties of a server. Backup_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
createMode The mode to create a new PostgreSQL server. ServerProperties_CreateMode_STATUS
Optional
dataEncryption Data encryption properties of a server. DataEncryption_STATUS
Optional
fullyQualifiedDomainName The fully qualified domain name of a server. string
Optional
highAvailability High availability properties of a server. HighAvailability_STATUS
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
identity Describes the identity of the application. UserAssignedIdentity_STATUS
Optional
location The geo-location where the resource lives string
Optional
maintenanceWindow Maintenance window properties of a server. MaintenanceWindow_STATUS
Optional
minorVersion The minor version of the server. string
Optional
name The name of the resource string
Optional
network Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server. Network_STATUS
Optional
pointInTimeUTC Restore point creation time (ISO8601 format), specifying the time to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’ or ‘GeoRestore’ or ‘ReviveDropped’. string
Optional
privateEndpointConnections List of private endpoint connections associated with the specified resource. PrivateEndpointConnection_STATUS[]
Optional
replica Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server. Replica_STATUS
Optional
replicaCapacity Replicas allowed for a server. int
Optional
replicationRole Replication role of the server ReplicationRole_STATUS
Optional
sku The SKU (pricing tier) of the server. Sku_STATUS
Optional
sourceServerResourceId The source server resource ID to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’ or ‘GeoRestore’ or ‘Replica’ or ‘ReviveDropped’. This property is returned only for Replica server string
Optional
state A state of a server that is visible to user. ServerProperties_State_STATUS
Optional
storage Storage properties of a server. Storage_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
tags Resource tags. map[string]string
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional
version PostgreSQL Server version. ServerVersion_STATUS
Optional

FlexibleServerList

Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/FlexibleServers.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DBforPostgreSQL/flexibleServers/{serverName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items FlexibleServer[]
Optional

FlexibleServersConfiguration

Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/Configuration.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}

Used by: FlexibleServersConfigurationList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec FlexibleServersConfiguration_Spec
Optional
status FlexibleServersConfiguration_STATUS
Optional

FlexibleServersConfiguration_Spec

Property Description Type
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. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure FlexibleServersConfigurationOperatorSpec
Optional
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 dbforpostgresql.azure.com/FlexibleServer resource genruntime.KnownResourceReference
Required
source Source of the configuration. string
Optional
value Value of the configuration. string
Optional

FlexibleServersConfiguration_STATUS

Property Description Type
allowedValues Allowed values of the configuration. string
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
dataType Data type of the configuration. ConfigurationProperties_DataType_STATUS
Optional
defaultValue Default value of the configuration. string
Optional
description Description of the configuration. string
Optional
documentationLink Configuration documentation link. string
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
isConfigPendingRestart Configuration is pending restart or not. bool
Optional
isDynamicConfig Configuration dynamic or static. bool
Optional
isReadOnly Configuration read-only or not. bool
Optional
name The name of the resource string
Optional
source Source of the configuration. string
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional
unit Configuration unit. string
Optional
value Value of the configuration. string
Optional

FlexibleServersConfigurationList

Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/Configuration.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items FlexibleServersConfiguration[]
Optional

FlexibleServersDatabase

Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/Databases.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName}

Used by: FlexibleServersDatabaseList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec FlexibleServersDatabase_Spec
Optional
status FlexibleServersDatabase_STATUS
Optional

FlexibleServersDatabase_Spec

Property Description Type
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. string
Optional
charset The charset of the database. string
Optional
collation The collation of the database. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure FlexibleServersDatabaseOperatorSpec
Optional
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 dbforpostgresql.azure.com/FlexibleServer resource genruntime.KnownResourceReference
Required

FlexibleServersDatabase_STATUS

Property Description Type
charset The charset of the database. string
Optional
collation The collation of the database. string
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
name The name of the resource string
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

FlexibleServersDatabaseList

Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/Databases.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items FlexibleServersDatabase[]
Optional

FlexibleServersFirewallRule

Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/FirewallRules.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}

Used by: FlexibleServersFirewallRuleList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec FlexibleServersFirewallRule_Spec
Optional
status FlexibleServersFirewallRule_STATUS
Optional

FlexibleServersFirewallRule_Spec

Property Description Type
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. string
Optional
endIpAddress The end IP address of the server firewall rule. Must be IPv4 format. string
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure FlexibleServersFirewallRuleOperatorSpec
Optional
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 dbforpostgresql.azure.com/FlexibleServer resource genruntime.KnownResourceReference
Required
startIpAddress The start IP address of the server firewall rule. Must be IPv4 format. string
Required

FlexibleServersFirewallRule_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
endIpAddress The end IP address of the server firewall rule. Must be IPv4 format. string
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
name The name of the resource string
Optional
startIpAddress The start IP address of the server firewall rule. Must be IPv4 format. string
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

FlexibleServersFirewallRuleList

Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/FirewallRules.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items FlexibleServersFirewallRule[]
Optional

FlexibleServer_Spec

Used by: FlexibleServer.

Property Description Type
administratorLogin The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation). string
Optional
administratorLoginPassword The administrator login password (required for server creation). genruntime.SecretReference
Optional
authConfig AuthConfig properties of a server. AuthConfig
Optional
availabilityZone availability zone information of the server. string
Optional
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. string
Optional
backup Backup properties of a server. Backup
Optional
createMode The mode to create a new PostgreSQL server. ServerProperties_CreateMode
Optional
dataEncryption Data encryption properties of a server. DataEncryption
Optional
highAvailability High availability properties of a server. HighAvailability
Optional
identity Describes the identity of the application. UserAssignedIdentity
Optional
location The geo-location where the resource lives string
Required
maintenanceWindow Maintenance window properties of a server. MaintenanceWindow
Optional
network Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server. Network
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure FlexibleServerOperatorSpec
Optional
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 genruntime.KnownResourceReference
Required
pointInTimeUTC Restore point creation time (ISO8601 format), specifying the time to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’ or ‘GeoRestore’ or ‘ReviveDropped’. string
Optional
replica Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server. Replica
Optional
replicationRole Replication role of the server ReplicationRole
Optional
sku The SKU (pricing tier) of the server. Sku
Optional
sourceServerResourceReference The source server resource ID to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’ or ‘GeoRestore’ or ‘Replica’ or ‘ReviveDropped’. This property is returned only for Replica server genruntime.ResourceReference
Optional
storage Storage properties of a server. Storage
Optional
tags Resource tags. map[string]string
Optional
version PostgreSQL Server version. ServerVersion
Optional

FlexibleServer_STATUS

Used by: FlexibleServer.

Property Description Type
administratorLogin The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation). string
Optional
authConfig AuthConfig properties of a server. AuthConfig_STATUS
Optional
availabilityZone availability zone information of the server. string
Optional
backup Backup properties of a server. Backup_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
createMode The mode to create a new PostgreSQL server. ServerProperties_CreateMode_STATUS
Optional
dataEncryption Data encryption properties of a server. DataEncryption_STATUS
Optional
fullyQualifiedDomainName The fully qualified domain name of a server. string
Optional
highAvailability High availability properties of a server. HighAvailability_STATUS
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
identity Describes the identity of the application. UserAssignedIdentity_STATUS
Optional
location The geo-location where the resource lives string
Optional
maintenanceWindow Maintenance window properties of a server. MaintenanceWindow_STATUS
Optional
minorVersion The minor version of the server. string
Optional
name The name of the resource string
Optional
network Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server. Network_STATUS
Optional
pointInTimeUTC Restore point creation time (ISO8601 format), specifying the time to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’ or ‘GeoRestore’ or ‘ReviveDropped’. string
Optional
privateEndpointConnections List of private endpoint connections associated with the specified resource. PrivateEndpointConnection_STATUS[]
Optional
replica Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server. Replica_STATUS
Optional
replicaCapacity Replicas allowed for a server. int
Optional
replicationRole Replication role of the server ReplicationRole_STATUS
Optional
sku The SKU (pricing tier) of the server. Sku_STATUS
Optional
sourceServerResourceId The source server resource ID to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’ or ‘GeoRestore’ or ‘Replica’ or ‘ReviveDropped’. This property is returned only for Replica server string
Optional
state A state of a server that is visible to user. ServerProperties_State_STATUS
Optional
storage Storage properties of a server. Storage_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
tags Resource tags. map[string]string
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional
version PostgreSQL Server version. ServerVersion_STATUS
Optional

FlexibleServersConfiguration_Spec

Used by: FlexibleServersConfiguration.

Property Description Type
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. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure FlexibleServersConfigurationOperatorSpec
Optional
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 dbforpostgresql.azure.com/FlexibleServer resource genruntime.KnownResourceReference
Required
source Source of the configuration. string
Optional
value Value of the configuration. string
Optional

FlexibleServersConfiguration_STATUS

Used by: FlexibleServersConfiguration.

Property Description Type
allowedValues Allowed values of the configuration. string
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
dataType Data type of the configuration. ConfigurationProperties_DataType_STATUS
Optional
defaultValue Default value of the configuration. string
Optional
description Description of the configuration. string
Optional
documentationLink Configuration documentation link. string
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
isConfigPendingRestart Configuration is pending restart or not. bool
Optional
isDynamicConfig Configuration dynamic or static. bool
Optional
isReadOnly Configuration read-only or not. bool
Optional
name The name of the resource string
Optional
source Source of the configuration. string
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional
unit Configuration unit. string
Optional
value Value of the configuration. string
Optional

FlexibleServersDatabase_Spec

Used by: FlexibleServersDatabase.

Property Description Type
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. string
Optional
charset The charset of the database. string
Optional
collation The collation of the database. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure FlexibleServersDatabaseOperatorSpec
Optional
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 dbforpostgresql.azure.com/FlexibleServer resource genruntime.KnownResourceReference
Required

FlexibleServersDatabase_STATUS

Used by: FlexibleServersDatabase.

Property Description Type
charset The charset of the database. string
Optional
collation The collation of the database. string
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
name The name of the resource string
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

FlexibleServersFirewallRule_Spec

Used by: FlexibleServersFirewallRule.

Property Description Type
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. string
Optional
endIpAddress The end IP address of the server firewall rule. Must be IPv4 format. string
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure FlexibleServersFirewallRuleOperatorSpec
Optional
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 dbforpostgresql.azure.com/FlexibleServer resource genruntime.KnownResourceReference
Required
startIpAddress The start IP address of the server firewall rule. Must be IPv4 format. string
Required

FlexibleServersFirewallRule_STATUS

Used by: FlexibleServersFirewallRule.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
endIpAddress The end IP address of the server firewall rule. Must be IPv4 format. string
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
name The name of the resource string
Optional
startIpAddress The start IP address of the server firewall rule. Must be IPv4 format. string
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

AuthConfig

Authentication configuration properties of a server

Used by: FlexibleServer_Spec.

Property Description Type
activeDirectoryAuth If Enabled, Azure Active Directory authentication is enabled. AuthConfig_ActiveDirectoryAuth
Optional
passwordAuth If Enabled, Password authentication is enabled. AuthConfig_PasswordAuth
Optional
tenantId Tenant id of the server. string
Optional

AuthConfig_STATUS

Authentication configuration properties of a server

Used by: FlexibleServer_STATUS.

Property Description Type
activeDirectoryAuth If Enabled, Azure Active Directory authentication is enabled. AuthConfig_ActiveDirectoryAuth_STATUS
Optional
passwordAuth If Enabled, Password authentication is enabled. AuthConfig_PasswordAuth_STATUS
Optional
tenantId Tenant id of the server. string
Optional

Backup

Backup properties of a server

Used by: FlexibleServer_Spec.

Property Description Type
backupRetentionDays Backup retention days for the server. int
Optional
geoRedundantBackup A value indicating whether Geo-Redundant backup is enabled on the server. Backup_GeoRedundantBackup
Optional

Backup_STATUS

Backup properties of a server

Used by: FlexibleServer_STATUS.

Property Description Type
backupRetentionDays Backup retention days for the server. int
Optional
earliestRestoreDate The earliest restore point time (ISO8601 format) for server. string
Optional
geoRedundantBackup A value indicating whether Geo-Redundant backup is enabled on the server. Backup_GeoRedundantBackup_STATUS
Optional

ConfigurationProperties_DataType_STATUS

Used by: FlexibleServersConfiguration_STATUS.

Value Description
“Boolean”
“Enumeration”
“Integer”
“Numeric”

DataEncryption

Data encryption properties of a server

Used by: FlexibleServer_Spec.

Property Description Type
geoBackupEncryptionKeyStatus Geo-backup encryption key status for Data encryption enabled server. DataEncryption_GeoBackupEncryptionKeyStatus
Optional
geoBackupKeyURI URI for the key in keyvault for data encryption for geo-backup of server. string
Optional
geoBackupKeyURIFromConfig URI for the key in keyvault for data encryption for geo-backup of server. genruntime.ConfigMapReference
Optional
geoBackupUserAssignedIdentityReference Resource Id for the User assigned identity to be used for data encryption for geo-backup of server. genruntime.ResourceReference
Optional
primaryEncryptionKeyStatus Primary encryption key status for Data encryption enabled server. DataEncryption_PrimaryEncryptionKeyStatus
Optional
primaryKeyURI URI for the key in keyvault for data encryption of the primary server. string
Optional
primaryKeyURIFromConfig URI for the key in keyvault for data encryption of the primary server. genruntime.ConfigMapReference
Optional
primaryUserAssignedIdentityReference Resource Id for the User assigned identity to be used for data encryption of the primary server. genruntime.ResourceReference
Optional
type Data encryption type to depict if it is System Managed vs Azure Key vault. DataEncryption_Type
Optional

DataEncryption_STATUS

Data encryption properties of a server

Used by: FlexibleServer_STATUS.

Property Description Type
geoBackupEncryptionKeyStatus Geo-backup encryption key status for Data encryption enabled server. DataEncryption_GeoBackupEncryptionKeyStatus_STATUS
Optional
geoBackupKeyURI URI for the key in keyvault for data encryption for geo-backup of server. string
Optional
geoBackupUserAssignedIdentityId Resource Id for the User assigned identity to be used for data encryption for geo-backup of server. string
Optional
primaryEncryptionKeyStatus Primary encryption key status for Data encryption enabled server. DataEncryption_PrimaryEncryptionKeyStatus_STATUS
Optional
primaryKeyURI URI for the key in keyvault for data encryption of the primary server. string
Optional
primaryUserAssignedIdentityId Resource Id for the User assigned identity to be used for data encryption of the primary server. string
Optional
type Data encryption type to depict if it is System Managed vs Azure Key vault. DataEncryption_Type_STATUS
Optional

FlexibleServerOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: FlexibleServer_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
configMaps configures where to place operator written ConfigMaps. FlexibleServerOperatorConfigMaps
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional
secrets configures where to place Azure generated secrets. FlexibleServerOperatorSecrets
Optional

FlexibleServersConfigurationOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: FlexibleServersConfiguration_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

FlexibleServersDatabaseOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: FlexibleServersDatabase_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

FlexibleServersFirewallRuleOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: FlexibleServersFirewallRule_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

HighAvailability

High availability properties of a server

Used by: FlexibleServer_Spec.

Property Description Type
mode The HA mode for the server. HighAvailability_Mode
Optional
standbyAvailabilityZone availability zone information of the standby. string
Optional

HighAvailability_STATUS

High availability properties of a server

Used by: FlexibleServer_STATUS.

Property Description Type
mode The HA mode for the server. HighAvailability_Mode_STATUS
Optional
standbyAvailabilityZone availability zone information of the standby. string
Optional
state A state of a HA server that is visible to user. HighAvailability_State_STATUS
Optional

MaintenanceWindow

Maintenance window properties of a server.

Used by: FlexibleServer_Spec.

Property Description Type
customWindow indicates whether custom window is enabled or disabled string
Optional
dayOfWeek day of week for maintenance window int
Optional
startHour start hour for maintenance window int
Optional
startMinute start minute for maintenance window int
Optional

MaintenanceWindow_STATUS

Maintenance window properties of a server.

Used by: FlexibleServer_STATUS.

Property Description Type
customWindow indicates whether custom window is enabled or disabled string
Optional
dayOfWeek day of week for maintenance window int
Optional
startHour start hour for maintenance window int
Optional
startMinute start minute for maintenance window int
Optional

Network

Network properties of a server.

Used by: FlexibleServer_Spec.

Property Description Type
delegatedSubnetResourceReference Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. genruntime.ResourceReference
Optional
privateDnsZoneArmResourceReference Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. genruntime.ResourceReference
Optional
publicNetworkAccess public network access is enabled or not Network_PublicNetworkAccess
Optional

Network_STATUS

Network properties of a server.

Used by: FlexibleServer_STATUS.

Property Description Type
delegatedSubnetResourceId Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. string
Optional
privateDnsZoneArmResourceId Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone. string
Optional
publicNetworkAccess public network access is enabled or not Network_PublicNetworkAccess_STATUS
Optional

PrivateEndpointConnection_STATUS

The private endpoint connection resource.

Used by: FlexibleServer_STATUS.

Property Description Type
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional

Replica

Replica properties of a server

Used by: FlexibleServer_Spec.

Property Description Type
promoteMode Sets the promote mode for a replica server. This is a write only property. Replica_PromoteMode
Optional
promoteOption Sets the promote options for a replica server. This is a write only property. Replica_PromoteOption
Optional
role Used to indicate role of the server in replication set. ReplicationRole
Optional

Replica_STATUS

Replica properties of a server

Used by: FlexibleServer_STATUS.

Property Description Type
capacity Replicas allowed for a server. int
Optional
promoteMode Sets the promote mode for a replica server. This is a write only property. Replica_PromoteMode_STATUS
Optional
promoteOption Sets the promote options for a replica server. This is a write only property. Replica_PromoteOption_STATUS
Optional
replicationState Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring Replica_ReplicationState_STATUS
Optional
role Used to indicate role of the server in replication set. ReplicationRole_STATUS
Optional

ReplicationRole

Used to indicate role of the server in replication set.

Used by: FlexibleServer_Spec, and Replica.

Value Description
“AsyncReplica”
“GeoAsyncReplica”
“None”
“Primary”

ReplicationRole_STATUS

Used to indicate role of the server in replication set.

Used by: FlexibleServer_STATUS, and Replica_STATUS.

Value Description
“AsyncReplica”
“GeoAsyncReplica”
“None”
“Primary”

ServerProperties_CreateMode

Used by: FlexibleServer_Spec.

Value Description
“Create”
“Default”
“GeoRestore”
“PointInTimeRestore”
“Replica”
“ReviveDropped”
“Update”

ServerProperties_CreateMode_STATUS

Used by: FlexibleServer_STATUS.

Value Description
“Create”
“Default”
“GeoRestore”
“PointInTimeRestore”
“Replica”
“ReviveDropped”
“Update”

ServerProperties_State_STATUS

Used by: FlexibleServer_STATUS.

Value Description
“Disabled”
“Dropping”
“Ready”
“Starting”
“Stopped”
“Stopping”
“Updating”

ServerVersion

The version of a server.

Used by: FlexibleServer_Spec.

Value Description
“11”
“12”
“13”
“14”
“15”
“16”

ServerVersion_STATUS

The version of a server.

Used by: FlexibleServer_STATUS.

Value Description
“11”
“12”
“13”
“14”
“15”
“16”

Sku

Sku information related properties of a server.

Used by: FlexibleServer_Spec.

Property Description Type
name The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. string
Required
tier The tier of the particular SKU, e.g. Burstable. Sku_Tier
Required

Sku_STATUS

Sku information related properties of a server.

Used by: FlexibleServer_STATUS.

Property Description Type
name The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. string
Optional
tier The tier of the particular SKU, e.g. Burstable. Sku_Tier_STATUS
Optional

Storage

Storage properties of a server

Used by: FlexibleServer_Spec.

Property Description Type
autoGrow Flag to enable / disable Storage Auto grow for flexible server. Storage_AutoGrow
Optional
iops Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS int
Optional
storageSizeGB Max storage allowed for a server. int
Optional
throughput Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS int
Optional
tier Name of storage tier for IOPS. Storage_Tier
Optional
type Storage type for the server. Allowed values are Premium_LRS and PremiumV2_LRS, and default is Premium_LRS if not specified Storage_Type
Optional

Storage_STATUS

Storage properties of a server

Used by: FlexibleServer_STATUS.

Property Description Type
autoGrow Flag to enable / disable Storage Auto grow for flexible server. Storage_AutoGrow_STATUS
Optional
iops Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS int
Optional
storageSizeGB Max storage allowed for a server. int
Optional
throughput Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS int
Optional
tier Name of storage tier for IOPS. Storage_Tier_STATUS
Optional
type Storage type for the server. Allowed values are Premium_LRS and PremiumV2_LRS, and default is Premium_LRS if not specified Storage_Type_STATUS
Optional

SystemData_STATUS

Metadata pertaining to creation and last modification of the resource.

Used by: FlexibleServer_STATUS, FlexibleServersConfiguration_STATUS, FlexibleServersDatabase_STATUS, and FlexibleServersFirewallRule_STATUS.

Property Description Type
createdAt The timestamp of resource creation (UTC). string
Optional
createdBy The identity that created the resource. string
Optional
createdByType The type of identity that created the resource. SystemData_CreatedByType_STATUS
Optional
lastModifiedAt The timestamp of resource last modification (UTC) string
Optional
lastModifiedBy The identity that last modified the resource. string
Optional
lastModifiedByType The type of identity that last modified the resource. SystemData_LastModifiedByType_STATUS
Optional

UserAssignedIdentity

Information describing the identities associated with this application.

Used by: FlexibleServer_Spec.

Property Description Type
type the types of identities associated with this resource; currently restricted to ‘None and UserAssigned’ UserAssignedIdentity_Type
Required
userAssignedIdentities represents user assigned identities map. UserAssignedIdentityDetails[]
Optional

UserAssignedIdentity_STATUS

Information describing the identities associated with this application.

Used by: FlexibleServer_STATUS.

Property Description Type
tenantId Tenant id of the server. string
Optional
type the types of identities associated with this resource; currently restricted to ‘None and UserAssigned’ UserAssignedIdentity_Type_STATUS
Optional
userAssignedIdentities represents user assigned identities map. map[string]UserIdentity_STATUS
Optional

AuthConfig_ActiveDirectoryAuth

Used by: AuthConfig.

Value Description
“Disabled”
“Enabled”

AuthConfig_ActiveDirectoryAuth_STATUS

Used by: AuthConfig_STATUS.

Value Description
“Disabled”
“Enabled”

AuthConfig_PasswordAuth

Used by: AuthConfig.

Value Description
“Disabled”
“Enabled”

AuthConfig_PasswordAuth_STATUS

Used by: AuthConfig_STATUS.

Value Description
“Disabled”
“Enabled”

Backup_GeoRedundantBackup

Used by: Backup.

Value Description
“Disabled”
“Enabled”

Backup_GeoRedundantBackup_STATUS

Used by: Backup_STATUS.

Value Description
“Disabled”
“Enabled”

DataEncryption_GeoBackupEncryptionKeyStatus

Used by: DataEncryption.

Value Description
“Invalid”
“Valid”

DataEncryption_GeoBackupEncryptionKeyStatus_STATUS

Used by: DataEncryption_STATUS.

Value Description
“Invalid”
“Valid”

DataEncryption_PrimaryEncryptionKeyStatus

Used by: DataEncryption.

Value Description
“Invalid”
“Valid”

DataEncryption_PrimaryEncryptionKeyStatus_STATUS

Used by: DataEncryption_STATUS.

Value Description
“Invalid”
“Valid”

DataEncryption_Type

Used by: DataEncryption.

Value Description
“AzureKeyVault”
“SystemManaged”

DataEncryption_Type_STATUS

Used by: DataEncryption_STATUS.

Value Description
“AzureKeyVault”
“SystemManaged”

FlexibleServerOperatorConfigMaps

Used by: FlexibleServerOperatorSpec.

Property Description Type
fullyQualifiedDomainName indicates where the FullyQualifiedDomainName config map should be placed. If omitted, no config map will be created. genruntime.ConfigMapDestination
Optional

FlexibleServerOperatorSecrets

Used by: FlexibleServerOperatorSpec.

Property Description Type
fullyQualifiedDomainName indicates where the FullyQualifiedDomainName secret should be placed. If omitted, the secret will not be retrieved from Azure. genruntime.SecretDestination
Optional

HighAvailability_Mode

Used by: HighAvailability.

Value Description
“Disabled”
“SameZone”
“ZoneRedundant”

HighAvailability_Mode_STATUS

Used by: HighAvailability_STATUS.

Value Description
“Disabled”
“SameZone”
“ZoneRedundant”

HighAvailability_State_STATUS

Used by: HighAvailability_STATUS.

Value Description
“CreatingStandby”
“FailingOver”
“Healthy”
“NotEnabled”
“RemovingStandby”
“ReplicatingData”

Network_PublicNetworkAccess

Used by: Network.

Value Description
“Disabled”
“Enabled”

Network_PublicNetworkAccess_STATUS

Used by: Network_STATUS.

Value Description
“Disabled”
“Enabled”

Replica_PromoteMode

Used by: Replica.

Value Description
“standalone”
“switchover”

Replica_PromoteMode_STATUS

Used by: Replica_STATUS.

Value Description
“standalone”
“switchover”

Replica_PromoteOption

Used by: Replica.

Value Description
“forced”
“planned”

Replica_PromoteOption_STATUS

Used by: Replica_STATUS.

Value Description
“forced”
“planned”

Replica_ReplicationState_STATUS

Used by: Replica_STATUS.

Value Description
“Active”
“Broken”
“Catchup”
“Provisioning”
“Reconfiguring”
“Updating”

Sku_Tier

Used by: Sku.

Value Description
“Burstable”
“GeneralPurpose”
“MemoryOptimized”

Sku_Tier_STATUS

Used by: Sku_STATUS.

Value Description
“Burstable”
“GeneralPurpose”
“MemoryOptimized”

Storage_AutoGrow

Used by: Storage.

Value Description
“Disabled”
“Enabled”

Storage_AutoGrow_STATUS

Used by: Storage_STATUS.

Value Description
“Disabled”
“Enabled”

Storage_Tier

Used by: Storage.

Value Description
“P1”
“P10”
“P15”
“P2”
“P20”
“P3”
“P30”
“P4”
“P40”
“P50”
“P6”
“P60”
“P70”
“P80”

Storage_Tier_STATUS

Used by: Storage_STATUS.

Value Description
“P1”
“P10”
“P15”
“P2”
“P20”
“P3”
“P30”
“P4”
“P40”
“P50”
“P6”
“P60”
“P70”
“P80”

Storage_Type

Used by: Storage.

Value Description
“PremiumV2_LRS”
“Premium_LRS”

Storage_Type_STATUS

Used by: Storage_STATUS.

Value Description
“PremiumV2_LRS”
“Premium_LRS”

SystemData_CreatedByType_STATUS

Used by: SystemData_STATUS.

Value Description
“Application”
“Key”
“ManagedIdentity”
“User”

SystemData_LastModifiedByType_STATUS

Used by: SystemData_STATUS.

Value Description
“Application”
“Key”
“ManagedIdentity”
“User”

UserAssignedIdentity_Type

Used by: UserAssignedIdentity.

Value Description
“None”
“UserAssigned”

UserAssignedIdentity_Type_STATUS

Used by: UserAssignedIdentity_STATUS.

Value Description
“None”
“UserAssigned”

UserAssignedIdentityDetails

Information about the user assigned identity for the resource

Used by: UserAssignedIdentity.

Property Description Type
reference genruntime.ResourceReference
Optional

UserIdentity_STATUS

Describes a single user-assigned identity associated with the application.

Used by: UserAssignedIdentity_STATUS.

Property Description Type
clientId the client identifier of the Service Principal which this identity represents. string
Optional
principalId the object identifier of the Service Principal which this identity represents. string
Optional