Cassandra Data Centers - Update

Serviço:

Cosmos DB Resource Provider

Versão da API:

2025-04-15

Atualize algumas das propriedades de um data center Cassandra gerenciado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
clusterName	path	True	string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$	Nome do cluster Cassandra gerenciado.
dataCenterName	path	True	string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$	Nome do data center em um cluster Cassandra gerenciado.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
properties	Properties	Propriedades de um data center Cassandra gerenciado.

Respostas

Name	Tipo	Description
200 OK	DataCenterResource	Concluído de forma síncrona. Isso só acontecerá se os campos alterados pelo patch não exigirem alterações no cluster Cassandra real, como a edição das tags.
202 Accepted	DataCenterResource	Aceito. A atualização prosseguirá de forma assíncrona.
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	Personificar a sua conta de utilizador

Exemplos

CosmosDBManagedCassandraDataCenterUpdate

Pedido de amostra

HTTP

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

{
  "properties": {
    "dataCenterLocation": "West US 2",
    "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1-subnet",
    "nodeCount": 9,
    "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA="
  }
}

Java

import com.azure.resourcemanager.cosmos.fluent.models.DataCenterResourceInner;
import com.azure.resourcemanager.cosmos.models.DataCenterResourceProperties;

/**
 * Samples for CassandraDataCenters Update.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBManagedCassandraDataCenterPatch.json
     */
    /**
     * Sample code: CosmosDBManagedCassandraDataCenterUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBManagedCassandraDataCenterUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getCassandraDataCenters().update("cassandra-prod-rg",
            "cassandra-prod", "dc1",
            new DataCenterResourceInner().withProperties(new DataCenterResourceProperties()
                .withDataCenterLocation("West US 2")
                .withDelegatedSubnetId(
                    "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1-subnet")
                .withNodeCount(9).withBase64EncodedCassandraYamlFragment("fakeTokenPlaceholder")),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_managed_cassandra_data_center_patch.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.cassandra_data_centers.begin_update(
        resource_group_name="cassandra-prod-rg",
        cluster_name="cassandra-prod",
        data_center_name="dc1",
        body={
            "properties": {
                "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=",
                "dataCenterLocation": "West US 2",
                "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1-subnet",
                "nodeCount": 9,
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBManagedCassandraDataCenterPatch.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/011ecc5633300a5eefe43dde748f269d39e96458/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBManagedCassandraDataCenterPatch.json
func ExampleCassandraDataCentersClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewCassandraDataCentersClient().BeginUpdate(ctx, "cassandra-prod-rg", "cassandra-prod", "dc1", armcosmos.DataCenterResource{
		Properties: &armcosmos.DataCenterResourceProperties{
			Base64EncodedCassandraYamlFragment: to.Ptr("Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA="),
			DataCenterLocation:                 to.Ptr("West US 2"),
			DelegatedSubnetID:                  to.Ptr("/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1-subnet"),
			NodeCount:                          to.Ptr[int32](9),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DataCenterResource = armcosmos.DataCenterResource{
	// 	Name: to.Ptr("dc1"),
	// 	Type: to.Ptr("Microsoft.DocumentDB/cassandraClusters/dataCenters"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters/dc1"),
	// 	Properties: &armcosmos.DataCenterResourceProperties{
	// 		Base64EncodedCassandraYamlFragment: to.Ptr("Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA="),
	// 		DataCenterLocation: to.Ptr("West US 2"),
	// 		DelegatedSubnetID: to.Ptr("/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1"),
	// 		NodeCount: to.Ptr[int32](9),
	// 		ProvisioningState: to.Ptr(armcosmos.ManagedCassandraProvisioningStateSucceeded),
	// 		SeedNodes: []*armcosmos.SeedNode{
	// 			{
	// 				IPAddress: to.Ptr("192.168.12.2"),
	// 			},
	// 			{
	// 				IPAddress: to.Ptr("192.168.12.3"),
	// 			},
	// 			{
	// 				IPAddress: to.Ptr("192.168.12.4"),
	// 		}},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Update some of the properties of a managed Cassandra data center.
 *
 * @summary Update some of the properties of a managed Cassandra data center.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBManagedCassandraDataCenterPatch.json
 */
