dbforpostgresql.azure.com/v1beta20210601
dbforpostgresql.azure.com/v1beta20210601
Package v1beta20210601 contains API Schema definitions for the dbforpostgresql v1beta20210601 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2021-06-01" |
Backup
(Appears on:FlexibleServers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/Backup
Field | Description |
---|---|
backupRetentionDays int |
BackupRetentionDays: Backup retention days for the server. |
geoRedundantBackup BackupGeoRedundantBackup |
GeoRedundantBackup: A value indicating whether Geo-Redundant backup is enabled on the server. |
BackupARM
(Appears on:ServerPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/Backup
Field | Description |
---|---|
backupRetentionDays int |
BackupRetentionDays: Backup retention days for the server. |
geoRedundantBackup BackupGeoRedundantBackup |
GeoRedundantBackup: A value indicating whether Geo-Redundant backup is enabled on the server. |
BackupGeoRedundantBackup
(string
alias)
(Appears on:Backup, BackupARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
BackupStatusGeoRedundantBackup
(string
alias)
(Appears on:Backup_Status, Backup_StatusARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
Backup_Status
(Appears on:Server_Status)
Field | Description |
---|---|
backupRetentionDays int |
BackupRetentionDays: Backup retention days for the server. |
earliestRestoreDate string |
EarliestRestoreDate: The earliest restore point time (ISO8601 format) for server. |
geoRedundantBackup BackupStatusGeoRedundantBackup |
GeoRedundantBackup: A value indicating whether Geo-Redundant backup is enabled on the server. |
Backup_StatusARM
(Appears on:ServerProperties_StatusARM)
Field | Description |
---|---|
backupRetentionDays int |
BackupRetentionDays: Backup retention days for the server. |
earliestRestoreDate string |
EarliestRestoreDate: The earliest restore point time (ISO8601 format) for server. |
geoRedundantBackup BackupStatusGeoRedundantBackup |
GeoRedundantBackup: A value indicating whether Geo-Redundant backup is enabled on the server. |
ConfigurationPropertiesARM
(Appears on:FlexibleServersConfigurations_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/ConfigurationProperties
Field | Description |
---|---|
source string |
Source: Source of the configuration. |
value string |
Value: Value of the configuration. |
ConfigurationPropertiesStatusDataType
(string
alias)
(Appears on:ConfigurationProperties_StatusARM, Configuration_Status)
Value | Description |
---|---|
"Boolean" |
|
"Enumeration" |
|
"Integer" |
|
"Numeric" |
ConfigurationProperties_StatusARM
(Appears on:Configuration_StatusARM)
Field | Description |
---|---|
allowedValues string |
AllowedValues: Allowed values of the configuration. |
dataType ConfigurationPropertiesStatusDataType |
DataType: Data type of the configuration. |
defaultValue string |
DefaultValue: Default value of the configuration. |
description string |
Description: Description of the configuration. |
documentationLink string |
DocumentationLink: Configuration documentation link. |
isConfigPendingRestart bool |
IsConfigPendingRestart: Configuration is pending restart or not. |
isDynamicConfig bool |
IsDynamicConfig: Configuration dynamic or static. |
isReadOnly bool |
IsReadOnly: Configuration read-only or not. |
source string |
Source: Source of the configuration. |
unit string |
Unit: Configuration unit. |
value string |
Value: Value of the configuration. |
Configuration_Status
(Appears on:FlexibleServersConfiguration)
Field | Description |
---|---|
allowedValues string |
AllowedValues: Allowed values of the configuration. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
dataType ConfigurationPropertiesStatusDataType |
DataType: Data type of the configuration. |
defaultValue string |
DefaultValue: Default value of the configuration. |
description string |
Description: Description of the configuration. |
documentationLink string |
DocumentationLink: Configuration documentation link. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
isConfigPendingRestart bool |
IsConfigPendingRestart: Configuration is pending restart or not. |
isDynamicConfig bool |
IsDynamicConfig: Configuration dynamic or static. |
isReadOnly bool |
IsReadOnly: Configuration read-only or not. |
name string |
Name: The name of the resource |
source string |
Source: Source of the configuration. |
systemData SystemData_Status |
SystemData: The system metadata relating to this resource. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
unit string |
Unit: Configuration unit. |
value string |
Value: Value of the configuration. |
Configuration_StatusARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
properties ConfigurationProperties_StatusARM |
Properties: The properties of a configuration. |
systemData SystemData_StatusARM |
SystemData: The system metadata relating to this resource. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
DatabasePropertiesARM
(Appears on:FlexibleServersDatabases_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/DatabaseProperties
Field | Description |
---|---|
charset string |
Charset: The charset of the database. |
collation string |
Collation: The collation of the database. |
DatabaseProperties_StatusARM
(Appears on:Database_StatusARM)
Field | Description |
---|---|
charset string |
Charset: The charset of the database. |
collation string |
Collation: The collation of the database. |
Database_Status
(Appears on:FlexibleServersDatabase)
Field | Description |
---|---|
charset string |
Charset: The charset of the database. |
collation string |
Collation: The collation of the database. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
systemData SystemData_Status |
SystemData: The system metadata relating to this resource. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
Database_StatusARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
properties DatabaseProperties_StatusARM |
Properties: The properties of a database. |
systemData SystemData_StatusARM |
SystemData: The system metadata relating to this resource. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
FirewallRulePropertiesARM
(Appears on:FlexibleServersFirewallRules_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/FirewallRuleProperties
Field | Description |
---|---|
endIpAddress string |
EndIpAddress: The end IP address of the server firewall rule. Must be IPv4 format. |
startIpAddress string |
StartIpAddress: The start IP address of the server firewall rule. Must be IPv4 format. |
FirewallRuleProperties_StatusARM
(Appears on:FirewallRule_StatusARM)
Field | Description |
---|---|
endIpAddress string |
EndIpAddress: The end IP address of the server firewall rule. Must be IPv4 format. |
startIpAddress string |
StartIpAddress: The start IP address of the server firewall rule. Must be IPv4 format. |
FirewallRule_Status
(Appears on:FlexibleServersFirewallRule)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
endIpAddress string |
EndIpAddress: The end IP address of the server firewall rule. Must be IPv4 format. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
startIpAddress string |
StartIpAddress: The start IP address of the server firewall rule. Must be IPv4 format. |
systemData SystemData_Status |
SystemData: The system metadata relating to this resource. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
FirewallRule_StatusARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
properties FirewallRuleProperties_StatusARM |
Properties: The properties of a firewall rule. |
systemData SystemData_StatusARM |
SystemData: The system metadata relating to this resource. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
FlexibleServer
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/resourceDefinitions/flexibleServers
Field | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||
spec FlexibleServers_Spec |
|
||||||||||||||||||||||||||||||||||||
status Server_Status |
FlexibleServerOperatorSecrets
(Appears on:FlexibleServerOperatorSpec)
Field | Description |
---|---|
fullyQualifiedDomainName genruntime.SecretDestination |
FullyQualifiedDomainName: indicates where the FullyQualifiedDomainName secret should be placed. If omitted, the secret will not be retrieved from Azure. |
FlexibleServerOperatorSpec
(Appears on:FlexibleServers_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
secrets FlexibleServerOperatorSecrets |
Secrets: configures where to place Azure generated secrets. |
FlexibleServersConfiguration
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/resourceDefinitions/flexibleServers_configurations
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec FlexibleServersConfigurations_Spec |
|
||||||||||||
status Configuration_Status |
FlexibleServersConfigurations_Spec
(Appears on:FlexibleServersConfiguration)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
location string |
Location: Location to deploy resource to |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a dbforpostgresql.azure.com/FlexibleServer resource |
source string |
Source: Source of the configuration. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
value string |
Value: Value of the configuration. |
FlexibleServersConfigurations_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: The name of the server configuration. |
properties ConfigurationPropertiesARM |
Properties: The properties of a configuration. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
FlexibleServersDatabase
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/resourceDefinitions/flexibleServers_databases
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec FlexibleServersDatabases_Spec |
|
||||||||||||
status Database_Status |
FlexibleServersDatabases_Spec
(Appears on:FlexibleServersDatabase)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
charset string |
Charset: The charset of the database. |
collation string |
Collation: The collation of the database. |
location string |
Location: Location to deploy resource to |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a dbforpostgresql.azure.com/FlexibleServer resource |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
FlexibleServersDatabases_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: The name of the database. |
properties DatabasePropertiesARM |
Properties: The properties of a database. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
FlexibleServersFirewallRule
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/resourceDefinitions/flexibleServers_firewallRules
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec FlexibleServersFirewallRules_Spec |
|
||||||||||||
status FirewallRule_Status |
FlexibleServersFirewallRules_Spec
(Appears on:FlexibleServersFirewallRule)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
endIpAddress string |
EndIpAddress: The end IP address of the server firewall rule. Must be IPv4 format. |
location string |
Location: Location to deploy resource to |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a dbforpostgresql.azure.com/FlexibleServer resource |
startIpAddress string |
StartIpAddress: The start IP address of the server firewall rule. Must be IPv4 format. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
FlexibleServersFirewallRules_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: The name of the server firewall rule. |
properties FirewallRulePropertiesARM |
Properties: The properties of a server firewall rule. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
FlexibleServers_Spec
(Appears on:FlexibleServer)
Field | Description |
---|---|
administratorLogin string |
AdministratorLogin: The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation). |
administratorLoginPassword genruntime.SecretReference |
AdministratorLoginPassword: The administrator login password (required for server creation). |
availabilityZone string |
AvailabilityZone: availability zone information of the server. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
backup Backup |
Backup: Backup properties of a server |
createMode ServerPropertiesCreateMode |
CreateMode: The mode to create a new PostgreSQL server. |
highAvailability HighAvailability |
HighAvailability: High availability properties of a server |
location string |
Location: The geo-location where the resource lives |
maintenanceWindow MaintenanceWindow |
MaintenanceWindow: Maintenance window properties of a server. |
network Network |
Network: Network properties of a server |
operatorSpec FlexibleServerOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
pointInTimeUTC string |
PointInTimeUTC: Restore point creation time (ISO8601 format), specifying the time to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’. |
sku Sku |
Sku: Sku information related properties of a server. |
sourceServerResourceReference genruntime.ResourceReference |
SourceServerResourceReference: The source server resource ID to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’. |
storage Storage |
Storage: Storage properties of a server |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
version ServerPropertiesVersion |
Version: PostgreSQL Server version. |
FlexibleServers_SpecARM
Field | Description |
---|---|
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the server. |
properties ServerPropertiesARM |
Properties: The properties of a server. |
sku SkuARM |
Sku: Sku information related properties of a server. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
HighAvailability
(Appears on:FlexibleServers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/HighAvailability
Field | Description |
---|---|
mode HighAvailabilityMode |
Mode: The HA mode for the server. |
standbyAvailabilityZone string |
StandbyAvailabilityZone: availability zone information of the standby. |
HighAvailabilityARM
(Appears on:ServerPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/HighAvailability
Field | Description |
---|---|
mode HighAvailabilityMode |
Mode: The HA mode for the server. |
standbyAvailabilityZone string |
StandbyAvailabilityZone: availability zone information of the standby. |
HighAvailabilityMode
(string
alias)
(Appears on:HighAvailability, HighAvailabilityARM)
Value | Description |
---|---|
"Disabled" |
|
"ZoneRedundant" |
HighAvailabilityStatusMode
(string
alias)
(Appears on:HighAvailability_Status, HighAvailability_StatusARM)
Value | Description |
---|---|
"Disabled" |
|
"ZoneRedundant" |
HighAvailabilityStatusState
(string
alias)
(Appears on:HighAvailability_Status, HighAvailability_StatusARM)
Value | Description |
---|---|
"CreatingStandby" |
|
"FailingOver" |
|
"Healthy" |
|
"NotEnabled" |
|
"RemovingStandby" |
|
"ReplicatingData" |
HighAvailability_Status
(Appears on:Server_Status)
Field | Description |
---|---|
mode HighAvailabilityStatusMode |
Mode: The HA mode for the server. |
standbyAvailabilityZone string |
StandbyAvailabilityZone: availability zone information of the standby. |
state HighAvailabilityStatusState |
State: A state of a HA server that is visible to user. |
HighAvailability_StatusARM
(Appears on:ServerProperties_StatusARM)
Field | Description |
---|---|
mode HighAvailabilityStatusMode |
Mode: The HA mode for the server. |
standbyAvailabilityZone string |
StandbyAvailabilityZone: availability zone information of the standby. |
state HighAvailabilityStatusState |
State: A state of a HA server that is visible to user. |
MaintenanceWindow
(Appears on:FlexibleServers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/MaintenanceWindow
Field | Description |
---|---|
customWindow string |
CustomWindow: indicates whether custom window is enabled or disabled |
dayOfWeek int |
DayOfWeek: day of week for maintenance window |
startHour int |
StartHour: start hour for maintenance window |
startMinute int |
StartMinute: start minute for maintenance window |
MaintenanceWindowARM
(Appears on:ServerPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/MaintenanceWindow
Field | Description |
---|---|
customWindow string |
CustomWindow: indicates whether custom window is enabled or disabled |
dayOfWeek int |
DayOfWeek: day of week for maintenance window |
startHour int |
StartHour: start hour for maintenance window |
startMinute int |
StartMinute: start minute for maintenance window |
MaintenanceWindow_Status
(Appears on:Server_Status)
Field | Description |
---|---|
customWindow string |
CustomWindow: indicates whether custom window is enabled or disabled |
dayOfWeek int |
DayOfWeek: day of week for maintenance window |
startHour int |
StartHour: start hour for maintenance window |
startMinute int |
StartMinute: start minute for maintenance window |
MaintenanceWindow_StatusARM
(Appears on:ServerProperties_StatusARM)
Field | Description |
---|---|
customWindow string |
CustomWindow: indicates whether custom window is enabled or disabled |
dayOfWeek int |
DayOfWeek: day of week for maintenance window |
startHour int |
StartHour: start hour for maintenance window |
startMinute int |
StartMinute: start minute for maintenance window |
Network
(Appears on:FlexibleServers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/Network
Field | Description |
---|---|
delegatedSubnetResourceReference genruntime.ResourceReference |
DelegatedSubnetResourceReference: delegated subnet arm resource id. |
privateDnsZoneArmResourceReference genruntime.ResourceReference |
PrivateDnsZoneArmResourceReference: private dns zone arm resource id. |
NetworkARM
(Appears on:ServerPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/Network
Field | Description |
---|---|
delegatedSubnetResourceId string |
|
privateDnsZoneArmResourceId string |
NetworkStatusPublicNetworkAccess
(string
alias)
(Appears on:Network_Status, Network_StatusARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
Network_Status
(Appears on:Server_Status)
Field | Description |
---|---|
delegatedSubnetResourceId string |
DelegatedSubnetResourceId: delegated subnet arm resource id. |
privateDnsZoneArmResourceId string |
PrivateDnsZoneArmResourceId: private dns zone arm resource id. |
publicNetworkAccess NetworkStatusPublicNetworkAccess |
PublicNetworkAccess: public network access is enabled or not |
Network_StatusARM
(Appears on:ServerProperties_StatusARM)
Field | Description |
---|---|
delegatedSubnetResourceId string |
DelegatedSubnetResourceId: delegated subnet arm resource id. |
privateDnsZoneArmResourceId string |
PrivateDnsZoneArmResourceId: private dns zone arm resource id. |
publicNetworkAccess NetworkStatusPublicNetworkAccess |
PublicNetworkAccess: public network access is enabled or not |
ServerPropertiesARM
(Appears on:FlexibleServers_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/ServerProperties
Field | Description |
---|---|
administratorLogin string |
AdministratorLogin: The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation). |
administratorLoginPassword string |
AdministratorLoginPassword: The administrator login password (required for server creation). |
availabilityZone string |
AvailabilityZone: availability zone information of the server. |
backup BackupARM |
Backup: Backup properties of a server |
createMode ServerPropertiesCreateMode |
CreateMode: The mode to create a new PostgreSQL server. |
highAvailability HighAvailabilityARM |
HighAvailability: High availability properties of a server |
maintenanceWindow MaintenanceWindowARM |
MaintenanceWindow: Maintenance window properties of a server. |
network NetworkARM |
Network: Network properties of a server |
pointInTimeUTC string |
PointInTimeUTC: Restore point creation time (ISO8601 format), specifying the time to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’. |
sourceServerResourceId string |
|
storage StorageARM |
Storage: Storage properties of a server |
version ServerPropertiesVersion |
Version: PostgreSQL Server version. |
ServerPropertiesCreateMode
(string
alias)
(Appears on:FlexibleServers_Spec, ServerPropertiesARM)
Value | Description |
---|---|
"Create" |
|
"Default" |
|
"PointInTimeRestore" |
|
"Update" |
ServerPropertiesStatusCreateMode
(string
alias)
(Appears on:ServerProperties_StatusARM, Server_Status)
Value | Description |
---|---|
"Create" |
|
"Default" |
|
"PointInTimeRestore" |
|
"Update" |
ServerPropertiesStatusState
(string
alias)
(Appears on:ServerProperties_StatusARM, Server_Status)
Value | Description |
---|---|
"Disabled" |
|
"Dropping" |
|
"Ready" |
|
"Starting" |
|
"Stopped" |
|
"Stopping" |
|
"Updating" |
ServerPropertiesVersion
(string
alias)
(Appears on:FlexibleServers_Spec, ServerPropertiesARM)
Value | Description |
---|---|
"11" |
|
"12" |
|
"13" |
ServerProperties_StatusARM
(Appears on:Server_StatusARM)
Field | Description |
---|---|
administratorLogin string |
AdministratorLogin: The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation). |
availabilityZone string |
AvailabilityZone: availability zone information of the server. |
backup Backup_StatusARM |
Backup: Backup properties of a server. |
createMode ServerPropertiesStatusCreateMode |
CreateMode: The mode to create a new PostgreSQL server. |
fullyQualifiedDomainName string |
FullyQualifiedDomainName: The fully qualified domain name of a server. |
highAvailability HighAvailability_StatusARM |
HighAvailability: High availability properties of a server. |
maintenanceWindow MaintenanceWindow_StatusARM |
MaintenanceWindow: Maintenance window properties of a server. |
minorVersion string |
MinorVersion: The minor version of the server. |
network Network_StatusARM |
Network: Network properties of a server. |
pointInTimeUTC string |
PointInTimeUTC: Restore point creation time (ISO8601 format), specifying the time to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’. |
sourceServerResourceId string |
SourceServerResourceId: The source server resource ID to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’. |
state ServerPropertiesStatusState |
State: A state of a server that is visible to user. |
storage Storage_StatusARM |
Storage: Storage properties of a server. |
version ServerVersion_Status |
Version: PostgreSQL Server version. |
ServerVersion_Status
(string
alias)
(Appears on:ServerProperties_StatusARM, Server_Status)
Value | Description |
---|---|
"11" |
|
"12" |
|
"13" |
Server_Status
(Appears on:FlexibleServer)
Field | Description |
---|---|
administratorLogin string |
AdministratorLogin: The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation). |
availabilityZone string |
AvailabilityZone: availability zone information of the server. |
backup Backup_Status |
Backup: Backup properties of a server. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
createMode ServerPropertiesStatusCreateMode |
CreateMode: The mode to create a new PostgreSQL server. |
fullyQualifiedDomainName string |
FullyQualifiedDomainName: The fully qualified domain name of a server. |
highAvailability HighAvailability_Status |
HighAvailability: High availability properties of a server. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
location string |
Location: The geo-location where the resource lives |
maintenanceWindow MaintenanceWindow_Status |
MaintenanceWindow: Maintenance window properties of a server. |
minorVersion string |
MinorVersion: The minor version of the server. |
name string |
Name: The name of the resource |
network Network_Status |
Network: Network properties of a server. |
pointInTimeUTC string |
PointInTimeUTC: Restore point creation time (ISO8601 format), specifying the time to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’. |
sku Sku_Status |
Sku: The SKU (pricing tier) of the server. |
sourceServerResourceId string |
SourceServerResourceId: The source server resource ID to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’. |
state ServerPropertiesStatusState |
State: A state of a server that is visible to user. |
storage Storage_Status |
Storage: Storage properties of a server. |
systemData SystemData_Status |
SystemData: The system metadata relating to this resource. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
version ServerVersion_Status |
Version: PostgreSQL Server version. |
Server_StatusARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the resource |
properties ServerProperties_StatusARM |
Properties: Properties of the server. |
sku Sku_StatusARM |
Sku: The SKU (pricing tier) of the server. |
systemData SystemData_StatusARM |
SystemData: The system metadata relating to this resource. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
Sku
(Appears on:FlexibleServers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/Sku
Field | Description |
---|---|
name string |
Name: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. |
tier SkuTier |
Tier: The tier of the particular SKU, e.g. Burstable. |
SkuARM
(Appears on:FlexibleServers_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/Sku
Field | Description |
---|---|
name string |
Name: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. |
tier SkuTier |
Tier: The tier of the particular SKU, e.g. Burstable. |
SkuStatusTier
(string
alias)
(Appears on:Sku_Status, Sku_StatusARM)
Value | Description |
---|---|
"Burstable" |
|
"GeneralPurpose" |
|
"MemoryOptimized" |
SkuTier
(string
alias)
Value | Description |
---|---|
"Burstable" |
|
"GeneralPurpose" |
|
"MemoryOptimized" |
Sku_Status
(Appears on:Server_Status)
Field | Description |
---|---|
name string |
Name: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. |
tier SkuStatusTier |
Tier: The tier of the particular SKU, e.g. Burstable. |
Sku_StatusARM
(Appears on:Server_StatusARM)
Field | Description |
---|---|
name string |
Name: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. |
tier SkuStatusTier |
Tier: The tier of the particular SKU, e.g. Burstable. |
Storage
(Appears on:FlexibleServers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/Storage
Field | Description |
---|---|
storageSizeGB int |
StorageSizeGB: Max storage allowed for a server. |
StorageARM
(Appears on:ServerPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.DBforPostgreSQL.json#/definitions/Storage
Field | Description |
---|---|
storageSizeGB int |
StorageSizeGB: Max storage allowed for a server. |
Storage_Status
(Appears on:Server_Status)
Field | Description |
---|---|
storageSizeGB int |
StorageSizeGB: Max storage allowed for a server. |
Storage_StatusARM
(Appears on:ServerProperties_StatusARM)
Field | Description |
---|---|
storageSizeGB int |
StorageSizeGB: Max storage allowed for a server. |
SystemDataStatusCreatedByType
(string
alias)
(Appears on:SystemData_Status, SystemData_StatusARM)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemDataStatusLastModifiedByType
(string
alias)
(Appears on:SystemData_Status, SystemData_StatusARM)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_Status
(Appears on:Configuration_Status, Database_Status, FirewallRule_Status, Server_Status)
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemDataStatusCreatedByType |
CreatedByType: The type of identity that created the resource. |
lastModifiedAt string |
LastModifiedAt: The timestamp of resource last modification (UTC) |
lastModifiedBy string |
LastModifiedBy: The identity that last modified the resource. |
lastModifiedByType SystemDataStatusLastModifiedByType |
LastModifiedByType: The type of identity that last modified the resource. |
SystemData_StatusARM
(Appears on:Configuration_StatusARM, Database_StatusARM, FirewallRule_StatusARM, Server_StatusARM)
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemDataStatusCreatedByType |
CreatedByType: The type of identity that created the resource. |
lastModifiedAt string |
LastModifiedAt: The timestamp of resource last modification (UTC) |
lastModifiedBy string |
LastModifiedBy: The identity that last modified the resource. |
lastModifiedByType SystemDataStatusLastModifiedByType |
LastModifiedByType: The type of identity that last modified the resource. |