Database Accounts - Update

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Novedades las propiedades de una cuenta de base de datos de Azure Cosmos DB existente.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string	Nombre de la cuenta de base de datos de Cosmos DB. Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
identity	ManagedServiceIdentity	Identidad del recurso.
location	string	Ubicación del grupo de recursos al que pertenece el recurso.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Propiedades específicas del almacenamiento analítico.
properties.apiProperties	ApiProperties	Propiedades específicas de la API. Actualmente, solo se admite para la API de MongoDB.
properties.backupPolicy	BackupPolicy: PeriodicModeBackupPolicy ContinuousModeBackupPolicy	Objeto que representa la directiva para realizar copias de seguridad en una cuenta.
properties.capabilities	Capability[]	Lista de funcionalidades de Cosmos DB para la cuenta
properties.capacity	Capacity	Objeto que representa todas las propiedades relacionadas con la aplicación de capacidad en una cuenta.
properties.connectorOffer	ConnectorOffer	Tipo de oferta del conector cassandra para la cuenta de C* de base de datos de Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy	Directiva de coherencia de la cuenta de Cosmos DB.
properties.cors	CorsPolicy[]	Directiva de CORS para la cuenta de base de datos de Cosmos DB.
properties.customerManagedKeyStatus	string	Indica el estado de la característica Clave administrada por el cliente en la cuenta. En caso de que haya errores, la propiedad proporciona instrucciones para la solución de problemas.
properties.defaultIdentity	string	La identidad predeterminada para acceder al almacén de claves usado en características como claves administradas por el cliente. Los usuarios deben establecer explícitamente la identidad predeterminada. Puede ser "FirstPartyIdentity", "SystemAssignedIdentity" y mucho más.
properties.disableKeyBasedMetadataWriteAccess	boolean	Deshabilitación de operaciones de escritura en recursos de metadatos (bases de datos, contenedores, rendimiento) a través de claves de cuenta
properties.disableLocalAuth	boolean	No participar en la autenticación local y asegurarse de que solo se puede usar MSI y AAD exclusivamente para la autenticación.
properties.enableAnalyticalStorage	boolean	Marca para indicar si se va a habilitar el análisis de almacenamiento.
properties.enableAutomaticFailover	boolean	Habilita la conmutación automática por error de la región de escritura en el caso poco frecuente de que la región no esté disponible debido a una interrupción. La conmutación automática por error dará lugar a una nueva región de escritura para la cuenta y se elige en función de las prioridades de conmutación por error configuradas para la cuenta.
properties.enableBurstCapacity	boolean	Marca para indicar la habilitación o deshabilitación de la característica de versión preliminar de capacidad de ráfaga en la cuenta
properties.enableCassandraConnector	boolean	Habilita el conector cassandra en la cuenta de C* de Cosmos DB.
properties.enableFreeTier	boolean	Marca para indicar si el nivel gratis está habilitado.
properties.enableMultipleWriteLocations	boolean	Permite que la cuenta escriba en varias ubicaciones.
properties.enablePartitionMerge	boolean	Marca para indicar la habilitación o deshabilitación de la característica De combinación de particiones en la cuenta
properties.ipRules	IpAddressOrRange[]	Lista de IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Marca para indicar si habilitar o deshabilitar Virtual Network reglas de ACL.
properties.keyVaultKeyUri	string	URI del almacén de claves
properties.locations	Location[]	Matriz que contiene las ubicaciones de georeplicación habilitadas para la cuenta de Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion	Indica la versión mínima permitida de Tls. El valor predeterminado es Tls 1.2. Las API de Cassandra y Mongo solo funcionan con Tls 1.2.
properties.networkAclBypass	NetworkAclBypass	Indica qué servicios pueden omitir las comprobaciones de firewall.
properties.networkAclBypassResourceIds	string[]	Matriz que contiene los identificadores de recursos para la omisión de Acl de red para la cuenta de Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess	Indica si se permiten solicitudes de la red pública
properties.virtualNetworkRules	VirtualNetworkRule[]	Lista de Virtual Network reglas de ACL configuradas para la cuenta de Cosmos DB.
tags	object	Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB".

Respuestas

Nombre	Tipo	Description
200 OK	DatabaseAccountGetResults	La operación de actualización de la cuenta de base de datos se completará de forma asincrónica.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	Suplantación de su cuenta de usuario

Ejemplos

