次の方法で共有

Servers - Get

  • リファレンス
サービス:
PostgreSQL
API バージョン:
2022-12-01

サーバーに関する情報を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}?api-version=2022-12-01

URI パラメーター

名前 / 必須 型 説明
resourceGroupName
 path True

string

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

string

サーバーの名前。

正規表現パターン: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*
subscriptionId
 path True

string

ターゲット サブスクリプションの ID。
api-version
 query True

string

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

応答

名前 型 説明
200 OK

Server

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 ユーザー アカウントの借用

例

ServerGet
ServerGetWithVnet

ServerGet

要求のサンプル

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1?api-version=2022-12-01

応答のサンプル

状態コード:
200 
{
  "sku": {
    "name": "Standard_D4s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "storage": {
      "storageSizeGB": 512
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00"
    },
    "network": {
      "publicNetworkAccess": "Enabled"
    },
    "highAvailability": {
      "mode": "Disabled",
      "state": "NotEnabled"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1",
  "name": "pgtestsvc1",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

ServerGetWithVnet

要求のサンプル

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4?api-version=2022-12-01

応答のサンプル

状態コード:
200 
{
  "sku": {
    "name": "Standard_D4s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "storage": {
      "storageSizeGB": 512
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "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"
}

定義

名前 説明
activeDirectoryAuthEnum

[有効] の場合、Azure Active Directory 認証が有効になります。
ArmServerKeyType

システム マネージドと Azure Key Vault の場合に示すデータ暗号化の種類。
AuthConfig

サーバーの AuthConfig プロパティ。
Backup

サーバーのバックアップ プロパティ。
createdByType

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

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

サーバーのデータ暗号化プロパティ。
ErrorAdditionalInfo

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

エラーの詳細。
ErrorResponse

エラー応答
GeoRedundantBackupEnum

Geo-Redundant バックアップがサーバーで有効になっているかどうかを示す 値。
HighAvailability

サーバーの高可用性プロパティ。
HighAvailabilityMode

サーバーの HA モード。
IdentityType

このリソースに関連付けられている ID の種類。現在、'None と UserAssigned' に制限されています
MaintenanceWindow

サーバーのメンテナンス期間のプロパティ。
Network

サーバーのネットワーク プロパティ。 このネットワーク プロパティは、サーバーをプライベート アクセス サーバーにする場合にのみ渡す必要があります。
passwordAuthEnum

[有効] の場合、パスワード認証が有効になります。
ReplicationRole

サーバーのレプリケーション ロール
Server

サーバーを表します。
ServerHAState

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

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

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

PostgreSQL Server のバージョン。
Sku

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

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

サーバーのストレージ プロパティ。
systemData

このリソースに関連するシステム メタデータ。
UserAssignedIdentity

アプリケーションの ID について説明します。
UserIdentity

アプリケーションに関連付けられている 1 つのユーザー割り当て ID について説明します。

activeDirectoryAuthEnum

[有効] の場合、Azure Active Directory 認証が有効になります。

名前 型 説明
Disabled

string

Enabled

string

ArmServerKeyType

システム マネージドと Azure Key Vault の場合に示すデータ暗号化の種類。

名前 型 説明
AzureKeyVault

string

SystemManaged

string

AuthConfig

サーバーの AuthConfig プロパティ。

名前 型 規定値 説明
activeDirectoryAuth

activeDirectoryAuthEnum

[有効] の場合、Azure Active Directory 認証が有効になります。
passwordAuth

passwordAuthEnum

Enabled

[有効] の場合、パスワード認証が有効になります。
tenantId

string

サーバーのテナント ID。

Backup

サーバーのバックアップ プロパティ。

名前 型 規定値 説明
backupRetentionDays

integer

7

サーバーのバックアップ保有日数。
earliestRestoreDate

string

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

GeoRedundantBackupEnum

Disabled

Geo-Redundant バックアップがサーバーで有効になっているかどうかを示す 値。

createdByType

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

名前 型 説明
Application

string

Key

string

ManagedIdentity

string

User

string

CreateMode

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

名前 型 説明
Create

string

Default

string

GeoRestore

string

PointInTimeRestore

string

Replica

string

Update

string

DataEncryption

サーバーのデータ暗号化プロパティ。

名前 型 説明
primaryKeyURI

string

プライマリ サーバーのデータ暗号化のキーの URI。
primaryUserAssignedIdentityId

string

プライマリ サーバーのデータ暗号化に使用するユーザー割り当て ID のリソース ID。
type

ArmServerKeyType

システム マネージドと Azure Key Vault の場合に示すデータ暗号化の種類。

ErrorAdditionalInfo

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

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細です。
message

string

エラー メッセージ。
target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 型 説明
error

ErrorDetail

error オブジェクト。

GeoRedundantBackupEnum

Geo-Redundant バックアップがサーバーで有効になっているかどうかを示す 値。

名前 型 説明
Disabled

string

Enabled

string

HighAvailability

サーバーの高可用性プロパティ。

名前 型 規定値 説明
mode

HighAvailabilityMode

Disabled

サーバーの HA モード。
standbyAvailabilityZone

string

スタンバイの可用性ゾーン情報。
state

ServerHAState

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

HighAvailabilityMode

サーバーの HA モード。

名前 型 説明
Disabled

string

SameZone

string

ZoneRedundant

string

IdentityType

このリソースに関連付けられている ID の種類。現在、'None と UserAssigned' に制限されています

名前 型 説明
None

string

UserAssigned

string

MaintenanceWindow

サーバーのメンテナンス期間のプロパティ。

名前 型 規定値 説明
customWindow

string

Disabled

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

integer

0

メンテナンス期間の曜日
startHour

integer

0

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

integer

0

メンテナンス期間の開始時間 (分)

Network

サーバーのネットワーク プロパティ。 このネットワーク プロパティは、サーバーをプライベート アクセス サーバーにする場合にのみ渡す必要があります。

名前 型 説明
delegatedSubnetResourceId

string

委任されたサブネット arm リソース ID。これは、サーバーを VNET に挿入する場合 (つまり、プライベート アクセス サーバー) の作成時に渡す必要があります。 更新中に、ゾーンの値を更新する場合にのみプライベート DNS渡します。
privateDnsZoneArmResourceId

string

プライベート DNS ゾーンの arm リソース ID。これは、サーバーを VNET に挿入する場合 (つまり、プライベート アクセス サーバー) の作成時に渡す必要があります。 更新中に、ゾーンの値を更新する場合にのみプライベート DNS渡します。
publicNetworkAccess

ServerPublicNetworkAccessState

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

passwordAuthEnum

[有効] の場合、パスワード認証が有効になります。

名前 型 説明
Disabled

string

Enabled

string

ReplicationRole

サーバーのレプリケーション ロール

名前 型 説明
AsyncReplica

string

GeoAsyncReplica

string

None

string

Primary

string

Server

サーバーを表します。

名前 型 説明
id

string

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

UserAssignedIdentity

アプリケーションの ID について説明します。
location

string

リソースが保存されている地理的な場所
name

string

リソースの名前
properties.administratorLogin

string

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

string

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

AuthConfig

サーバーの AuthConfig プロパティ。
properties.availabilityZone

string

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

Backup

サーバーのバックアップ プロパティ。
properties.createMode

CreateMode

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

DataEncryption

サーバーのデータ暗号化プロパティ。
properties.fullyQualifiedDomainName

string

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

HighAvailability

サーバーの高可用性プロパティ。
properties.maintenanceWindow

MaintenanceWindow

サーバーのメンテナンス期間のプロパティ。
properties.minorVersion

string

サーバーのマイナー バージョン。
properties.network

Network

サーバーのネットワーク プロパティ。 このネットワーク プロパティは、サーバーをプライベート アクセス サーバーにする場合にのみ渡す必要があります。
properties.pointInTimeUTC

string

復元ポイントの作成時刻 (ISO8601形式)、復元元の時刻を指定します。 'createMode' が 'PointInTimeRestore' または 'GeoRestore' の場合は必須です。
properties.replicaCapacity

integer

サーバーに対して許可されているレプリカ。
properties.replicationRole

ReplicationRole

サーバーのレプリケーション ロール
properties.sourceServerResourceId

string

復元元のソース サーバー リソース ID。 'createMode' が 'PointInTimeRestore' または 'GeoRestore' または 'Replica' の場合は必須です。 このプロパティは、レプリカ サーバーに対してのみ返されます
properties.state

ServerState

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

Storage

サーバーのストレージ プロパティ。
properties.version

ServerVersion

PostgreSQL Server のバージョン。
sku

Sku

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

systemData

このリソースに関連するシステム メタデータ。
tags

object

リソース タグ。
type

string

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

ServerHAState

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

名前 型 説明
CreatingStandby

string

FailingOver

string

Healthy

string

NotEnabled

string

RemovingStandby

string

ReplicatingData

string

ServerPublicNetworkAccessState

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

名前 型 説明
Disabled

string

Enabled

string

ServerState

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

名前 型 説明
Disabled

string

Dropping

string

Ready

string

Starting

string

Stopped

string

Stopping

string

Updating

string

ServerVersion

PostgreSQL Server のバージョン。

名前 型 説明
11

string

12

string

13

string

14

string

Sku

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

名前 型 説明
name

string

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

SkuTier

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

SkuTier

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

名前 型 説明
Burstable

string

GeneralPurpose

string

MemoryOptimized

string

Storage

サーバーのストレージ プロパティ。

名前 型 説明
storageSizeGB

integer

サーバーに対して許可される最大ストレージ数。

systemData

このリソースに関連するシステム メタデータ。

名前 型 説明
createdAt

string

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

string

リソースを作成した ID。
createdByType

createdByType

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

string

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

string

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

createdByType

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

UserAssignedIdentity

アプリケーションの ID について説明します。

名前 型 説明
tenantId

string

サーバーのテナント ID。
type

IdentityType

このリソースに関連付けられている ID の種類。現在、'None と UserAssigned' に制限されています
userAssignedIdentities

<string,  UserIdentity>

は、ユーザー割り当て ID マップを表します。

UserIdentity

アプリケーションに関連付けられている 1 つのユーザー割り当て ID について説明します。

名前 型 説明
clientId

string

この ID が表すサービス プリンシパルのクライアント識別子。
principalId

string

この ID が表すサービス プリンシパルのオブジェクト識別子。