Database Accounts - Update

Serviço:

Cosmos DB Resource Provider

Versão da API:

2026-03-15

Atualiza as propriedades de uma conta de banco de dados existente do Azure Cosmos DB.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}?api-version=2026-03-15

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nome da conta do banco de dados do Cosmos DB.
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)	O 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	Descrição
identity	ManagedServiceIdentity	Identidade do recurso.
location	string	O local do grupo de recursos ao qual o recurso pertence.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Propriedades específicas de armazenamento analítico.
properties.apiProperties	ApiProperties	Propriedades específicas da API. Atualmente, suportado apenas para a API do MongoDB.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy	O objeto que representa a política para fazer backups em uma conta.
properties.capabilities	Capability[]	Lista de recursos do Cosmos DB para a conta
properties.capacity	Capacity	O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta.
properties.connectorOffer	ConnectorOffer	O conector cassandra oferece o tipo de oferta para a conta C* do banco de dados do Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy	A política de consistência para a conta do Cosmos DB.
properties.cors	CorsPolicy[]	A política CORS para a conta de banco de dados do Cosmos DB.
properties.customerManagedKeyStatus	string	Indica o status do recurso Chave gerenciada pelo cliente na conta. Caso haja erros, a propriedade fornece orientação para solução de problemas.
properties.defaultIdentity	string	A identidade padrão para acessar o cofre de chaves usada em recursos como chaves gerenciadas pelo cliente. A identidade padrão precisa ser definida explicitamente pelos usuários. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais.
properties.defaultPriorityLevel	DefaultPriorityLevel	Enum para indicar o Nível de Prioridade padrão da solicitação para Execução Baseada em Prioridade.
properties.disableKeyBasedMetadataWriteAccess	boolean	Desabilitar operações de gravação em recursos de metadados (bancos de dados, contêineres, taxa de transferência) por meio de chaves de conta
properties.disableLocalAuth	boolean	Desative a autenticação local e garanta que apenas MSI e AAD possam ser usados exclusivamente para autenticação.
properties.enableAnalyticalStorage	boolean	Sinalizador para indicar se a análise de armazenamento deve ser habilitada.
properties.enableAutomaticFailover	boolean	Permite o failover automático da região de gravação no caso raro de a região não estar disponível devido a uma interrupção. O failover automático resultará em uma nova região de gravação para a conta e será escolhido com base nas prioridades de failover configuradas para a conta.
properties.enableBurstCapacity	boolean	Sinalizador para indicar a ativação/desativação do recurso de visualização de capacidade de intermitência na conta
properties.enableCassandraConnector	boolean	Ativa o conector cassandra na conta C* do Cosmos DB
properties.enableFreeTier	boolean	Sinalizador para indicar se o Nível Livre está habilitado.
properties.enableMultipleWriteLocations	boolean	Permite que a conta escreva em vários locais
properties.enablePartitionMerge	boolean	Sinalizador para indicar a ativação/desativação do recurso Mesclagem de Partições na conta
properties.enablePerRegionPerPartitionAutoscale	boolean	Sinalizador para indicar a ativação/desativação de Per-Region recurso de visualização de dimensionamento automático por partição na conta
properties.enablePriorityBasedExecution	boolean	Sinalizador para indicar a ativação/desativação do recurso Visualização de Execução Baseada em Prioridade na conta
properties.enforceHierarchicalPartitionKeyIdLastLevel	boolean	Flag para indicar a habilitação/desativação da aplicação hierárquica da chave de partição ID na conta.
properties.ipRules	IpAddressOrRange[]	Lista de IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Sinalizador para indicar se deve ativar/desativar as regras da Rede Virtual ACL.
properties.keyVaultKeyUri	string	O URI do cofre de chaves
properties.locations	Location[]	Uma matriz que contém os locais de replicação geográfica habilitados para a conta do Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion	Indica a versão mínima permitida do Tls. O padrão é Tls 1.0, exceto para Cassandra e Mongo API's, que só funcionam com Tls 1.2.
properties.networkAclBypass	NetworkAclBypass	Indica quais serviços têm permissão para ignorar as verificações de firewall.
properties.networkAclBypassResourceIds	string[]	Uma matriz que contém as Ids de Recursos para Desvio de Acl de Rede para a conta do Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess	Se as solicitações da Rede Pública são permitidas
properties.virtualNetworkRules	VirtualNetworkRule[]	Lista de regras da Rede Virtual ACL configuradas para a conta do Cosmos DB.
tags	object	As tags são uma lista de pares chave-valor que descrevem o recurso. Essas tags podem ser usadas para visualizar e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 tags podem ser fornecidas para um recurso. Cada tag deve ter uma chave não superior a 128 caracteres e um valor não superior a 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB".

Respostas

Name	Tipo	Descrição
200 OK	DatabaseAccountGetResults	O pedido foi bem-sucedido. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Descrição
user_impersonation	assumir a identidade da sua conta de utilizador

Exemplos

CosmosDBDatabaseAccountPatch

Pedido de amostra

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1?api-version=2026-03-15

{
  "location": "westus",
  "tags": {
    "dept": "finance"
  },
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  },
  "properties": {
    "ipRules": [
      {
        "ipAddressOrRange": "23.43.230.120"
      },
      {
        "ipAddressOrRange": "110.12.240.0/12"
      }
    ],
    "isVirtualNetworkFilterEnabled": true,
    "virtualNetworkRules": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "ignoreMissingVNetServiceEndpoint": false
      }
    ],
    "consistencyPolicy": {
      "defaultConsistencyLevel": "BoundedStaleness",
      "maxIntervalInSeconds": 10,
      "maxStalenessPrefix": 200
    },
    "defaultIdentity": "FirstPartyIdentity",
    "enableFreeTier": false,
    "enableAnalyticalStorage": true,
    "enableBurstCapacity": true,
    "enablePriorityBasedExecution": true,
    "defaultPriorityLevel": "Low",
    "enablePerRegionPerPartitionAutoscale": true,
    "analyticalStorageConfiguration": {
      "schemaType": "WellDefined"
    },
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 720,
        "backupStorageRedundancy": "Local"
      }
    },
    "networkAclBypass": "AzureServices",
    "networkAclBypassResourceIds": [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
    ],
    "capacity": {
      "totalThroughputLimit": 2000
    },
    "enablePartitionMerge": true,
    "enforceHierarchicalPartitionKeyIdLastLevel": false,
    "minimalTlsVersion": "Tls"
  }
}

Java

