Database Accounts - Update

Referência

Serviço:: Cosmos DB Resource Provider

Versão da API:: 2024-11-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=2024-11-15

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accountName	path	True	string	Nome da conta de banco de dados do Cosmos DB. Padrão Regex: `^[a-z0-9]+(-[a-z0-9]+)*`
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
identity	ManagedServiceIdentity	Identidade do recurso.
location	string	O local do grupo de recursos ao qual o recurso pertence.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Propriedades específicas do armazenamento analítico.
properties.apiProperties	ApiProperties	Propriedades específicas da API. Atualmente, há suporte apenas para a API do MongoDB.
properties.backupPolicy	BackupPolicy: PeriodicModeBackupPolicy ContinuousModeBackupPolicy	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 tipo de oferta do conector do Cassandra para a conta C* do banco de dados do Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy	A política de consistência da 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 diretrizes de solução de problemas.
properties.defaultIdentity	string	A identidade padrão para acessar o cofre de chaves usado 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.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	Opte pela autenticação local e verifique se apenas a MSI e o AAD podem ser usados exclusivamente para autenticação.
properties.enableAnalyticalStorage	boolean	Sinalizar para indicar se a análise de armazenamento deve ser habilitada.
properties.enableAutomaticFailover	boolean	Habilita o failover automático da região de gravação no evento raro em que a região está indisponí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	Sinalizar para indicar a habilitação/desabilitação do recurso capacidade de intermitência na conta
properties.enableCassandraConnector	boolean	Habilita o conector do Cassandra na conta do C* do Cosmos DB
properties.enableFreeTier	boolean	Sinalizar para indicar se a Camada Livre está habilitada.
properties.enableMultipleWriteLocations	boolean	Permite que a conta escreva em vários locais
properties.enablePartitionMerge	boolean	Sinalizar para indicar a habilitação/desabilitação do recurso mesclagem de partição na conta
properties.enablePerRegionPerPartitionAutoscale	boolean	Sinalizador para indicar a habilitação/desabilitação do recurso PerRegionPerPartitionAutoscale na conta
properties.ipRules	IpAddressOrRange[]	Lista de IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Sinalizar para indicar se as regras de ACL da Rede Virtual devem ser habilitadas/desabilitadas.
properties.keyVaultKeyUri	string	O URI do cofre de chaves
properties.locations	Location[]	Uma matriz que contém os locais de georeplicação habilitados para a conta do Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion	Indica a versão mínima de TLS permitida. O valor padrão é Tls 1.2. As APIs cassandra e mongo só funcionam com tls 1.2.
properties.networkAclBypass	NetworkAclBypass	Indica quais serviços têm permissão para ignorar verificações de firewall.
properties.networkAclBypassResourceIds	string[]	Uma matriz que contém as IDs de Recurso para Bypass 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 de ACL de Rede Virtual configuradas para a conta do Cosmos DB.
tags	object	As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas na exibição e agrupamento desse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave não maior que 128 caracteres e o valor não seja maior que 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

Nome	Tipo	Description
200 OK	DatabaseAccountGetResults	A operação de atualização da conta de banco de dados será concluída de forma assíncrona.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	Representar sua conta de usuário

Exemplos

CosmosDBDatabaseAccountPatch

Solicitação de exemplo

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1?api-version=2024-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,
    "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,
    "minimalTlsVersion": "Tls"
  }
}


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/2024-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)
                .withEnablePerRegionPerPartitionAutoscale(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

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,
                "enablePerRegionPerPartitionAutoscale": 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/2024-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

package armcosmos_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ded6306d00ae294c24211e5069c1f56b15ba8ef5/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-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),
			EnablePerRegionPerPartitionAutoscale: 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

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/2024-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,
    enablePerRegionPerPartitionAutoscale: 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

Resposta de exemplo

Código de status:: 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"
  }
}

Definições

