Configurations - Update

Updates a configuration of a server.

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

URI Parameters

Name In Required Type Description
configurationName
path True

string

The name of the server configuration.

Regex pattern: ^[-\w\._]+$

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

serverName
path True

string

The name of the server.

Regex pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*

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
properties.source

string

Source of the configuration. Required to update the configuration.

properties.value

string

Value of the configuration. Required to update the configuration.

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

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

Update a user configuration

Sample request

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/event_scheduler?api-version=2022-12-01

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

Sample response

{
  "properties": {
    "value": "ON",
    "description": "Indicates the status of the Event Scheduler.",
    "defaultValue": "OFF",
    "dataType": "Enumeration",
    "allowedValues": "ON,OFF,DISABLED",
    "source": "user-override"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/event_scheduler",
  "name": "event_scheduler",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations"
}
{
  "properties": {
    "value": "ON",
    "description": "Indicates the status of the Event Scheduler.",
    "defaultValue": "OFF",
    "dataType": "Enumeration",
    "allowedValues": "ON,OFF,DISABLED",
    "source": "user-override"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/event_scheduler",
  "name": "event_scheduler",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations"
}
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=2022-12-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=2022-12-01

Definitions

Name Description
Configuration

Represents a Configuration.

ConfigurationDataType

Data type of the configuration.

ConfigurationForUpdate

Represents a Configuration.

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

Represents a Configuration.

Name Type Description
id

string

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

name

string

The name of the resource

properties.allowedValues

string

Allowed values of the configuration.

properties.dataType

ConfigurationDataType

Data type of the configuration.

properties.defaultValue

string

Default value of the configuration.

properties.description

string

Description of the configuration.

properties.documentationLink

string

Configuration documentation link.

properties.isConfigPendingRestart

boolean

Configuration is pending restart or not.

properties.isDynamicConfig

boolean

Configuration dynamic or static.

properties.isReadOnly

boolean

Configuration read-only or not.

properties.source

string

Source of the configuration. Required to update the configuration.

properties.unit

string

Configuration unit.

properties.value

string

Value of the configuration. Required to update the configuration.

systemData

systemData

The system metadata relating to this resource.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ConfigurationDataType

Data type of the configuration.

Name Type Description
Boolean

string

Enumeration

string

Integer

string

Numeric

string

ConfigurationForUpdate

Represents a Configuration.

Name Type Description
properties.allowedValues

string

Allowed values of the configuration.

properties.dataType

ConfigurationDataType

Data type of the configuration.

properties.defaultValue

string

Default value of the configuration.

properties.description

string

Description of the configuration.

properties.documentationLink

string

Configuration documentation link.

properties.isConfigPendingRestart

boolean

Configuration is pending restart or not.

properties.isDynamicConfig

boolean

Configuration dynamic or static.

properties.isReadOnly

boolean

Configuration read-only or not.

properties.source

string

Source of the configuration. Required to update the configuration.

properties.unit

string

Configuration unit.

properties.value

string

Value of the configuration. Required to update the configuration.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

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

Error response

Name Type Description
error

ErrorDetail

The error object.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

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

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.