import com.azure.resourcemanager.cosmos.models.AnalyticalStorageConfiguration;
import com.azure.resourcemanager.cosmos.models.AnalyticalStorageSchemaType;
import com.azure.resourcemanager.cosmos.models.BackupStorageRedundancy;
import com.azure.resourcemanager.cosmos.models.Capacity;
import com.azure.resourcemanager.cosmos.models.ConsistencyPolicy;
import com.azure.resourcemanager.cosmos.models.DatabaseAccountUpdateParameters;
import com.azure.resourcemanager.cosmos.models.DefaultConsistencyLevel;
import com.azure.resourcemanager.cosmos.models.DefaultPriorityLevel;
import com.azure.resourcemanager.cosmos.models.IpAddressOrRange;
import com.azure.resourcemanager.cosmos.models.ManagedServiceIdentity;
import com.azure.resourcemanager.cosmos.models.ManagedServiceIdentityUserAssignedIdentities;
import com.azure.resourcemanager.cosmos.models.MinimalTlsVersion;
import com.azure.resourcemanager.cosmos.models.NetworkAclBypass;
import com.azure.resourcemanager.cosmos.models.PeriodicModeBackupPolicy;
import com.azure.resourcemanager.cosmos.models.PeriodicModeProperties;
import com.azure.resourcemanager.cosmos.models.ResourceIdentityType;
import com.azure.resourcemanager.cosmos.models.VirtualNetworkRule;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for DatabaseAccounts Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-03-15/CosmosDBDatabaseAccountPatch.json
     */
    /**
     * Sample code: CosmosDBDatabaseAccountPatch.
     * 
     * @param manager Entry point to CosmosManager.
     */
    public static void cosmosDBDatabaseAccountPatch(com.azure.resourcemanager.cosmos.CosmosManager manager) {
        manager.serviceClient().getDatabaseAccounts().update("rg1", "ddb1", new DatabaseAccountUpdateParameters()
            .withTags(mapOf("dept", "finance")).withLocation("westus")
            .withIdentity(new ManagedServiceIdentity().withType(ResourceIdentityType.SYSTEM_ASSIGNED_USER_ASSIGNED)
                .withUserAssignedIdentities(mapOf(
                    "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1",
                    new ManagedServiceIdentityUserAssignedIdentities())))
            .withConsistencyPolicy(
                new ConsistencyPolicy().withDefaultConsistencyLevel(DefaultConsistencyLevel.BOUNDED_STALENESS)
                    .withMaxStalenessPrefix(200L).withMaxIntervalInSeconds(10))
            .withIpRules(
                Arrays.asList(new IpAddressOrRange().withIpAddressOrRange("23.43.230.120"),
                    new IpAddressOrRange().withIpAddressOrRange("110.12.240.0/12")))
            .withIsVirtualNetworkFilterEnabled(true)
            .withVirtualNetworkRules(Arrays.asList(new VirtualNetworkRule().withId(
                "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1")
                .withIgnoreMissingVNetServiceEndpoint(false)))
            .withDefaultIdentity("FirstPartyIdentity").withEnableFreeTier(false).withEnableAnalyticalStorage(true)
            .withAnalyticalStorageConfiguration(
                new AnalyticalStorageConfiguration().withSchemaType(AnalyticalStorageSchemaType.WELL_DEFINED))
            .withBackupPolicy(new PeriodicModeBackupPolicy().withPeriodicModeProperties(
                new PeriodicModeProperties().withBackupIntervalInMinutes(240).withBackupRetentionIntervalInHours(720)
                    .withBackupStorageRedundancy(BackupStorageRedundancy.LOCAL)))
            .withNetworkAclBypass(NetworkAclBypass.AZURE_SERVICES)
            .withNetworkAclBypassResourceIds(Arrays.asList(
                "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"))
            .withCapacity(new Capacity().withTotalThroughputLimit(2000)).withEnablePartitionMerge(true)
            .withEnableBurstCapacity(true).withMinimalTlsVersion(MinimalTlsVersion.TLS)
            .withEnablePriorityBasedExecution(true).withDefaultPriorityLevel(DefaultPriorityLevel.LOW)
            .withEnablePerRegionPerPartitionAutoscale(true).withEnforceHierarchicalPartitionKeyIdLastLevel(false),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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_database_account_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="SUBSCRIPTION_ID",
    )

    response = client.database_accounts.begin_update(
        resource_group_name="rg1",
        account_name="ddb1",
        update_parameters={
            "identity": {
                "type": "SystemAssigned,UserAssigned",
                "userAssignedIdentities": {
                    "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
                },
            },
            "location": "westus",
            "properties": {
                "analyticalStorageConfiguration": {"schemaType": "WellDefined"},
                "backupPolicy": {
                    "periodicModeProperties": {
                        "backupIntervalInMinutes": 240,
                        "backupRetentionIntervalInHours": 720,
                        "backupStorageRedundancy": "Local",
                    },
                    "type": "Periodic",
                },
                "capacity": {"totalThroughputLimit": 2000},
                "consistencyPolicy": {
                    "defaultConsistencyLevel": "BoundedStaleness",
                    "maxIntervalInSeconds": 10,
                    "maxStalenessPrefix": 200,
                },
                "defaultIdentity": "FirstPartyIdentity",
                "defaultPriorityLevel": "Low",
                "enableAnalyticalStorage": True,
                "enableBurstCapacity": True,
                "enableFreeTier": False,
                "enablePartitionMerge": True,
                "enablePerRegionPerPartitionAutoscale": True,
                "enablePriorityBasedExecution": True,
                "enforceHierarchicalPartitionKeyIdLastLevel": False,
                "ipRules": [{"ipAddressOrRange": "23.43.230.120"}, {"ipAddressOrRange": "110.12.240.0/12"}],
                "isVirtualNetworkFilterEnabled": True,
                "minimalTlsVersion": "Tls",
                "networkAclBypass": "AzureServices",
                "networkAclBypassResourceIds": [
                    "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
                ],
                "virtualNetworkRules": [
                    {
                        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
                        "ignoreMissingVNetServiceEndpoint": False,
                    }
                ],
            },
            "tags": {"dept": "finance"},
        },
    ).result()
    print(response)


# x-ms-original-file: 2026-03-15/CosmosDBDatabaseAccountPatch.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/v4"
)