Nome	Description
AccountKeyMetadata	Os metadados relacionados a uma chave de acesso para uma determinada conta de banco de dados.
AnalyticalStorageConfiguration	Propriedades específicas do 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	Enumerar para indicar o tipo de redundância de armazenamento de backup.
Capability	Objeto de funcionalidade do Cosmos DB
Capacity	O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta.
ConnectorOffer	O tipo de oferta do conector do Cassandra para a conta de banco de dados do C* do Cosmos DB.
ConsistencyPolicy	A política de consistência da conta de banco de dados do Cosmos DB.
ContinuousModeBackupPolicy	O objeto que representa a política de backup de modo contínuo.
ContinuousModeProperties	Valores de configuração para backup de modo periódico
ContinuousTier	Enumerar 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	Enumerar 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 a conta de banco de dados do Cosmos DB fornecida.
DatabaseAccountKind	Indica o tipo de conta de banco de dados. Isso só pode ser definido na criação da conta de banco de dados.
DatabaseAccountOfferType	O tipo de oferta para a conta de banco de dados do Cosmos DB.
DatabaseAccountUpdateParameters	Parâmetros para corrigir as propriedades da conta de banco de dados do Azure Cosmos DB.
DatabaseRestoreResource	Bancos de dados específicos a serem restaurados.
DefaultConsistencyLevel	O nível de consistência padrão e as configurações da conta do Cosmos DB.
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 a serem restaurados.
IpAddressOrRange	Objeto IpAddressOrRange
Location	Uma região na qual a conta de banco de dados do Azure Cosmos DB é implantada.
ManagedServiceIdentity	Identidade do recurso.
MinimalTlsVersion	Indica a versão mínima de TLS permitida. O valor padrão é Tls 1.2. As APIs cassandra e mongo só funcionam com tls 1.2.
NetworkAclBypass	Indica quais serviços têm permissão para ignorar 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 privado
PrivateEndpointProperty	Ponto de extremidade privado ao qual a conexão pertence.
PrivateLinkServiceConnectionStateProperty	Estado de conexão da conexão de ponto de extremidade 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 'None' removerá 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 do MongoDB.
systemData	Metadados relativos à criação e última modificação do recurso.
UserAssignedIdentities	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 do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
VirtualNetworkRule	Objeto de Regra de ACL de Rede Virtual

AccountKeyMetadata

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

Nome	Tipo	Description
generationTime	string	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 disparada antes de 2022-06-18.

AnalyticalStorageConfiguration

Propriedades específicas do armazenamento analítico.

Nome	Tipo	Description
schemaType	AnalyticalStorageSchemaType	Descreve os tipos de esquema para armazenamento analítico.

AnalyticalStorageSchemaType

Descreve os tipos de esquema para armazenamento analítico.

Nome	Tipo	Description
FullFidelity	string
WellDefined	string

ApiProperties

Nome	Tipo	Description
serverVersion	ServerVersion	Descreve a versão da conta do MongoDB.

BackupPolicyMigrationState

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

Nome	Tipo	Description
startTime	string	Hora 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

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

Nome	Tipo	Description
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

Descreve o modo de backups.

Nome	Tipo	Description
Continuous	string
Periodic	string

BackupStorageRedundancy

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

Nome	Tipo	Description
Geo	string
Local	string
Zone	string

Capability

Objeto de funcionalidade do Cosmos DB

Nome	Tipo	Description
name	string	Nome da funcionalidade do Cosmos DB. Por exemplo, "name": "EnableCassandra". Os valores atuais também incluem "EnableTable" e "EnableGremlin".

Capacity

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

Nome	Tipo	Description
totalThroughputLimit	integer	O limite total de taxa de transferência imposto na conta. Um totalthroughputLimit de 2000 impõe um limite estrito de taxa de transferência máxima que pode ser provisionado nessa conta para 2000. Um totalThroughputLimit de -1 não indica limites de provisionamento de taxa de transferência.

ConnectorOffer

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

Nome	Tipo	Description
Small	string

ConsistencyPolicy

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

Nome	Tipo	Description
defaultConsistencyLevel	DefaultConsistencyLevel	O nível de consistência padrão e as configurações da conta do Cosmos DB.
maxIntervalInSeconds	integer	Quando usado com o nível de consistência de Desatualização Limitada, esse valor representa o tempo de desatualização (em segundos) tolerado. O intervalo aceito para esse valor é de 5 a 86400. Necessário quando defaultConsistencyPolicy é definido como 'BoundedStaleness'.
maxStalenessPrefix	integer	Quando usado com o nível de consistência Desatualização Limitada, esse valor representa o número de solicitações obsoletas toleradas. O intervalo aceito para esse valor é 1 – 2.147.483.647. Necessário quando defaultConsistencyPolicy é definido como 'BoundedStaleness'.

ContinuousModeBackupPolicy

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

Nome	Tipo	Description
continuousModeProperties	ContinuousModeProperties	Valores de configuração para backup de 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

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

