Configurations - Update

Service:: PostgreSQL

API-versie:: 2024-08-01

Updates, met behulp van Patch-werkwoord, de waarde die is toegewezen aan een specifieke aanpasbare serverparameter van een flexibele server.

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

URI-parameters

Name	In	Vereist	Type	Description
configurationName	path	True	string minLength: 1 pattern: ^[-\w\._]+$	Naam van de serverparameter.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	De naam van de server.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
properties.source	string	Bron van de waarde die aan de serverparameter is toegewezen. Vereist om de waarde bij te werken die is toegewezen aan een specifieke aanpasbare serverparameter.
properties.value	string	Waarde van de serverparameter (ook wel configuratie genoemd). Vereist om de waarde bij te werken die is toegewezen aan een specifieke aanpasbare serverparameter.

Antwoorden

Name	Type	Description
200 OK	Configuration	OK
201 Created	Configuration	Gecreëerd
202 Accepted		Geaccepteerd Kopteksten Location: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Microsoft Entra OAuth2 Flow

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Update, using Patch verb, the value assigned to a specific modifiable server parameter of a flexible server.

Voorbeeldaanvraag

HTTP

PATCH 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"
  }
}

Voorbeeldrespons

Statuscode:: 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"
}

Statuscode:: 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"
}

Statuscode:: 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

Definities

Name	Description
Configuration	Server parameter.
ConfigurationDataType	Gegevenstype van de serverparameter.
ConfigurationForUpdate	Server parameter.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Configuration

Object

Server parameter.

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.allowedValues	string	Toegestane waarden van de serverparameter.
properties.dataType	ConfigurationDataType	Gegevenstype van de serverparameter.
properties.defaultValue	string	Waarde die standaard wordt toegewezen aan de serverparameter.
properties.description	string	Beschrijving van de serverparameter.
properties.documentationLink	string	Link die verwijst naar de documentatie van de serverparameter.
properties.isConfigPendingRestart	boolean	Geeft aan of de waarde die aan de serverparameter is toegewezen, in afwachting is van een herstart van de server voordat de waarde van kracht wordt.
properties.isDynamicConfig	boolean	Geeft aan of het een dynamische (waar) of statische (onwaar) serverparameter is. Statische serverparameters vereisen dat de server opnieuw wordt opgestart nadat de waarde is gewijzigd die eraan is toegewezen, om de wijziging door te voeren. Voor dynamische serverparameters hoeft de server niet opnieuw te worden opgestart na het wijzigen van de waarde die eraan is toegewezen, om de wijziging door te voeren.
properties.isReadOnly	boolean	Geeft aan of het een alleen-lezen (waar) of aanpasbare (onwaar) serverparameter is.
properties.source	string	Bron van de waarde die aan de serverparameter is toegewezen. Vereist om de waarde bij te werken die is toegewezen aan een specifieke aanpasbare serverparameter.
properties.unit	string	Eenheden waarin de waarde van de serverparameter wordt uitgedrukt.
properties.value	string	Waarde van de serverparameter (ook wel configuratie genoemd). Vereist om de waarde bij te werken die is toegewezen aan een specifieke aanpasbare serverparameter.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ConfigurationDataType

Inventarisatie

Gegevenstype van de serverparameter.

Waarde	Description
Boolean
Enumeration
Integer
Numeric

ConfigurationForUpdate

Object

Server parameter.

Name	Type	Description
properties.allowedValues	string	Toegestane waarden van de serverparameter.
properties.dataType	ConfigurationDataType	Gegevenstype van de serverparameter.
properties.defaultValue	string	Waarde die standaard wordt toegewezen aan de serverparameter.
properties.description	string	Beschrijving van de serverparameter.
properties.documentationLink	string	Link die verwijst naar de documentatie van de serverparameter.
properties.isConfigPendingRestart	boolean	Geeft aan of de waarde die aan de serverparameter is toegewezen, in afwachting is van een herstart van de server voordat de waarde van kracht wordt.
properties.isDynamicConfig	boolean	Geeft aan of het een dynamische (waar) of statische (onwaar) serverparameter is. Statische serverparameters vereisen dat de server opnieuw wordt opgestart nadat de waarde is gewijzigd die eraan is toegewezen, om de wijziging door te voeren. Voor dynamische serverparameters hoeft de server niet opnieuw te worden opgestart na het wijzigen van de waarde die eraan is toegewezen, om de wijziging door te voeren.
properties.isReadOnly	boolean	Geeft aan of het een alleen-lezen (waar) of aanpasbare (onwaar) serverparameter is.
properties.source	string	Bron van de waarde die aan de serverparameter is toegewezen. Vereist om de waarde bij te werken die is toegewezen aan een specifieke aanpasbare serverparameter.
properties.unit	string	Eenheden waarin de waarde van de serverparameter wordt uitgedrukt.
properties.value	string	Waarde van de serverparameter (ook wel configuratie genoemd). Vereist om de waarde bij te werken die is toegewezen aan een specifieke aanpasbare serverparameter.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Delen via

Configurations - Update

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

Update, using Patch verb, the value assigned to a specific modifiable server parameter of a flexible server.

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Configuration

ConfigurationDataType

ConfigurationForUpdate

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

systemData