// Generated from example definition: 2026-03-15/CosmosDBDatabaseAccountPatch.json
func ExampleDatabaseAccountsClient_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("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDatabaseAccountsClient().BeginUpdate(ctx, "rg1", "ddb1", armcosmos.DatabaseAccountUpdateParameters{
		Location: to.Ptr("westus"),
		Tags: map[string]*string{
			"dept": to.Ptr("finance"),
		},
		Identity: &armcosmos.ManagedServiceIdentity{
			Type: to.Ptr(armcosmos.ResourceIdentityTypeSystemAssignedUserAssigned),
			UserAssignedIdentities: map[string]*armcosmos.ManagedServiceIdentityUserAssignedIdentities{
				"/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
			},
		},
		Properties: &armcosmos.DatabaseAccountUpdateProperties{
			IPRules: []*armcosmos.IPAddressOrRange{
				{
					IPAddressOrRange: to.Ptr("23.43.230.120"),
				},
				{
					IPAddressOrRange: to.Ptr("110.12.240.0/12"),
				},
			},
			IsVirtualNetworkFilterEnabled: to.Ptr(true),
			VirtualNetworkRules: []*armcosmos.VirtualNetworkRule{
				{
					ID:                               to.Ptr("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"),
					IgnoreMissingVNetServiceEndpoint: to.Ptr(false),
				},
			},
			ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
				DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelBoundedStaleness),
				MaxIntervalInSeconds:    to.Ptr[int32](10),
				MaxStalenessPrefix:      to.Ptr[int64](200),
			},
			DefaultIdentity:                      to.Ptr("FirstPartyIdentity"),
			EnableFreeTier:                       to.Ptr(false),
			EnableAnalyticalStorage:              to.Ptr(true),
			EnableBurstCapacity:                  to.Ptr(true),
			EnablePriorityBasedExecution:         to.Ptr(true),
			DefaultPriorityLevel:                 to.Ptr(armcosmos.DefaultPriorityLevelLow),
			EnablePerRegionPerPartitionAutoscale: to.Ptr(true),
			AnalyticalStorageConfiguration: &armcosmos.AnalyticalStorageConfiguration{
				SchemaType: to.Ptr(armcosmos.AnalyticalStorageSchemaTypeWellDefined),
			},
			BackupPolicy: &armcosmos.PeriodicModeBackupPolicy{
				Type: to.Ptr(armcosmos.BackupPolicyTypePeriodic),
				PeriodicModeProperties: &armcosmos.PeriodicModeProperties{
					BackupIntervalInMinutes:        to.Ptr[int32](240),
					BackupRetentionIntervalInHours: to.Ptr[int32](720),
					BackupStorageRedundancy:        to.Ptr(armcosmos.BackupStorageRedundancyLocal),
				},
			},
			NetworkACLBypass: to.Ptr(armcosmos.NetworkACLBypassAzureServices),
			NetworkACLBypassResourceIDs: []*string{
				to.Ptr("/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"),
			},
			Capacity: &armcosmos.Capacity{
				TotalThroughputLimit: to.Ptr[int32](2000),
			},
			EnablePartitionMerge:                       to.Ptr(true),
			EnforceHierarchicalPartitionKeyIDLastLevel: to.Ptr(false),
			MinimalTLSVersion:                          to.Ptr(armcosmos.MinimalTLSVersionTLS),
		},
	}, 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 poll 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 = armcosmos.DatabaseAccountsClientUpdateResponse{
	// 	DatabaseAccountGetResults: armcosmos.DatabaseAccountGetResults{
	// 		ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1"),
	// 		Name: to.Ptr("ddb1"),
	// 		Location: to.Ptr("West US"),
	// 		Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts"),
	// 		Kind: to.Ptr(armcosmos.DatabaseAccountKindGlobalDocumentDB),
	// 		Tags: map[string]*string{
	// 			"dept": to.Ptr("finance"),
	// 		},
	// 		Identity: &armcosmos.ManagedServiceIdentity{
	// 			Type: to.Ptr(armcosmos.ResourceIdentityTypeSystemAssignedUserAssigned),
	// 			PrincipalID: to.Ptr("52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656"),
	// 			TenantID: to.Ptr("33e01921-4d64-4f8c-a055-5bdaffd5e33d"),
	// 			UserAssignedIdentities: map[string]*armcosmos.ManagedServiceIdentityUserAssignedIdentities{
	// 				"/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armcosmos.ManagedServiceIdentityUserAssignedIdentities{
	// 					ClientID: to.Ptr("fbe75b66-01c5-4f87-a220-233af3270436"),
	// 					PrincipalID: to.Ptr("33e01921-4d64-4f8c-a055-5bdaffd5e33d"),
	// 				},
	// 			},
	// 		},
	// 		Properties: &armcosmos.DatabaseAccountGetProperties{
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			DocumentEndpoint: to.Ptr("https://ddb1.documents.azure.com:443/"),
	// 			DatabaseAccountOfferType: to.Ptr("Standard"),
	// 			IPRules: []*armcosmos.IPAddressOrRange{
	// 				{
	// 					IPAddressOrRange: to.Ptr("23.43.230.120"),
	// 				},
	// 				{
	// 					IPAddressOrRange: to.Ptr("110.12.240.0/12"),
	// 				},
	// 			},
	// 			IsVirtualNetworkFilterEnabled: to.Ptr(true),
	// 			DisableKeyBasedMetadataWriteAccess: to.Ptr(false),
	// 			ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
	// 				DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelBoundedStaleness),
	// 				MaxIntervalInSeconds: to.Ptr[int32](10),
	// 				MaxStalenessPrefix: to.Ptr[int64](200),
	// 			},
	// 			WriteLocations: []*armcosmos.Location{
	// 				{
	// 					ID: to.Ptr("ddb1-eastus"),
	// 					LocationName: to.Ptr("East US"),
	// 					DocumentEndpoint: to.Ptr("https://ddb1-eastus.documents.azure.com:443/"),
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 					FailoverPriority: to.Ptr[int32](0),
	// 				},
	// 			},
	// 			ReadLocations: []*armcosmos.Location{
	// 				{
	// 					ID: to.Ptr("ddb1-eastus"),
	// 					LocationName: to.Ptr("East US"),
	// 					DocumentEndpoint: to.Ptr("https://ddb1-eastus.documents.azure.com:443/"),
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 					FailoverPriority: to.Ptr[int32](0),
	// 				},
	// 			},
	// 			Locations: []*armcosmos.Location{
	// 				{
	// 					ID: to.Ptr("ddb1-eastus"),
	// 					LocationName: to.Ptr("East US"),
	// 					DocumentEndpoint: to.Ptr("https://ddb1-eastus.documents.azure.com:443/"),
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 					FailoverPriority: to.Ptr[int32](0),
	// 				},
	// 			},
	// 			FailoverPolicies: []*armcosmos.FailoverPolicy{
	// 				{
	// 					ID: to.Ptr("ddb1-eastus"),
	// 					LocationName: to.Ptr("East US"),
	// 					FailoverPriority: to.Ptr[int32](0),
	// 				},
	// 			},
	// 			VirtualNetworkRules: []*armcosmos.VirtualNetworkRule{
	// 				{
	// 					ID: to.Ptr("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"),
	// 					IgnoreMissingVNetServiceEndpoint: to.Ptr(false),
	// 				},
	// 			},
	// 			PrivateEndpointConnections: []*armcosmos.PrivateEndpointConnection{
	// 				{
	// 					ID: to.Ptr("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1"),
	// 					Properties: &armcosmos.PrivateEndpointConnectionProperties{
	// 						PrivateEndpoint: &armcosmos.PrivateEndpointProperty{
	// 							ID: to.Ptr("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1"),
	// 						},
	// 						PrivateLinkServiceConnectionState: &armcosmos.PrivateLinkServiceConnectionStateProperty{
	// 							Status: to.Ptr("Approved"),
	// 							ActionsRequired: to.Ptr("None"),
	// 						},
	// 					},
	// 				},
	// 			},
	// 			Cors: []*armcosmos.CorsPolicy{
	// 			},
	// 			DefaultIdentity: to.Ptr("FirstPartyIdentity"),
	// 			EnableFreeTier: to.Ptr(false),
	// 			APIProperties: &armcosmos.APIProperties{
	// 			},
	// 			EnableAnalyticalStorage: to.Ptr(true),
	// 			EnableBurstCapacity: to.Ptr(true),
	// 			EnablePriorityBasedExecution: to.Ptr(true),
	// 			DefaultPriorityLevel: to.Ptr(armcosmos.DefaultPriorityLevelLow),
	// 			AnalyticalStorageConfiguration: &armcosmos.AnalyticalStorageConfiguration{
	// 				SchemaType: to.Ptr(armcosmos.AnalyticalStorageSchemaTypeWellDefined),
	// 			},
	// 			BackupPolicy: &armcosmos.PeriodicModeBackupPolicy{
	// 				Type: to.Ptr(armcosmos.BackupPolicyTypePeriodic),
	// 				PeriodicModeProperties: &armcosmos.PeriodicModeProperties{
	// 					BackupIntervalInMinutes: to.Ptr[int32](240),
	// 					BackupRetentionIntervalInHours: to.Ptr[int32](720),
	// 					BackupStorageRedundancy: to.Ptr(armcosmos.BackupStorageRedundancyLocal),
	// 				},
	// 			},
	// 			NetworkACLBypass: to.Ptr(armcosmos.NetworkACLBypassAzureServices),
	// 			NetworkACLBypassResourceIDs: []*string{
	// 				to.Ptr("/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"),
	// 			},
	// 			Capacity: &armcosmos.Capacity{
	// 				TotalThroughputLimit: to.Ptr[int32](2000),
	// 			},
	// 			KeysMetadata: &armcosmos.DatabaseAccountKeysMetadata{
	// 				PrimaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 					GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11Z"); return t}()),
	// 				},
	// 				SecondaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 					GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11Z"); return t}()),
	// 				},
	// 				PrimaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 					GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11Z"); return t}()),
	// 				},
	// 				SecondaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 					GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11Z"); return t}()),
	// 				},
	// 			},
	// 			EnablePartitionMerge: to.Ptr(true),
	// 			EnforceHierarchicalPartitionKeyIDLastLevel: to.Ptr(false),
	// 			MinimalTLSVersion: to.Ptr(armcosmos.MinimalTLSVersionTLS),
	// 		},
	// 	},
	// }
}

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");

