Configurations - Create Or Update

Updates a configuration of a server.

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

URI Parameters

Name In Required Type Description
configurationName
path True

string

The name of the server configuration.

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

string

Source of the configuration.

properties.value

string

Value of the configuration.

Responses

Name Type Description
200 OK

Configuration

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

ConfigurationCreateOrUpdate

Sample request

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/array_nulls?api-version=2017-12-01

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

Sample response

{
  "properties": {
    "value": "off",
    "description": "Enable input of NULL elements in arrays.",
    "defaultValue": "on",
    "dataType": "Boolean",
    "allowedValues": "on,off",
    "source": "user-override"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/array_nulls",
  "name": "array_nulls",
  "type": "Microsoft.DBforPostgreSQL/servers/configurations"
}

Definitions

Name Description
CloudError

An error response from the Batch service.

Configuration

Represents a Configuration.

ErrorAdditionalInfo

The resource management error additional info.

ErrorResponse

Error Response

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.)

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

string

Data type of the configuration.

properties.defaultValue

string

Default value of the configuration.

properties.description

string

Description of the configuration.

properties.source

string

Source of the configuration.

properties.value

string

Value of the configuration.

type

string

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

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.