Configurations - Put

Service:

PostgreSQL

API Version:

2024-08-01

Updates, using Put verb, the value assigned to a specific modifiable server parameter of a flexible server.

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

URI Parameters

Name	In	Required	Type	Description
configurationName	path	True	string minLength: 1 pattern: ^[-\w\._]+$	Name of the 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 server parameter. Required to update the value assigned to a specific modifiable server parameter.
properties.value	string	Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter.

Responses

Name	Type	Description
200 OK	Configuration	OK
201 Created	Configuration	Created
202 Accepted		Accepted Headers Location: 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 server parameter of a flexible server.

Sample request

HTTP

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

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

Sample response

Status code:

200

{
  "properties": {
    "value": "on",
    "description": "Controls the query planner's use of table constraints to optimize queries.",
    "defaultValue": "partition",
    "dataType": "Enumeration",
    "allowedValues": "partition,on,off",
    "source": "user-override",
    "isDynamicConfig": true,
    "isReadOnly": false,
    "isConfigPendingRestart": false,
    "documentationLink": "https://www.postgresql.org/docs/13/runtime-config-query.html#GUC-CONSTRAINT-EXCLUSION"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/configurations/constraint_exclusion",
  "name": "constraint_exclusion",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations"
}

Status code:

201

{
  "properties": {
    "value": "on",
    "description": "Controls the query planner's use of table constraints to optimize queries.",
    "defaultValue": "partition",
    "dataType": "Enumeration",
    "allowedValues": "partition,on,off",
    "source": "user-override",
    "isDynamicConfig": true,
    "isReadOnly": false,
    "isConfigPendingRestart": false,
    "documentationLink": "https://www.postgresql.org/docs/13/runtime-config-query.html#GUC-CONSTRAINT-EXCLUSION"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/configurations/constraint_exclusion",
  "name": "constraint_exclusion",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations"
}

Status code:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01

Definitions

Name	Description
Configuration	Server parameter.
ConfigurationDataType	Data type of the server parameter.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
systemData	Metadata pertaining to creation and last modification of the resource.

Configuration

Object

Server parameter.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.allowedValues	string	Allowed values of the server parameter.
properties.dataType	ConfigurationDataType	Data type of the server parameter.
properties.defaultValue	string	Value assigned by default to the server parameter.
properties.description	string	Description of the server parameter.
properties.documentationLink	string	Link pointing to the documentation of the server parameter.
properties.isConfigPendingRestart	boolean	Indicates if the value assigned to the server parameter is pending a server restart for the value to take effect.
properties.isDynamicConfig	boolean	Indicates if it's a dynamic (true) or static (false) server parameter. Static server parameters require a server restart after changing the value assigned to it, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to it, for the change to take effect.
properties.isReadOnly	boolean	Indicates if it's a read-only (true) or modifiable (false) server parameter.
properties.source	string	Source of the value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter.
properties.unit	string	Units in which the server parameter value is expressed.
properties.value	string	Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ConfigurationDataType

Enumeration

Data type of the server parameter.

Value	Description
Boolean
Enumeration
Integer
Numeric

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
Application
Key
ManagedIdentity
User

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.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.