Servers - Update

Service:

PostgreSQL

API Version:

2017-12-01

Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}?api-version=2017-12-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
identity	ResourceIdentity	The Azure Active Directory identity of the server.
properties.administratorLoginPassword	string	The password of the administrator login.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Enforce a minimal Tls version for the server.
properties.publicNetworkAccess	PublicNetworkAccessEnum	Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
properties.replicationRole	string	The replication role of the server.
properties.sslEnforcement	SslEnforcementEnum	Enable ssl enforcement or not when connect to server.
properties.storageProfile	StorageProfile	Storage profile of a server.
properties.version	ServerVersion	The version of a server.
sku	Sku	The SKU (pricing tier) of the server.
tags	object	Application-specific metadata in the form of key-value pairs.

Responses

Name	Type	Description
200 OK	Server	OK
202 Accepted		Accepted
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ServerUpdate

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/pgtestsvc4?api-version=2017-12-01

{
  "properties": {
    "administratorLoginPassword": "<administratorLoginPassword>",
    "sslEnforcement": "Enabled",
    "minimalTlsVersion": "TLS1_2"
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.postgresql.models.MinimalTlsVersionEnum;
import com.azure.resourcemanager.postgresql.models.Server;
import com.azure.resourcemanager.postgresql.models.SslEnforcementEnum;

/** Samples for Servers Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerUpdate.json
     */
    /**
     * Sample code: ServerUpdate.
     *
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void serverUpdate(com.azure.resourcemanager.postgresql.PostgreSqlManager manager) {
        Server resource =
            manager.servers().getByResourceGroupWithResponse("testrg", "pgtestsvc4", Context.NONE).getValue();
        resource
            .update()
            .withAdministratorLoginPassword("<administratorLoginPassword>")
            .withSslEnforcement(SslEnforcementEnum.ENABLED)
            .withMinimalTlsVersion(MinimalTlsVersionEnum.TLS1_2)
            .apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.rdbms.postgresql import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-rdbms
# USAGE
    python server_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testrg",
        server_name="pgtestsvc4",
        parameters={
            "properties": {
                "administratorLoginPassword": "<administratorLoginPassword>",
                "minimalTlsVersion": "TLS1_2",
                "sslEnforcement": "Enabled",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armpostgresql_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/postgresql/armpostgresql"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerUpdate.json
func ExampleServersClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpostgresql.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewServersClient().BeginUpdate(ctx, "testrg", "pgtestsvc4", armpostgresql.ServerUpdateParameters{
		Properties: &armpostgresql.ServerUpdateParametersProperties{
			AdministratorLoginPassword: to.Ptr("<administratorLoginPassword>"),
			MinimalTLSVersion:          to.Ptr(armpostgresql.MinimalTLSVersionEnumTLS12),
			SSLEnforcement:             to.Ptr(armpostgresql.SSLEnforcementEnumEnabled),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Server = armpostgresql.Server{
	// 	Name: to.Ptr("pgtestsvc4"),
	// 	Type: to.Ptr("Microsoft.DBforPostgreSQL/servers"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/pgtestsvc4"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"ElasticServer": to.Ptr("1"),
	// 	},
	// 	Properties: &armpostgresql.ServerProperties{
	// 		AdministratorLogin: to.Ptr("cloudsa"),
	// 		EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-14T21:08:24.637Z"); return t}()),
	// 		FullyQualifiedDomainName: to.Ptr("pgtestsvc4.postgres.database.azure.com"),
	// 		MinimalTLSVersion: to.Ptr(armpostgresql.MinimalTLSVersionEnumTLS12),
	// 		SSLEnforcement: to.Ptr(armpostgresql.SSLEnforcementEnumEnabled),
	// 		StorageProfile: &armpostgresql.StorageProfile{
	// 			BackupRetentionDays: to.Ptr[int32](7),
	// 			GeoRedundantBackup: to.Ptr(armpostgresql.GeoRedundantBackupDisabled),
	// 			StorageMB: to.Ptr[int32](128000),
	// 		},
	// 		UserVisibleState: to.Ptr(armpostgresql.ServerStateReady),
	// 		Version: to.Ptr(armpostgresql.ServerVersionNine6),
	// 	},
	// 	SKU: &armpostgresql.SKU{
	// 		Name: to.Ptr("B_Gen4_2"),
	// 		Capacity: to.Ptr[int32](2),
	// 		Family: to.Ptr("Gen4"),
	// 		Tier: to.Ptr(armpostgresql.SKUTierBasic),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { PostgreSQLManagementClient } = require("@azure/arm-postgresql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
 *
 * @summary Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerUpdate.json
 */
async function serverUpdate() {
  const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = "testrg";
  const serverName = "pgtestsvc4";
  const parameters = {
    administratorLoginPassword: "<administratorLoginPassword>",
    minimalTlsVersion: "TLS1_2",
    sslEnforcement: "Enabled",
  };
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementClient(credential, subscriptionId);
  const result = await client.servers.beginUpdateAndWait(resourceGroupName, serverName, parameters);
  console.log(result);
}

serverUpdate().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.PostgreSql.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.PostgreSql;

// Generated from example definition: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerUpdate.json
// this example is just showing the usage of "Servers_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this PostgreSqlServerResource created on azure
// for more information of creating PostgreSqlServerResource, please refer to the document of PostgreSqlServerResource
string subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
string resourceGroupName = "testrg";
string serverName = "pgtestsvc4";
ResourceIdentifier postgreSqlServerResourceId = PostgreSqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
PostgreSqlServerResource postgreSqlServer = client.GetPostgreSqlServerResource(postgreSqlServerResourceId);

// invoke the operation
PostgreSqlServerPatch patch = new PostgreSqlServerPatch()
{
    AdministratorLoginPassword = "<administratorLoginPassword>",
    SslEnforcement = PostgreSqlSslEnforcementEnum.Enabled,
    MinimalTlsVersion = PostgreSqlMinimalTlsVersionEnum.Tls1_2,
};
ArmOperation<PostgreSqlServerResource> lro = await postgreSqlServer.UpdateAsync(WaitUntil.Completed, patch);
PostgreSqlServerResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
PostgreSqlServerData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "sku": {
    "name": "B_Gen4_2",
    "tier": "Basic",
    "family": "Gen4",
    "capacity": 2
  },
  "properties": {
    "administratorLogin": "cloudsa",
    "storageProfile": {
      "storageMB": 128000,
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled"
    },
    "version": "9.6",
    "sslEnforcement": "Enabled",
    "minimalTlsVersion": "TLS1_2",
    "userVisibleState": "Ready",
    "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
    "earliestRestoreDate": "2018-03-14T21:08:24.637+00:00"
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/pgtestsvc4",
  "name": "pgtestsvc4",
  "type": "Microsoft.DBforPostgreSQL/servers"
}

Status code:

202

Definitions

Name	Description
CloudError	An error response from the Batch service.
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponse	Error Response
GeoRedundantBackup	Enable Geo-redundant or not for server backup.
IdentityType	The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
InfrastructureEncryption	Add a second layer of encryption for your data using new encryption algorithm which gives additional data protection. Value is optional but if passed in, must be 'Disabled' or 'Enabled'.
MinimalTlsVersionEnum	Enforce a minimal Tls version for the server.
PrivateEndpointProperty
PrivateEndpointProvisioningState	State of the private endpoint connection.
PrivateLinkServiceConnectionStateActionsRequire	The actions required for private link service connection.
PrivateLinkServiceConnectionStateStatus	The private link service connection status.
PublicNetworkAccessEnum	Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
ResourceIdentity	Azure Active Directory identity configuration for a resource.
Server	Represents a server.
ServerPrivateEndpointConnection	A private endpoint connection under a server
ServerPrivateEndpointConnectionProperties	Properties of a private endpoint connection.
ServerPrivateLinkServiceConnectionStateProperty
ServerState	A state of a server that is visible to user.
ServerUpdateParameters	Parameters allowed to update for a server.
ServerVersion	The version of a server.
Sku	Billing information related properties of a server.
SkuTier	The tier of the particular SKU, e.g. Basic.
SslEnforcementEnum	Enable ssl enforcement or not when connect to server.
StorageAutogrow	Enable Storage Auto Grow.
StorageProfile	Storage Profile properties of a server

CloudError

An error response from the Batch service.

Name	Type	Description
error	ErrorResponse	Error Response Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorResponse

Error Response

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorResponse[]	The error details.
message	string	The error message.
target	string	The error target.

GeoRedundantBackup

Enable Geo-redundant or not for server backup.

Name	Type	Description
Disabled	string
Enabled	string

IdentityType

The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.

Name	Type	Description
SystemAssigned	string

InfrastructureEncryption

Add a second layer of encryption for your data using new encryption algorithm which gives additional data protection. Value is optional but if passed in, must be 'Disabled' or 'Enabled'.

Name	Type	Description
Disabled	string	Additional (2nd) layer of encryption for data at rest
Enabled	string	Default value for single layer of encryption for data at rest.

MinimalTlsVersionEnum

Enforce a minimal Tls version for the server.

Name	Type	Description
TLS1_0	string
TLS1_1	string
TLS1_2	string
TLSEnforcementDisabled	string

PrivateEndpointProperty

Name	Type	Description
id	string	Resource id of the private endpoint.

PrivateEndpointProvisioningState

State of the private endpoint connection.

Name	Type	Description
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

The actions required for private link service connection.

Name	Type	Description
None	string

PrivateLinkServiceConnectionStateStatus

The private link service connection status.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccessEnum

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

Name	Type	Description
Disabled	string
Enabled	string

ResourceIdentity

Azure Active Directory identity configuration for a resource.

Name	Type	Description
principalId	string	The Azure Active Directory principal id.
tenantId	string	The Azure Active Directory tenant id.
type	IdentityType	The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.

Server

Represents a server.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ResourceIdentity	The Azure Active Directory identity of the server.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.administratorLogin	string	The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
properties.byokEnforcement	string	Status showing whether the server data encryption is enabled with customer-managed keys.
properties.earliestRestoreDate	string	Earliest restore point creation time (ISO8601 format)
properties.fullyQualifiedDomainName	string	The fully qualified domain name of a server.
properties.infrastructureEncryption	InfrastructureEncryption	Status showing whether the server enabled infrastructure encryption.
properties.masterServerId	string	The master server id of a replica server.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Enforce a minimal Tls version for the server.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	List of private endpoint connections on a server
properties.publicNetworkAccess	PublicNetworkAccessEnum	Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
properties.replicaCapacity	integer	The maximum number of replicas that a master server can have.
properties.replicationRole	string	The replication role of the server.
properties.sslEnforcement	SslEnforcementEnum	Enable ssl enforcement or not when connect to server.
properties.storageProfile	StorageProfile	Storage profile of a server.
properties.userVisibleState	ServerState	A state of a server that is visible to user.
properties.version	ServerVersion	Server version.
sku	Sku	The SKU (pricing tier) of the server.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ServerPrivateEndpointConnection

A private endpoint connection under a server

Name	Type	Description
id	string	Resource ID of the Private Endpoint Connection.
properties	ServerPrivateEndpointConnectionProperties	Private endpoint connection properties

ServerPrivateEndpointConnectionProperties

Properties of a private endpoint connection.

Name	Type	Description
privateEndpoint	PrivateEndpointProperty	Private endpoint which the connection belongs to.
privateLinkServiceConnectionState	ServerPrivateLinkServiceConnectionStateProperty	Connection state of the private endpoint connection.
provisioningState	PrivateEndpointProvisioningState	State of the private endpoint connection.

ServerPrivateLinkServiceConnectionStateProperty

Name	Type	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	The actions required for private link service connection.
description	string	The private link service connection description.
status	PrivateLinkServiceConnectionStateStatus	The private link service connection status.

ServerState

A state of a server that is visible to user.

Name	Type	Description
Disabled	string
Dropping	string
Inaccessible	string
Ready	string

ServerUpdateParameters

Parameters allowed to update for a server.

Name	Type	Description
identity	ResourceIdentity	The Azure Active Directory identity of the server.
properties.administratorLoginPassword	string	The password of the administrator login.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Enforce a minimal Tls version for the server.
properties.publicNetworkAccess	PublicNetworkAccessEnum	Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
properties.replicationRole	string	The replication role of the server.
properties.sslEnforcement	SslEnforcementEnum	Enable ssl enforcement or not when connect to server.
properties.storageProfile	StorageProfile	Storage profile of a server.
properties.version	ServerVersion	The version of a server.
sku	Sku	The SKU (pricing tier) of the server.
tags	object	Application-specific metadata in the form of key-value pairs.

ServerVersion

The version of a server.

Name	Type	Description
10	string
10.0	string
10.2	string
11	string
9.5	string
9.6	string

Sku

Billing information related properties of a server.

Name	Type	Description
capacity	integer	The scale up/out capacity, representing server's compute units.
family	string	The family of hardware.
name	string	The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.
size	string	The size code, to be interpreted by resource as appropriate.
tier	SkuTier	The tier of the particular SKU, e.g. Basic.

SkuTier

The tier of the particular SKU, e.g. Basic.

Name	Type	Description
Basic	string
GeneralPurpose	string
MemoryOptimized	string

SslEnforcementEnum

Enable ssl enforcement or not when connect to server.

Name	Type	Description
Disabled	string
Enabled	string

StorageAutogrow

Enable Storage Auto Grow.

Name	Type	Description
Disabled	string
Enabled	string

StorageProfile

Storage Profile properties of a server

Name	Type	Description
backupRetentionDays	integer	Backup retention days for the server.
geoRedundantBackup	GeoRedundantBackup	Enable Geo-redundant or not for server backup.
storageAutogrow	StorageAutogrow	Enable Storage Auto Grow.
storageMB	integer	Max storage allowed for a server.