CosmosDBDatabaseAccountPatch

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1?api-version=2023-11-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,
    "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,
    "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.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: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
     * CosmosDBDatabaseAccountPatch.json
     */
    /**
     * Sample code: CosmosDBDatabaseAccountPatch.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBDatabaseAccountPatch(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().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)
                .withMinimalTlsVersion(MinimalTlsVersion.TLS).withEnableBurstCapacity(true),
            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="subid",
    )

    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",
                "enableAnalyticalStorage": True,
                "enableBurstCapacity": True,
                "enableFreeTier": False,
                "enablePartitionMerge": True,
                "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: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/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("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDatabaseAccountsClient().BeginUpdate(ctx, "rg1", "ddb1", armcosmos.DatabaseAccountUpdateParameters{
		Identity: &armcosmos.ManagedServiceIdentity{
			Type: to.Ptr(armcosmos.ResourceIdentityTypeSystemAssignedUserAssigned),
			UserAssignedIdentities: map[string]*armcosmos.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
				"/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
			},
		},
		Location: to.Ptr("westus"),
		Properties: &armcosmos.DatabaseAccountUpdateProperties{
			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),
				},
			},
			Capacity: &armcosmos.Capacity{
				TotalThroughputLimit: to.Ptr[int32](2000),
			},
			ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
				DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelBoundedStaleness),
				MaxIntervalInSeconds:    to.Ptr[int32](10),
				MaxStalenessPrefix:      to.Ptr[int64](200),
			},
			DefaultIdentity:         to.Ptr("FirstPartyIdentity"),
			EnableAnalyticalStorage: to.Ptr(true),
			EnableBurstCapacity:     to.Ptr(true),
			EnableFreeTier:          to.Ptr(false),
			EnablePartitionMerge:    to.Ptr(true),
			IPRules: []*armcosmos.IPAddressOrRange{
				{
					IPAddressOrRange: to.Ptr("23.43.230.120"),
				},
				{
					IPAddressOrRange: to.Ptr("110.12.240.0/12"),
				}},
			IsVirtualNetworkFilterEnabled: to.Ptr(true),
			MinimalTLSVersion:             to.Ptr(armcosmos.MinimalTLSVersionTLS),
			NetworkACLBypass:              to.Ptr(armcosmos.NetworkACLBypassAzureServices),
			NetworkACLBypassResourceIDs: []*string{
				to.Ptr("/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName")},
			VirtualNetworkRules: []*armcosmos.VirtualNetworkRule{
				{
					ID:                               to.Ptr("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"),
					IgnoreMissingVNetServiceEndpoint: to.Ptr(false),
				}},
		},
		Tags: map[string]*string{
			"dept": to.Ptr("finance"),
		},
	}, 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.DatabaseAccountGetResults = armcosmos.DatabaseAccountGetResults{
	// 	Name: to.Ptr("ddb1"),
	// 	Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1"),
	// 	Location: to.Ptr("West US"),
	// 	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.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
	// 			"/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armcosmos.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
	// 				ClientID: to.Ptr("fbe75b66-01c5-4f87-a220-233af3270436"),
	// 				PrincipalID: to.Ptr("33e01921-4d64-4f8c-a055-5bdaffd5e33d"),
	// 			},
	// 		},
	// 	},
	// 	Kind: to.Ptr(armcosmos.DatabaseAccountKindGlobalDocumentDB),
	// 	Properties: &armcosmos.DatabaseAccountGetProperties{
	// 		AnalyticalStorageConfiguration: &armcosmos.AnalyticalStorageConfiguration{
	// 			SchemaType: to.Ptr(armcosmos.AnalyticalStorageSchemaTypeWellDefined),
	// 		},
	// 		APIProperties: &armcosmos.APIProperties{
	// 		},
	// 		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),
	// 			},
	// 		},
	// 		Capacity: &armcosmos.Capacity{
	// 			TotalThroughputLimit: to.Ptr[int32](2000),
	// 		},
	// 		ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
	// 			DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelBoundedStaleness),
	// 			MaxIntervalInSeconds: to.Ptr[int32](10),
	// 			MaxStalenessPrefix: to.Ptr[int64](200),
	// 		},
	// 		Cors: []*armcosmos.CorsPolicy{
	// 		},
	// 		DatabaseAccountOfferType: to.Ptr("Standard"),
	// 		DefaultIdentity: to.Ptr("FirstPartyIdentity"),
	// 		DisableKeyBasedMetadataWriteAccess: to.Ptr(false),
	// 		DocumentEndpoint: to.Ptr("https://ddb1.documents.azure.com:443/"),
	// 		EnableAnalyticalStorage: to.Ptr(true),
	// 		EnableBurstCapacity: to.Ptr(true),
	// 		EnableFreeTier: to.Ptr(false),
	// 		EnablePartitionMerge: to.Ptr(true),
	// 		FailoverPolicies: []*armcosmos.FailoverPolicy{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-eastus"),
	// 				LocationName: to.Ptr("East US"),
	// 		}},
	// 		IPRules: []*armcosmos.IPAddressOrRange{
	// 			{
	// 				IPAddressOrRange: to.Ptr("23.43.230.120"),
	// 			},
	// 			{
	// 				IPAddressOrRange: to.Ptr("110.12.240.0/12"),
	// 		}},
	// 		IsVirtualNetworkFilterEnabled: to.Ptr(true),
	// 		KeysMetadata: &armcosmos.DatabaseAccountKeysMetadata{
	// 			PrimaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
	// 			},
	// 			PrimaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
	// 			},
	// 			SecondaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
	// 			},
	// 			SecondaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
	// 			},
	// 		},
	// 		Locations: []*armcosmos.Location{
	// 			{
	// 				DocumentEndpoint: to.Ptr("https://ddb1-eastus.documents.azure.com:443/"),
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-eastus"),
	// 				LocationName: to.Ptr("East US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 		MinimalTLSVersion: to.Ptr(armcosmos.MinimalTLSVersionTLS),
	// 		NetworkACLBypass: to.Ptr(armcosmos.NetworkACLBypassAzureServices),
	// 		NetworkACLBypassResourceIDs: []*string{
	// 			to.Ptr("/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName")},
	// 			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{
	// 							ActionsRequired: to.Ptr("None"),
	// 							Status: to.Ptr("Approved"),
	// 						},
	// 					},
	// 			}},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			ReadLocations: []*armcosmos.Location{
	// 				{
	// 					DocumentEndpoint: to.Ptr("https://ddb1-eastus.documents.azure.com:443/"),
	// 					FailoverPriority: to.Ptr[int32](0),
	// 					ID: to.Ptr("ddb1-eastus"),
	// 					LocationName: to.Ptr("East US"),
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 			}},
	// 			VirtualNetworkRules: []*armcosmos.VirtualNetworkRule{
	// 				{
	// 					ID: to.Ptr("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"),
	// 					IgnoreMissingVNetServiceEndpoint: to.Ptr(false),
	// 			}},
	// 			WriteLocations: []*armcosmos.Location{
	// 				{
	// 					DocumentEndpoint: to.Ptr("https://ddb1-eastus.documents.azure.com:443/"),
	// 					FailoverPriority: to.Ptr[int32](0),
	// 					ID: to.Ptr("ddb1-eastus"),
	// 					LocationName: to.Ptr("East US"),
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 			}},
	// 		},
	// 	}
}

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: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountPatch.json
 */
