次の方法で共有


Clusters - Get

コンピューティングやストレージの構成などのクラスターに関する情報と、クラスターの作成日時などのクラスター ライフサイクル メタデータを取得します。

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

URI パラメーター

名前 / 必須 説明
clusterName
path True

string

クラスターの名前です。

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

resourceGroupName
path True

string

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

subscriptionId
path True

string

uuid

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

api-version
query True

string

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

応答

名前 説明
200 OK

Cluster

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 ユーザー アカウントを偽装します。

Get the cluster

要求のサンプル

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1?api-version=2023-03-02-preview

応答のサンプル

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1",
  "name": "testcluster1",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "tags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "location": "eastus",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0,
      "customWindow": "Disabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 4,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 2,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 8,
    "nodeEnablePublicIpAccess": false,
    "serverNames": [
      {
        "name": "testcluster1-c",
        "fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w0",
        "fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w1",
        "fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
      }
    ],
    "sourceResourceId": null,
    "readReplicas": [
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSQL/serverGroupsv2/testreadreplica-01",
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSQL/serverGroupsv2/testreadreplica-02"
    ],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  }
}

定義

名前 説明
AadEnabledEnum

クラスターが AAD 認証を使用して作成されたかどうかを示します。

ActiveDirectoryAuth
AuthConfig

クラスターの認証構成。

Cluster

クラスターを表します。

createdByType

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

DataEncryption

クラスターのデータ暗号化プロパティ。

DataEncryptionType
ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

IdentityProperties

クラスターの ID について説明します。

IdentityType
MaintenanceWindow

定期的なクラスター更新プログラムの設定をスケジュールします。

PasswordAuth
PasswordEnabledEnum

クラスターがパスワードで作成されたか、AAD 認証を使用して作成されたかを示します。

PrivateEndpointProperty

プライベート エンドポイントのリソース ID を表す プロパティ。

PrivateEndpointServiceConnectionStatus

プライベート エンドポイント接続の状態。

PrivateLinkServiceConnectionState

サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。

ServerNameItem

サーバーの名前オブジェクト。

SimplePrivateEndpointConnection

プライベート エンドポイント接続。

systemData

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

UserAssignedIdentity

ユーザー割り当て ID プロパティ

AadEnabledEnum

クラスターが AAD 認証を使用して作成されたかどうかを示します。

名前 説明
disabled

string

enabled

string

ActiveDirectoryAuth

名前 説明
disabled

string

enabled

string

AuthConfig

クラスターの認証構成。

名前 説明
activeDirectoryAuth

ActiveDirectoryAuth

passwordAuth

PasswordAuth

Cluster

クラスターを表します。

名前 説明
id

string

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

identity

IdentityProperties

クラスターの ID について説明します。

location

string

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

name

string

リソースの名前

properties.aadAuthEnabled

AadEnabledEnum

クラスターが AAD 認証を使用して作成されたかどうかを示します。

properties.administratorLogin

string

クラスター内のサーバーの管理者のログイン名。

properties.administratorLoginPassword

string

管理者ログインのパスワード。 作成に必要です。

properties.authConfig

AuthConfig

クラスターの認証構成。

properties.citusVersion

string

すべてのクラスター サーバー上の Citus 拡張機能バージョン。

properties.coordinatorEnablePublicIpAccess

boolean

コーディネーターでパブリック アクセスが有効になっている場合。

properties.coordinatorServerEdition

string

コーディネーター サーバーのエディション (既定値: GeneralPurpose)。 作成に必要です。

properties.coordinatorStorageQuotaInMb

integer

サーバーのストレージ (MB 単位)。 作成に必要です。 詳細については、「 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute 」を参照してください。

properties.coordinatorVCores

integer

サーバーの仮想コア数 (最大: 96)。 作成に必要です。 詳細については、「 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute 」を参照してください。

properties.dataEncryption

DataEncryption

クラスターのデータ暗号化プロパティ。

properties.databaseName

string

クラスターのデータベース名。 クラスターごとに 1 つのデータベースのみがサポートされます。

properties.earliestRestoreTime

string

クラスターの最も古い復元ポイント時間 (ISO8601形式)。

properties.enableGeoBackup

boolean

クラスターのバックアップが、クラスターのリージョンに格納されているバックアップのコピーに加えて、別の Azure リージョンに格納されている場合。 クラスターの作成時にのみ有効になります。

properties.enableHa

boolean

高可用性 (HA) がクラスターに対して有効になっているかどうか。

properties.enableShardsOnCoordinator

boolean

分散テーブルがコーディネーターに配置されているかどうか。 単一ノード クラスターでは、"true" に設定する必要があります。 値が変更された後にシャードの再調整が必要です。

properties.maintenanceWindow

MaintenanceWindow

