次の方法で共有


Configurations - List By Server

クラスター内のサーバーのすべての構成を一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/servers/{serverName}/configurations?api-version=2023-03-02-preview

URI パラメーター

名前 / 必須 説明
clusterName
path True

string

クラスターの名前です。

正規表現パターン: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$

resourceGroupName
path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

serverName
path True

string

サーバーの名前。

正規表現パターン: ^[-\w\._]+$

subscriptionId
path True

string

uuid

ターゲット サブスクリプションの ID。 値は UUID である必要があります。

api-version
query True

string

この操作に使用する API バージョン。

応答

名前 説明
200 OK

ServerConfigurationListResult

OK

Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

List configurations of the server that in the cluster

要求のサンプル

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster/servers/testserver/configurations?api-version=2023-03-02-preview

応答のサンプル

{
  "value": [
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster/servers/testserver/configurations/application_name",
      "name": "application_name",
      "type": "Microsoft.DBforPostgreSQL/serverGroupsv2/servers/configurations",
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-01-01T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
      },
      "properties": {
        "value": "",
        "description": "Sets the application name to be reported in statistics and logs.",
        "defaultValue": "",
        "dataType": "String",
        "allowedValues": "[A-Za-z0-9._-]*",
        "source": "system-default",
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster/servers/testserver/configurations/array_nulls",
      "name": "array_nulls",
      "type": "Microsoft.DBforPostgreSQL/serverGroupsv2/servers/configurations",
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-01-01T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
      },
      "properties": {
        "value": "on",
        "description": "Enables input of NULL elements in arrays.",
        "defaultValue": "on",
        "dataType": "Boolean",
        "allowedValues": "on,off",
        "source": "system-default",
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster/servers/testserver/configurations/autovacuum",
      "name": "autovacuum",
      "type": "Microsoft.DBforPostgreSQL/serverGroupsv2/servers/configurations",
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-01-01T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
      },
      "properties": {
        "value": "on",
        "description": "Starts the autovacuum subprocess.",
        "defaultValue": "on",
        "dataType": "Boolean",
        "allowedValues": "on,off",
        "source": "system-default",
        "provisioningState": "Succeeded"
      }
    }
  ]
}

定義

名前 説明
ConfigurationDataType

構成のデータ型。

createdByType

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

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

ProvisioningState

現在のプロビジョニング状態。

ServerConfiguration

構成を表します。

ServerConfigurationListResult

サーバー構成の一覧。

systemData

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

ConfigurationDataType

構成のデータ型。

名前 説明
Boolean

string

Enumeration

string

Integer

string

Numeric

string

createdByType

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

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。

ProvisioningState

現在のプロビジョニング状態。

名前 説明
Canceled

string

Failed

string

InProgress

string

Succeeded

string

ServerConfiguration

構成を表します。

名前 説明
id

string

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

リソースの名前

properties.allowedValues

string

構成で使用できる値。

properties.dataType

ConfigurationDataType

構成のデータ型。

properties.defaultValue

string

構成の既定値。

properties.description

string

構成の説明。

properties.provisioningState

ProvisioningState

構成のプロビジョニング状態。

properties.requiresRestart

boolean

構成の変更で再起動が必要な場合。

properties.source

string

構成のソース。

properties.value

string

構成の値。

systemData

systemData

createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。

type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ServerConfigurationListResult

サーバー構成の一覧。

名前 説明
nextLink

string

結果の次のページを取得するためのリンク。

value

ServerConfiguration[]

サーバー構成の一覧。

systemData

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

名前 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。

createdBy

string

リソースを作成した ID。

createdByType

createdByType

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

lastModifiedAt

string

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy

string

リソースを最後に変更した ID。

lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。