Nome	Tipo	Description
tier	ContinuousTier	Enumeração para indicar o tipo de modo de backup contínuo

ContinuousTier

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

Nome	Tipo	Description
Continuous30Days	string
Continuous7Days	string

CorsPolicy

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

Nome	Tipo	Description
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 no serviço por meio do 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	O tempo máximo de tempo que um navegador deve armazenar em cache a solicitação OPTIONS de pré-vôo.

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

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

Nome	Tipo	Description
Default	string
Restore	string

DatabaseAccountGetResults

Uma conta de banco de dados do Azure Cosmos DB.

Nome	Tipo	Valor padrão	Description
id	string		O identificador de recurso exclusivo do recurso do ARM.
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 do ARM.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Propriedades específicas do 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 tipo de oferta do conector do Cassandra para a conta C* do banco de dados do Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy		A política de consistência da 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	Enumerar 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 diretrizes de solução de problemas.
properties.databaseAccountOfferType	DatabaseAccountOfferType		O tipo de oferta para a conta de banco de dados do Cosmos DB. Valor padrão: Standard.
properties.defaultIdentity	string		A identidade padrão para acessar o cofre de chaves usado 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.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		Opte pela autenticação local e verifique se apenas a MSI e o AAD podem ser usados exclusivamente para autenticação.
properties.documentEndpoint	string		O ponto de extremidade de conexão da conta de banco de dados do Cosmos DB.
properties.enableAnalyticalStorage	boolean		Sinalizar para indicar se a análise de armazenamento deve ser habilitada.
properties.enableAutomaticFailover	boolean		Habilita o failover automático da região de gravação no evento raro em que a região está indisponí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		Sinalizar para indicar a habilitação/desabilitação do recurso capacidade de intermitência na conta
properties.enableCassandraConnector	boolean		Habilita o conector do Cassandra na conta do C* do Cosmos DB
properties.enableFreeTier	boolean		Sinalizar para indicar se a Camada Livre está habilitada.
properties.enableMultipleWriteLocations	boolean		Permite que a conta escreva em vários locais
properties.enablePartitionMerge	boolean		Sinalizar para indicar a habilitação/desabilitação do recurso mesclagem de partição na conta
properties.enablePerRegionPerPartitionAutoscale	boolean		Sinalizador para indicar a habilitação/desabilitação do recurso PerRegionPerPartitionAutoscale 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 de banco de dados
properties.ipRules	IpAddressOrRange[]		Lista de IpRules.
properties.isVirtualNetworkFilterEnabled	boolean		Sinalizar para indicar se as regras de ACL da Rede Virtual devem ser habilitadas/desabilitadas.
properties.keyVaultKeyUri	string		O URI do cofre de chaves
properties.keysMetadata	DatabaseAccountKeysMetadata		O objeto que representa os metadados das 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 de TLS permitida. O valor padrão é Tls 1.2. As APIs cassandra e mongo só funcionam com tls 1.2.
properties.networkAclBypass	NetworkAclBypass		Indica quais serviços têm permissão para ignorar verificações de firewall.
properties.networkAclBypassResourceIds	string[]		Uma matriz que contém as IDs de Recurso para Bypass de Acl de Rede para a conta do Cosmos DB.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista de conexões de ponto de extremidade privado configuradas para a conta do Cosmos DB.
properties.provisioningState	string		O status da conta do Cosmos DB no momento em que a operação foi chamada. O status pode ser um dos seguintes. 'Criando' – a conta do Cosmos DB está sendo criada. Quando uma conta está em Criando estado, somente as propriedades especificadas como entrada para a operação de conta Criar Cosmos DB são retornadas. 'Êxito' – a conta do Cosmos DB está ativa para uso. 'Atualizando' – a conta do Cosmos DB está sendo atualizada. 'Excluindo' – a conta do Cosmos DB está sendo excluída. 'Falha' – falha na criação da conta do Cosmos DB. 'DeletionFailed' – falha na exclusão da conta do Cosmos DB.
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 de ACL de Rede Virtual configuradas para a conta do Cosmos DB.
properties.writeLocations	Location[]		Uma matriz que contém o local de gravação da conta do Cosmos DB.
systemData	systemData		Os metadados do sistema relacionados a esse recurso.
tags	object		As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas na exibição e agrupamento desse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave não maior que 128 caracteres e o valor não seja maior que 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 de recurso do Azure.

DatabaseAccountKeysMetadata

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