/**
 * This sample demonstrates how to updates the properties of an existing Azure Cosmos DB database account.
 *
 * @summary updates the properties of an existing Azure Cosmos DB database account.
 * x-ms-original-file: 2026-03-15/CosmosDBDatabaseAccountPatch.json
 */
async function cosmosDBDatabaseAccountPatch() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.databaseAccounts.update("rg1", "ddb1", {
    location: "westus",
    tags: { dept: "finance" },
    identity: {
      type: "SystemAssigned,UserAssigned",
      userAssignedIdentities: {
        "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1":
          {},
      },
    },
    ipRules: [{ ipAddressOrRange: "23.43.230.120" }, { ipAddressOrRange: "110.12.240.0/12" }],
    isVirtualNetworkFilterEnabled: true,
    virtualNetworkRules: [
      {
        id: "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        ignoreMissingVNetServiceEndpoint: false,
      },
    ],
    consistencyPolicy: {
      defaultConsistencyLevel: "BoundedStaleness",
      maxIntervalInSeconds: 10,
      maxStalenessPrefix: 200,
    },
    defaultIdentity: "FirstPartyIdentity",
    enableFreeTier: false,
    enableAnalyticalStorage: true,
    enableBurstCapacity: true,
    enablePriorityBasedExecution: true,
    defaultPriorityLevel: "Low",
    enablePerRegionPerPartitionAutoscale: true,
    analyticalStorageConfiguration: { schemaType: "WellDefined" },
    backupPolicy: {
      type: "Periodic",
      periodicModeProperties: {
        backupIntervalInMinutes: 240,
        backupRetentionIntervalInHours: 720,
        backupStorageRedundancy: "Local",
      },
    },
    networkAclBypass: "AzureServices",
    networkAclBypassResourceIds: [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName",
    ],
    capacity: { totalThroughputLimit: 2000 },
    enablePartitionMerge: true,
    enforceHierarchicalPartitionKeyIdLastLevel: false,
    minimalTlsVersion: "Tls",
  });
  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:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
  "name": "ddb1",
  "location": "West US",
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "kind": "GlobalDocumentDB",
  "tags": {
    "dept": "finance"
  },
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656",
    "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d",
    "userAssignedIdentities": {
      "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "fbe75b66-01c5-4f87-a220-233af3270436",
        "principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d"
      }
    }
  },
  "properties": {
    "provisioningState": "Succeeded",
    "documentEndpoint": "https://ddb1.documents.azure.com:443/",
    "databaseAccountOfferType": "Standard",
    "ipRules": [
      {
        "ipAddressOrRange": "23.43.230.120"
      },
      {
        "ipAddressOrRange": "110.12.240.0/12"
      }
    ],
    "isVirtualNetworkFilterEnabled": true,
    "disableKeyBasedMetadataWriteAccess": false,
    "consistencyPolicy": {
      "defaultConsistencyLevel": "BoundedStaleness",
      "maxIntervalInSeconds": 10,
      "maxStalenessPrefix": 200
    },
    "writeLocations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "readLocations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "locations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "failoverPolicies": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "failoverPriority": 0
      }
    ],
    "virtualNetworkRules": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "ignoreMissingVNetServiceEndpoint": false
      }
    ],
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "actionsRequired": "None"
          }
        }
      }
    ],
    "cors": [],
    "defaultIdentity": "FirstPartyIdentity",
    "enableFreeTier": false,
    "apiProperties": {},
    "enableAnalyticalStorage": true,
    "enableBurstCapacity": true,
    "enablePriorityBasedExecution": true,
    "defaultPriorityLevel": "Low",
    "analyticalStorageConfiguration": {
      "schemaType": "WellDefined"
    },
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 720,
        "backupStorageRedundancy": "Local"
      }
    },
    "networkAclBypass": "AzureServices",
    "networkAclBypassResourceIds": [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
    ],
    "capacity": {
      "totalThroughputLimit": 2000
    },
    "keysMetadata": {
      "primaryMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "secondaryMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "primaryReadonlyMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "secondaryReadonlyMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      }
    },
    "enablePartitionMerge": true,
    "enforceHierarchicalPartitionKeyIdLastLevel": false,
    "minimalTlsVersion": "Tls"
  }
}

Definições

