dbforpostgresql.azure.com/v1api20210601

dbforpostgresql.azure.com/v1api20210601

Package v1api20210601 contains API Schema definitions for the dbforpostgresql v1api20210601 API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2021-06-01"

    Backup

    (Appears on:FlexibleServer_Spec)

    Backup properties of a server

    Field Description
    backupRetentionDays
    int

    BackupRetentionDays: Backup retention days for the server.

    geoRedundantBackup
    Backup_GeoRedundantBackup

    GeoRedundantBackup: A value indicating whether Geo-Redundant backup is enabled on the server.

    Backup_ARM

    (Appears on:ServerProperties_ARM)

    Backup properties of a server

    Field Description
    backupRetentionDays
    int

    BackupRetentionDays: Backup retention days for the server.

    geoRedundantBackup
    Backup_GeoRedundantBackup_ARM

    GeoRedundantBackup: A value indicating whether Geo-Redundant backup is enabled on the server.

    Backup_GeoRedundantBackup (string alias)

    (Appears on:Backup)

    Value Description

    "Disabled"

    "Enabled"

    Backup_GeoRedundantBackup_ARM (string alias)

    (Appears on:Backup_ARM)

    Value Description

    "Disabled"

    "Enabled"

    Backup_GeoRedundantBackup_STATUS (string alias)

    (Appears on:Backup_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    Backup_GeoRedundantBackup_STATUS_ARM (string alias)

    (Appears on:Backup_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    Backup_STATUS

    (Appears on:FlexibleServer_STATUS)

    Backup properties of a server

    Field Description
    backupRetentionDays
    int

    BackupRetentionDays: Backup retention days for the server.

    earliestRestoreDate
    string

    EarliestRestoreDate: The earliest restore point time (ISO8601 format) for server.

    geoRedundantBackup
    Backup_GeoRedundantBackup_STATUS

    GeoRedundantBackup: A value indicating whether Geo-Redundant backup is enabled on the server.

    Backup_STATUS_ARM

    (Appears on:ServerProperties_STATUS_ARM)

    Backup properties of a server

    Field Description
    backupRetentionDays
    int

    BackupRetentionDays: Backup retention days for the server.

    earliestRestoreDate
    string

    EarliestRestoreDate: The earliest restore point time (ISO8601 format) for server.

    geoRedundantBackup
    Backup_GeoRedundantBackup_STATUS_ARM

    GeoRedundantBackup: A value indicating whether Geo-Redundant backup is enabled on the server.

    ConfigurationProperties_ARM

    (Appears on:FlexibleServers_Configuration_Spec_ARM)

    The properties of a configuration.

    Field Description
    source
    string

    Source: Source of the configuration.

    value
    string

    Value: Value of the configuration.

    ConfigurationProperties_DataType_STATUS (string alias)

    (Appears on:FlexibleServers_Configuration_STATUS)

    Value Description

    "Boolean"

    "Enumeration"

    "Integer"

    "Numeric"

    ConfigurationProperties_DataType_STATUS_ARM (string alias)

    (Appears on:ConfigurationProperties_STATUS_ARM)

    Value Description

    "Boolean"

    "Enumeration"

    "Integer"

    "Numeric"

    ConfigurationProperties_STATUS_ARM

    (Appears on:FlexibleServers_Configuration_STATUS_ARM)

    The properties of a configuration.

    Field Description
    allowedValues
    string

    AllowedValues: Allowed values of the configuration.

    dataType
    ConfigurationProperties_DataType_STATUS_ARM

    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.

    DatabaseProperties_ARM

    (Appears on:FlexibleServers_Database_Spec_ARM)

    The properties of a database.

    Field Description
    charset
    string

    Charset: The charset of the database.

    collation
    string

    Collation: The collation of the database.

    DatabaseProperties_STATUS_ARM

    (Appears on:FlexibleServers_Database_STATUS_ARM)

    The properties of a database.

    Field Description
    charset
    string

    Charset: The charset of the database.

    collation
    string

    Collation: The collation of the database.

    FirewallRuleProperties_ARM

    (Appears on:FlexibleServers_FirewallRule_Spec_ARM)

    The properties of a server firewall rule.

    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_STATUS_ARM

    (Appears on:FlexibleServers_FirewallRule_STATUS_ARM)

    The properties of a server firewall rule.

    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.

    FlexibleServer

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

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


    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
    ServerProperties_CreateMode

    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: The SKU (pricing tier) of the 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: Resource tags.

    version
    ServerVersion

    Version: PostgreSQL Server version.

    status
    FlexibleServer_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:FlexibleServer_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.

    FlexibleServer_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
    ServerProperties_CreateMode_STATUS

    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}

    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
    ServerProperties_State_STATUS

    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.

    FlexibleServer_STATUS_ARM

    Field Description
    id
    string

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

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    properties
    ServerProperties_STATUS_ARM

    Properties: Properties of the server.

    sku
    Sku_STATUS_ARM

    Sku: The SKU (pricing tier) of the server.

    systemData
    SystemData_STATUS_ARM

    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”

    FlexibleServer_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
    ServerProperties_CreateMode

    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: The SKU (pricing tier) of the 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: Resource tags.

    version
    ServerVersion

    Version: PostgreSQL Server version.

    FlexibleServer_Spec_ARM

    Field Description
    location
    string

    Location: The geo-location where the resource lives

    name
    string
    properties
    ServerProperties_ARM

    Properties: Properties of the server.

    sku
    Sku_ARM

    Sku: The SKU (pricing tier) of the server.

    tags
    map[string]string

    Tags: Resource tags.

    FlexibleServersConfiguration

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

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


    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    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.

    value
    string

    Value: Value of the configuration.

    status
    FlexibleServers_Configuration_STATUS

    FlexibleServersDatabase

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

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


    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    charset
    string

    Charset: The charset of the database.

    collation
    string

    Collation: The collation of the database.

    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

    status
    FlexibleServers_Database_STATUS

    FlexibleServersFirewallRule

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

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


    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    endIpAddress
    string

    EndIpAddress: The end IP address of the server firewall rule. Must be IPv4 format.

    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.

    status
    FlexibleServers_FirewallRule_STATUS

    FlexibleServers_Configuration_STATUS

    (Appears on:FlexibleServersConfiguration)

    Field Description
    allowedValues
    string

    AllowedValues: Allowed values of the configuration.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    dataType
    ConfigurationProperties_DataType_STATUS

    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}

    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.

    FlexibleServers_Configuration_STATUS_ARM

    Field Description
    id
    string

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

    name
    string

    Name: The name of the resource

    properties
    ConfigurationProperties_STATUS_ARM

    Properties: The properties of a configuration.

    systemData
    SystemData_STATUS_ARM

    SystemData: The system metadata relating to this resource.

    type
    string

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

    FlexibleServers_Configuration_Spec

    (Appears on:FlexibleServersConfiguration)

    Field Description
    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    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.

    value
    string

    Value: Value of the configuration.

    FlexibleServers_Configuration_Spec_ARM

    Field Description
    name
    string
    properties
    ConfigurationProperties_ARM

    Properties: The properties of a configuration.

    FlexibleServers_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}

    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”

    FlexibleServers_Database_STATUS_ARM

    Field Description
    id
    string

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

    name
    string

    Name: The name of the resource

    properties
    DatabaseProperties_STATUS_ARM

    Properties: The properties of a database.

    systemData
    SystemData_STATUS_ARM

    SystemData: The system metadata relating to this resource.

    type
    string

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

    FlexibleServers_Database_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.

    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

    FlexibleServers_Database_Spec_ARM

    Field Description
    name
    string
    properties
    DatabaseProperties_ARM

    Properties: The properties of a database.

    FlexibleServers_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}

    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”

    FlexibleServers_FirewallRule_STATUS_ARM

    Field Description
    id
    string

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

    name
    string

    Name: The name of the resource

    properties
    FirewallRuleProperties_STATUS_ARM

    Properties: The properties of a firewall rule.

    systemData
    SystemData_STATUS_ARM

    SystemData: The system metadata relating to this resource.

    type
    string

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

    FlexibleServers_FirewallRule_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.

    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.

    FlexibleServers_FirewallRule_Spec_ARM

    Field Description
    name
    string
    properties
    FirewallRuleProperties_ARM

    Properties: The properties of a firewall rule.

    HighAvailability

    (Appears on:FlexibleServer_Spec)

    High availability properties of a server

    Field Description
    mode
    HighAvailability_Mode

    Mode: The HA mode for the server.

    standbyAvailabilityZone
    string

    StandbyAvailabilityZone: availability zone information of the standby.

    HighAvailability_ARM

    (Appears on:ServerProperties_ARM)

    High availability properties of a server

    Field Description
    mode
    HighAvailability_Mode_ARM

    Mode: The HA mode for the server.

    standbyAvailabilityZone
    string

    StandbyAvailabilityZone: availability zone information of the standby.

    HighAvailability_Mode (string alias)

    (Appears on:HighAvailability)

    Value Description

    "Disabled"

    "ZoneRedundant"

    HighAvailability_Mode_ARM (string alias)

    (Appears on:HighAvailability_ARM)

    Value Description

    "Disabled"

    "ZoneRedundant"

    HighAvailability_Mode_STATUS (string alias)

    (Appears on:HighAvailability_STATUS)

    Value Description

    "Disabled"

    "ZoneRedundant"

    HighAvailability_Mode_STATUS_ARM (string alias)

    (Appears on:HighAvailability_STATUS_ARM)

    Value Description

    "Disabled"

    "ZoneRedundant"

    HighAvailability_STATUS

    (Appears on:FlexibleServer_STATUS)

    High availability properties of a server

    Field Description
    mode
    HighAvailability_Mode_STATUS

    Mode: The HA mode for the server.

    standbyAvailabilityZone
    string

    StandbyAvailabilityZone: availability zone information of the standby.

    state
    HighAvailability_State_STATUS

    State: A state of a HA server that is visible to user.

    HighAvailability_STATUS_ARM

    (Appears on:ServerProperties_STATUS_ARM)

    High availability properties of a server

    Field Description
    mode
    HighAvailability_Mode_STATUS_ARM

    Mode: The HA mode for the server.

    standbyAvailabilityZone
    string

    StandbyAvailabilityZone: availability zone information of the standby.

    state
    HighAvailability_State_STATUS_ARM

    State: A state of a HA server that is visible to user.

    HighAvailability_State_STATUS (string alias)

    (Appears on:HighAvailability_STATUS)

    Value Description

    "CreatingStandby"

    "FailingOver"

    "Healthy"

    "NotEnabled"

    "RemovingStandby"

    "ReplicatingData"

    HighAvailability_State_STATUS_ARM (string alias)

    (Appears on:HighAvailability_STATUS_ARM)

    Value Description

    "CreatingStandby"

    "FailingOver"

    "Healthy"

    "NotEnabled"

    "RemovingStandby"

    "ReplicatingData"

    MaintenanceWindow

    (Appears on:FlexibleServer_Spec)

    Maintenance window properties of a server.

    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_ARM

    (Appears on:ServerProperties_ARM)

    Maintenance window properties of a server.

    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:FlexibleServer_STATUS)

    Maintenance window properties of a server.

    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_ARM

    (Appears on:ServerProperties_STATUS_ARM)

    Maintenance window properties of a server.

    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:FlexibleServer_Spec)

    Network properties of a server

    Field Description
    delegatedSubnetResourceReference
    genruntime.ResourceReference

    DelegatedSubnetResourceReference: delegated subnet arm resource id.

    privateDnsZoneArmResourceReference
    genruntime.ResourceReference

    PrivateDnsZoneArmResourceReference: private dns zone arm resource id.

    Network_ARM

    (Appears on:ServerProperties_ARM)

    Network properties of a server

    Field Description
    delegatedSubnetResourceId
    string
    privateDnsZoneArmResourceId
    string

    Network_PublicNetworkAccess_STATUS (string alias)

    (Appears on:Network_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    Network_PublicNetworkAccess_STATUS_ARM (string alias)

    (Appears on:Network_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    Network_STATUS

    (Appears on:FlexibleServer_STATUS)

    Network properties of a server

    Field Description
    delegatedSubnetResourceId
    string

    DelegatedSubnetResourceId: delegated subnet arm resource id.

    privateDnsZoneArmResourceId
    string

    PrivateDnsZoneArmResourceId: private dns zone arm resource id.

    publicNetworkAccess
    Network_PublicNetworkAccess_STATUS

    PublicNetworkAccess: public network access is enabled or not

    Network_STATUS_ARM

    (Appears on:ServerProperties_STATUS_ARM)

    Network properties of a server

    Field Description
    delegatedSubnetResourceId
    string

    DelegatedSubnetResourceId: delegated subnet arm resource id.

    privateDnsZoneArmResourceId
    string

    PrivateDnsZoneArmResourceId: private dns zone arm resource id.

    publicNetworkAccess
    Network_PublicNetworkAccess_STATUS_ARM

    PublicNetworkAccess: public network access is enabled or not

    ServerProperties_ARM

    (Appears on:FlexibleServer_Spec_ARM)

    The properties of a server.

    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
    Backup_ARM

    Backup: Backup properties of a server.

    createMode
    ServerProperties_CreateMode_ARM

    CreateMode: The mode to create a new PostgreSQL server.

    highAvailability
    HighAvailability_ARM

    HighAvailability: High availability properties of a server.

    maintenanceWindow
    MaintenanceWindow_ARM

    MaintenanceWindow: Maintenance window properties of a server.

    network
    Network_ARM

    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
    Storage_ARM

    Storage: Storage properties of a server.

    version
    ServerVersion_ARM

    Version: PostgreSQL Server version.

    ServerProperties_CreateMode (string alias)

    (Appears on:FlexibleServer_Spec)

    Value Description

    "Create"

    "Default"

    "PointInTimeRestore"

    "Update"

    ServerProperties_CreateMode_ARM (string alias)

    (Appears on:ServerProperties_ARM)

    Value Description

    "Create"

    "Default"

    "PointInTimeRestore"

    "Update"

    ServerProperties_CreateMode_STATUS (string alias)

    (Appears on:FlexibleServer_STATUS)

    Value Description

    "Create"

    "Default"

    "PointInTimeRestore"

    "Update"

    ServerProperties_CreateMode_STATUS_ARM (string alias)

    (Appears on:ServerProperties_STATUS_ARM)

    Value Description

    "Create"

    "Default"

    "PointInTimeRestore"

    "Update"

    ServerProperties_STATUS_ARM

    (Appears on:FlexibleServer_STATUS_ARM)

    The properties of a server.

    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_ARM

    Backup: Backup properties of a server.

    createMode
    ServerProperties_CreateMode_STATUS_ARM

    CreateMode: The mode to create a new PostgreSQL server.

    fullyQualifiedDomainName
    string

    FullyQualifiedDomainName: The fully qualified domain name of a server.

    highAvailability
    HighAvailability_STATUS_ARM

    HighAvailability: High availability properties of a server.

    maintenanceWindow
    MaintenanceWindow_STATUS_ARM

    MaintenanceWindow: Maintenance window properties of a server.

    minorVersion
    string

    MinorVersion: The minor version of the server.

    network
    Network_STATUS_ARM

    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
    ServerProperties_State_STATUS_ARM

    State: A state of a server that is visible to user.

    storage
    Storage_STATUS_ARM

    Storage: Storage properties of a server.

    version
    ServerVersion_STATUS_ARM

    Version: PostgreSQL Server version.

    ServerProperties_State_STATUS (string alias)

    (Appears on:FlexibleServer_STATUS)

    Value Description

    "Disabled"

    "Dropping"

    "Ready"

    "Starting"

    "Stopped"

    "Stopping"

    "Updating"

    ServerProperties_State_STATUS_ARM (string alias)

    (Appears on:ServerProperties_STATUS_ARM)

    Value Description

    "Disabled"

    "Dropping"

    "Ready"

    "Starting"

    "Stopped"

    "Stopping"

    "Updating"

    ServerVersion (string alias)

    (Appears on:FlexibleServer_Spec)

    The version of a server.

    Value Description

    "11"

    "12"

    "13"

    "14"

    ServerVersion_ARM (string alias)

    (Appears on:ServerProperties_ARM)

    The version of a server.

    Value Description

    "11"

    "12"

    "13"

    "14"

    ServerVersion_STATUS (string alias)

    (Appears on:FlexibleServer_STATUS)

    The version of a server.

    Value Description

    "11"

    "12"

    "13"

    "14"

    ServerVersion_STATUS_ARM (string alias)

    (Appears on:ServerProperties_STATUS_ARM)

    The version of a server.

    Value Description

    "11"

    "12"

    "13"

    "14"

    Sku

    (Appears on:FlexibleServer_Spec)

    Sku information related properties of a server.

    Field Description
    name
    string

    Name: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.

    tier
    Sku_Tier

    Tier: The tier of the particular SKU, e.g. Burstable.

    Sku_ARM

    (Appears on:FlexibleServer_Spec_ARM)

    Sku information related properties of a server.

    Field Description
    name
    string

    Name: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.

    tier
    Sku_Tier_ARM

    Tier: The tier of the particular SKU, e.g. Burstable.

    Sku_STATUS

    (Appears on:FlexibleServer_STATUS)

    Sku information related properties of a server.

    Field Description
    name
    string

    Name: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.

    tier
    Sku_Tier_STATUS

    Tier: The tier of the particular SKU, e.g. Burstable.

    Sku_STATUS_ARM

    (Appears on:FlexibleServer_STATUS_ARM)

    Sku information related properties of a server.

    Field Description
    name
    string

    Name: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.

    tier
    Sku_Tier_STATUS_ARM

    Tier: The tier of the particular SKU, e.g. Burstable.

    Sku_Tier (string alias)

    (Appears on:Sku)

    Value Description

    "Burstable"

    "GeneralPurpose"

    "MemoryOptimized"

    Sku_Tier_ARM (string alias)

    (Appears on:Sku_ARM)

    Value Description

    "Burstable"

    "GeneralPurpose"

    "MemoryOptimized"

    Sku_Tier_STATUS (string alias)

    (Appears on:Sku_STATUS)

    Value Description

    "Burstable"

    "GeneralPurpose"

    "MemoryOptimized"

    Sku_Tier_STATUS_ARM (string alias)

    (Appears on:Sku_STATUS_ARM)

    Value Description

    "Burstable"

    "GeneralPurpose"

    "MemoryOptimized"

    Storage

    (Appears on:FlexibleServer_Spec)

    Storage properties of a server

    Field Description
    storageSizeGB
    int

    StorageSizeGB: Max storage allowed for a server.

    Storage_ARM

    (Appears on:ServerProperties_ARM)

    Storage properties of a server

    Field Description
    storageSizeGB
    int

    StorageSizeGB: Max storage allowed for a server.

    Storage_STATUS

    (Appears on:FlexibleServer_STATUS)

    Storage properties of a server

    Field Description
    storageSizeGB
    int

    StorageSizeGB: Max storage allowed for a server.

    Storage_STATUS_ARM

    (Appears on:ServerProperties_STATUS_ARM)

    Storage properties of a server

    Field Description
    storageSizeGB
    int

    StorageSizeGB: Max storage allowed for a server.

    SystemData_CreatedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_CreatedByType_STATUS_ARM (string alias)

    (Appears on:SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS_ARM (string alias)

    (Appears on:SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_STATUS

    (Appears on:FlexibleServer_STATUS, FlexibleServers_Configuration_STATUS, FlexibleServers_Database_STATUS, FlexibleServers_FirewallRule_STATUS)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemData_CreatedByType_STATUS

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemData_LastModifiedByType_STATUS

    LastModifiedByType: The type of identity that last modified the resource.

    SystemData_STATUS_ARM

    (Appears on:FlexibleServer_STATUS_ARM, FlexibleServers_Configuration_STATUS_ARM, FlexibleServers_Database_STATUS_ARM, FlexibleServers_FirewallRule_STATUS_ARM)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemData_CreatedByType_STATUS_ARM

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemData_LastModifiedByType_STATUS_ARM

    LastModifiedByType: The type of identity that last modified the resource.