Cassandra Clusters - List By Subscription

Vypíše všechny spravované clustery Cassandra v tomto předplatném.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/cassandraClusters?api-version=2021-03-01-preview

Parametry identifikátoru URI

Name In Required Type Description
subscriptionId
path True
  • string

ID cílového předplatného

api-version
query True
  • string

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

Odpovědi

Name Type Description
200 OK

Seznam spravovaných clusterů Cassandra byl úspěšně načten.

Other Status Codes

Chybová odezva popisující, proč se operace nezdařila

Zabezpečení

azure_auth

Azure Active Directory tok OAuth2

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

Scopes

Name Description
user_impersonation Zosobnění uživatelského účtu

Příklady

CosmosDBManagedCassandraClusterListBySubscription

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.DocumentDB/cassandraClusters?api-version=2021-03-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/cassandraClusters",
      "name": "cassandra-prod",
      "type": "Microsoft.DocumentDB/cassandraClusters",
      "location": "West US",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded",
        "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management",
        "cassandraVersion": "3.11",
        "hoursBetweenBackups": 24,
        "authenticationMethod": "Cassandra",
        "externalSeedNodes": [
          {
            "ipAddress": "10.52.221.2"
          },
          {
            "ipAddress": "10.52.221.3"
          },
          {
            "ipAddress": "10.52.221.4"
          }
        ],
        "clusterNameOverride": "ClusterNameIllegalForAzureResource",
        "seedNodes": [
          {
            "ipAddress": "10.52.221.2"
          },
          {
            "ipAddress": "10.52.221.3"
          },
          {
            "ipAddress": "10.52.221.4"
          },
          {
            "ipAddress": "192.168.12.2"
          },
          {
            "ipAddress": "192.168.12.3"
          },
          {
            "ipAddress": "192.168.12.4"
          }
        ],
        "clientCertificates": [
          {
            "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----"
          }
        ],
        "externalGossipCertificates": [
          {
            "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----"
          }
        ],
        "gossipCertificates": [
          {
            "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----"
          }
        ]
      }
    }
  ]
}

Definice

AuthenticationMethod

Jakou metodu ověřování Cassandra by měl použít k ověřování klientů. Možnost žádné vypne ověřování, takže by se neměla používat s výjimkou případů nouze. ' Cassandra ' je výchozí ověřování založené na heslech. Výchozí hodnota je ' Cassandra '.

Certificate
CloudError

Odpověď na chybu od služby.

ClusterResource

Reprezentace spravovaného clusteru Cassandra.

ErrorResponse

Chybná odpověď.

ListClusters

Seznam spravovaných clusterů Cassandra.

ManagedCassandraProvisioningState

Stav prostředku v době, kdy byla operace volána.

ManagedServiceIdentity

Identita prostředku

Properties

Vlastnosti spravovaného clusteru Cassandra.

ResourceIdentityType

Typ identity použitý pro prostředek. Typ "SystemAssigned, UserAssigned" zahrnuje implicitně vytvořenou identitu a sadu identit přiřazených uživateli. Typ None odebere ze služby všechny identity.

SeedNode
UserAssignedIdentities

Seznam identit uživatelů přidružených k prostředku Odkazy na klíč uživatele slovníku identity budou mít ID prostředků ARM ve formátu: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} '.

AuthenticationMethod

Jakou metodu ověřování Cassandra by měl použít k ověřování klientů. Možnost žádné vypne ověřování, takže by se neměla používat s výjimkou případů nouze. ' Cassandra ' je výchozí ověřování založené na heslech. Výchozí hodnota je ' Cassandra '.

Name Type Description
Cassandra
  • string
None
  • string

Certificate

Name Type Description
pem
  • string

PEM formátovaný veřejný klíč.

CloudError

Odpověď na chybu od služby.

Name Type Description
error

Chybná odpověď.

ClusterResource

Reprezentace spravovaného clusteru Cassandra.

Name Type Description
id
  • string

Jedinečný identifikátor prostředku pro prostředek ARM

identity

Identita prostředku

location
  • string

Umístění skupiny prostředků, do které prostředek patří.

name
  • string

Název prostředku ARM

properties

Vlastnosti spravovaného clusteru Cassandra.

tags
  • object

Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky se dají použít k zobrazení a seskupení tohoto prostředku (mezi skupinami prostředků). Pro prostředek lze zadat maximálně 15 značek. Každá značka musí mít klíč větší než 128 znaků a hodnota nesmí být delší než 256 znaků. Například výchozí prostředí pro typ šablony je nastaveno na "defaultExperience": "Cassandra". Aktuální hodnoty "defaultExperience" také zahrnují "Table", "Graph", "DocumentDB" a "MongoDB".

type
  • string

Typ prostředku Azure.

ErrorResponse

Chybná odpověď.

Name Type Description
code
  • string

Kód chyby

message
  • string

Chybová zpráva indikující, proč se operace nezdařila.

ListClusters

Seznam spravovaných clusterů Cassandra.

Name Type Description
value

Kontejner pro pole clusterů.

ManagedCassandraProvisioningState

Stav prostředku v době, kdy byla operace volána.

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

ManagedServiceIdentity

Identita prostředku

Name Type Description
principalId
  • string

