Sdílet prostřednictvím


Configurations - List By Server

Vypíše všechny konfigurace serveru v clusteru.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
clusterName
path True

string

Název clusteru.

Vzor regulárního výrazu: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$

resourceGroupName
path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serverName
path True

string

Název serveru.

Vzor regulárního výrazu: ^[-\w\._]+$

subscriptionId
path True

string

uuid

ID cílového předplatného. Hodnota musí být UUID.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Typ Description
200 OK

ServerConfigurationListResult

OK

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation Zosobněte svůj uživatelský účet.

Příklady

List configurations of the server that in the cluster

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
ConfigurationDataType

Datový typ konfigurace.

createdByType

Typ identity, která prostředek vytvořila.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě

ErrorResponse

Chybová odpověď

ProvisioningState

Aktuální stav zřizování.

ServerConfiguration

Představuje konfiguraci.

ServerConfigurationListResult

Seznam konfigurací serveru.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

ConfigurationDataType

Datový typ konfigurace.

Name Typ Description
Boolean

string

Enumeration

string

Integer

string

Numeric

string

createdByType

Typ identity, která prostředek vytvořila.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.

code

string

Kód chyby

details

ErrorDetail[]

Podrobnosti o chybě.

message

string

Chybová zpráva

target

string

Cíl chyby.

ErrorResponse

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.

ProvisioningState

Aktuální stav zřizování.

Name Typ Description
Canceled

string

Failed

string

InProgress

string

Succeeded

string

ServerConfiguration

Představuje konfiguraci.

Name Typ Description
id

string

Plně kvalifikované ID prostředku Například /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{název_poskytovatele_prostředku}/{typ_prostředku}/{název_prostředku}.

name

string

Název prostředku

properties.allowedValues

string

Povolené hodnoty konfigurace.

properties.dataType

ConfigurationDataType

Datový typ konfigurace.

properties.defaultValue

string

Výchozí hodnota konfigurace.

properties.description

string

Popis konfigurace.

properties.provisioningState

ProvisioningState

Stav zřizování konfigurace.

properties.requiresRestart

boolean

Pokud změna konfigurace vyžaduje restartování.

properties.source

string

Zdroj konfigurace.

properties.value

string

Hodnota konfigurace.

systemData

systemData

Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ServerConfigurationListResult

Seznam konfigurací serveru.

Name Typ Description
nextLink

string

Odkaz na načtení další stránky výsledků

value

ServerConfiguration[]

Seznam konfigurací serveru.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name Typ Description
createdAt

string

Časové razítko vytvoření prostředku (UTC)

createdBy

string

Identita, která vytvořila prostředek.

createdByType

createdByType

Typ identity, která prostředek vytvořila.

lastModifiedAt

string

Časové razítko poslední změny prostředku (UTC)

lastModifiedBy

string

Identita, která naposledy změnila prostředek.

lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.