Condividi tramite


Cassandra Clusters - Update

Aggiorna alcune delle proprietà di un cluster Cassandra gestito.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}?api-version=2025-04-15

Parametri dell'URI

Nome In Necessario Tipo Descrizione
clusterName
path True

string

minLength: 1
maxLength: 100
pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$

Nome del cluster Cassandra gestito.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.

subscriptionId
path True

string (uuid)

ID della sottoscrizione di destinazione. Il valore deve essere un UUID.

api-version
query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Tipo Descrizione
identity

ManagedCassandraManagedServiceIdentity

Identity for the resource.

location

string

The location of the resource group to which the resource belongs.

properties

Properties

Proprietà di un cluster Cassandra gestito.

tags

object

I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere usati per visualizzare e raggruppare questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non maggiore di 128 caratteri e un valore non maggiore di 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB".

Risposte

Nome Tipo Descrizione
200 OK

ClusterResource

Completata in modo sincrono. Ciò si verifica solo se i campi modificati da patch non richiedono modifiche al data center Cassandra effettivo.

202 Accepted

ClusterResource

Il cluster Cassandra gestito viene aggiornato. Eseguire il polling dell'operazione fornita per il completamento.

Other Status Codes

CloudError

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation Rappresentare l'account utente

Esempio

CosmosDBManagedCassandraClusterPatch

Esempio di richiesta

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod?api-version=2025-04-15

{
  "tags": {
    "owner": "mike"
  },
  "properties": {
    "externalSeedNodes": [
      {
        "ipAddress": "10.52.221.2"
      },
      {
        "ipAddress": "10.52.221.3"
      },
      {
        "ipAddress": "10.52.221.4"
      }
    ],
    "externalGossipCertificates": [
      {
        "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----"
      }
    ],
    "hoursBetweenBackups": 12,
    "authenticationMethod": "None"
  }
}

Risposta di esempio

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus/operationsStatus/318653d0-3da5-4814-b8f6-429f2af0b2a4?api-version=2025-04-15
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod",
  "name": "cassandra-prod",
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "location": "West US",
  "tags": {
    "owner": "mike"
  },
  "properties": {
    "provisioningState": "Updating",
    "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-----"
      }
    ]
  }
}
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod",
  "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-----"
      }
    ]
  }
}

Definizioni

Nome Descrizione
AuthenticationMethod

Quale metodo di autenticazione deve usare Cassandra per autenticare i client. "Nessuno" disattiva l'autenticazione, quindi non deve essere usata tranne nelle emergenze. 'Cassandra' è l'autenticazione predefinita basata su password. Il valore predefinito è "Cassandra".

AzureConnectionType

Come connettersi ai servizi di Azure necessari per l'esecuzione del cluster

CassandraError
Certificate
CloudError

Risposta di errore dal servizio.

ClusterResource

Rappresentazione di un cluster Cassandra gestito.

ErrorResponse

Risposta errore.

ManagedCassandraManagedServiceIdentity

Identity for the resource.

ManagedCassandraProvisioningState

Stato della risorsa al momento della chiamata dell'operazione.

ManagedCassandraResourceIdentityType

Tipo di risorsa.

Properties

Proprietà di un cluster Cassandra gestito.

SeedNode

AuthenticationMethod

Quale metodo di autenticazione deve usare Cassandra per autenticare i client. "Nessuno" disattiva l'autenticazione, quindi non deve essere usata tranne nelle emergenze. 'Cassandra' è l'autenticazione predefinita basata su password. Il valore predefinito è "Cassandra".

Valore Descrizione
Cassandra
Ldap
None

AzureConnectionType

Come connettersi ai servizi di Azure necessari per l'esecuzione del cluster

Valore Descrizione
None
VPN

CassandraError

Nome Tipo Descrizione
additionalErrorInfo

string

Informazioni aggiuntive sull'errore.

code

string

Codice di errore che si è verificato.

message

string

Messaggio dell'errore.

target

string

Risorsa di destinazione dell'errore.

Certificate

Nome Tipo Descrizione
pem

string

Chiave pubblica con formattazione PEM.

CloudError

Risposta di errore dal servizio.

Nome Tipo Descrizione
error

ErrorResponse

Risposta errore.

ClusterResource

Rappresentazione di un cluster Cassandra gestito.

Nome Tipo Descrizione
id

string

Identificatore univoco della risorsa arm.

identity

ManagedCassandraManagedServiceIdentity

Identity for the resource.

location

string

The location of the resource group to which the resource belongs.

name

string

Nome della risorsa arm.

properties

Properties

Proprietà di un cluster Cassandra gestito.

tags

object

I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere usati per visualizzare e raggruppare questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non maggiore di 128 caratteri e un valore non maggiore di 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB".

type

string

Tipo di risorsa di Azure.

ErrorResponse

Risposta errore.

Nome Tipo Descrizione
code

string

Codice di errore.

message

string

Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