Name	Descrição
AccountKeyMetadata	Os metadados relacionados a uma chave de acesso para uma determinada conta de banco de dados.
AnalyticalStorageConfiguration	Propriedades específicas de armazenamento analítico.
AnalyticalStorageSchemaType	Descreve os tipos de esquema para armazenamento analítico.
ApiProperties
BackupPolicyMigrationState	O objeto que representa o estado da migração entre as políticas de backup.
BackupPolicyMigrationStatus	Descreve o status da migração entre tipos de política de backup.
BackupPolicyType	Descreve o modo de backups.
BackupStorageRedundancy	Enum para indicar o tipo de redundância de armazenamento de backup.
Capability	Objeto de capacidade do Cosmos DB
Capacity	O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta.
ConnectorOffer	O conector cassandra oferece o tipo de oferta para a conta de banco de dados C* do Cosmos DB.
ConsistencyPolicy	A política de consistência para a conta de banco de dados do Cosmos DB.
ContinuousModeBackupPolicy	O objeto que representa a política de backup em modo contínuo.
ContinuousModeProperties	Valores de configuração para backup de modo periódico
ContinuousTier	Enum para indicar o tipo de camada de backup contínuo.
CorsPolicy	A política CORS para a conta de banco de dados do Cosmos DB.
createdByType	O tipo de identidade que criou o recurso.
CreateMode	Enum para indicar o modo de criação da conta.
DatabaseAccountGetResults	Uma conta de banco de dados do Azure Cosmos DB.
DatabaseAccountKeysMetadata	Os metadados relacionados a cada chave de acesso para determinada conta de banco de dados do Cosmos DB.
DatabaseAccountKind	Indica o tipo de conta de banco de dados. Isso só pode ser definido na criação da conta de banco de dados.
DatabaseAccountUpdateParameters	Parâmetros para aplicar patches nas propriedades da conta de banco de dados do Azure Cosmos DB.
DatabaseRestoreResource	Bases de Dados específicas para restaurar.
DefaultConsistencyLevel	O nível de consistência padrão e as definições de configuração da conta do Cosmos DB.
DefaultPriorityLevel	Enum para indicar prioridade padrãoNível de solicitações
ErrorResponse	Resposta de erro.
FailoverPolicy	A política de failover para uma determinada região de uma conta de banco de dados.
GremlinDatabaseRestoreResource	Bancos de dados Gremlin específicos para restaurar.
IpAddressOrRange	Objeto IpAddressOrRange
Location	Uma região na qual a conta de banco de dados do Azure Cosmos DB é implantada.
ManagedServiceIdentity	Identidade do recurso.
ManagedServiceIdentityUserAssignedIdentities
MinimalTlsVersion	Indica a versão mínima permitida do Tls. O padrão é Tls 1.0, exceto para Cassandra e Mongo API's, que só funcionam com Tls 1.2.
NetworkAclBypass	Indica quais serviços têm permissão para ignorar as verificações de firewall.
PeriodicModeBackupPolicy	O objeto que representa a política de backup de modo periódico.
PeriodicModeProperties	Valores de configuração para backup de modo periódico
PrivateEndpointConnection	Uma conexão de ponto de extremidade privada
PrivateEndpointProperty	Ponto de extremidade privado ao qual a conexão pertence.
PrivateLinkServiceConnectionStateProperty	Estado da Conexão da Conexão de Ponto Final Privado.
PublicNetworkAccess	Se as solicitações da Rede Pública são permitidas
ResourceIdentityType	O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço.
RestoreMode	Descreve o modo da restauração.
RestoreParameters	Parâmetros para indicar as informações sobre a restauração.
ServerVersion	Descreve a versão da conta MongoDB.
systemData	Metadados referentes à criação e última modificação do recurso.
VirtualNetworkRule	Objeto de regra de ACL de rede virtual

AccountKeyMetadata

Object

Os metadados relacionados a uma chave de acesso para uma determinada conta de banco de dados.

Name	Tipo	Descrição
generationTime	string (date-time)	Tempo de geração em UTC da chave no formato ISO-8601. Se o valor estiver ausente do objeto, isso significa que a última regeneração de chave foi acionada antes de 2022-06-18.

AnalyticalStorageConfiguration

Object

Propriedades específicas de armazenamento analítico.

Name	Tipo	Descrição
schemaType	AnalyticalStorageSchemaType	Descreve os tipos de esquema para armazenamento analítico.

AnalyticalStorageSchemaType

Enumeração

Descreve os tipos de esquema para armazenamento analítico.

Valor	Descrição
WellDefined
FullFidelity

ApiProperties

Object

Name	Tipo	Descrição
serverVersion	ServerVersion	Descreve a versão da conta MongoDB.

BackupPolicyMigrationState

Object

O objeto que representa o estado da migração entre as políticas de backup.

Name	Tipo	Descrição
startTime	string (date-time)	Momento em que a migração da política de backup foi iniciada (formato ISO-8601).
status	BackupPolicyMigrationStatus	Descreve o status da migração entre tipos de política de backup.
targetType	BackupPolicyType	Descreve o tipo de política de backup de destino da migração da política de backup.

BackupPolicyMigrationStatus

Enumeração

Descreve o status da migração entre tipos de política de backup.

Valor	Descrição
Invalid
InProgress
Completed
Failed

BackupPolicyType

Enumeração

Descreve o modo de backups.

Valor	Descrição
Periodic
Continuous

BackupStorageRedundancy

Enumeração

Enum para indicar o tipo de redundância de armazenamento de backup.

Valor	Descrição
Geo
Local
Zone

Capability

Object

Objeto de capacidade do Cosmos DB

Name	Tipo	Descrição
name	string	Nome do recurso do Cosmos DB. Por exemplo, "nome": "EnableCassandra". Os valores atuais também incluem "EnableTable" e "EnableGremlin".

Capacity

Object

O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta.

Name	Tipo	Descrição
totalThroughputLimit	integer (int32) minimum: -1	O limite de taxa de transferência total imposto à conta. Um totalThroughputLimit de 2000 impõe um limite estrito de taxa de transferência máxima que pode ser provisionado nessa conta para ser 2000. Um totalThroughputLimit de -1 indica que não há limites no provisionamento da taxa de transferência.

ConnectorOffer

Enumeração

O conector cassandra oferece o tipo de oferta para a conta de banco de dados C* do Cosmos DB.

Valor	Descrição
Small

ConsistencyPolicy

Object

A política de consistência para a conta de banco de dados do Cosmos DB.

Name	Tipo	Descrição
defaultConsistencyLevel	DefaultConsistencyLevel	O nível de consistência padrão e as definições de configuração da conta do Cosmos DB.
maxIntervalInSeconds	integer (int32) minimum: 5 maximum: 86400	Quando usado com o nível de consistência Bounded Staleness, esse valor representa a quantidade de tempo de atraso (em segundos) tolerada. O intervalo aceite para este valor é 5 - 86400. Necessário quando defaultConsistencyPolicy está definido como 'BoundedStaleness'.
maxStalenessPrefix	integer (int64) minimum: 1 maximum: 2147483647	Quando usado com o nível de consistência Bounded Staleness, esse valor representa o número de solicitações obsoletas toleradas. O intervalo aceito para este valor é 1 – 2.147.483.647. Necessário quando defaultConsistencyPolicy está definido como 'BoundedStaleness'.

ContinuousModeBackupPolicy

Object

O objeto que representa a política de backup em modo contínuo.