Nome	Tipo	Description
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 à Chave de Read-Write Secundária para a conta de banco de dados do Cosmos DB fornecida.
secondaryReadonlyMasterKey	AccountKeyMetadata	Os metadados relacionados à Chave de Read-Only Secundária para a conta de banco de dados do Cosmos DB fornecida.

DatabaseAccountKind

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

Nome	Tipo	Description
GlobalDocumentDB	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

O tipo de oferta para a conta de banco de dados do Cosmos DB.

Nome	Tipo	Description
Standard	string

DatabaseAccountUpdateParameters

Parâmetros para corrigir as propriedades da conta de banco de dados do Azure Cosmos DB.

Nome	Tipo	Description
identity	ManagedServiceIdentity	Identidade do recurso.
location	string	O local do grupo de recursos ao qual o recurso pertence.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Propriedades específicas do armazenamento analítico.
properties.apiProperties	ApiProperties	Propriedades específicas da API. Atualmente, há suporte 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 tipo de oferta do conector do Cassandra para a conta C* do banco de dados do Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy	A política de consistência da 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 diretrizes de solução de problemas.
properties.defaultIdentity	string	A identidade padrão para acessar o cofre de chaves usado 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.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	Opte pela autenticação local e verifique se apenas a MSI e o AAD podem ser usados exclusivamente para autenticação.
properties.enableAnalyticalStorage	boolean	Sinalizar para indicar se a análise de armazenamento deve ser habilitada.
properties.enableAutomaticFailover	boolean	Habilita o failover automático da região de gravação no evento raro em que a região está indisponí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	Sinalizar para indicar a habilitação/desabilitação do recurso capacidade de intermitência na conta
properties.enableCassandraConnector	boolean	Habilita o conector do Cassandra na conta do C* do Cosmos DB
properties.enableFreeTier	boolean	Sinalizar para indicar se a Camada Livre está habilitada.
properties.enableMultipleWriteLocations	boolean	Permite que a conta escreva em vários locais
properties.enablePartitionMerge	boolean	Sinalizar para indicar a habilitação/desabilitação do recurso mesclagem de partição na conta
properties.enablePerRegionPerPartitionAutoscale	boolean	Sinalizador para indicar a habilitação/desabilitação do recurso PerRegionPerPartitionAutoscale na conta
properties.ipRules	IpAddressOrRange[]	Lista de IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Sinalizar para indicar se as regras de ACL da Rede Virtual devem ser habilitadas/desabilitadas.
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 das Chaves de Conta da conta do Cosmos DB.
properties.locations	Location[]	Uma matriz que contém os locais de georeplicação habilitados para a conta do Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion	Indica a versão mínima de TLS permitida. O valor padrão é Tls 1.2. As APIs cassandra e mongo só funcionam com tls 1.2.
properties.networkAclBypass	NetworkAclBypass	Indica quais serviços têm permissão para ignorar verificações de firewall.
properties.networkAclBypassResourceIds	string[]	Uma matriz que contém as IDs de Recurso para Bypass 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 de ACL de Rede Virtual configuradas para a conta do Cosmos DB.
tags	object	As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas na exibição e agrupamento desse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave não maior que 128 caracteres e o valor não seja maior que 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

Bancos de dados específicos a serem restaurados.

Nome	Tipo	Description
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

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

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

FailoverPolicy

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

Nome	Tipo	Description
failoverPriority	integer	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

Bancos de Dados Gremlin específicos a serem restaurados.

Nome	Tipo	Description
databaseName	string	O nome do banco de dados gremlin disponível para restauração.
graphNames	string[]	Os nomes dos grafos disponíveis para restauração.

IpAddressOrRange

Objeto IpAddressOrRange

Nome	Tipo	Description
ipAddressOrRange	string	Um único endereço IPv4 ou um único intervalo de endereços IPv4 no formato CIDR. Os IPs fornecidos devem ser bem formatados e não podem ser 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, pois eles 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

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

Nome	Tipo	Description
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	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 dentro da conta de banco de dados. Exemplo: <accountName>–<locationName>.
isZoneRedundant	boolean	Sinalizador para indicar se essa região é ou não uma região de AvailabilityZone
locationName	string	O nome da região.
provisioningState	string	O status da conta do Cosmos DB no momento em que a operação foi chamada. O status pode ser um dos seguintes. 'Criando' – a conta do Cosmos DB está sendo criada. Quando uma conta está em Criando estado, somente as propriedades especificadas como entrada para a operação de conta Criar Cosmos DB são retornadas. 'Êxito' – a conta do Cosmos DB está ativa para uso. 'Atualizando' – a conta do Cosmos DB está sendo atualizada. 'Excluindo' – a conta do Cosmos DB está sendo excluída. 'Falha' – falha na criação da conta do Cosmos DB. 'DeletionFailed' – falha na exclusão da conta do Cosmos DB.

