Aracılığıyla paylaş


Clusters - Get

İşlem ve depolama yapılandırması ve küme oluşturma tarihi ve saati gibi küme yaşam döngüsü meta verileri gibi küme hakkında bilgi alır.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
clusterName
path True

string

Kümenin adı.

Normal ifade deseni: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$

resourceGroupName
path True

string

Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.

subscriptionId
path True

string

uuid

Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.

api-version
query True

string

Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name Tür Description
200 OK

Cluster

Tamam

Other Status Codes

ErrorResponse

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
user_impersonation Kullanıcı hesabınızın kimliğine bürünme.

Örnekler

Get the cluster

Örnek isteği

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

Örnek yanıt

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

Tanımlar

Name Description
AadEnabledEnum

Kümenin AAD kimlik doğrulaması kullanılarak oluşturulup oluşturulmadığını gösterir.

ActiveDirectoryAuth
AuthConfig

Kümenin kimlik doğrulaması yapılandırması.

Cluster

Kümeyi temsil eder.

createdByType

Kaynağı oluşturan kimliğin türü.

DataEncryption

Kümenin veri şifreleme özellikleri.

DataEncryptionType
ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

ErrorDetail

Hata ayrıntısı.

ErrorResponse

Hata yanıtı

IdentityProperties

Kümenin kimliğini açıklar.

IdentityType
MaintenanceWindow

Normal küme güncelleştirmeleri için ayarları zamanlayın.

PasswordAuth
PasswordEnabledEnum

Kümenin parolayla mı yoksa AAD kimlik doğrulamasıyla mı oluşturulduğunu gösterir.

PrivateEndpointProperty

Özel uç noktanın kaynak kimliğini temsil eden özellik.

PrivateEndpointServiceConnectionStatus

Özel uç nokta bağlantı durumu.

PrivateLinkServiceConnectionState

Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.

ServerNameItem

Bir sunucunun ad nesnesi.

SimplePrivateEndpointConnection

Özel uç nokta bağlantısı.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

UserAssignedIdentity

Kullanıcı tarafından atanan kimlik özellikleri

AadEnabledEnum

Kümenin AAD kimlik doğrulaması kullanılarak oluşturulup oluşturulmadığını gösterir.

Name Tür Description
disabled

string

enabled

string

ActiveDirectoryAuth

Name Tür Description
disabled

string

enabled

string

AuthConfig

Kümenin kimlik doğrulaması yapılandırması.

Name Tür Description
activeDirectoryAuth

ActiveDirectoryAuth

passwordAuth

PasswordAuth

Cluster

Kümeyi temsil eder.

Name Tür Description
id

string

Kaynağın tam kaynak kimliği. Örneğin, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

IdentityProperties

Kümenin kimliğini açıklar.

location

string

Kaynağın bulunduğu coğrafi konum

name

string

Kaynağın adı

properties.aadAuthEnabled

AadEnabledEnum

Kümenin AAD kimlik doğrulaması kullanılarak oluşturulup oluşturulmadığını gösterir.

properties.administratorLogin

string

Yöneticinin kümedeki sunucuların oturum açma adı.

properties.administratorLoginPassword

string

Yönetici oturum açma parolası. Oluşturma için gereklidir.

properties.authConfig

AuthConfig

Kümenin kimlik doğrulaması yapılandırması.

properties.citusVersion

string

Tüm küme sunucularında Citus uzantısı sürümü.

properties.coordinatorEnablePublicIpAccess

boolean

Koordinatörde genel erişim etkinleştirildiyse.

properties.coordinatorServerEdition

string

Koordinatör sunucusunun sürümü (varsayılan: GeneralPurpose). Oluşturma için gereklidir.

properties.coordinatorStorageQuotaInMb

integer

Bir sunucunun MB cinsinden depolanması. Oluşturma için gereklidir. Daha fazla bilgi edinmek için bkz. https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.coordinatorVCores

integer

Bir sunucunun sanal çekirdek sayısı (maksimum: 96). Oluşturma için gereklidir. Daha fazla bilgi edinmek için bkz. https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.dataEncryption