Name	Tipo	Descrição
continuousModeProperties	ContinuousModeProperties	Valores de configuração para backup em modo contínuo
migrationState	BackupPolicyMigrationState	O objeto que representa o estado da migração entre as políticas de backup.
type	string: Continuous	Descreve o modo de backups.

ContinuousModeProperties

Object

Valores de configuração para backup de modo periódico

Name	Tipo	Descrição
tier	ContinuousTier	Enum para indicar o tipo de modo de backup Continuos

ContinuousTier

Enumeração

Enum para indicar o tipo de camada de backup contínuo.

Valor	Descrição
Continuous7Days
Continuous30Days

CorsPolicy

Object

A política CORS para a conta de banco de dados do Cosmos DB.

Name	Tipo	Descrição
allowedHeaders	string	Os cabeçalhos de solicitação que o domínio de origem pode especificar na solicitação CORS.
allowedMethods	string	Os métodos (verbos de solicitação HTTP) que o domínio de origem pode usar para uma solicitação CORS.
allowedOrigins	string	Os domínios de origem que têm permissão para fazer uma solicitação contra o serviço via CORS.
exposedHeaders	string	Os cabeçalhos de resposta que podem ser enviados na resposta à solicitação CORS e expostos pelo navegador ao emissor da solicitação.
maxAgeInSeconds	integer (int64) minimum: 1 maximum: 2147483647	O tempo máximo que um navegador deve armazenar em cache a solicitação OPTIONS de comprovação.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

CreateMode

Enumeração

Enum para indicar o modo de criação da conta.

Valor	Descrição
Default
Restore

DatabaseAccountGetResults

Object

Uma conta de banco de dados do Azure Cosmos DB.

Name	Tipo	Valor predefinido	Descrição
id	string (arm-id)		ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity		Identidade do recurso.
kind	DatabaseAccountKind	GlobalDocumentDB	Indica o tipo de conta de banco de dados. Isso só pode ser definido na criação da conta de banco de dados.
location	string		O local do grupo de recursos ao qual o recurso pertence.
name	string		O nome do recurso
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Propriedades específicas de armazenamento analítico.
properties.apiProperties	ApiProperties		Propriedades específicas da API.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		O objeto que representa a política para fazer backups em uma conta.
properties.capabilities	Capability[]		Lista de recursos do Cosmos DB para a conta
properties.capacity	Capacity		O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta.
properties.connectorOffer	ConnectorOffer		O conector cassandra oferece o tipo de oferta para a conta C* do banco de dados do Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy		A política de consistência para a conta de banco de dados do Cosmos DB.
properties.cors	CorsPolicy[]		A política CORS para a conta de banco de dados do Cosmos DB.
properties.createMode	CreateMode	Default	Enum para indicar o modo de criação da conta.
properties.customerManagedKeyStatus	string		Indica o status do recurso Chave gerenciada pelo cliente na conta. Caso haja erros, a propriedade fornece orientação para solução de problemas.
properties.databaseAccountOfferType	enum: Standard		O tipo de oferta para a conta de banco de dados do Cosmos DB. Valor padrão: Padrão.
properties.defaultIdentity	string		A identidade padrão para acessar o cofre de chaves usada em recursos como chaves gerenciadas pelo cliente. A identidade padrão precisa ser definida explicitamente pelos usuários. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais.
properties.defaultPriorityLevel	DefaultPriorityLevel		Enum para indicar o Nível de Prioridade padrão da solicitação para Execução Baseada em Prioridade.
properties.disableKeyBasedMetadataWriteAccess	boolean		Desabilitar operações de gravação em recursos de metadados (bancos de dados, contêineres, taxa de transferência) por meio de chaves de conta
properties.disableLocalAuth	boolean		Desative a autenticação local e garanta que apenas MSI e AAD possam ser usados exclusivamente para autenticação.
properties.documentEndpoint	string		O ponto de extremidade de conexão para a conta de banco de dados do Cosmos DB.
properties.enableAnalyticalStorage	boolean		Sinalizador para indicar se a análise de armazenamento deve ser habilitada.
properties.enableAutomaticFailover	boolean		Permite o failover automático da região de gravação no caso raro de a região não estar disponível devido a uma interrupção. O failover automático resultará em uma nova região de gravação para a conta e será escolhido com base nas prioridades de failover configuradas para a conta.
properties.enableBurstCapacity	boolean		Sinalizador para indicar a ativação/desativação do recurso de visualização de capacidade de intermitência na conta
properties.enableCassandraConnector	boolean		Ativa o conector cassandra na conta C* do Cosmos DB
properties.enableFreeTier	boolean		Sinalizador para indicar se o Nível Livre está habilitado.
properties.enableMultipleWriteLocations	boolean		Permite que a conta escreva em vários locais
properties.enablePartitionMerge	boolean		Sinalizador para indicar a ativação/desativação do recurso Mesclagem de Partições na conta
properties.enablePerRegionPerPartitionAutoscale	boolean		Sinalizador para indicar a ativação/desativação de Per-Region recurso de visualização de dimensionamento automático por partição na conta
properties.enablePriorityBasedExecution	boolean		Sinalizador para indicar a ativação/desativação do recurso Visualização de Execução Baseada em Prioridade na conta
properties.enforceHierarchicalPartitionKeyIdLastLevel	boolean		Flag para indicar a habilitação/desativação da aplicação hierárquica da chave de partição ID na conta.
properties.failoverPolicies	FailoverPolicy[]		Uma matriz que contém as regiões ordenadas por suas prioridades de failover.
properties.instanceId	string		Um identificador exclusivo atribuído à conta do banco de dados
properties.ipRules	IpAddressOrRange[]		Lista de IpRules.
properties.isVirtualNetworkFilterEnabled	boolean		Sinalizador para indicar se deve ativar/desativar as regras da Rede Virtual ACL.
properties.keyVaultKeyUri	string		O URI do cofre de chaves
properties.keyVaultKeyUriVersion	string		A versão da Chave Gerenciada do Cliente atualmente sendo usada pela conta
properties.keysMetadata	DatabaseAccountKeysMetadata		O objeto que representa os metadados para as chaves de conta da conta do Cosmos DB.
properties.locations	Location[]		Uma matriz que contém todos os locais habilitados para a conta do Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion		Indica a versão mínima permitida do Tls. O padrão é Tls 1.0, exceto para Cassandra e Mongo API's, que só funcionam com Tls 1.2.
properties.networkAclBypass	NetworkAclBypass		Indica quais serviços têm permissão para ignorar as verificações de firewall.
properties.networkAclBypassResourceIds	string[] (arm-id)		Uma matriz que contém as Ids de Recursos para Desvio de Acl de Rede para a conta do Cosmos DB.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista de Conexões de Ponto Final Privadas configuradas para a conta do Cosmos DB.
properties.provisioningState	string		O estado de provisionamento do recurso.
properties.publicNetworkAccess	PublicNetworkAccess		Se as solicitações da Rede Pública são permitidas
properties.readLocations	Location[]		Uma matriz que contém os locais de leitura habilitados para a conta do Cosmos DB.
properties.restoreParameters	RestoreParameters		Parâmetros para indicar as informações sobre a restauração.
properties.virtualNetworkRules	VirtualNetworkRule[]		Lista de regras da Rede Virtual ACL configuradas para a conta do Cosmos DB.
properties.writeLocations	Location[]		Uma matriz que contém o local de gravação para a conta do Cosmos DB.
systemData	systemData		Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object		As tags são uma lista de pares chave-valor que descrevem o recurso. Essas tags podem ser usadas para visualizar e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 tags podem ser fornecidas para um recurso. Cada tag deve ter uma chave não superior a 128 caracteres e um valor não superior a 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB".
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