async function cosmosDbDatabaseAccountPatch() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const updateParameters = {
    analyticalStorageConfiguration: { schemaType: "WellDefined" },
    backupPolicy: {
      type: "Periodic",
      periodicModeProperties: {
        backupIntervalInMinutes: 240,
        backupRetentionIntervalInHours: 720,
        backupStorageRedundancy: "Local",
      },
    },
    capacity: { totalThroughputLimit: 2000 },
    consistencyPolicy: {
      defaultConsistencyLevel: "BoundedStaleness",
      maxIntervalInSeconds: 10,
      maxStalenessPrefix: 200,
    },
    defaultIdentity: "FirstPartyIdentity",
    enableAnalyticalStorage: true,
    enableBurstCapacity: true,
    enableFreeTier: false,
    enablePartitionMerge: true,
    identity: {
      type: "SystemAssigned,UserAssigned",
      userAssignedIdentities: {
        "/subscriptions/fa5fc227A624475eB696Cdd604c735bc/resourceGroups/eu2cgroup/providers/MicrosoftManagedIdentity/userAssignedIdentities/id1":
          {},
      },
    },
    ipRules: [{ ipAddressOrRange: "23.43.230.120" }, { ipAddressOrRange: "110.12.240.0/12" }],
    isVirtualNetworkFilterEnabled: true,
    location: "westus",
    minimalTlsVersion: "Tls",
    networkAclBypass: "AzureServices",
    networkAclBypassResourceIds: [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName",
    ],
    tags: { dept: "finance" },
    virtualNetworkRules: [
      {
        id: "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        ignoreMissingVNetServiceEndpoint: false,
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.databaseAccounts.beginUpdateAndWait(
    resourceGroupName,
    accountName,
    updateParameters,
  );
  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

Sample Response

Status code:

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,
    "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,
    "minimalTlsVersion": "Tls"
  }
}

Definiciones

Nombre	Description
AccountKeyMetadata	Metadatos relacionados con una clave de acceso para una cuenta de base de datos determinada.
AnalyticalStorageConfiguration	Propiedades específicas del almacenamiento analítico.
AnalyticalStorageSchemaType	Describe los tipos de esquema para el almacenamiento analítico.
ApiProperties
BackupPolicyMigrationState	Objeto que representa el estado de la migración entre las directivas de copia de seguridad.
BackupPolicyMigrationStatus	Describe el estado de la migración entre los tipos de directiva de copia de seguridad.
BackupPolicyType	Describe el modo de copias de seguridad.
BackupStorageRedundancy	Enumeración para indicar el tipo de redundancia del almacenamiento de copia de seguridad.
Capability	Objeto de funcionalidad de Cosmos DB
Capacity	Objeto que representa todas las propiedades relacionadas con la aplicación de capacidad en una cuenta.
ConnectorOffer	Tipo de oferta del conector cassandra para la cuenta de base de datos de C* de Cosmos DB.
ConsistencyPolicy	Directiva de coherencia para la cuenta de base de datos de Cosmos DB.
ContinuousModeBackupPolicy	Objeto que representa la directiva de copia de seguridad en modo continuo.
ContinuousModeProperties	Valores de configuración para la copia de seguridad en modo periódico
ContinuousTier	Enumeración para indicar el tipo de nivel de copia de seguridad continua.
CorsPolicy	Directiva de CORS para la cuenta de base de datos de Cosmos DB.
createdByType	Tipo de identidad que creó el recurso.
CreateMode	Enumeración para indicar el modo de creación de la cuenta.
DatabaseAccountGetResults	Una cuenta de base de datos de Azure Cosmos DB.
DatabaseAccountKeysMetadata	Metadatos relacionados con cada clave de acceso de la cuenta de base de datos de Cosmos DB determinada.
DatabaseAccountKind	Indica el tipo de cuenta de base de datos. Esto solo se puede establecer en la creación de la cuenta de base de datos.
DatabaseAccountOfferType	Tipo de oferta para la cuenta de base de datos de Cosmos DB.
DatabaseAccountUpdateParameters	Parámetros para aplicar revisiones a las propiedades de la cuenta de base de datos de Azure Cosmos DB.
DatabaseRestoreResource	Bases de datos específicas para restaurar.
DefaultConsistencyLevel	Los valores de configuración y nivel de coherencia predeterminados de la cuenta de Cosmos DB.
FailoverPolicy	Directiva de conmutación por error de una región determinada de una cuenta de base de datos.
GremlinDatabaseRestoreResource	Bases de datos de Gremlin específicas que se van a restaurar.
IpAddressOrRange	Objeto IpAddressOrRange
Location	Región en la que se implementa la cuenta de base de datos de Azure Cosmos DB.
ManagedServiceIdentity	Identidad del recurso.
MinimalTlsVersion	Indica la versión mínima permitida de Tls. El valor predeterminado es Tls 1.2. Las API de Cassandra y Mongo solo funcionan con Tls 1.2.
NetworkAclBypass	Indica qué servicios pueden omitir las comprobaciones de firewall.
PeriodicModeBackupPolicy	Objeto que representa la directiva de copia de seguridad del modo periódico.
PeriodicModeProperties	Valores de configuración para la copia de seguridad en modo periódico
PrivateEndpointConnection	Una conexión de punto de conexión privado
PrivateEndpointProperty	Punto de conexión privado al que pertenece la conexión.
PrivateLinkServiceConnectionStateProperty	Estado de conexión de la conexión de punto de conexión privado.
PublicNetworkAccess	Indica si se permiten solicitudes de la red pública
ResourceIdentityType	Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned", UserAssigned incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio.
RestoreMode	Describe el modo de restauración.
RestoreParameters	Parámetros para indicar la información sobre la restauración.
ServerVersion	Describe serverVersion de una cuenta de MongoDB.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
UserAssignedIdentities	Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
VirtualNetworkRule	Virtual Network objeto Rule de ACL

AccountKeyMetadata

Metadatos relacionados con una clave de acceso para una cuenta de base de datos determinada.

Nombre	Tipo	Description
generationTime	string	Hora de generación en UTC de la clave en formato ISO-8601. Si falta el valor del objeto, significa que la última regeneración de claves se desencadenó antes de 2022-06-18.

AnalyticalStorageConfiguration

Propiedades específicas del almacenamiento analítico.

Nombre	Tipo	Description
schemaType	AnalyticalStorageSchemaType	Describe los tipos de esquema para el almacenamiento analítico.

AnalyticalStorageSchemaType

Describe los tipos de esquema para el almacenamiento analítico.

Nombre	Tipo	Description
FullFidelity	string
WellDefined	string

ApiProperties

Nombre	Tipo	Description
serverVersion	ServerVersion	Describe serverVersion de una cuenta de MongoDB.

BackupPolicyMigrationState

Objeto que representa el estado de la migración entre las directivas de copia de seguridad.

Nombre	Tipo	Description
startTime	string	Hora en la que se inició la migración de directivas de copia de seguridad (formato ISO-8601).
status	BackupPolicyMigrationStatus	Describe el estado de la migración entre los tipos de directiva de copia de seguridad.
targetType	BackupPolicyType	Describe el tipo de directiva de copia de seguridad de destino de la migración de directivas de copia de seguridad.

BackupPolicyMigrationStatus

Describe el estado de la migración entre los tipos de directiva de copia de seguridad.

Nombre	Tipo	Description
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

Describe el modo de copias de seguridad.

Nombre	Tipo	Description
Continuous	string
Periodic	string

BackupStorageRedundancy

Enumeración para indicar el tipo de redundancia del almacenamiento de copia de seguridad.

Nombre	Tipo	Description
Geo	string
Local	string
Zone	string

Capability

Objeto de funcionalidad de Cosmos DB

Nombre	Tipo	Description
name	string	Nombre de la funcionalidad de Cosmos DB. Por ejemplo, "name": "EnableCassandra". Los valores actuales también incluyen "EnableTable" y "EnableGremlin".

Capacity

Objeto que representa todas las propiedades relacionadas con la aplicación de capacidad en una cuenta.

Nombre	Tipo	Description
totalThroughputLimit	integer	Límite total de rendimiento impuesto en la cuenta. Un valor totalThroughputLimit de 2000 impone un límite estricto de rendimiento máximo que se puede aprovisionar en esa cuenta para ser 2000. Un valor totalThroughputLimit de -1 indica que no hay límites en el aprovisionamiento del rendimiento.

ConnectorOffer

Tipo de oferta del conector cassandra para la cuenta de base de datos de C* de Cosmos DB.

Nombre	Tipo	Description
Small	string

ConsistencyPolicy

Directiva de coherencia para la cuenta de base de datos de Cosmos DB.

Nombre	Tipo	Description
defaultConsistencyLevel	DefaultConsistencyLevel	Los valores de configuración y nivel de coherencia predeterminados de la cuenta de Cosmos DB.
maxIntervalInSeconds	integer	Cuando se usa con el nivel de coherencia obsolescencia limitada, este valor representa la cantidad de tiempo de obsolescencia (en segundos) tolerada. El intervalo aceptado para este valor es 5 - 86400. Obligatorio cuando defaultConsistencyPolicy está establecido en "BoundedStaleness".
maxStalenessPrefix	integer	Cuando se usa con el nivel de coherencia obsolescencia limitada, este valor representa el número de solicitudes obsoletas toleradas. El intervalo aceptado para este valor es de 1 - 2.147.483.647. Obligatorio cuando defaultConsistencyPolicy está establecido en "BoundedStaleness".

ContinuousModeBackupPolicy

Objeto que representa la directiva de copia de seguridad en modo continuo.

Nombre	Tipo	Description
continuousModeProperties	ContinuousModeProperties	Valores de configuración para la copia de seguridad en modo continuo
migrationState	BackupPolicyMigrationState	Objeto que representa el estado de la migración entre las directivas de copia de seguridad.
type	string: Continuous	Describe el modo de copias de seguridad.

ContinuousModeProperties

Valores de configuración para la copia de seguridad en modo periódico

Nombre	Tipo	Description
tier	ContinuousTier	Enumeración para indicar el tipo de modo de copia de seguridad continua

ContinuousTier

Enumeración para indicar el tipo de nivel de copia de seguridad continua.

Nombre	Tipo	Description
Continuous30Days	string
Continuous7Days	string

CorsPolicy

Directiva de CORS para la cuenta de base de datos de Cosmos DB.

Nombre	Tipo	Description
allowedHeaders	string	los encabezados de solicitud que el dominio de origen puede especificar en la solicitud de CORS.
allowedMethods	string	los métodos (verbos de solicitud HTTP) que el dominio de origen puede usar para una solicitud de CORS.
allowedOrigins	string	Los dominios de origen que pueden realizar una solicitud en el servicio a través de CORS.
exposedHeaders	string	los encabezados de respuesta que se pueden enviar en la respuesta a la solicitud de CORS y que el explorador expone al emisor de la solicitud.
maxAgeInSeconds	integer	el tiempo máximo que un explorador debe almacenar en la memoria caché la solicitud preparatoria OPTIONS.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Enumeración para indicar el modo de creación de la cuenta.

Nombre	Tipo	Description
Default	string
Restore	string

DatabaseAccountGetResults

Una cuenta de base de datos de Azure Cosmos DB.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de recurso único del recurso de ARM.
identity	ManagedServiceIdentity		Identidad del recurso.
kind	DatabaseAccountKind	GlobalDocumentDB	Indica el tipo de cuenta de base de datos. Esto solo se puede establecer en la creación de la cuenta de base de datos.
location	string		Ubicación del grupo de recursos al que pertenece el recurso.
name	string		Nombre del recurso de ARM.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Propiedades específicas del almacenamiento analítico.
properties.apiProperties	ApiProperties		Propiedades específicas de la API.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		Objeto que representa la directiva para realizar copias de seguridad en una cuenta.
properties.capabilities	Capability[]		Lista de funcionalidades de Cosmos DB para la cuenta
properties.capacity	Capacity		Objeto que representa todas las propiedades relacionadas con la aplicación de capacidad en una cuenta.
properties.connectorOffer	ConnectorOffer		Tipo de oferta del conector cassandra para la cuenta de C* de base de datos de Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy		Directiva de coherencia para la cuenta de base de datos de Cosmos DB.
properties.cors	CorsPolicy[]		Directiva de CORS para la cuenta de base de datos de Cosmos DB.
properties.createMode	CreateMode	Default	Enumeración para indicar el modo de creación de la cuenta.
properties.customerManagedKeyStatus	string		Indica el estado de la característica Clave administrada por el cliente en la cuenta. En caso de que haya errores, la propiedad proporciona instrucciones para la solución de problemas.
properties.databaseAccountOfferType	DatabaseAccountOfferType		Tipo de oferta para la cuenta de base de datos de Cosmos DB. Valor predeterminado: Estándar.
properties.defaultIdentity	string		La identidad predeterminada para acceder al almacén de claves usado en características como claves administradas por el cliente. Los usuarios deben establecer explícitamente la identidad predeterminada. Puede ser "FirstPartyIdentity", "SystemAssignedIdentity" y mucho más.
properties.disableKeyBasedMetadataWriteAccess	boolean		Deshabilitación de operaciones de escritura en recursos de metadatos (bases de datos, contenedores, rendimiento) a través de claves de cuenta
properties.disableLocalAuth	boolean		No participar en la autenticación local y asegurarse de que solo se puede usar MSI y AAD exclusivamente para la autenticación.
properties.documentEndpoint	string		Punto de conexión de la cuenta de base de datos de Cosmos DB.
properties.enableAnalyticalStorage	boolean		Marca para indicar si se va a habilitar el análisis de almacenamiento.
properties.enableAutomaticFailover	boolean		Habilita la conmutación automática por error de la región de escritura en el caso poco frecuente de que la región no esté disponible debido a una interrupción. La conmutación automática por error dará lugar a una nueva región de escritura para la cuenta y se elige en función de las prioridades de conmutación por error configuradas para la cuenta.
properties.enableBurstCapacity	boolean		Marca para indicar la habilitación o deshabilitación de la característica de versión preliminar de capacidad de ráfaga en la cuenta
properties.enableCassandraConnector	boolean		Habilita el conector cassandra en la cuenta de C* de Cosmos DB.
properties.enableFreeTier	boolean		Marca para indicar si el nivel gratis está habilitado.
properties.enableMultipleWriteLocations	boolean		Permite que la cuenta escriba en varias ubicaciones.
properties.enablePartitionMerge	boolean		Marca para indicar la habilitación o deshabilitación de la característica De combinación de particiones en la cuenta
properties.failoverPolicies	FailoverPolicy[]		Matriz que contiene las regiones ordenadas por sus prioridades de conmutación por error.
properties.instanceId	string		Identificador único asignado a la cuenta de base de datos
properties.ipRules	IpAddressOrRange[]		Lista de IpRules.
properties.isVirtualNetworkFilterEnabled	boolean		Marca para indicar si habilitar o deshabilitar Virtual Network reglas de ACL.
properties.keyVaultKeyUri	string		URI del almacén de claves
properties.keysMetadata	DatabaseAccountKeysMetadata		Objeto que representa los metadatos de las claves de cuenta de la cuenta de Cosmos DB.
properties.locations	Location[]		Matriz que contiene todas las ubicaciones habilitadas para la cuenta de Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion		Indica la versión mínima permitida de Tls. El valor predeterminado es Tls 1.2. Las API de Cassandra y Mongo solo funcionan con Tls 1.2.
properties.networkAclBypass	NetworkAclBypass		Indica qué servicios pueden omitir las comprobaciones de firewall.
properties.networkAclBypassResourceIds	string[]		Matriz que contiene los identificadores de recursos para la omisión de Acl de red para la cuenta de Cosmos DB.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista de Connections de puntos de conexión privados configurados para la cuenta de Cosmos DB.
properties.provisioningState	string		Estado de la cuenta de Cosmos DB en el momento en que se llamó a la operación. El estado puede ser uno de los siguientes. 'Crear': se está creando la cuenta de Cosmos DB. Cuando una cuenta está en estado Crear, solo se devuelven las propiedades que se especifican como entrada para la operación Crear cuenta de Cosmos DB. 'Correcto': la cuenta de Cosmos DB está activa para su uso. "Actualización" : se está actualizando la cuenta de Cosmos DB. "Eliminación" : se está eliminando la cuenta de Cosmos DB. 'Failed': se produjo un error en la creación de la cuenta de Cosmos DB. 'DeletionFailed': se produjo un error en la eliminación de la cuenta de Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess		Indica si se permiten solicitudes de la red pública
properties.readLocations	Location[]		Matriz que contiene las ubicaciones de lectura habilitadas para la cuenta de Cosmos DB.
properties.restoreParameters	RestoreParameters		Parámetros para indicar la información sobre la restauración.
properties.virtualNetworkRules	VirtualNetworkRule[]		Lista de Virtual Network reglas de ACL configuradas para la cuenta de Cosmos DB.
properties.writeLocations	Location[]		Matriz que contiene la ubicación de escritura de la cuenta de Cosmos DB.
systemData	systemData		Metadatos del sistema relacionados con este recurso.
tags	object		Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB".
type	string		Tipo de recurso de Azure.

DatabaseAccountKeysMetadata

Metadatos relacionados con cada clave de acceso de la cuenta de base de datos de Cosmos DB determinada.

Nombre	Tipo	Description
primaryMasterKey	AccountKeyMetadata	Metadatos relacionados con la clave de Read-Write principal de la cuenta de base de datos de Cosmos DB determinada.
primaryReadonlyMasterKey	AccountKeyMetadata	Metadatos relacionados con la clave de Read-Only principal de la cuenta de base de datos de Cosmos DB determinada.
secondaryMasterKey	AccountKeyMetadata	Metadatos relacionados con la clave de Read-Write secundaria de la cuenta de base de datos de Cosmos DB determinada.
secondaryReadonlyMasterKey	AccountKeyMetadata	Metadatos relacionados con la clave de Read-Only secundaria de la cuenta de base de datos de Cosmos DB determinada.

DatabaseAccountKind

Indica el tipo de cuenta de base de datos. Esto solo se puede establecer en la creación de la cuenta de base de datos.

Nombre	Tipo	Description
GlobalDocumentDB	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

Tipo de oferta para la cuenta de base de datos de Cosmos DB.

Nombre	Tipo	Description
Standard	string

DatabaseAccountUpdateParameters

Parámetros para aplicar revisiones a las propiedades de la cuenta de base de datos de Azure Cosmos DB.

Nombre	Tipo	Description
identity	ManagedServiceIdentity	Identidad del recurso.
location	string	Ubicación del grupo de recursos al que pertenece el recurso.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Propiedades específicas del almacenamiento analítico.
properties.apiProperties	ApiProperties	Propiedades específicas de la API. Actualmente, solo se admite para la API de MongoDB.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy	Objeto que representa la directiva para realizar copias de seguridad en una cuenta.
properties.capabilities	Capability[]	Lista de funcionalidades de Cosmos DB para la cuenta
properties.capacity	Capacity	Objeto que representa todas las propiedades relacionadas con la aplicación de capacidad en una cuenta.
properties.connectorOffer	ConnectorOffer	Tipo de oferta del conector cassandra para la cuenta de C* de base de datos de Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy	Directiva de coherencia de la cuenta de Cosmos DB.
properties.cors	CorsPolicy[]	Directiva de CORS para la cuenta de base de datos de Cosmos DB.
properties.customerManagedKeyStatus	string	Indica el estado de la característica Clave administrada por el cliente en la cuenta. En caso de que haya errores, la propiedad proporciona instrucciones para la solución de problemas.
properties.defaultIdentity	string	La identidad predeterminada para acceder al almacén de claves usado en características como claves administradas por el cliente. Los usuarios deben establecer explícitamente la identidad predeterminada. Puede ser "FirstPartyIdentity", "SystemAssignedIdentity" y mucho más.
properties.disableKeyBasedMetadataWriteAccess	boolean	Deshabilitación de operaciones de escritura en recursos de metadatos (bases de datos, contenedores, rendimiento) a través de claves de cuenta
properties.disableLocalAuth	boolean	No participar en la autenticación local y asegurarse de que solo se puede usar MSI y AAD exclusivamente para la autenticación.
properties.enableAnalyticalStorage	boolean	Marca para indicar si se va a habilitar el análisis de almacenamiento.
properties.enableAutomaticFailover	boolean	Habilita la conmutación automática por error de la región de escritura en el caso poco frecuente de que la región no esté disponible debido a una interrupción. La conmutación automática por error dará lugar a una nueva región de escritura para la cuenta y se elige en función de las prioridades de conmutación por error configuradas para la cuenta.
properties.enableBurstCapacity	boolean	Marca para indicar la habilitación o deshabilitación de la característica de versión preliminar de capacidad de ráfaga en la cuenta
properties.enableCassandraConnector	boolean	Habilita el conector cassandra en la cuenta de C* de Cosmos DB.
properties.enableFreeTier	boolean	Marca para indicar si el nivel gratis está habilitado.
properties.enableMultipleWriteLocations	boolean	Permite que la cuenta escriba en varias ubicaciones.
properties.enablePartitionMerge	boolean	Marca para indicar la habilitación o deshabilitación de la característica De combinación de particiones en la cuenta
properties.ipRules	IpAddressOrRange[]	Lista de IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Marca para indicar si habilitar o deshabilitar Virtual Network reglas de ACL.
properties.keyVaultKeyUri	string	URI del almacén de claves
properties.keysMetadata	DatabaseAccountKeysMetadata	Esta propiedad se omite durante la operación de actualización, ya que los metadatos son de solo lectura. El objeto representa los metadatos de las claves de cuenta de la cuenta de Cosmos DB.
properties.locations	Location[]	Matriz que contiene las ubicaciones de georeplicación habilitadas para la cuenta de Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion	Indica la versión mínima permitida de Tls. El valor predeterminado es Tls 1.2. Las API de Cassandra y Mongo solo funcionan con Tls 1.2.
properties.networkAclBypass	NetworkAclBypass	Indica qué servicios pueden omitir las comprobaciones de firewall.
properties.networkAclBypassResourceIds	string[]	Matriz que contiene los identificadores de recursos para la omisión de Acl de red para la cuenta de Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess	Indica si se permiten solicitudes de la red pública
properties.virtualNetworkRules	VirtualNetworkRule[]	Lista de Virtual Network reglas de ACL configuradas para la cuenta de Cosmos DB.
tags	object	Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB".

DatabaseRestoreResource

Bases de datos específicas para restaurar.

Nombre	Tipo	Description
collectionNames	string[]	Los nombres de las colecciones disponibles para restaurar.
databaseName	string	Nombre de la base de datos disponible para restaurar.

DefaultConsistencyLevel

Los valores de configuración y nivel de coherencia predeterminados de la cuenta de Cosmos DB.

Nombre	Tipo	Description
BoundedStaleness	string
ConsistentPrefix	string
Eventual	string
Session	string
Strong	string

FailoverPolicy

Directiva de conmutación por error de una región determinada de una cuenta de base de datos.

Nombre	Tipo	Description
failoverPriority	integer	Prioridad de conmutación por error de la región. Una prioridad de conmutación por error de 0 indica una región de escritura. Valor máximo de una prioridad de conmutación por error = (número total de regiones - 1). Los valores de prioridad de conmutación por error deben ser únicos para cada una de las regiones en las que existe la cuenta de base de datos.
id	string	Identificador único de la región en la que se replica la cuenta de base de datos. Ejemplo: <accountName-locationName>><.
locationName	string	Nombre de la región en la que existe la cuenta de base de datos.

GremlinDatabaseRestoreResource

Bases de datos de Gremlin específicas que se van a restaurar.

Nombre	Tipo	Description
databaseName	string	Nombre de la base de datos de gremlin disponible para la restauración.
graphNames	string[]	Los nombres de los gráficos disponibles para la restauración.

IpAddressOrRange

Objeto IpAddressOrRange

Nombre	Tipo	Description
ipAddressOrRange	string	Una sola dirección IPv4 o un único intervalo de direcciones IPv4 en formato CIDR. Las direcciones IP proporcionadas deben tener un formato correcto y no se pueden incluir en uno de los siguientes intervalos: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, ya que no son aplicables por el filtro de direcciones IP. Ejemplo de entradas válidas: "23.40.210.245" o "23.40.210.0/8".

Location

Región en la que se implementa la cuenta de base de datos de Azure Cosmos DB.

Nombre	Tipo	Description
documentEndpoint	string	Punto de conexión de la región específica. Ejemplo: https://< accountName-locationName.documents.azure.com:443/><>
failoverPriority	integer	Prioridad de conmutación por error de la región. Una prioridad de conmutación por error de 0 indica una región de escritura. Valor máximo de una prioridad de conmutación por error = (número total de regiones - 1). Los valores de prioridad de conmutación por error deben ser únicos para cada una de las regiones en las que existe la cuenta de base de datos.
id	string	Identificador único de la región dentro de la cuenta de base de datos. Ejemplo: <accountName-locationName>><.
isZoneRedundant	boolean	Marca para indicar si esta región es o no una región AvailabilityZone
locationName	string	El nombre de la región.
provisioningState	string	Estado de la cuenta de Cosmos DB en el momento en que se llamó a la operación. El estado puede ser uno de los siguientes. 'Crear': se está creando la cuenta de Cosmos DB. Cuando una cuenta está en estado Crear, solo se devuelven las propiedades que se especifican como entrada para la operación Crear cuenta de Cosmos DB. 'Correcto': la cuenta de Cosmos DB está activa para su uso. "Actualización" : se está actualizando la cuenta de Cosmos DB. "Eliminación" : se está eliminando la cuenta de Cosmos DB. 'Failed': se produjo un error en la creación de la cuenta de Cosmos DB. 'DeletionFailed': se produjo un error en la eliminación de la cuenta de Cosmos DB.

ManagedServiceIdentity

Identidad del recurso.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
tenantId	string	Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
type	ResourceIdentityType	Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned", UserAssigned incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio.
userAssignedIdentities	UserAssignedIdentities	Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

MinimalTlsVersion

Indica la versión mínima permitida de Tls. El valor predeterminado es Tls 1.2. Las API de Cassandra y Mongo solo funcionan con Tls 1.2.

Nombre	Tipo	Description
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

Indica qué servicios pueden omitir las comprobaciones de firewall.

Nombre	Tipo	Description
AzureServices	string
None	string

PeriodicModeBackupPolicy

Objeto que representa la directiva de copia de seguridad del modo periódico.

Nombre	Tipo	Description
migrationState	BackupPolicyMigrationState	Objeto que representa el estado de la migración entre las directivas de copia de seguridad.
periodicModeProperties	PeriodicModeProperties	Valores de configuración para la copia de seguridad en modo periódico
type	string: Periodic	Describe el modo de copias de seguridad.

PeriodicModeProperties

Valores de configuración para la copia de seguridad en modo periódico

Nombre	Tipo	Description
backupIntervalInMinutes	integer	Entero que representa el intervalo en minutos entre dos copias de seguridad
backupRetentionIntervalInHours	integer	Entero que representa el tiempo (en horas) que se conserva cada copia de seguridad.
backupStorageRedundancy	BackupStorageRedundancy	Enumeración para indicar el tipo de residencia de copia de seguridad

PrivateEndpointConnection

Una conexión de punto de conexión privado

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties.groupId	string	Identificador de grupo del punto de conexión privado.
properties.privateEndpoint	PrivateEndpointProperty	Punto de conexión privado al que pertenece la conexión.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Estado de conexión de la conexión de punto de conexión privado.
properties.provisioningState	string	Estado de aprovisionamiento del punto de conexión privado.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Punto de conexión privado al que pertenece la conexión.

Nombre	Tipo	Description
id	string	Identificador de recurso del punto de conexión privado.

PrivateLinkServiceConnectionStateProperty

Estado de conexión de la conexión de punto de conexión privado.

Nombre	Tipo	Description
actionsRequired	string	Cualquier acción que sea necesaria más allá del flujo de trabajo básico (aprobar, rechazar o desconectar)
description	string	Descripción de la conexión del servicio private link.
status	string	Estado de conexión del servicio Private Link.

PublicNetworkAccess

Indica si se permiten solicitudes de la red pública

Nombre	Tipo	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned", UserAssigned incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio.

Nombre	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

Describe el modo de restauración.

Nombre	Tipo	Description
PointInTime	string

RestoreParameters

Parámetros para indicar la información sobre la restauración.

Nombre	Tipo	Description
databasesToRestore	DatabaseRestoreResource[]	Lista de bases de datos específicas disponibles para la restauración.
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	Lista de bases de datos gremlin específicas disponibles para la restauración.
restoreMode	RestoreMode	Describe el modo de restauración.
restoreSource	string	Identificador de la cuenta de base de datos restaurable desde la que se debe iniciar la restauración. Por ejemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Hora a la que se debe restaurar la cuenta (formato ISO-8601).
tablesToRestore	string[]	Lista de tablas específicas disponibles para la restauración.

ServerVersion

Describe serverVersion de una cuenta de MongoDB.

Nombre	Tipo	Description
3.2	string
3.6	string
4.0	string
4.2	string

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

UserAssignedIdentities

Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Nombre	Tipo	Description

VirtualNetworkRule

Virtual Network objeto Rule de ACL

Nombre	Tipo	Description
id	string	Identificador de recurso de una subred, por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint	boolean	Cree una regla de firewall antes de que la red virtual tenga habilitado el punto de conexión de servicio de red virtual.