dbforpostgresql.azure.com/v1api20240801
APIVersion
| Value | Description |
|---|---|
| “2024-08-01” |
FlexibleServer
Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/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 | Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn’t deleted. | string Optional |
| administratorLoginPassword | Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time. | genruntime.SecretReference Optional |
| authConfig | Authentication configuration properties of a flexible server. | AuthConfig Optional |
| availabilityZone | Availability zone of a flexible 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 flexible server. | Backup Optional |
| createMode | Creation mode of a new flexible server. | ServerProperties_CreateMode Optional |
| dataEncryption | Data encryption properties of a flexible server. | DataEncryption Optional |
| highAvailability | High availability properties of a flexible server. | HighAvailability Optional |
| identity | User assigned managed identities assigned to the flexible server. | UserAssignedIdentity Optional |
| location | The geo-location where the resource lives | string Required |
| maintenanceWindow | Maintenance window properties of a flexible server. | MaintenanceWindow Optional |
| network | Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer. | 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 | Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It’s required when createMode is PointInTimeRestore, GeoRestore, or ReviveDropped. |
string Optional |
| replica | Read replica properties of a flexible server. Required only in case that you want to promote a server. | Replica Optional |
| replicationRole | Role of the server in a replication set. | ReplicationRole Optional |
| sku | Compute tier and size of a flexible server. | Sku Optional |
| sourceServerResourceReference | Identifier of the flexible server to be used as the source of the new flexible server. Required when createMode is PointInTimeRestore, GeoRestore, Replica, or ReviveDropped. This property is returned only when the target flexible server is a read replica. |
genruntime.ResourceReference Optional |
| storage | Storage properties of a flexible server. | Storage Optional |
| tags | Resource tags. | map[string]string Optional |
| version | Major version of PostgreSQL database engine. | ServerVersion Optional |
FlexibleServer_STATUS
| Property | Description | Type |
|---|---|---|
| administratorLogin | Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn’t deleted. | string Optional |
| authConfig | Authentication configuration properties of a flexible server. | AuthConfig_STATUS Optional |
| availabilityZone | Availability zone of a flexible server. | string Optional |
| backup | Backup properties of a flexible server. | Backup_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createMode | Creation mode of a new flexible server. | ServerProperties_CreateMode_STATUS Optional |
| dataEncryption | Data encryption properties of a flexible server. | DataEncryption_STATUS Optional |
| fullyQualifiedDomainName | Fully qualified domain name of a flexible server. | string Optional |
| highAvailability | High availability properties of a flexible 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 | User assigned managed identities assigned to the flexible server. | UserAssignedIdentity_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| maintenanceWindow | Maintenance window properties of a flexible server. | MaintenanceWindow_STATUS Optional |
| minorVersion | Minor version of PostgreSQL database engine. | string Optional |
| name | The name of the resource | string Optional |
| network | Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer. | Network_STATUS Optional |
| pointInTimeUTC | Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It’s required when createMode is PointInTimeRestore, GeoRestore, or ReviveDropped. |
string Optional |
| privateEndpointConnections | List of private endpoint connections associated with the specified flexible server. | PrivateEndpointConnection_STATUS[] Optional |
| replica | Read replica properties of a flexible server. Required only in case that you want to promote a server. | Replica_STATUS Optional |
| replicaCapacity | Maximum number of read replicas allowed for a flexible server. | int Optional |
| replicationRole | Role of the server in a replication set. | ReplicationRole_STATUS Optional |
| sku | Compute tier and size of a flexible server. | Sku_STATUS Optional |
| sourceServerResourceId | Identifier of the flexible server to be used as the source of the new flexible server. Required when createMode is PointInTimeRestore, GeoRestore, Replica, or ReviveDropped. This property is returned only when the target flexible server is a read replica. |
string Optional |
| state | Possible states of a flexible server. | ServerProperties_State_STATUS Optional |
| storage | Storage properties of a flexible 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 | Major version of PostgreSQL database engine. | ServerVersion_STATUS Optional |
FlexibleServerList
Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FlexibleServers.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | FlexibleServer[] Optional |
FlexibleServersAdvancedThreatProtectionSettings
Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ThreatProtection.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/Default
Used by: FlexibleServersAdvancedThreatProtectionSettingsList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | FlexibleServersAdvancedThreatProtectionSettings_Spec Optional |
|
| status | FlexibleServersAdvancedThreatProtectionSettings_STATUS Optional |
FlexibleServersAdvancedThreatProtectionSettings_Spec
| Property | Description | Type |
|---|---|---|
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FlexibleServersAdvancedThreatProtectionSettingsOperatorSpec 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 |
| state | Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the flexible server. | ServerThreatProtectionProperties_State Required |
FlexibleServersAdvancedThreatProtectionSettings_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| creationTime | Specifies the creation time (UTC) of the policy. | 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 |
| state | Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the flexible server. | ServerThreatProtectionProperties_State_STATUS 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 |
FlexibleServersAdvancedThreatProtectionSettingsList
Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ThreatProtection.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/Default
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | FlexibleServersAdvancedThreatProtectionSettings[] Optional |
FlexibleServersBackup
Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Backups.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/backups/{backupName}
Used by: FlexibleServersBackupList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | FlexibleServersBackup_Spec Optional |
|
| status | FlexibleServersBackup_STATUS Optional |
FlexibleServersBackup_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 | FlexibleServersBackupOperatorSpec 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 |
FlexibleServersBackup_STATUS
| Property | Description | Type |
|---|---|---|
| backupType | Type of backup. | ServerBackupProperties_BackupType_STATUS Optional |
| completedTime | Time(ISO8601 format) at which the backup was completed. | 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 |
| source | Source of the backup. | 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 |
FlexibleServersBackupList
Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Backups.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/backups/{backupName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | FlexibleServersBackup[] Optional |
FlexibleServersConfiguration
Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/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 value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter. | string Optional |
| value | Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter. | string Optional |
FlexibleServersConfiguration_STATUS
| Property | Description | Type |
|---|---|---|
| allowedValues | Allowed values of the server parameter. | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataType | Data type of the server parameter. | ConfigurationProperties_DataType_STATUS Optional |
| defaultValue | Value assigned by default to the server parameter. | string Optional |
| description | Description of the server parameter. | string Optional |
| documentationLink | Link pointing to the documentation of the server parameter. | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| isConfigPendingRestart | Indicates if the value assigned to the server parameter is pending a server restart for the value to take effect. | bool Optional |
| isDynamicConfig | Indicates if it’s a dynamic (true) or static (false) server parameter. Static server parameters require a server restart after changing the value assigned to it, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to it, for the change to take effect. | bool Optional |
| isReadOnly | Indicates if it’s a read-only (true) or modifiable (false) server parameter. | bool Optional |
| name | The name of the resource | string Optional |
| source | Source of the value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter. | 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 | Units in which the server parameter value is expressed. | string Optional |
| value | Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter. | string Optional |
FlexibleServersConfigurationList
Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/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/stable/2024-08-01/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 | Character set of the database. | string Optional |
| collation | 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 | Character set of the database. | string Optional |
| collation | 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/stable/2024-08-01/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/stable/2024-08-01/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 | IP address defining the end of the range of addresses of a firewall rule. Must be expressed in 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 | IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format. | string Required |
FlexibleServersFirewallRule_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| endIpAddress | IP address defining the end of the range of addresses of a firewall rule. Must be expressed in 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 | IP address defining the start of the range of addresses of a firewall rule. Must be expressed in 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/stable/2024-08-01/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 |
FlexibleServersVirtualEndpoint
Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualEndpoints.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints/{virtualEndpointName}
Used by: FlexibleServersVirtualEndpointList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | FlexibleServersVirtualEndpoint_Spec Optional |
|
| status | FlexibleServersVirtualEndpoint_STATUS Optional |
FlexibleServersVirtualEndpoint_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 |
| endpointType | Type of endpoint for the virtual endpoints. | VirtualEndpointResourceProperties_EndpointType Optional |
| members | List of flexible servers that one of the virtual endpoints can refer to. | string[] Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FlexibleServersVirtualEndpointOperatorSpec 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 |
FlexibleServersVirtualEndpoint_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| endpointType | Type of endpoint for the virtual endpoints. | VirtualEndpointResourceProperties_EndpointType_STATUS Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| members | List of flexible servers that one of the virtual endpoints can refer to. | 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 |
| virtualEndpoints | List of virtual endpoints for a flexible server. | string[] Optional |
FlexibleServersVirtualEndpointList
Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualEndpoints.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints/{virtualEndpointName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | FlexibleServersVirtualEndpoint[] Optional |
FlexibleServer_Spec
Used by: FlexibleServer.
| Property | Description | Type |
|---|---|---|
| administratorLogin | Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn’t deleted. | string Optional |
| administratorLoginPassword | Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time. | genruntime.SecretReference Optional |
| authConfig | Authentication configuration properties of a flexible server. | AuthConfig Optional |
| availabilityZone | Availability zone of a flexible 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 flexible server. | Backup Optional |
| createMode | Creation mode of a new flexible server. | ServerProperties_CreateMode Optional |
| dataEncryption | Data encryption properties of a flexible server. | DataEncryption Optional |
| highAvailability | High availability properties of a flexible server. | HighAvailability Optional |
| identity | User assigned managed identities assigned to the flexible server. | UserAssignedIdentity Optional |
| location | The geo-location where the resource lives | string Required |
| maintenanceWindow | Maintenance window properties of a flexible server. | MaintenanceWindow Optional |
| network | Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer. | 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 | Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It’s required when createMode is PointInTimeRestore, GeoRestore, or ReviveDropped. |
string Optional |
| replica | Read replica properties of a flexible server. Required only in case that you want to promote a server. | Replica Optional |
| replicationRole | Role of the server in a replication set. | ReplicationRole Optional |
| sku | Compute tier and size of a flexible server. | Sku Optional |
| sourceServerResourceReference | Identifier of the flexible server to be used as the source of the new flexible server. Required when createMode is PointInTimeRestore, GeoRestore, Replica, or ReviveDropped. This property is returned only when the target flexible server is a read replica. |
genruntime.ResourceReference Optional |
| storage | Storage properties of a flexible server. | Storage Optional |
| tags | Resource tags. | map[string]string Optional |
| version | Major version of PostgreSQL database engine. | ServerVersion Optional |
FlexibleServer_STATUS
Used by: FlexibleServer.
| Property | Description | Type |
|---|---|---|
| administratorLogin | Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn’t deleted. | string Optional |
| authConfig | Authentication configuration properties of a flexible server. | AuthConfig_STATUS Optional |
| availabilityZone | Availability zone of a flexible server. | string Optional |
| backup | Backup properties of a flexible server. | Backup_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createMode | Creation mode of a new flexible server. | ServerProperties_CreateMode_STATUS Optional |
| dataEncryption | Data encryption properties of a flexible server. | DataEncryption_STATUS Optional |
| fullyQualifiedDomainName | Fully qualified domain name of a flexible server. | string Optional |
| highAvailability | High availability properties of a flexible 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 | User assigned managed identities assigned to the flexible server. | UserAssignedIdentity_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| maintenanceWindow | Maintenance window properties of a flexible server. | MaintenanceWindow_STATUS Optional |
| minorVersion | Minor version of PostgreSQL database engine. | string Optional |
| name | The name of the resource | string Optional |
| network | Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer. | Network_STATUS Optional |
| pointInTimeUTC | Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It’s required when createMode is PointInTimeRestore, GeoRestore, or ReviveDropped. |
string Optional |
| privateEndpointConnections | List of private endpoint connections associated with the specified flexible server. | PrivateEndpointConnection_STATUS[] Optional |
| replica | Read replica properties of a flexible server. Required only in case that you want to promote a server. | Replica_STATUS Optional |
| replicaCapacity | Maximum number of read replicas allowed for a flexible server. | int Optional |
| replicationRole | Role of the server in a replication set. | ReplicationRole_STATUS Optional |
| sku | Compute tier and size of a flexible server. | Sku_STATUS Optional |
| sourceServerResourceId | Identifier of the flexible server to be used as the source of the new flexible server. Required when createMode is PointInTimeRestore, GeoRestore, Replica, or ReviveDropped. This property is returned only when the target flexible server is a read replica. |
string Optional |
| state | Possible states of a flexible server. | ServerProperties_State_STATUS Optional |
| storage | Storage properties of a flexible 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 | Major version of PostgreSQL database engine. | ServerVersion_STATUS Optional |
FlexibleServersAdvancedThreatProtectionSettings_Spec
Used by: FlexibleServersAdvancedThreatProtectionSettings.
| Property | Description | Type |
|---|---|---|
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FlexibleServersAdvancedThreatProtectionSettingsOperatorSpec 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 |
| state | Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the flexible server. | ServerThreatProtectionProperties_State Required |
FlexibleServersAdvancedThreatProtectionSettings_STATUS
Used by: FlexibleServersAdvancedThreatProtectionSettings.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| creationTime | Specifies the creation time (UTC) of the policy. | 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 |
| state | Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the flexible server. | ServerThreatProtectionProperties_State_STATUS 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 |
FlexibleServersBackup_Spec
Used by: FlexibleServersBackup.
| 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 | FlexibleServersBackupOperatorSpec 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 |
FlexibleServersBackup_STATUS
Used by: FlexibleServersBackup.
| Property | Description | Type |
|---|---|---|
| backupType | Type of backup. | ServerBackupProperties_BackupType_STATUS Optional |
| completedTime | Time(ISO8601 format) at which the backup was completed. | 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 |
| source | Source of the backup. | 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 |
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 value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter. | string Optional |
| value | Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter. | string Optional |
FlexibleServersConfiguration_STATUS
Used by: FlexibleServersConfiguration.
| Property | Description | Type |
|---|---|---|
| allowedValues | Allowed values of the server parameter. | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataType | Data type of the server parameter. | ConfigurationProperties_DataType_STATUS Optional |
| defaultValue | Value assigned by default to the server parameter. | string Optional |
| description | Description of the server parameter. | string Optional |
| documentationLink | Link pointing to the documentation of the server parameter. | string Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| isConfigPendingRestart | Indicates if the value assigned to the server parameter is pending a server restart for the value to take effect. | bool Optional |
| isDynamicConfig | Indicates if it’s a dynamic (true) or static (false) server parameter. Static server parameters require a server restart after changing the value assigned to it, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to it, for the change to take effect. | bool Optional |
| isReadOnly | Indicates if it’s a read-only (true) or modifiable (false) server parameter. | bool Optional |
| name | The name of the resource | string Optional |
| source | Source of the value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter. | 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 | Units in which the server parameter value is expressed. | string Optional |
| value | Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter. | 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 | Character set of the database. | string Optional |
| collation | 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 | Character set of the database. | string Optional |
| collation | 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 | IP address defining the end of the range of addresses of a firewall rule. Must be expressed in 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 | IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format. | string Required |
FlexibleServersFirewallRule_STATUS
Used by: FlexibleServersFirewallRule.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| endIpAddress | IP address defining the end of the range of addresses of a firewall rule. Must be expressed in 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 | IP address defining the start of the range of addresses of a firewall rule. Must be expressed in 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 |
FlexibleServersVirtualEndpoint_Spec
Used by: FlexibleServersVirtualEndpoint.
| 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 |
| endpointType | Type of endpoint for the virtual endpoints. | VirtualEndpointResourceProperties_EndpointType Optional |
| members | List of flexible servers that one of the virtual endpoints can refer to. | string[] Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | FlexibleServersVirtualEndpointOperatorSpec 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 |
FlexibleServersVirtualEndpoint_STATUS
Used by: FlexibleServersVirtualEndpoint.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| endpointType | Type of endpoint for the virtual endpoints. | VirtualEndpointResourceProperties_EndpointType_STATUS Optional |
| id | Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” | string Optional |
| members | List of flexible servers that one of the virtual endpoints can refer to. | 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 |
| virtualEndpoints | List of virtual endpoints for a flexible server. | string[] Optional |
AuthConfig
Authentication configuration properties of a flexible server.
Used by: FlexibleServer_Spec.
| Property | Description | Type |
|---|---|---|
| activeDirectoryAuth | Indicates if the server supports Microsoft Entra authentication. | AuthConfig_ActiveDirectoryAuth Optional |
| passwordAuth | Indicates if the server supports password based authentication. | AuthConfig_PasswordAuth Optional |
| tenantId | Identifier of the tenant of the delegated resource. | string Optional |
AuthConfig_STATUS
Authentication configuration properties of a flexible server.
Used by: FlexibleServer_STATUS.
| Property | Description | Type |
|---|---|---|
| activeDirectoryAuth | Indicates if the server supports Microsoft Entra authentication. | AuthConfig_ActiveDirectoryAuth_STATUS Optional |
| passwordAuth | Indicates if the server supports password based authentication. | AuthConfig_PasswordAuth_STATUS Optional |
| tenantId | Identifier of the tenant of the delegated resource. | string Optional |
Backup
Backup properties of a flexible server.
Used by: FlexibleServer_Spec.
| Property | Description | Type |
|---|---|---|
| backupRetentionDays | Backup retention days for the flexible server. | int Optional |
| geoRedundantBackup | Indicates if the server is configured to create geographically redundant backups. | Backup_GeoRedundantBackup Optional |
Backup_STATUS
Backup properties of a flexible server.
Used by: FlexibleServer_STATUS.
| Property | Description | Type |
|---|---|---|
| backupRetentionDays | Backup retention days for the flexible server. | int Optional |
| earliestRestoreDate | Earliest restore point time (ISO8601 format) for a flexible server. | string Optional |
| geoRedundantBackup | Indicates if the server is configured to create geographically redundant backups. | Backup_GeoRedundantBackup_STATUS Optional |
ConfigurationProperties_DataType_STATUS
Used by: FlexibleServersConfiguration_STATUS.
| Value | Description |
|---|---|
| “Boolean” | |
| “Enumeration” | |
| “Integer” | |
| “Numeric” |
DataEncryption
Data encryption properties of a flexible server.
Used by: FlexibleServer_Spec.
| Property | Description | Type |
|---|---|---|
| geoBackupEncryptionKeyStatus | Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. | DataEncryption_GeoBackupEncryptionKeyStatus Optional |
| geoBackupKeyURI | Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups. | string Optional |
| geoBackupKeyURIFromConfig | Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups. | genruntime.ConfigMapReference Optional |
| geoBackupUserAssignedIdentityReference | Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups. | genruntime.ResourceReference Optional |
| primaryEncryptionKeyStatus | Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. | DataEncryption_PrimaryEncryptionKeyStatus Optional |
| primaryKeyURI | URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible server. | string Optional |
| primaryKeyURIFromConfig | URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible server. | genruntime.ConfigMapReference Optional |
| primaryUserAssignedIdentityReference | Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a flexible server. | genruntime.ResourceReference Optional |
| type | Data encryption type used by a flexible server. | DataEncryption_Type Optional |
DataEncryption_STATUS
Data encryption properties of a flexible server.
Used by: FlexibleServer_STATUS.
| Property | Description | Type |
|---|---|---|
| geoBackupEncryptionKeyStatus | Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. | DataEncryption_GeoBackupEncryptionKeyStatus_STATUS Optional |
| geoBackupKeyURI | Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups. | string Optional |
| geoBackupUserAssignedIdentityId | Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups. | string Optional |
| primaryEncryptionKeyStatus | Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. | DataEncryption_PrimaryEncryptionKeyStatus_STATUS Optional |
| primaryKeyURI | URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible server. | string Optional |
| primaryUserAssignedIdentityId | Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a flexible server. | string Optional |
| type | Data encryption type used by a flexible server. | 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 |
FlexibleServersAdvancedThreatProtectionSettingsOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: FlexibleServersAdvancedThreatProtectionSettings_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 |
FlexibleServersBackupOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: FlexibleServersBackup_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 |
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 |
FlexibleServersVirtualEndpointOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: FlexibleServersVirtualEndpoint_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 flexible server.
Used by: FlexibleServer_Spec.
| Property | Description | Type |
|---|---|---|
| mode | High availability mode for a flexible server. | HighAvailability_Mode Optional |
| standbyAvailabilityZone | Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant. | string Optional |
HighAvailability_STATUS
High availability properties of a flexible server.
Used by: FlexibleServer_STATUS.
| Property | Description | Type |
|---|---|---|
| mode | High availability mode for a flexible server. | HighAvailability_Mode_STATUS Optional |
| standbyAvailabilityZone | Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant. | string Optional |
| state | Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. | HighAvailability_State_STATUS Optional |
MaintenanceWindow
Maintenance window properties of a flexible server.
Used by: FlexibleServer_Spec.
| Property | Description | Type |
|---|---|---|
| customWindow | Indicates whether custom window is enabled or disabled. | string Optional |
| dayOfWeek | Day of the week to be used for maintenance window. | int Optional |
| startHour | Start hour to be used for maintenance window. | int Optional |
| startMinute | Start minute to be used for maintenance window. | int Optional |
MaintenanceWindow_STATUS
Maintenance window properties of a flexible server.
Used by: FlexibleServer_STATUS.
| Property | Description | Type |
|---|---|---|
| customWindow | Indicates whether custom window is enabled or disabled. | string Optional |
| dayOfWeek | Day of the week to be used for maintenance window. | int Optional |
| startHour | Start hour to be used for maintenance window. | int Optional |
| startMinute | Start minute to be used for maintenance window. | int Optional |
Network
Network properties of a flexible server.
Used by: FlexibleServer_Spec.
| Property | Description | Type |
|---|---|---|
| delegatedSubnetResourceReference | Resource identifier of the delegated subnet. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. | genruntime.ResourceReference Optional |
| privateDnsZoneArmResourceReference | Identifier of the private DNS zone. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. | genruntime.ResourceReference Optional |
| publicNetworkAccess | Indicates if public network access is enabled or not. | Network_PublicNetworkAccess Optional |
Network_STATUS
Network properties of a flexible server.
Used by: FlexibleServer_STATUS.
| Property | Description | Type |
|---|---|---|
| delegatedSubnetResourceId | Resource identifier of the delegated subnet. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. | string Optional |
| privateDnsZoneArmResourceId | Identifier of the private DNS zone. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. | string Optional |
| publicNetworkAccess | Indicates if 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 flexible server.
Used by: FlexibleServer_Spec.
| Property | Description | Type |
|---|---|---|
| promoteMode | Type of operation to apply on the read replica. This property is write only. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server. | Replica_PromoteMode Optional |
| promoteOption | Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation. | Replica_PromoteOption Optional |
| role | Role of the server in a replication set. | ReplicationRole Optional |
Replica_STATUS
Replica properties of a flexible server.
Used by: FlexibleServer_STATUS.
| Property | Description | Type |
|---|---|---|
| capacity | Maximum number of read replicas allowed for a flexible server. | int Optional |
| promoteMode | Type of operation to apply on the read replica. This property is write only. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server. | Replica_PromoteMode_STATUS Optional |
| promoteOption | Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation. | Replica_PromoteOption_STATUS Optional |
| replicationState | Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating | Replica_ReplicationState_STATUS Optional |
| role | Role of the server in a replication set. | ReplicationRole_STATUS Optional |
ReplicationRole
Role of the flexible server in a replication set.
Used by: FlexibleServer_Spec, and Replica.
| Value | Description |
|---|---|
| “AsyncReplica” | |
| “GeoAsyncReplica” | |
| “None” | |
| “Primary” |
ReplicationRole_STATUS
Role of the flexible server in a replication set.
Used by: FlexibleServer_STATUS, and Replica_STATUS.
| Value | Description |
|---|---|
| “AsyncReplica” | |
| “GeoAsyncReplica” | |
| “None” | |
| “Primary” |
ServerBackupProperties_BackupType_STATUS
Used by: FlexibleServersBackup_STATUS.
| Value | Description |
|---|---|
| “Customer On-Demand” | |
| “Full” |
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” |
ServerThreatProtectionProperties_State
Used by: FlexibleServersAdvancedThreatProtectionSettings_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
ServerThreatProtectionProperties_State_STATUS
Used by: FlexibleServersAdvancedThreatProtectionSettings_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
ServerVersion
Major version of PostgreSQL database engine.
Used by: FlexibleServer_Spec.
| Value | Description |
|---|---|
| “11” | |
| “12” | |
| “13” | |
| “14” | |
| “15” | |
| “16” |
ServerVersion_STATUS
Major version of PostgreSQL database engine.
Used by: FlexibleServer_STATUS.
| Value | Description |
|---|---|
| “11” | |
| “12” | |
| “13” | |
| “14” | |
| “15” | |
| “16” |
Sku
Compute information of a flexible server.
Used by: FlexibleServer_Spec.
| Property | Description | Type |
|---|---|---|
| name | Name by which is known a given compute size assigned to a flexible server. | string Required |
| tier | Tier of the compute assigned to a flexible server. | Sku_Tier Required |
Sku_STATUS
Compute information of a flexible server.
Used by: FlexibleServer_STATUS.
| Property | Description | Type |
|---|---|---|
| name | Name by which is known a given compute size assigned to a flexible server. | string Optional |
| tier | Tier of the compute assigned to a flexible server. | Sku_Tier_STATUS Optional |
Storage
Storage properties of a flexible server.
Used by: FlexibleServer_Spec.
| Property | Description | Type |
|---|---|---|
| autoGrow | Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size. | Storage_AutoGrow Optional |
| iops | Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS. | int Optional |
| storageSizeGB | Size of storage assigned to a flexible server. | int Optional |
| throughput | Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS. | int Optional |
| tier | Storage tier of a flexible server. | Storage_Tier Optional |
| type | Type of storage assigned to a flexible server. Allowed values are Premium_LRS or PremiumV2_LRS. If not specified, it defaults to Premium_LRS. | Storage_Type Optional |
Storage_STATUS
Storage properties of a flexible server.
Used by: FlexibleServer_STATUS.
| Property | Description | Type |
|---|---|---|
| autoGrow | Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size. | Storage_AutoGrow_STATUS Optional |
| iops | Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS. | int Optional |
| storageSizeGB | Size of storage assigned to a flexible server. | int Optional |
| throughput | Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS. | int Optional |
| tier | Storage tier of a flexible server. | Storage_Tier_STATUS Optional |
| type | Type of storage assigned to a flexible server. Allowed values are Premium_LRS or PremiumV2_LRS. If not specified, it defaults to Premium_LRS. | Storage_Type_STATUS Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: FlexibleServer_STATUS, FlexibleServersAdvancedThreatProtectionSettings_STATUS, FlexibleServersBackup_STATUS, FlexibleServersConfiguration_STATUS, FlexibleServersDatabase_STATUS, FlexibleServersFirewallRule_STATUS, and FlexibleServersVirtualEndpoint_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
Identities associated with a flexible server.
Used by: FlexibleServer_Spec.
| Property | Description | Type |
|---|---|---|
| principalId | Identifier of the object of the service principal associated to the user assigned managed identity. | string Optional |
| type | Types of identities associated with a flexible server. | UserAssignedIdentity_Type Required |
| userAssignedIdentities | Map of user assigned managed identities. | UserAssignedIdentityDetails[] Optional |
UserAssignedIdentity_STATUS
Identities associated with a flexible server.
Used by: FlexibleServer_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | Identifier of the object of the service principal associated to the user assigned managed identity. | string Optional |
| tenantId | Identifier of the tenant of a flexible server. | string Optional |
| type | Types of identities associated with a flexible server. | UserAssignedIdentity_Type_STATUS Optional |
| userAssignedIdentities | Map of user assigned managed identities. | map[string]UserIdentity_STATUS Optional |
VirtualEndpointResourceProperties_EndpointType
Used by: FlexibleServersVirtualEndpoint_Spec.
| Value | Description |
|---|---|
| “ReadWrite” |
VirtualEndpointResourceProperties_EndpointType_STATUS
Used by: FlexibleServersVirtualEndpoint_STATUS.
| Value | Description |
|---|---|
| “ReadWrite” |
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” | |
| “SystemAssigned” | |
| “SystemAssigned,UserAssigned” | |
| “UserAssigned” |
UserAssignedIdentity_Type_STATUS
Used by: UserAssignedIdentity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned,UserAssigned” | |
| “UserAssigned” |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: UserAssignedIdentity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
UserIdentity_STATUS
User assigned managed identity associated with a flexible server.
Used by: UserAssignedIdentity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | Identifier of the client of the service principal associated to the user assigned managed identity. | string Optional |
| principalId | Identifier of the object of the service principal associated to the user assigned managed identity. | string Optional |