async function cosmosDbManagedCassandraDataCenterUpdate() {
  const subscriptionId =
    process.env["COSMOSDB_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "cassandra-prod-rg";
  const clusterName = "cassandra-prod";
  const dataCenterName = "dc1";
  const body = {
    properties: {
      base64EncodedCassandraYamlFragment:
        "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=",
      dataCenterLocation: "West US 2",
      delegatedSubnetId:
        "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1-subnet",
      nodeCount: 9,
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.cassandraDataCenters.beginUpdateAndWait(
    resourceGroupName,
    clusterName,
    dataCenterName,
    body,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus2/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/dataCenters/dc1",
  "name": "dc1",
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "properties": {
    "provisioningState": "Updating",
    "dataCenterLocation": "West US 2",
    "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1",
    "nodeCount": 9,
    "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=",
    "seedNodes": [
      {
        "ipAddress": "192.168.12.2"
      },
      {
        "ipAddress": "192.168.12.3"
      },
      {
        "ipAddress": "192.168.12.4"
      }
    ]
  }
}

Código de estado:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters/dc1",
  "name": "dc1",
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "properties": {
    "provisioningState": "Succeeded",
    "dataCenterLocation": "West US 2",
    "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1",
    "nodeCount": 9,
    "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=",
    "seedNodes": [
      {
        "ipAddress": "192.168.12.2"
      },
      {
        "ipAddress": "192.168.12.3"
      },
      {
        "ipAddress": "192.168.12.4"
      }
    ]
  }
}

Definições

Name	Description
AuthenticationMethod	Qual método de autenticação Cassandra deve usar para autenticar clientes. 'Nenhum' desativa a autenticação, por isso não deve ser usado exceto em emergências. 'Cassandra' é a autenticação padrão baseada em senha. O padrão é 'Cassandra'.
AuthenticationMethodLdapProperties	Propriedades do método de autenticação LDAP. Esta funcionalidade está em pré-visualização.
AzureConnectionType	Como conectar-se aos serviços azure necessários para executar o cluster
CassandraError
Certificate
CloudError	Uma resposta de erro do serviço.
DataCenterResource	Um centro de dados Cassandra gerido.
ErrorResponse	Resposta de erro.
ManagedCassandraProvisioningState	O status do recurso no momento em que a operação foi chamada.
Properties	Propriedades de um cluster Cassandra gerenciado.
SeedNode

AuthenticationMethod

Enumeração

Qual método de autenticação Cassandra deve usar para autenticar clientes. 'Nenhum' desativa a autenticação, por isso não deve ser usado exceto em emergências. 'Cassandra' é a autenticação padrão baseada em senha. O padrão é 'Cassandra'.

Valor	Description
Cassandra
Ldap
None

AuthenticationMethodLdapProperties

Object

Propriedades do método de autenticação LDAP. Esta funcionalidade está em pré-visualização.

Name	Tipo	Description
connectionTimeoutInMs	integer (int32)	Tempo limite para conexão com o servidor LDAP em milissegundos. O padrão é 5000 ms.
searchBaseDistinguishedName	string	Nome distinto do objeto a partir do qual iniciar a pesquisa recursiva de usuários.
searchFilterTemplate	string	Modelo a utilizar na pesquisa. O padrão é (cn=%s) onde %s será substituído pelo nome de usuário usado para fazer login.
serverCertificates	Certificate[]
serverHostname	string	Nome do host do servidor LDAP.
serverPort	integer (int32)	Porta do servidor LDAP.
serviceUserDistinguishedName	string	Nome distinto da conta de usuário de pesquisa, que pode procurar detalhes do usuário na autenticação.
serviceUserPassword	string	Senha do usuário de pesquisa.

AzureConnectionType

Enumeração

Como conectar-se aos serviços azure necessários para executar o cluster

Valor	Description
None
VPN

CassandraError

Object

Name	Tipo	Description
additionalErrorInfo	string	Informações adicionais sobre o erro.
code	string	O código de erro que ocorreu.
message	string	A mensagem do erro.
target	string	O recurso de destino do erro.

Certificate

Object

Name	Tipo	Description
pem	string	Chave pública formatada PEM.

CloudError

Object

Uma resposta de erro do serviço.

Name	Tipo	Description
error	ErrorResponse	Resposta de erro.

DataCenterResource

Object

Um centro de dados Cassandra gerido.

Name	Tipo	Description
id	string	O identificador de recurso exclusivo da conta de banco de dados.
name	string	O nome da conta de banco de dados.
properties	Properties	Propriedades de um data center Cassandra gerenciado.
type	string	O tipo de recurso do Azure.

ErrorResponse

Object

Resposta de erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.

ManagedCassandraProvisioningState

Enumeração

O status do recurso no momento em que a operação foi chamada.

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

Properties

Object

Propriedades de um cluster Cassandra gerenciado.

Name	Tipo	Description
authenticationMethod	AuthenticationMethod	Qual método de autenticação Cassandra deve usar para autenticar clientes. 'Nenhum' desativa a autenticação, por isso não deve ser usado exceto em emergências. 'Cassandra' é a autenticação padrão baseada em senha. O padrão é 'Cassandra'.
azureConnectionMethod	AzureConnectionType	Como conectar-se aos serviços azure necessários para executar o cluster
cassandraAuditLoggingEnabled	boolean	Se o log de auditoria Cassandra está habilitado
cassandraVersion	string	Qual versão do Cassandra esse cluster deve convergir para a execução (por exemplo, 3.11). Quando atualizado, o cluster pode levar algum tempo para migrar para a nova versão.
clientCertificates	Certificate[]	Lista de certificados TLS usados para autorizar clientes que se conectam ao cluster. Todas as conexões são criptografadas TLS, quer clientCertificates esteja definida ou não, mas se clientCertificates estiver definido, o cluster Cassandra gerenciado rejeitará todas as conexões que não possuam um certificado de cliente TLS que possa ser validado a partir de um ou mais certificados públicos nessa propriedade.
clusterNameOverride	string	Se você precisar definir a propriedade clusterName em cassandra.yaml para algo além do nome do recurso do cluster, defina o valor a ser usado nessa propriedade.
deallocated	boolean	Se o cluster e os data centers associados foram deslocalizados.
delegatedManagementSubnetId	string	ID de recurso de uma sub-rede à qual o serviço de gerenciamento desse cluster deve ter sua interface de rede conectada. A sub-rede deve ser roteável para todas as sub-redes que serão delegadas aos data centers. O id do recurso deve ser do formato '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
externalGossipCertificates	Certificate[]	Lista de certificados TLS usados para autorizar fofocas de data centers não gerenciados. Os certificados TLS de todos os nós em data centers não gerenciados devem ser verificáveis usando um dos certificados fornecidos nesta propriedade.
externalSeedNodes	SeedNode[]	Lista de endereços IP de nós de propagação em centros de dados não geridos. Eles serão adicionados às listas de nós de propagação de todos os nós gerenciados.
gossipCertificates	Certificate[]	Lista de certificados TLS nos quais os nós não gerenciados devem confiar para fofocas com nós gerenciados. Todos os nós gerenciados apresentarão certificados de cliente TLS verificáveis usando um dos certificados fornecidos nesta propriedade.
hoursBetweenBackups	integer (int32)	(Preterido) Número de horas de espera entre a realização de um backup do cluster.
initialCassandraAdminPassword	string	Senha inicial para clientes que se conectam como administrador ao cluster. Deve ser alterado após a criação do cluster. Retorna null em GET. Este campo só se aplica quando o campo authenticationMethod é 'Cassandra'.
privateLinkResourceId	string (arm-id)	Se o Método de Conexão for VPN, essa será a ID do recurso de link privado ao qual os datacenters precisam se conectar.
prometheusEndpoint	SeedNode	Nome do host ou endereço IP onde o ponto de extremidade Prometheus contendo dados sobre os nós Cassandra gerenciados pode ser alcançado.
provisionError	CassandraError	Erro relacionado ao provisionamento de recursos.
provisioningState	ManagedCassandraProvisioningState	O status do recurso no momento em que a operação foi chamada.
repairEnabled	boolean	Os reparos automáticos devem ser executados neste cluster? Se omitido, isso é verdade e deve permanecer verdadeiro, a menos que você esteja executando um cluster híbrido onde já esteja fazendo seus próprios reparos.
restoreFromBackupId	string	Para criar um cluster vazio, omita este campo ou defina-o como nulo. Para restaurar um backup em um novo cluster, defina este campo como a id de recurso do backup.
seedNodes	SeedNode[]	Lista de endereços IP de nós semente nos data centers gerenciados. Eles devem ser adicionados às listas de nós de propagação de todos os nós não gerenciados.

SeedNode

Object

Name	Tipo	Description
ipAddress	string	Endereço IP deste nó semente.