Share via

Configurations - Put

Service:
PostgreSQL
API Version:
2025-08-01

Updates, using Put verb, the value assigned to a specific modifiable configuration (also known as server parameter) of a server.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}?api-version=2025-08-01

URI Parameters

Name In Required Type Description
configurationName
 path True

string

minLength: 1
maxLength: 256
pattern: ^[-\w\._]+$

Name of the configuration (also known as server parameter).
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
serverName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*

The name of the server.
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Type Description
properties.source

string

Source of the value assigned to the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.
properties.value

string

Value of the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.

Responses

Name Type Description
202 Accepted

Accepted.

Headers

  • Location: string
  • Azure-AsyncOperation: string
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Microsoft Entra 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

Update, using Put verb, the value assigned to a specific modifiable configuration (also known as server parameter) of a server.

Sample request

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/configurations/constraint_exclusion?api-version=2025-08-01

{
  "properties": {
    "value": "on",
    "source": "user-override"
  }
}

Sample response

Status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2025-06-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2025-06-01-preview

Definitions

Name Description
ConfigurationDataType

Data type of the configuration (also known as server parameter).
ConfigurationForUpdate

Configuration (also known as server parameter).
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response

ConfigurationDataType

Enumeration

Data type of the configuration (also known as server parameter).

Value Description
Boolean

A boolean value.
Numeric

A numeric value.
Integer

An integer value.
Enumeration

An enumeration value.
String

A string value.
Set

A set of values.

ConfigurationForUpdate

Object

Configuration (also known as server parameter).

Name Type Description
properties.allowedValues

string

Allowed values of the configuration (also known as server parameter).
properties.dataType

ConfigurationDataType

Data type of the configuration (also known as server parameter).
properties.defaultValue

string

Value assigned by default to the configuration (also known as server parameter).
properties.description

string

Description of the configuration (also known as server parameter).
properties.documentationLink

string

Link pointing to the documentation of the configuration (also known as server parameter).
properties.isConfigPendingRestart

boolean

Indicates if the value assigned to the configuration (also known as server parameter) is pending a server restart for it to take effect.
properties.isDynamicConfig

boolean

Indicates if it's a dynamic (true) or static (false) configuration (also known as server parameter). Static server parameters require a server restart after changing the value assigned to them, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to them, for the change to take effect.
properties.isReadOnly

boolean

Indicates if it's a read-only (true) or modifiable (false) configuration (also known as server parameter).
properties.source

string

Source of the value assigned to the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.
properties.unit

string

Units in which the configuration (also known as server parameter) value is expressed.
properties.value

string

Value of the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.