DataEncryption

Kümenin veri şifreleme özellikleri.

properties.databaseName

string

Kümenin veritabanı adı. Küme başına yalnızca bir veritabanı desteklenir.

properties.earliestRestoreTime

string

Küme için en erken geri yükleme noktası saati (ISO8601 biçimi).

properties.enableGeoBackup

boolean

Küme yedeklemesi, kümenin bölgesinde depolanan yedeklemenin kopyasına ek olarak başka bir Azure bölgesinde depolanıyorsa. Yalnızca küme oluşturma sırasında etkinleştirilir.

properties.enableHa

boolean

Küme için yüksek kullanılabilirlik (HA) etkinleştirildiyse veya etkinleştirilmediyse.

properties.enableShardsOnCoordinator

boolean

Dağıtılmış tablolar koordinatöre yerleştirilirse veya yerleştirilmediyse. Tek düğüm kümelerinde 'true' olarak ayarlanmalıdır. Değer değiştirildikten sonra parçanın yeniden dengelenmesi gerekir.

properties.maintenanceWindow

MaintenanceWindow

Kümenin bakım penceresi.

properties.nodeCount

integer

Kümenin çalışan düğümü sayısı. Düğüm sayısı 0 olduğunda, bu düğümde dağıtılmış tablolar oluşturma özelliğine sahip tek bir düğüm yapılandırmasını temsil eder. 2 veya daha fazla çalışan düğümü çok düğümlü yapılandırmayı temsil etti. Düğüm sayısı değeri 1 olamaz. Oluşturma için gereklidir.

properties.nodeEnablePublicIpAccess

boolean

Çalışan düğümlerinde genel erişim etkinleştirildiyse.

properties.nodeServerEdition

string

Düğüm sunucusunun sürümü (varsayılan: MemoryOptimized).

properties.nodeStorageQuotaInMb

integer

Her çalışan düğümünde MB cinsinden depolama. Daha fazla bilgi edinmek için bkz. https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.nodeVCores

integer

Her çalışan düğümündeki sanal çekirdeklerdeki işlem (maksimum: 104). Daha fazla bilgi edinmek için bkz. https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.passwordEnabled

PasswordEnabledEnum

Kümenin parolayla mı yoksa AAD kimlik doğrulamasıyla mı oluşturulduğunu gösterir.

properties.pointInTimeUTC

string

Küme geri yükleme için UTC (ISO8601 biçiminde) tarih ve saat.

properties.postgresqlVersion

string

Tüm küme sunucularında ana PostgreSQL sürümü.

properties.preferredPrimaryZone

string

Tüm küme sunucuları için tercih edilen birincil kullanılabilirlik alanı (AZ).

properties.privateEndpointConnections

SimplePrivateEndpointConnection[]

Küme için özel uç nokta bağlantıları.

properties.provisioningState

string

Kümenin sağlama durumu

properties.readReplicas

string[]

Okuma amaçlı çoğaltma kümeleri dizisi.

properties.serverNames

ServerNameItem[]

Kümedeki sunucu adlarının listesi

properties.sourceLocation

string

Okuma amaçlı çoğaltma kümeleri için kaynak kümenin Azure bölgesi.

properties.sourceResourceId

string

Okuma amaçlı çoğaltma kümeleri için kaynak kümenin kaynak kimliği.

properties.state

string

Kullanıcının görebilmesi için kümenin/sunucunun durumu.

systemData

systemData

Azure Resource Manager createdBy ve modifiedBy bilgilerini içeren meta veriler.

tags

object

Kaynak etiketleri.

type

string

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

createdByType

Kaynağı oluşturan kimliğin türü.

Name Tür Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataEncryption

Kümenin veri şifreleme özellikleri.

Name Tür Description
primaryKeyUri

string

Birincil sunucunun veri şifrelemesi için keyvault içindeki anahtar için URI.

primaryUserAssignedIdentityId

string

