Configurations - Put

サービス:: PostgreSQL

API バージョン:: 2024-08-01

Put verb を使用して、フレキシブルサーバーの特定の変更可能なサーバーパラメーターに割り当てられた値を更新します。

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

URI パラメーター

名前	/	必須	型	説明
configurationName	path	True	string minLength: 1 pattern: ^[-\w\._]+$	サーバ・パラメータの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字が区別されます。
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	サーバーの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties.source	string	サーバー・パラメーターに割り当てられた値のソース。特定の変更可能なサーバー・パラメーターに割り当てられた値を更新するために必要です。
properties.value	string	サーバー・パラメーターの値 (構成とも呼ばれます)。特定の変更可能なサーバー・パラメーターに割り当てられた値を更新するために必要です。

応答

名前	型	説明
200 OK	Configuration	[OK]
201 Created	Configuration	作成
202 Accepted		受け入れられたヘッダー Location: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Microsoft Entra OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

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

要求のサンプル

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

応答のサンプル

状態コード:: 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"
}

状態コード:: 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"
}

状態コード:: 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

定義

名前	説明
Configuration	Server パラメータ。
ConfigurationDataType	サーバ・パラメータのデータ・タイプ。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
systemData	リソースの作成と最後の変更に関連するメタデータ。

Configuration

Object

Server パラメータ。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.allowedValues	string	server パラメータの許容値。
properties.dataType	ConfigurationDataType	サーバ・パラメータのデータ・タイプ。
properties.defaultValue	string	デフォルトではサーバー・パラメータに割り当てられる値。
properties.description	string	サーバー・パラメーターの説明。
properties.documentationLink	string	server パラメータのドキュメンテーションを指すリンク。
properties.isConfigPendingRestart	boolean	server パラメーターに割り当てられた値が、値を有効にするためにサーバーの再起動を保留しているかどうかを示します。
properties.isDynamicConfig	boolean	動的 (true) サーバーパラメータか静的 (false) サーバーパラメータかを示します。静的サーバー・パラメーターは、割り当てられた値を変更した後、変更を有効にするためにサーバーを再始動する必要があります。動的サーバー・パラメーターでは、割り当てられた値を変更した後にサーバーを再始動しなくても、変更が有効になります。
properties.isReadOnly	boolean	読み取り専用 (true) または変更可能 (false) のサーバーパラメータかを示します。
properties.source	string	サーバー・パラメーターに割り当てられた値のソース。特定の変更可能なサーバー・パラメーターに割り当てられた値を更新するために必要です。
properties.unit	string	サーバー・パラメーター値を表わす単位。
properties.value	string	サーバー・パラメーターの値 (構成とも呼ばれます)。特定の変更可能なサーバー・パラメーターに割り当てられた値を更新するために必要です。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ConfigurationDataType

列挙

サーバ・パラメータのデータ・タイプ。

値	説明
Boolean
Enumeration
Integer
Numeric

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Configurations - Put

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

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

要求のサンプル

応答のサンプル

定義

Configuration

ConfigurationDataType

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

systemData