ManagedCassandraManagedServiceIdentity

Identity for the resource.

Nome Tipo Descrizione
principalId

string

ID oggetto della risorsa di identità.

tenantId

string

ID tenant della risorsa.

type

ManagedCassandraResourceIdentityType

Tipo di risorsa.

ManagedCassandraProvisioningState

Stato della risorsa al momento della chiamata dell'operazione.

Valore Descrizione
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ManagedCassandraResourceIdentityType

Tipo di risorsa.

Valore Descrizione
None
SystemAssigned

Properties

Proprietà di un cluster Cassandra gestito.

Nome Tipo Descrizione
authenticationMethod

AuthenticationMethod

Quale metodo di autenticazione deve usare Cassandra per autenticare i client. "Nessuno" disattiva l'autenticazione, quindi non deve essere usata tranne nelle emergenze. 'Cassandra' è l'autenticazione predefinita basata su password. Il valore predefinito è "Cassandra".

azureConnectionMethod

AzureConnectionType

Come connettersi ai servizi di Azure necessari per l'esecuzione del cluster

cassandraAuditLoggingEnabled

boolean

Indica se la registrazione di controllo cassandra è abilitata

cassandraVersion

string

Quale versione di Cassandra deve convergere per l'esecuzione del cluster (ad esempio, 3.11). Quando viene aggiornato, il cluster potrebbe richiedere del tempo per eseguire la migrazione alla nuova versione.

clientCertificates

Certificate[]

Elenco di certificati TLS usati per autorizzare i client che si connettono al cluster. Tutte le connessioni sono crittografate tramite TLS indipendentemente dal fatto che clientCertificates sia impostato o meno, ma se clientCertificates è impostato, il cluster Cassandra gestito rifiuterà tutte le connessioni che non hanno un certificato client TLS che può essere convalidato da uno o più certificati pubblici in questa proprietà.

clusterNameOverride

string

Se è necessario impostare la proprietà clusterName in cassandra.yaml su un valore diverso dal nome della risorsa del cluster, impostare il valore da usare in questa proprietà.

deallocated

boolean

Indica se il cluster e i data center associati sono stati deallocati.

delegatedManagementSubnetId

string

ID risorsa di una subnet a cui deve essere collegata l'interfaccia di rete del servizio di gestione del cluster. La subnet deve essere instradabile a tutte le subnet che verranno delegate ai data center. L'ID risorsa deve essere nel formato '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'

externalGossipCertificates

Certificate[]

Elenco dei certificati TLS usati per autorizzare gossip da data center non gestiti. I certificati TLS di tutti i nodi nei data center non gestiti devono essere verificabili usando uno dei certificati forniti in questa proprietà.

externalSeedNodes

SeedNode[]

Elenco di indirizzi IP dei nodi di inizializzazione nei data center non gestiti. Questi verranno aggiunti agli elenchi di nodi di inizializzazione di tutti i nodi gestiti.

gossipCertificates

Certificate[]

Elenco di certificati TLS che i nodi non gestiti devono considerare attendibili per gossip con nodi gestiti. Tutti i nodi gestiti presenteranno certificati client TLS verificabili usando uno dei certificati forniti in questa proprietà.

hoursBetweenBackups

integer (int32)

(Deprecato) Numero di ore di attesa tra l'esecuzione di un backup del cluster.

initialCassandraAdminPassword

string

Password iniziale per i client che si connettono come amministratore al cluster. Deve essere modificato dopo la creazione del cluster. Restituisce null in GET. Questo campo si applica solo quando il campo authenticationMethod è 'Cassandra'.

privateLinkResourceId

string (arm-id)

Se il metodo di connessione è VPN, si tratta dell'ID della risorsa di collegamento privato a cui devono connettersi i data center.

prometheusEndpoint

SeedNode

Nome host o indirizzo IP in cui è possibile raggiungere l'endpoint Prometheus contenente dati sui nodi Cassandra gestiti.

provisionError

CassandraError

Errore correlato al provisioning delle risorse.

provisioningState

ManagedCassandraProvisioningState

Stato della risorsa al momento della chiamata dell'operazione.

repairEnabled

boolean

Le riparazioni automatiche devono essere eseguite in questo cluster? Se omesso, questo valore è true e deve rimanere true a meno che non si esegua un cluster ibrido in cui si stanno già eseguendo riparazioni personalizzate.

restoreFromBackupId

string

Per creare un cluster vuoto, omettere questo campo o impostarlo su Null. Per ripristinare un backup in un nuovo cluster, impostare questo campo sull'ID risorsa del backup.

seedNodes

SeedNode[]

Elenco di indirizzi IP dei nodi di inizializzazione nei data center gestiti. Questi nodi devono essere aggiunti agli elenchi di nodi di inizializzazione di tutti i nodi non gestiti.

SeedNode

Nome Tipo Descrizione
ipAddress

string

Indirizzo IP del nodo di inizializzazione.