DatabaseAccountKeysMetadata

Object

Os metadados relacionados a cada chave de acesso para determinada conta de banco de dados do Cosmos DB.

Name	Tipo	Descrição
primaryMasterKey	AccountKeyMetadata	Os metadados relacionados à Chave de Read-Write Primária para a conta de banco de dados do Cosmos DB fornecida.
primaryReadonlyMasterKey	AccountKeyMetadata	Os metadados relacionados à Chave de Read-Only Primária para a conta de banco de dados do Cosmos DB fornecida.
secondaryMasterKey	AccountKeyMetadata	Os metadados relacionados à Secondary Read-Write Key para uma determinada conta de banco de dados do Cosmos DB.
secondaryReadonlyMasterKey	AccountKeyMetadata	Os metadados relacionados à Secondary Read-Only Key para uma determinada conta de banco de dados do Cosmos DB.

DatabaseAccountKind

Enumeração

Indica o tipo de conta de banco de dados. Isso só pode ser definido na criação da conta de banco de dados.

Valor	Descrição
GlobalDocumentDB
MongoDB
Parse

DatabaseAccountUpdateParameters

Object

Parâmetros para aplicar patches nas propriedades da conta de banco de dados do Azure Cosmos DB.

Name	Tipo	Descrição
identity	ManagedServiceIdentity	Identidade do recurso.
location	string	O local do grupo de recursos ao qual o recurso pertence.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Propriedades específicas de armazenamento analítico.
properties.apiProperties	ApiProperties	Propriedades específicas da API. Atualmente, suportado apenas para a API do MongoDB.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy	O objeto que representa a política para fazer backups em uma conta.
properties.capabilities	Capability[]	Lista de recursos do Cosmos DB para a conta
properties.capacity	Capacity	O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta.
properties.connectorOffer	ConnectorOffer	O conector cassandra oferece o tipo de oferta para a conta C* do banco de dados do Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy	A política de consistência para a conta do Cosmos DB.
properties.cors	CorsPolicy[]	A política CORS para a conta de banco de dados do Cosmos DB.
properties.customerManagedKeyStatus	string	Indica o status do recurso Chave gerenciada pelo cliente na conta. Caso haja erros, a propriedade fornece orientação para solução de problemas.
properties.defaultIdentity	string	A identidade padrão para acessar o cofre de chaves usada em recursos como chaves gerenciadas pelo cliente. A identidade padrão precisa ser definida explicitamente pelos usuários. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais.
properties.defaultPriorityLevel	DefaultPriorityLevel	Enum para indicar o Nível de Prioridade padrão da solicitação para Execução Baseada em Prioridade.
properties.disableKeyBasedMetadataWriteAccess	boolean	Desabilitar operações de gravação em recursos de metadados (bancos de dados, contêineres, taxa de transferência) por meio de chaves de conta
properties.disableLocalAuth	boolean	Desative a autenticação local e garanta que apenas MSI e AAD possam ser usados exclusivamente para autenticação.
properties.enableAnalyticalStorage	boolean	Sinalizador para indicar se a análise de armazenamento deve ser habilitada.
properties.enableAutomaticFailover	boolean	Permite o failover automático da região de gravação no caso raro de a região não estar disponível devido a uma interrupção. O failover automático resultará em uma nova região de gravação para a conta e será escolhido com base nas prioridades de failover configuradas para a conta.
properties.enableBurstCapacity	boolean	Sinalizador para indicar a ativação/desativação do recurso de visualização de capacidade de intermitência na conta
properties.enableCassandraConnector	boolean	Ativa o conector cassandra na conta C* do Cosmos DB
properties.enableFreeTier	boolean	Sinalizador para indicar se o Nível Livre está habilitado.
properties.enableMultipleWriteLocations	boolean	Permite que a conta escreva em vários locais
properties.enablePartitionMerge	boolean	Sinalizador para indicar a ativação/desativação do recurso Mesclagem de Partições na conta
properties.enablePerRegionPerPartitionAutoscale	boolean	Sinalizador para indicar a ativação/desativação de Per-Region recurso de visualização de dimensionamento automático por partição na conta
properties.enablePriorityBasedExecution	boolean	Sinalizador para indicar a ativação/desativação do recurso Visualização de Execução Baseada em Prioridade na conta
properties.enforceHierarchicalPartitionKeyIdLastLevel	boolean	Flag para indicar a habilitação/desativação da aplicação hierárquica da chave de partição ID na conta.
properties.ipRules	IpAddressOrRange[]	Lista de IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Sinalizador para indicar se deve ativar/desativar as regras da Rede Virtual ACL.
properties.keyVaultKeyUri	string	O URI do cofre de chaves
properties.keysMetadata	DatabaseAccountKeysMetadata	Essa propriedade é ignorada durante a operação de atualização, pois os metadados são somente leitura. O objeto representa os metadados para as chaves de conta da conta do Cosmos DB.
properties.locations	Location[]	Uma matriz que contém os locais de replicação geográfica habilitados para a conta do Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion	Indica a versão mínima permitida do Tls. O padrão é Tls 1.0, exceto para Cassandra e Mongo API's, que só funcionam com Tls 1.2.
properties.networkAclBypass	NetworkAclBypass	Indica quais serviços têm permissão para ignorar as verificações de firewall.
properties.networkAclBypassResourceIds	string[]	Uma matriz que contém as Ids de Recursos para Desvio de Acl de Rede para a conta do Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess	Se as solicitações da Rede Pública são permitidas
properties.virtualNetworkRules	VirtualNetworkRule[]	Lista de regras da Rede Virtual ACL configuradas para a conta do Cosmos DB.
tags	object	As tags são uma lista de pares chave-valor que descrevem o recurso. Essas tags podem ser usadas para visualizar e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 tags podem ser fornecidas para um recurso. Cada tag deve ter uma chave não superior a 128 caracteres e um valor não superior a 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB".

DatabaseRestoreResource

Object

Bases de Dados específicas para restaurar.

Name	Tipo	Descrição
collectionNames	string[]	Os nomes das coleções disponíveis para restauração.
databaseName	string	O nome do banco de dados disponível para restauração.

DefaultConsistencyLevel

Enumeração

O nível de consistência padrão e as definições de configuração da conta do Cosmos DB.

Valor	Descrição
Eventual
Session
BoundedStaleness
Strong
ConsistentPrefix

DefaultPriorityLevel

Enumeração

