Interface Server

public interface Server
An immutable client-side representation of Server.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Server.Definition
    The entirety of the Server definition.
    static interface 
    Server.DefinitionStages
    The Server definition stages.
    static interface 
    Server.Update
    The template for Server update.
    static interface 
    Server.UpdateStages
    The Server update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    administratorLogin()
    Gets the administratorLogin property: Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL.
    String
    administratorLoginPassword()
    Gets the administratorLoginPassword property: Password assigned to the administrator login.
    AuthConfig
    authConfig()
    Gets the authConfig property: Authentication configuration properties of a server.
    String
    availabilityZone()
    Gets the availabilityZone property: Availability zone of a server.
    Backup
    backup()
    Gets the backup property: Backup properties of a server.
    Cluster
    cluster()
    Gets the cluster property: Cluster properties of a server.
    CreateMode
    createMode()
    Gets the createMode property: Creation mode of a new server.
    DataEncryption
    dataEncryption()
    Gets the dataEncryption property: Data encryption properties of a server.
    String
    fullyQualifiedDomainName()
    Gets the fullyQualifiedDomainName property: Fully qualified domain name of a server.
    HighAvailability
    highAvailability()
    Gets the highAvailability property: High availability properties of a server.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    UserAssignedIdentity
    identity()
    Gets the identity property: User assigned managed identities assigned to the server.
    ServerInner
    innerModel()
    Gets the inner com.azure.resourcemanager.postgresqlflexibleserver.fluent.models.ServerInner object.
    String
    location()
    Gets the location property: The geo-location where the resource lives.
    MaintenanceWindow
    maintenanceWindow()
    Gets the maintenanceWindow property: Maintenance window properties of a server.
    String
    minorVersion()
    Gets the minorVersion property: Minor version of PostgreSQL database engine.
    String
    name()
    Gets the name property: The name of the resource.
    Network
    network()
    Gets the network property: Network properties of a server.
    OffsetDateTime
    pointInTimeUtc()
    Gets the pointInTimeUtc property: Creation time (in ISO8601 format) of the backup which you want to restore in the new server.
    List<PrivateEndpointConnection>
    privateEndpointConnections()
    Gets the privateEndpointConnections property: List of private endpoint connections associated with the specified server.
    Server
    refresh()
    Refreshes the resource to sync with Azure.
    Server
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    com.azure.core.management.Region
    region()
    Gets the region of the resource.
    String
    regionName()
    Gets the name of the resource region.
    Replica
    replica()
    Gets the replica property: Read replica properties of a server.
    Integer
    replicaCapacity()
    Gets the replicaCapacity property: Maximum number of read replicas allowed for a server.
    ReplicationRole
    replicationRole()
    Gets the replicationRole property: Role of the server in a replication set.
    String
    resourceGroupName()
    Gets the name of the resource group.
    void
    restart()
    Restarts PostgreSQL database engine in a server.
    void
    restart(RestartParameter parameters, com.azure.core.util.Context context)
    Restarts PostgreSQL database engine in a server.
    Sku
    sku()
    Gets the sku property: Compute tier and size of a server.
    String
    sourceServerResourceId()
    Gets the sourceServerResourceId property: Identifier of the server to be used as the source of the new server.
    void
    start()
    Starts a stopped server.
    void
    start(com.azure.core.util.Context context)
    Starts a stopped server.
    ServerState
    state()
    Gets the state property: Possible states of a server.
    void
    stop()
    Stops a server.
    void
    stop(com.azure.core.util.Context context)
    Stops a server.
    Storage
    storage()
    Gets the storage property: Storage properties of a server.
    com.azure.core.management.SystemData
    systemData()
    Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Map<String,String>
    tags()
    Gets the tags property: Resource tags.
    String
    type()
    Gets the type property: The type of the resource.
    Server.Update
    update()
    Begins update for the Server resource.
    PostgresMajorVersion
    version()
    Gets the version property: Major version of PostgreSQL database engine.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • sku

      Sku sku()
      Gets the sku property: Compute tier and size of a server.
      Returns:
      the sku value.

    • identity

      UserAssignedIdentity identity()
      Gets the identity property: User assigned managed identities assigned to the server.
      Returns:
      the identity value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
      Returns:
      the systemData value.

    • administratorLogin

      String administratorLogin()
      Gets the administratorLogin property: 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.
      Returns:
      the administratorLogin value.

    • administratorLoginPassword

      String administratorLoginPassword()
      Gets the administratorLoginPassword property: Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.
      Returns:
      the administratorLoginPassword value.

    • version

      PostgresMajorVersion version()
      Gets the version property: Major version of PostgreSQL database engine.
      Returns:
      the version value.

    • minorVersion

      String minorVersion()
      Gets the minorVersion property: Minor version of PostgreSQL database engine.
      Returns:
      the minorVersion value.

    • state

      ServerState state()
      Gets the state property: Possible states of a server.
      Returns:
      the state value.

    • fullyQualifiedDomainName

      String fullyQualifiedDomainName()
      Gets the fullyQualifiedDomainName property: Fully qualified domain name of a server.
      Returns:
      the fullyQualifiedDomainName value.

    • storage

      Storage storage()
      Gets the storage property: Storage properties of a server.
      Returns:
      the storage value.

    • authConfig

      AuthConfig authConfig()
      Gets the authConfig property: Authentication configuration properties of a server.
      Returns:
      the authConfig value.

    • dataEncryption

      DataEncryption dataEncryption()
      Gets the dataEncryption property: Data encryption properties of a server.
      Returns:
      the dataEncryption value.

    • backup

      Backup backup()
      Gets the backup property: Backup properties of a server.
      Returns:
      the backup value.

    • network

      Network network()
      Gets the network property: Network properties of a server. Only required if you want your server to be integrated into a virtual network provided by customer.
      Returns:
      the network value.

    • highAvailability

      HighAvailability highAvailability()
      Gets the highAvailability property: High availability properties of a server.
      Returns:
      the highAvailability value.

    • maintenanceWindow

      MaintenanceWindow maintenanceWindow()
      Gets the maintenanceWindow property: Maintenance window properties of a server.
      Returns:
      the maintenanceWindow value.

    • sourceServerResourceId

      String sourceServerResourceId()
      Gets the sourceServerResourceId property: Identifier of the server to be used as the source of the new server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target server is a read replica.
      Returns:
      the sourceServerResourceId value.

    • pointInTimeUtc

      OffsetDateTime pointInTimeUtc()
      Gets the pointInTimeUtc property: Creation time (in ISO8601 format) of the backup which you want to restore in the new server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'.
      Returns:
      the pointInTimeUtc value.

    • availabilityZone

      String availabilityZone()
      Gets the availabilityZone property: Availability zone of a server.
      Returns:
      the availabilityZone value.

    • replicationRole

      ReplicationRole replicationRole()
      Gets the replicationRole property: Role of the server in a replication set.
      Returns:
      the replicationRole value.

    • replicaCapacity

      Integer replicaCapacity()
      Gets the replicaCapacity property: Maximum number of read replicas allowed for a server.
      Returns:
      the replicaCapacity value.

    • replica

      Replica replica()
      Gets the replica property: Read replica properties of a server. Required only in case that you want to promote a server.
      Returns:
      the replica value.

    • createMode

      CreateMode createMode()
      Gets the createMode property: Creation mode of a new server.
      Returns:
      the createMode value.

    • privateEndpointConnections

      List<PrivateEndpointConnection> privateEndpointConnections()
      Gets the privateEndpointConnections property: List of private endpoint connections associated with the specified server.
      Returns:
      the privateEndpointConnections value.

    • cluster

      Cluster cluster()
      Gets the cluster property: Cluster properties of a server.
      Returns:
      the cluster value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      ServerInner innerModel()
      Gets the inner com.azure.resourcemanager.postgresqlflexibleserver.fluent.models.ServerInner object.
      Returns:
      the inner object.

    • update

      Server.Update update()
      Begins update for the Server resource.
      Returns:
      the stage of resource update.

    • refresh

      Server refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      Server refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • restart

      void restart()
      Restarts PostgreSQL database engine in a server.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • restart

      void restart(RestartParameter parameters, com.azure.core.util.Context context)
      Restarts PostgreSQL database engine in a server.
      Parameters:
      parameters - Parameters to restart a server.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • start

      void start()
      Starts a stopped server.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • start

      void start(com.azure.core.util.Context context)
      Starts a stopped server.
      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stop

      void stop()
      Stops a server.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stop

      void stop(com.azure.core.util.Context context)
      Stops a server.
      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.