ID objektu zabezpečení identity přiřazené systémem. Tato vlastnost bude k dispozici pouze pro identitu přiřazenou systémem.

tenantId
  • string

ID tenanta identity přiřazené systémem. Tato vlastnost bude k dispozici pouze pro identitu přiřazenou systémem.

type

Typ identity použitý pro prostředek. Typ "SystemAssigned, UserAssigned" zahrnuje implicitně vytvořenou identitu a sadu identit přiřazených uživateli. Typ None odebere ze služby všechny identity.

userAssignedIdentities

Seznam identit uživatelů přidružených k prostředku Odkazy na klíč uživatele slovníku identity budou mít ID prostředků ARM ve formátu: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} '.

Properties

Vlastnosti spravovaného clusteru Cassandra.

Name Type Description
authenticationMethod

Jakou metodu ověřování Cassandra by měl použít k ověřování klientů. Možnost žádné vypne ověřování, takže by se neměla používat s výjimkou případů nouze. ' Cassandra ' je výchozí ověřování založené na heslech. Výchozí hodnota je ' Cassandra '.

cassandraVersion
  • string

Jakou verzi Cassandra by měl tento cluster konvergovat (např. 3,11). Když se aktualizace aktualizuje, může trvat nějakou dobu, než se migruje na novou verzi.

clientCertificates

Seznam certifikátů TLS používaných k autorizaci klientů připojujících se ke clusteru. Všechna připojení jsou šifrovaná, ať už je vlastnost ClientCertificates nastavená nebo ne, ale pokud je nastavená možnost vlastnost ClientCertificates, bude spravovaný cluster Cassandra odmítat všechna připojení, která nenesou certifikát klienta TLS, který se dá ověřit z jednoho nebo více veřejných certifikátů v této vlastnosti.

clusterNameOverride
  • string

Pokud potřebujete nastavit vlastnost název_clusteru v Cassandra. yaml na něco kromě názvu prostředku clusteru, nastavte hodnotu, která se má pro tuto vlastnost použít.

delegatedManagementSubnetId
  • string

ID prostředku podsítě, ke které má služba správy tohoto clusteru být připojená vaše síťové rozhraní. Podsíť musí být směrovatelný do všech podsítí, které budou delegovány na datová centra. ID prostředku musí být ve formátu '/Subscriptions/ /ResourceGroups/ /providers/Microsoft.Network/virtualNetworks/ /subnets/ '

externalGossipCertificates

Seznam certifikátů TLS používaných k autorizaci Gossip z nespravovaných datových center. Certifikáty TLS všech uzlů v nespravovaných datových centrech musí být možné ověřit pomocí jednoho z certifikátů uvedených v této vlastnosti.

externalSeedNodes

Seznam IP adres počátečních uzlů v nespravovaných datových centrech. Ty se přidají do seznamu uzlů počáteční hodnoty všech spravovaných uzlů.

gossipCertificates

Seznam certifikátů TLS, které nespravované uzly musí důvěřovat pro Gossip se spravovanými uzly Všechny spravované uzly budou prezentovat klientské certifikáty TLS, které lze ověřit pomocí jednoho z certifikátů uvedených v této vlastnosti.

hoursBetweenBackups
  • integer

Počet hodin, po které se má čekat, než se zálohuje cluster Chcete-li zakázat zálohování, nastavte tuto vlastnost na hodnotu 0.

initialCassandraAdminPassword
  • string

Počáteční heslo pro klienty připojující se jako správce ke clusteru. Po vytvoření clusteru by se měla změnit. Při získání vrátí hodnotu null. Toto pole platí pouze v případě, že pole authenticationMethod je ' Cassandra '.

prometheusEndpoint

Název hostitele nebo IP adresa, kde je možné dosáhnout koncového bodu Prometheus obsahujícího data o spravovaných uzlech Cassandra.

provisioningState

Stav prostředku v době, kdy byla operace volána.

repairEnabled
  • boolean

Měly by se v tomto clusteru spouštět automatické opravy? Pokud tento parametr vynecháte, má hodnotu true a měla by zůstat nastavena na hodnotu true, pokud nepoužíváte hybridní cluster, ve kterém již vlastní opravy provádíte.

restoreFromBackupId
  • string

Chcete-li vytvořit prázdný cluster, vynechejte toto pole nebo ho nastavte na hodnotu null. Chcete-li obnovit zálohu do nového clusteru, nastavte toto pole na ID prostředku zálohy.

seedNodes

Seznam IP adres uzlů počátečních dat ve spravovaných datových centrech. Ty by měly být přidány do seznamu uzlů počátečního nasazení všech nespravovaných uzlů.

ResourceIdentityType

Typ identity použitý pro prostředek. Typ "SystemAssigned, UserAssigned" zahrnuje implicitně vytvořenou identitu a sadu identit přiřazených uživateli. Typ None odebere ze služby všechny identity.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

SeedNode

Name Type Description
ipAddress
  • string

IP adresa tohoto počátečního uzlu

UserAssignedIdentities

Seznam identit uživatelů přidružených k prostředku Odkazy na klíč uživatele slovníku identity budou mít ID prostředků ARM ve formátu: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} '.

Name Type Description