Birincil sunucunun veri şifrelemesi için kullanılacak Kullanıcı tarafından atanan kimliğin kaynak kimliği.

type

DataEncryptionType

DataEncryptionType

Name Tür Description
AzureKeyVault

string

SystemAssigned

string

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

object

Ek bilgiler.

type

string

Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name Tür Description
additionalInfo

ErrorAdditionalInfo[]

Hata ek bilgileri.

code

string

Hata kodu.

details

ErrorDetail[]

Hata ayrıntıları.

message

string

Hata iletisi.

target

string

Hata hedefi.

ErrorResponse

Hata yanıtı

Name Tür Description
error

ErrorDetail

Hata nesnesi.

IdentityProperties

Kümenin kimliğini açıklar.

Name Tür Description
type

IdentityType

userAssignedIdentities

<string,  UserAssignedIdentity>

kimlikleri User-Assigned
Kaynakla ilişkili kullanıcı tarafından atanan kimlik kümesi. userAssignedIdentities sözlük anahtarları şu biçimde ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Sözlük değerleri, isteklerdeki boş nesneler ({}) olabilir.

IdentityType

Name Tür Description
SystemAssigned

string

UserAssigned

string

MaintenanceWindow

Normal küme güncelleştirmeleri için ayarları zamanlayın.

Name Tür Description
customWindow

string

Özel bakım penceresinin etkinleştirilip etkinleştirilmediğini gösterir.

dayOfWeek

integer

Bakım penceresi için haftanın tercih edilen günü.

startHour

integer

Bakım penceresi için haftanın tercih edilen günü içinde başlangıç saati.

startMinute

integer

Bakım penceresi için başlangıç saati içinde başlangıç dakikası.

PasswordAuth

Name Tür Description
disabled

string

enabled

string

PasswordEnabledEnum

Kümenin parolayla mı yoksa AAD kimlik doğrulamasıyla mı oluşturulduğunu gösterir.

Name Tür Description
disabled

string

enabled

string

PrivateEndpointProperty

Özel uç noktanın kaynak kimliğini temsil eden özellik.

Name Tür Description
id

string

Özel uç noktanın kaynak kimliği.

PrivateEndpointServiceConnectionStatus

Özel uç nokta bağlantı durumu.

Name Tür Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.

Name Tür Description
actionsRequired

string

Hizmet sağlayıcısındaki değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.

description

string

Bağlantının onay/reddedilme nedeni.

status

PrivateEndpointServiceConnectionStatus

Bağlantının hizmet sahibi tarafından Onaylanıp Reddedildiğini/Kaldırıldığını gösterir.

ServerNameItem

Bir sunucunun ad nesnesi.

Name Tür Description
fullyQualifiedDomainName

string

Sunucunun tam etki alanı adı.

name

string

Sunucunun adı.

SimplePrivateEndpointConnection

Özel uç nokta bağlantısı.

Name Tür Description
id

string

Kaynağın tam kaynak kimliği. Örneğin, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Kaynağın adı

properties.groupIds

string[]

Özel uç nokta bağlantısının grup kimlikleri.

properties.privateEndpoint

PrivateEndpointProperty

Bağlantının ait olduğu özel uç nokta.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.

systemData

systemData

Azure Resource Manager createdBy ve modifiedBy bilgilerini içeren meta veriler.

type

string

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name Tür Description
createdAt

string

Kaynak oluşturma (UTC) zaman damgası.

createdBy

string

Kaynağı oluşturan kimlik.

createdByType

createdByType

Kaynağı oluşturan kimliğin türü.

lastModifiedAt

string

Kaynağın son değişikliğinin zaman damgası (UTC)

lastModifiedBy

string

Kaynağı en son değiştiren kimlik.

lastModifiedByType

createdByType

Kaynağı en son değiştiren kimliğin türü.

UserAssignedIdentity

Kullanıcı tarafından atanan kimlik özellikleri

Name Tür Description
clientId

string

Atanan kimliğin istemci kimliği.

principalId

string

Atanan kimliğin asıl kimliği.