Enum para indicar prioridade padrãoNível de solicitações

Valor	Descrição
High
Low

ErrorResponse

Object

Resposta de erro.

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

FailoverPolicy

Object

A política de failover para uma determinada região de uma conta de banco de dados.

Name	Tipo	Descrição
failoverPriority	integer (int32) minimum: 0	A prioridade de failover da região. Uma prioridade de failover de 0 indica uma região de gravação. O valor máximo para uma prioridade de failover = (número total de regiões - 1). Os valores de prioridade de failover devem ser exclusivos para cada uma das regiões nas quais a conta de banco de dados existe.
id	string	O identificador exclusivo da região na qual a conta de banco de dados é replicada. Exemplo: <accountName-locationName><>.
locationName	string	O nome da região na qual a conta de banco de dados existe.

GremlinDatabaseRestoreResource

Object

Bancos de dados Gremlin específicos para restaurar.

Name	Tipo	Descrição
databaseName	string	O nome do banco de dados gremlin disponível para restauração.
graphNames	string[]	Os nomes dos gráficos disponíveis para restauração.

IpAddressOrRange

Object

Objeto IpAddressOrRange

Name	Tipo	Descrição
ipAddressOrRange	string	Um único endereço IPv4 ou um único intervalo de endereços IPv4 no formato CIDR. Os IPs fornecidos devem estar bem formatados e não podem estar contidos em um dos seguintes intervalos: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, uma vez que não são aplicáveis pelo filtro de endereço IP. Exemplo de entradas válidas: "23.40.210.245" ou "23.40.210.0/8".

Location

Object

Uma região na qual a conta de banco de dados do Azure Cosmos DB é implantada.

Name	Tipo	Descrição
documentEndpoint	string	O ponto de extremidade de conexão para a região específica. Exemplo: https://< accountName-locationName.documents.azure.com:443/><>
failoverPriority	integer (int32) minimum: 0	A prioridade de failover da região. Uma prioridade de failover de 0 indica uma região de gravação. O valor máximo para uma prioridade de failover = (número total de regiões - 1). Os valores de prioridade de failover devem ser exclusivos para cada uma das regiões nas quais a conta de banco de dados existe.
id	string	O identificador exclusivo da região na conta do banco de dados. Exemplo: <accountName-locationName><>.
isZoneRedundant	boolean	Sinalizador para indicar se esta região é ou não uma região AvailabilityZone
locationName	string	O nome da região.
provisioningState	string	O estado de provisionamento do recurso.

ManagedServiceIdentity

Object

Identidade do recurso.

Name	Tipo	Descrição
principalId	string	O id principal da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
tenantId	string	A ID do locatário da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
type	ResourceIdentityType	O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço.
userAssignedIdentities	<string,  ManagedServiceIdentityUserAssignedIdentities>	A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ManagedServiceIdentityUserAssignedIdentities

Object

Name	Tipo	Descrição
clientId	string	O ID do cliente da identidade atribuída ao usuário.
principalId	string	O id principal da identidade atribuída ao usuário.

MinimalTlsVersion

Enumeração

Indica a versão mínima permitida do Tls. O padrão é Tls 1.0, exceto para Cassandra e Mongo API's, que só funcionam com Tls 1.2.

Valor	Descrição
Tls
Tls11
Tls12

NetworkAclBypass

Enumeração

Indica quais serviços têm permissão para ignorar as verificações de firewall.

Valor	Descrição
None
AzureServices

PeriodicModeBackupPolicy

Object

O objeto que representa a política de backup de modo periódico.

Name	Tipo	Descrição
migrationState	BackupPolicyMigrationState	O objeto que representa o estado da migração entre as políticas de backup.
periodicModeProperties	PeriodicModeProperties	Valores de configuração para backup de modo periódico
type	string: Periodic	Descreve o modo de backups.

PeriodicModeProperties

Object

Valores de configuração para backup de modo periódico

Name	Tipo	Descrição
backupIntervalInMinutes	integer (int32) minimum: 0	Um inteiro que representa o intervalo em minutos entre dois backups
backupRetentionIntervalInHours	integer (int32) minimum: 0	Um inteiro que representa o tempo (em horas) em que cada backup é retido
backupStorageRedundancy	BackupStorageRedundancy	Enum para indicar o tipo de residência de backup

PrivateEndpointConnection

Object

Uma conexão de ponto de extremidade privada

Name	Tipo	Descrição
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.groupId	string	ID de grupo do ponto de extremidade privado.
properties.privateEndpoint	PrivateEndpointProperty	Ponto de extremidade privado ao qual a conexão pertence.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Estado da Conexão da Conexão de Ponto Final Privado.
properties.provisioningState	string	Estado de provisionamento do ponto de extremidade privado.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Object

Ponto de extremidade privado ao qual a conexão pertence.

Name	Tipo	Descrição
id	string	ID do recurso do ponto de extremidade privado.

PrivateLinkServiceConnectionStateProperty

Object

Estado da Conexão da Conexão de Ponto Final Privado.

Name	Tipo	Descrição
actionsRequired	string	Qualquer ação necessária além do fluxo de trabalho básico (aprovar/rejeitar/desconectar)
description	string	A descrição da conexão do serviço de link privado.
status	string	O status da conexão do serviço de link privado.

PublicNetworkAccess

Enumeração

Se as solicitações da Rede Pública são permitidas

Valor	Descrição
Enabled
Disabled
SecuredByPerimeter

ResourceIdentityType

Enumeração

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço.

Valor	Descrição
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned
None

RestoreMode

Enumeração

Descreve o modo da restauração.

Valor	Descrição
PointInTime

RestoreParameters

Object

Parâmetros para indicar as informações sobre a restauração.

Name	Tipo	Descrição
databasesToRestore	DatabaseRestoreResource[]	Lista de bancos de dados específicos disponíveis para restauração.
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	Lista de bancos de dados gremlin específicos disponíveis para restauração.
restoreMode	RestoreMode	Descreve o modo da restauração.
restoreSource	string	A id da conta de banco de dados restaurável a partir da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft. DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string (date-time)	Tempo para o qual a conta tem de ser restaurada (formato ISO-8601).
restoreWithTtlDisabled	boolean	Especifica se a conta restaurada terá o Time-To-Live desabilitado após a restauração bem-sucedida.
sourceBackupLocation	string	O local de backup de origem para restauração.
tablesToRestore	string[]	Lista de tabelas específicas disponíveis para restauração.

ServerVersion

Enumeração

Descreve a versão da conta MongoDB.

Valor	Descrição
3.2
3.6
4.0
4.2
5.0
6.0
7.0

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Descrição
createdAt	string (date-time)	A marca temporal da criação do recurso (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	A data e hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

VirtualNetworkRule

Object

Objeto de regra de ACL de rede virtual

Name	Tipo	Descrição
id	string (arm-id)	ID de recurso de uma subrede, por exemplo: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft. Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint	boolean	Crie uma regra de firewall antes que a rede virtual tenha o ponto de extremidade do serviço vnet habilitado.