ManagedServiceIdentity

Identidade do recurso.

Nome	Tipo	Description
principalId	string	A ID principal da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.
tenantId	string	A ID do locatário da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo 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 'None' removerá as identidades do serviço.
userAssignedIdentities	UserAssignedIdentities	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 do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

MinimalTlsVersion

Indica a versão mínima de TLS permitida. O valor padrão é Tls 1.2. As APIs cassandra e mongo só funcionam com tls 1.2.

Nome	Tipo	Description
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

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

Nome	Tipo	Description
AzureServices	string
None	string

PeriodicModeBackupPolicy

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

Nome	Tipo	Description
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

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

Nome	Tipo	Description
backupIntervalInMinutes	integer	Um inteiro que representa o intervalo em minutos entre dois backups
backupRetentionIntervalInHours	integer	Um inteiro que representa o tempo (em horas) em que cada backup é mantido
backupStorageRedundancy	BackupStorageRedundancy	Enumeração para indicar o tipo de residência de backup

PrivateEndpointConnection

Uma conexão de ponto de extremidade privado

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.groupId	string	ID do grupo do ponto de extremidade privado.
properties.privateEndpoint	PrivateEndpointProperty	Ponto de extremidade privado ao qual a conexão pertence.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Estado de conexão da conexão de ponto de extremidade privado.
properties.provisioningState	string	Estado de provisionamento do ponto de extremidade privado.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

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

Nome	Tipo	Description
id	string	ID do recurso do ponto de extremidade privado.

PrivateLinkServiceConnectionStateProperty

Estado de conexão da conexão de ponto de extremidade privado.

Nome	Tipo	Description
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

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

Nome	Tipo	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

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 'None' removerá as identidades do serviço.

Nome	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

Descreve o modo da restauração.

Nome	Tipo	Description
PointInTime	string

RestoreParameters

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

Nome	Tipo	Description
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 da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Tempo para o qual a conta precisa ser restaurada (formato ISO-8601).
restoreWithTtlDisabled	boolean	Especifica se a conta restaurada terá o TempoTo-Live desabilitado após a restauração bem-sucedida.
tablesToRestore	string[]	Lista de tabelas específicas disponíveis para restauração.

ServerVersion

Descreve a versão da conta do MongoDB.

Nome	Tipo	Description
3.2	string
3.6	string
4.0	string
4.2	string
5.0	string
6.0	string
7.0	string

systemData

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

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/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.

UserAssignedIdentities

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 do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Nome	Tipo	Description

VirtualNetworkRule

Objeto de Regra de ACL de Rede Virtual

Nome	Tipo	Description
id	string	ID de recurso de uma sub-rede, 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 de serviço da vnet habilitado.

Compartilhar via

Database Accounts - Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

CosmosDBDatabaseAccountPatch

Solicitação de exemplo

Resposta de exemplo

Definições

AccountKeyMetadata

AnalyticalStorageConfiguration

AnalyticalStorageSchemaType

ApiProperties

BackupPolicyMigrationState

BackupPolicyMigrationStatus

BackupPolicyType

BackupStorageRedundancy

Capability

Capacity

ConnectorOffer

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

ContinuousTier

CorsPolicy

createdByType

CreateMode

DatabaseAccountGetResults

DatabaseAccountKeysMetadata

DatabaseAccountKind

DatabaseAccountOfferType

DatabaseAccountUpdateParameters

DatabaseRestoreResource

DefaultConsistencyLevel

FailoverPolicy

GremlinDatabaseRestoreResource

IpAddressOrRange

Location

ManagedServiceIdentity

MinimalTlsVersion

NetworkAclBypass

PeriodicModeBackupPolicy

PeriodicModeProperties

PrivateEndpointConnection

PrivateEndpointProperty

PrivateLinkServiceConnectionStateProperty

PublicNetworkAccess

ResourceIdentityType

RestoreMode

RestoreParameters

ServerVersion

systemData

UserAssignedIdentities

VirtualNetworkRule

Recursos adicionais