クラスターのメンテナンス期間。

properties.nodeCount

integer

クラスターのワーカー ノード数。 ノード数が 0 の場合は、そのノードに分散テーブルを作成できる単一のノード構成を表します。 2 つ以上のワーカー ノードがマルチノード構成を表します。 ノード数の値を 1 にすることはできません。 作成に必要です。

properties.nodeEnablePublicIpAccess

boolean

ワーカー ノードでパブリック アクセスが有効になっている場合。

properties.nodeServerEdition

string

ノード サーバーのエディション (既定値: MemoryOptimized)。

properties.nodeStorageQuotaInMb

integer

各ワーカー ノードのストレージ (MB 単位)。 詳細については、「 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute 」を参照してください。

properties.nodeVCores

integer

各ワーカー ノードの仮想コア単位のコンピューティング (最大: 104)。 詳細については、「 https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute 」を参照してください。

properties.passwordEnabled

PasswordEnabledEnum

クラスターがパスワードで作成されたか、AAD 認証を使用して作成されたかを示します。

properties.pointInTimeUTC

string

クラスターの復元の UTC (ISO8601形式) の日付と時刻。

properties.postgresqlVersion

string

すべてのクラスター サーバー上の PostgreSQL のメジャー バージョン。

properties.preferredPrimaryZone

string

すべてのクラスター サーバーに推奨されるプライマリ可用性ゾーン (AZ)。

properties.privateEndpointConnections

SimplePrivateEndpointConnection[]

クラスターのプライベート エンドポイント接続。

properties.provisioningState

string

クラスターのプロビジョニング状態

properties.readReplicas

string[]

読み取りレプリカ クラスターの配列。

properties.serverNames

ServerNameItem[]

クラスター内のサーバー名の一覧

properties.sourceLocation

string

読み取りレプリカ クラスターのソース クラスターの Azure リージョン。

properties.sourceResourceId

string

読み取りレプリカ クラスターのソース クラスターのリソース ID。

properties.state

string

ユーザーに表示されるクラスター/サーバーの状態。

systemData

systemData

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

tags

object

リソース タグ。

type

string

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

createdByType

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

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

DataEncryption

クラスターのデータ暗号化プロパティ。

名前 説明
primaryKeyUri

string

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

primaryUserAssignedIdentityId

string

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

type

DataEncryptionType

DataEncryptionType

名前 説明
AzureKeyVault

string

SystemAssigned

string

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。

IdentityProperties

クラスターの ID について説明します。

名前 説明
type

IdentityType

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned ID
リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求で空のオブジェクト ({}) にすることができます。

IdentityType

名前 説明
SystemAssigned

string

UserAssigned

string

MaintenanceWindow

定期的なクラスター更新プログラムの設定をスケジュールします。

名前 説明
customWindow

string

カスタム メンテナンス期間が有効かどうかを示します。

dayOfWeek

integer

メンテナンス期間の優先曜日。

startHour

integer

メンテナンス期間の優先曜日内の開始時間。

startMinute

integer

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

PasswordAuth

名前 説明
disabled

string

enabled

string

PasswordEnabledEnum

クラスターがパスワードで作成されたか、AAD 認証を使用して作成されたかを示します。

名前 説明
disabled

string

enabled

string

PrivateEndpointProperty

プライベート エンドポイントのリソース ID を表す プロパティ。

名前 説明
id

string

プライベート エンドポイントのリソース ID。

PrivateEndpointServiceConnectionStatus

プライベート エンドポイント接続の状態。

名前 説明
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。

名前 説明
actionsRequired

string

サービス プロバイダーの変更にコンシューマーに対する更新が必要かどうかを示すメッセージ。

description

string

接続の承認/拒否の理由。

status

PrivateEndpointServiceConnectionStatus

サービスの所有者によって接続が承認/拒否/削除されたかどうかを示します。

ServerNameItem

サーバーの名前オブジェクト。

名前 説明
fullyQualifiedDomainName

string

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

name

string

サーバーの名前。

SimplePrivateEndpointConnection

プライベート エンドポイント接続。

名前 説明
id

string

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

name

string

リソースの名前

properties.groupIds

string[]

プライベート エンドポイント接続のグループ ID。

properties.privateEndpoint

PrivateEndpointProperty

接続が属するプライベート エンドポイント。

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。

systemData

systemData

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

type

string

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

systemData

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

名前 説明
createdAt

string

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

createdBy

string

リソースを作成した ID。

createdByType

createdByType

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

lastModifiedAt

string

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

lastModifiedBy

string

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

lastModifiedByType

createdByType

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

UserAssignedIdentity

ユーザー割り当て ID プロパティ

名前 説明
clientId

string

割り当てられた ID のクライアント ID。

principalId

string

割り当てられた ID のプリンシパル ID。