Servers - List By Resource Group

特定のリソース グループ内のすべてのサーバーを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers?api-version=2020-02-14-preview

URI パラメーター

Name In Required Type Description
resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

ターゲット サブスクリプションの ID。

api-version
query True
  • string

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

応答

Name Type Description
200 OK

OK

Other Status Codes

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

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

ServerListByResourceGroup

Sample Request

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers?api-version=2020-02-14-preview

Sample Response

{
  "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2020-02-14-privatepreview&$top=3&$skiptoken=skiptoken",
  "value": [
    {
      "sku": {
        "tier": "GeneralPurpose",
        "name": "Standard_D4s_v3"
      },
      "properties": {
        "administratorLogin": "testuser",
        "version": "12",
        "minorVersion": "6",
        "state": "Ready",
        "haState": "NotEnabled",
        "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
        "displayName": "demosingleserver",
        "publicNetworkAccess": "Enabled",
        "storageProfile": {
          "storageMB": 524288,
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled"
        },
        "haEnabled": "Enabled",
        "standbyCount": 1,
        "logBackupStorageSku": "Standard_ZRS",
        "availabilityZone": "1",
        "standbyAvailabilityZone": "2",
        "maintenanceWindow": {
          "dayOfWeek": 0,
          "startHour": 10,
          "startMinute": 30,
          "customWindow": "Enabled"
        },
        "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00"
      },
      "location": "westus",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/pgtestsvc1",
      "name": "pgtestsvc1",
      "type": "Microsoft.DBforPostgreSQL/flexibleServers"
    },
    {
      "sku": {
        "tier": "GeneralPurpose",
        "name": "Standard_D4s_v3"
      },
      "properties": {
        "administratorLogin": "testuser",
        "version": "12",
        "minorVersion": "6",
        "state": "Ready",
        "haState": "Healthy",
        "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
        "displayName": "demosingleserver",
        "publicNetworkAccess": "Enabled",
        "storageProfile": {
          "storageMB": 524288,
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled"
        },
        "haEnabled": "Disabled",
        "standbyCount": 0,
        "logBackupStorageSku": "Standard_ZRS",
        "availabilityZone": "2",
        "maintenanceWindow": {
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0,
          "customWindow": "Disabled"
        },
        "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00"
      },
      "location": "westus",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc2",
      "name": "pgtestsvc2",
      "type": "Microsoft.DBforPostgreSQL/flexibleServers"
    },
    {
      "sku": {
        "tier": "GeneralPurpose",
        "name": "Standard_D4s_v3"
      },
      "properties": {
        "administratorLogin": "testuser",
        "version": "12",
        "minorVersion": "6",
        "state": "Ready",
        "haState": "Healthy",
        "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com",
        "displayName": "demosingleserver",
        "publicNetworkAccess": "Enabled",
        "storageProfile": {
          "storageMB": 524288,
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled"
        },
        "haEnabled": "Disabled",
        "standbyCount": 0,
        "logBackupStorageSku": "Standard_ZRS",
        "availabilityZone": "3",
        "maintenanceWindow": {
          "dayOfWeek": 0,
          "startHour": 10,
          "startMinute": 30,
          "customWindow": "Enabled"
        },
        "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00"
      },
      "location": "westus",
      "tags": {
        "ElasticServer": "1"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4",
      "name": "pgtestsvc4",
      "type": "Microsoft.DBforPostgreSQL/flexibleServers"
    }
  ]
}

定義

CloudError

Batch サービスからのエラー応答。

CreateMode

新しい PostgreSQL サーバーを作成するモード。

DelegatedSubnetArguments
ErrorAdditionalInfo

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

ErrorResponse

エラー応答

GeoRedundantBackupEnum

サーバーでGeo-Redundantバックアップが有効かどうかを示す値。

HAEnabledEnum

stand by count の値は、有効または無効にできます

Identity

リソースの ID。

MaintenanceWindow

サーバーのメンテナンス期間。

PrivateDnsZoneArguments
ResourceIdentityType

ID の種類。

Server

サーバーを表します。

ServerHAState

ユーザーに表示される HA サーバーの状態。

ServerListResult

サーバーの一覧。

ServerPublicNetworkAccessState

パブリック ネットワーク アクセスが有効かどうか

ServerState

ユーザーに表示されるサーバーの状態。

ServerVersion

サーバーのバージョン。

Sku

サーバーの SKU 情報に関連するプロパティ。

SkuTier

特定の SKU のレベル (バースト可能など)。

StorageProfile

サーバーのプロファイル プロパティのStorage

CloudError

Batch サービスからのエラー応答。

Name Type Description
error

エラー応答
失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

CreateMode

新しい PostgreSQL サーバーを作成するモード。

Name Type Description
Default
  • string
PointInTimeRestore
  • string

DelegatedSubnetArguments

Name Type Description
subnetArmResourceId
  • string

委任されたサブネット の arm リソース ID。

ErrorAdditionalInfo

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

Name Type Description
info
  • object

追加情報。

type
  • string

追加情報の種類。

ErrorResponse

エラー応答

Name Type Description
additionalInfo

エラーの追加情報。

code
  • string

エラー コード。

details

エラーの詳細です。

message
  • string

エラー メッセージ。

target
  • string

エラーターゲット。

GeoRedundantBackupEnum

サーバーでGeo-Redundantバックアップが有効かどうかを示す値。

Name Type Description
Disabled
  • string
Enabled
  • string

HAEnabledEnum

stand by count の値は、有効または無効にできます

Name Type Description
Disabled
  • string
Enabled
  • string

Identity

リソースの ID。

Name Type Description
principalId
  • string

リソース ID のプリンシパル ID。

tenantId
  • string

リソースのテナント ID。

type

ID の種類。

MaintenanceWindow

サーバーのメンテナンス期間。

Name Type Description
customWindow
  • string

は、カスタム ウィンドウが有効か無効かを示します

dayOfWeek
  • integer

メンテナンス期間の曜日

startHour
  • integer

メンテナンス期間の開始時刻

startMinute
  • integer

メンテナンス期間の開始分

PrivateDnsZoneArguments

Name Type Description
privateDnsZoneArmResourceId
  • string

プライベート DNS ゾーンの arm リソース ID。

ResourceIdentityType

ID の種類。

Name Type Description
SystemAssigned
  • string

Server

サーバーを表します。

Name Type Description
id
  • string

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

identity

サーバーのAzure Active Directory ID。

location
  • string

リソースが存在する地理的な場所

name
  • string

リソースの名前

properties.administratorLogin
  • string

サーバーの管理者のログイン名。 サーバーの作成時にのみ指定できます (作成に必要です)。

properties.administratorLoginPassword
  • string

管理者ログイン パスワード (サーバーの作成に必要)。

properties.availabilityZone
  • string

サーバーの可用性ゾーン情報。

properties.byokEnforcement
  • string

カスタマー マネージド キーでデータ暗号化が有効になっているかどうかを示す状態。

properties.createMode

新しい PostgreSQL サーバーを作成するモード。

properties.delegatedSubnetArguments
properties.displayName
  • string

サーバーの表示名。

properties.earliestRestoreDate
  • string

サーバーの最も古い復元ポイント時刻 (ISO8601 形式)。

properties.fullyQualifiedDomainName
  • string

サーバーの完全修飾ドメイン名。

properties.haEnabled

stand by count の値は、有効または無効にできます

properties.haState

ユーザーに表示される HA サーバーの状態。

properties.logBackupStorageSku
  • string

サーバーのログ バックアップ ストレージ SKU。

properties.maintenanceWindow

サーバーのメンテナンス期間。

properties.minorVersion
  • string

サーバーのマイナー バージョン。

properties.pointInTimeUTC
  • string

復元ポイントの作成時刻 (ISO8601 形式)、復元元の時刻を指定します。

properties.privateDnsZoneArguments
properties.publicNetworkAccess

パブリック ネットワーク アクセスが有効かどうか

properties.sourceResourceGroupName
  • string

ソースのリソース グループ名は、復元元の PostgreSQL サーバー名を提供します。

properties.sourceServerName
  • string

復元元の PostgreSQL サーバー名。

properties.sourceSubscriptionId
  • string

ソースのサブスクリプション ID は、復元元の PostgreSQL サーバー名を提供します。

properties.standbyAvailabilityZone
  • string

サーバーの可用性ゾーン情報。

properties.standbyCount
  • integer

スタンバイの数。

properties.state

ユーザーに表示されるサーバーの状態。

properties.storageProfile

サーバーのプロファイルをStorageします。

properties.tags
  • object

キーと値のペアの形式による、アプリケーション固有のメタデータ。

properties.version

PostgreSQL サーバーのバージョン。

sku

サーバーの SKU (価格レベル)。

tags
  • object

リソース タグ。

type
  • string

リソースの型。 "Microsoft.Compute/virtualMachines" や "Microsoft" など。Storage/storageAccounts"

ServerHAState

ユーザーに表示される HA サーバーの状態。

Name Type Description
CreatingStandby
  • string
FailingOver
  • string
Healthy
  • string
NotEnabled
  • string
RemovingStandby
  • string
ReplicatingData
  • string

ServerListResult

サーバーの一覧。

Name Type Description
nextLink
  • string

操作の次のページを取得するために使用されるリンク。

value

フレキシブル サーバーの一覧

ServerPublicNetworkAccessState

パブリック ネットワーク アクセスが有効かどうか

Name Type Description
Disabled
  • string
Enabled
  • string

ServerState

ユーザーに表示されるサーバーの状態。

Name Type Description
Disabled
  • string
Dropping
  • string
Ready
  • string
Starting
  • string
Stopped
  • string
Stopping
  • string
Updating
  • string

ServerVersion

サーバーのバージョン。

Name Type Description
11
  • string
12
  • string

Sku

サーバーの SKU 情報に関連するプロパティ。

Name Type Description
name
  • string

sku の名前 (通常は階層 + ファミリ + コア) (例: Standard_D4s_v3)。

tier

特定の SKU のレベル (バースト可能など)。

SkuTier

特定の SKU のレベル (バースト可能など)。

Name Type Description
Burstable
  • string
GeneralPurpose
  • string
MemoryOptimized
  • string

StorageProfile

サーバーのプロファイル プロパティのStorage

Name Type Description
backupRetentionDays
  • integer

サーバー Backupリテンション日。

geoRedundantBackup

サーバーでGeo-Redundantバックアップが有効かどうかを示す値。

storageMB
  • integer

サーバーで許可される最大ストレージ数。