Database Accounts - Update

서비스:: Cosmos DB Resource Provider

API 버전:: 2025-04-15

기존 Azure Cosmos DB 데이터베이스 계정의 속성을 업데이트합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB 데이터베이스 계정 이름입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
subscriptionId	path	True	string minLength: 1	대상 구독의 ID입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
identity	ManagedServiceIdentity	Identity for the resource.
___location	string	The ___location of the resource group to which the resource belongs.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	분석 스토리지 관련 속성입니다.
properties.apiProperties	ApiProperties	API specific properties. Currently, supported only for MongoDB API.
properties.backupPolicy	BackupPolicy: PeriodicModeBackupPolicy ContinuousModeBackupPolicy	The object representing the policy for taking backups on an account.
properties.capabilities	Capability[]	List of Cosmos DB capabilities for the account
properties.capacity	Capacity	계정의 용량 적용과 관련된 모든 속성을 나타내는 개체입니다.
properties.connectorOffer	ConnectorOffer	The cassandra connector offer type for the Cosmos DB database C* account.
properties.consistencyPolicy	ConsistencyPolicy	The consistency policy for the Cosmos DB account.
properties.cors	CorsPolicy[]	The CORS policy for the Cosmos DB database account.
properties.customerManagedKeyStatus	string	계정의 고객 관리형 키 기능 상태를 나타냅니다. 오류가 있는 경우 속성은 문제 해결 지침을 제공합니다.
properties.defaultIdentity	string	The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
properties.disableKeyBasedMetadataWriteAccess	boolean	Disable write operations on metadata resources (databases, containers, throughput) via account keys
properties.disableLocalAuth	boolean	로컬 인증을 옵트아웃하고 MSI 및 AAD만 인증에만 사용할 수 있는지 확인합니다.
properties.enableAnalyticalStorage	boolean	Flag to indicate whether to enable storage analytics.
properties.enableAutomaticFailover	boolean	Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
properties.enableBurstCapacity	boolean	계정에서 버스트 용량 기능의 사용/사용 안 함을 나타내는 플래그
properties.enableCassandraConnector	boolean	Enables the cassandra connector on the Cosmos DB C* account
properties.enableFreeTier	boolean	Flag to indicate whether Free Tier is enabled.
properties.enableMultipleWriteLocations	boolean	Enables the account to write in multiple locations
properties.enablePartitionMerge	boolean	계정에서 파티션 병합 기능의 사용/사용 안 함을 나타내는 플래그
properties.enablePerRegionPerPartitionAutoscale	boolean	계정에서 PerRegionPerPartitionAutoscale 기능의 사용/사용 안 함을 나타내는 플래그
properties.ipRules	IpAddressOrRange[]	List of IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Flag to indicate whether to enable/disable Virtual Network ACL rules.
properties.keyVaultKeyUri	string	The URI of the key vault
properties.locations	Location[]	An array that contains the georeplication locations enabled for the Cosmos DB account.
properties.minimalTlsVersion	MinimalTlsVersion	허용되는 최소 Tls 버전을 나타냅니다. 기본값은 Tls 1.2입니다. Cassandra 및 Mongo API는 Tls 1.2에서만 작동합니다.
properties.networkAclBypass	NetworkAclBypass	Indicates what services are allowed to bypass firewall checks.
properties.networkAclBypassResourceIds	string[]	An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
properties.publicNetworkAccess	PublicNetworkAccess	Whether requests from Public Network are allowed
properties.virtualNetworkRules	VirtualNetworkRule[]	List of Virtual Network ACL rules configured for the Cosmos DB account.
tags	object	태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 이러한 태그는 리소스 그룹 전체에서 이 리소스를 보고 그룹화할 때 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 키가 128자 이하이고 값이 256자 이하여야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다.

응답

Name	형식	Description
200 OK	DatabaseAccountGetResults	데이터베이스 계정 업데이트 작업이 비동기적으로 완료됩니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정으로 로그인하기

예제

CosmosDBDatabaseAccountPatch

샘플 요청

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1?api-version=2025-04-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/2025-04-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/2025-04-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/011ecc5633300a5eefe43dde748f269d39e96458/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-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");
require("dotenv/config");

/**
 * 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/2025-04-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

샘플 응답

상태 코드:: 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"
  }
}

정의

Name	Description
AccountKeyMetadata	지정된 데이터베이스 계정에 대한 액세스 키와 관련된 메타데이터입니다.
AnalyticalStorageConfiguration	분석 스토리지 관련 속성입니다.
AnalyticalStorageSchemaType	분석 스토리지에 대한 스키마 유형에 대해 설명합니다.
ApiProperties
BackupPolicyMigrationState	백업 정책 간의 마이그레이션 상태를 나타내는 개체입니다.
BackupPolicyMigrationStatus	백업 정책 유형 간의 마이그레이션 상태를 설명합니다.
BackupPolicyType	Describes the mode of backups.
BackupStorageRedundancy	백업 스토리지 중복의 유형을 나타내는 열거형입니다.
Capability	Cosmos DB 기능 개체
Capacity	계정의 용량 적용과 관련된 모든 속성을 나타내는 개체입니다.
ConnectorOffer	Cosmos DB C* 데이터베이스 계정에 대한 cassandra 커넥터 제품 유형입니다.
ConsistencyPolicy	Cosmos DB 데이터베이스 계정에 대한 일관성 정책입니다.
ContinuousModeBackupPolicy	연속 모드 백업 정책을 나타내는 개체입니다.
ContinuousModeProperties	Configuration values for periodic mode backup
ContinuousTier	연속 백업 계층의 유형을 나타내는 열거형입니다.
CorsPolicy	The CORS policy for the Cosmos DB database account.
createdByType	리소스를 만든 ID의 형식입니다.
CreateMode	Enum to indicate the mode of account creation.
DatabaseAccountGetResults	Azure Cosmos DB 데이터베이스 계정.
DatabaseAccountKeysMetadata	지정된 Cosmos DB 데이터베이스 계정에 대한 각 액세스 키와 관련된 메타데이터입니다.
DatabaseAccountKind	Indicates the type of database account. This can only be set at database account creation.
DatabaseAccountOfferType	Cosmos DB 데이터베이스 계정에 대한 제품 유형입니다.
DatabaseAccountUpdateParameters	Azure Cosmos DB 데이터베이스 계정 속성을 패치하기 위한 매개 변수입니다.
DatabaseRestoreResource	복원할 특정 데이터베이스입니다.
DefaultConsistencyLevel	The default consistency level and configuration settings of the Cosmos DB account.
FailoverPolicy	데이터베이스 계정의 지정된 지역에 대한 장애 조치(failover) 정책입니다.
GremlinDatabaseRestoreResource	복원할 특정 Gremlin 데이터베이스입니다.
IpAddressOrRange	IpAddressOrRange 개체
Location	Azure Cosmos DB 데이터베이스 계정이 배포되는 지역입니다.
ManagedServiceIdentity	Identity for the resource.
MinimalTlsVersion	허용되는 최소 Tls 버전을 나타냅니다. 기본값은 Tls 1.2입니다. Cassandra 및 Mongo API는 Tls 1.2에서만 작동합니다.
NetworkAclBypass	Indicates what services are allowed to bypass firewall checks.
PeriodicModeBackupPolicy	주기 모드 백업 정책을 나타내는 개체입니다.
PeriodicModeProperties	Configuration values for periodic mode backup
PrivateEndpointConnection	프라이빗 엔드포인트 연결
PrivateEndpointProperty	Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionStateProperty	Connection State of the Private Endpoint Connection.
PublicNetworkAccess	Whether requests from Public Network are allowed
ResourceIdentityType	The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
RestoreMode	Describes the mode of the restore.
RestoreParameters	Parameters to indicate the information about the restore.
ServerVersion	MongoDB 계정의 버전을 설명합니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
UserAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
VirtualNetworkRule	Virtual Network ACL 규칙 개체

AccountKeyMetadata

Object

지정된 데이터베이스 계정에 대한 액세스 키와 관련된 메타데이터입니다.

Name	형식	Description
generationTime	string (date-time)	키의 UTC 생성 시간(ISO-8601 형식)입니다. 개체에서 값이 누락된 경우 2022-06-18 이전에 마지막 키 다시 생성이 트리거되었음을 의미합니다.

AnalyticalStorageConfiguration

Object

분석 스토리지 관련 속성입니다.

Name	형식	Description
schemaType	AnalyticalStorageSchemaType	분석 스토리지에 대한 스키마 유형에 대해 설명합니다.

AnalyticalStorageSchemaType

열거형

분석 스토리지에 대한 스키마 유형에 대해 설명합니다.

값	Description
FullFidelity
WellDefined

ApiProperties

Object

Name	형식	Description
serverVersion	ServerVersion	MongoDB 계정의 버전을 설명합니다.

BackupPolicyMigrationState

Object

백업 정책 간의 마이그레이션 상태를 나타내는 개체입니다.

Name	형식	Description
startTime	string (date-time)	백업 정책 마이그레이션이 시작된 시간(ISO-8601 형식).
status	BackupPolicyMigrationStatus	백업 정책 유형 간의 마이그레이션 상태를 설명합니다.
targetType	BackupPolicyType	백업 정책 마이그레이션의 대상 백업 정책 유형을 설명합니다.

BackupPolicyMigrationStatus

열거형

백업 정책 유형 간의 마이그레이션 상태를 설명합니다.

값	Description
Completed
Failed
InProgress
Invalid

BackupPolicyType

열거형

Describes the mode of backups.

값	Description
Continuous
Periodic

BackupStorageRedundancy

열거형

백업 스토리지 중복의 유형을 나타내는 열거형입니다.

값	Description
Geo
Local
Zone

Capability

Object

Cosmos DB 기능 개체

Name	형식	Description
name	string	Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".

Capacity

Object

계정의 용량 적용과 관련된 모든 속성을 나타내는 개체입니다.

Name	형식	Description
totalThroughputLimit	integer (int32) minimum: -1	계정에 적용되는 총 처리량 제한입니다. totalThroughputLimit 2000은 해당 계정에 프로비전할 수 있는 최대 처리량의 엄격한 제한을 2000으로 적용합니다. -1 totalThroughputLimit는 처리량 프로비저닝에 제한이 없음을 나타냅니다.

ConnectorOffer

열거형

Cosmos DB C* 데이터베이스 계정에 대한 cassandra 커넥터 제품 유형입니다.

값	Description
Small

ConsistencyPolicy

Object

Cosmos DB 데이터베이스 계정에 대한 일관성 정책입니다.

Name	형식	Description
defaultConsistencyLevel	DefaultConsistencyLevel	The default consistency level and configuration settings of the Cosmos DB account.
maxIntervalInSeconds	integer (int32) minimum: 5 maximum: 86400	When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
maxStalenessPrefix	integer (int64) minimum: 1 maximum: 2147483647	When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.

ContinuousModeBackupPolicy

Object

연속 모드 백업 정책을 나타내는 개체입니다.

Name	형식	Description
continuousModeProperties	ContinuousModeProperties	연속 모드 백업에 대한 구성 값
migrationState	BackupPolicyMigrationState	백업 정책 간의 마이그레이션 상태를 나타내는 개체입니다.
type	string: Continuous	Describes the mode of backups.

ContinuousModeProperties

Object

Configuration values for periodic mode backup

Name	형식	Description
tier	ContinuousTier	연속 백업 모드 유형을 나타내는 열거형

ContinuousTier

열거형

연속 백업 계층의 유형을 나타내는 열거형입니다.

값	Description
Continuous30Days
Continuous7Days

CorsPolicy

Object

The CORS policy for the Cosmos DB database account.

Name	형식	Description
allowedHeaders	string	The request headers that the origin ___domain may specify on the CORS request.
allowedMethods	string	The methods (HTTP request verbs) that the origin ___domain may use for a CORS request.
allowedOrigins	string	The origin domains that are permitted to make a request against the service via CORS.
exposedHeaders	string	The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
maxAgeInSeconds	integer (int64) minimum: 1 maximum: 2147483647	The maximum amount time that a browser should cache the preflight OPTIONS request.

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
Application
Key
ManagedIdentity
User

CreateMode

열거형

Enum to indicate the mode of account creation.

값	Description
Default
Restore

DatabaseAccountGetResults

Object

Azure Cosmos DB 데이터베이스 계정.

Name	형식	Default value	Description
id	string		ARM 리소스의 고유 리소스 식별자입니다.
identity	ManagedServiceIdentity		Identity for the resource.
kind	DatabaseAccountKind	GlobalDocumentDB	Indicates the type of database account. This can only be set at database account creation.
___location	string		The ___location of the resource group to which the resource belongs.
name	string		ARM 리소스의 이름입니다.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		분석 스토리지 관련 속성입니다.
properties.apiProperties	ApiProperties		API specific properties.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		The object representing the policy for taking backups on an account.
properties.capabilities	Capability[]		List of Cosmos DB capabilities for the account
properties.capacity	Capacity		계정의 용량 적용과 관련된 모든 속성을 나타내는 개체입니다.
properties.connectorOffer	ConnectorOffer		The cassandra connector offer type for the Cosmos DB database C* account.
properties.consistencyPolicy	ConsistencyPolicy		Cosmos DB 데이터베이스 계정에 대한 일관성 정책입니다.
properties.cors	CorsPolicy[]		The CORS policy for the Cosmos DB database account.
properties.createMode	CreateMode	Default	Enum to indicate the mode of account creation.
properties.customerManagedKeyStatus	string		계정의 고객 관리형 키 기능 상태를 나타냅니다. 오류가 있는 경우 속성은 문제 해결 지침을 제공합니다.
properties.databaseAccountOfferType	DatabaseAccountOfferType		Cosmos DB 데이터베이스 계정에 대한 제품 유형입니다. 기본값: Standard.
properties.defaultIdentity	string		The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
properties.disableKeyBasedMetadataWriteAccess	boolean		Disable write operations on metadata resources (databases, containers, throughput) via account keys
properties.disableLocalAuth	boolean		로컬 인증을 옵트아웃하고 MSI 및 AAD만 인증에만 사용할 수 있는지 확인합니다.
properties.documentEndpoint	string		Cosmos DB 데이터베이스 계정에 대한 연결 엔드포인트입니다.
properties.enableAnalyticalStorage	boolean		Flag to indicate whether to enable storage analytics.
properties.enableAutomaticFailover	boolean		Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
properties.enableBurstCapacity	boolean		계정에서 버스트 용량 기능의 사용/사용 안 함을 나타내는 플래그
properties.enableCassandraConnector	boolean		Enables the cassandra connector on the Cosmos DB C* account
properties.enableFreeTier	boolean		Flag to indicate whether Free Tier is enabled.
properties.enableMultipleWriteLocations	boolean		Enables the account to write in multiple locations
properties.enablePartitionMerge	boolean		계정에서 파티션 병합 기능의 사용/사용 안 함을 나타내는 플래그
properties.enablePerRegionPerPartitionAutoscale	boolean		계정에서 PerRegionPerPartitionAutoscale 기능의 사용/사용 안 함을 나타내는 플래그
properties.failoverPolicies	FailoverPolicy[]		장애 조치(failover) 우선 순위에 따라 정렬된 지역을 포함하는 배열입니다.
properties.instanceId	string		데이터베이스 계정에 할당된 고유 식별자
properties.ipRules	IpAddressOrRange[]		List of IpRules.
properties.isVirtualNetworkFilterEnabled	boolean		Flag to indicate whether to enable/disable Virtual Network ACL rules.
properties.keyVaultKeyUri	string		The URI of the key vault
properties.keysMetadata	DatabaseAccountKeysMetadata		Cosmos DB 계정의 계정 키에 대한 메타데이터를 나타내는 개체입니다.
properties.locations	Location[]		Cosmos DB 계정에 대해 사용하도록 설정된 모든 위치를 포함하는 배열입니다.
properties.minimalTlsVersion	MinimalTlsVersion		허용되는 최소 Tls 버전을 나타냅니다. 기본값은 Tls 1.2입니다. Cassandra 및 Mongo API는 Tls 1.2에서만 작동합니다.
properties.networkAclBypass	NetworkAclBypass		Indicates what services are allowed to bypass firewall checks.
properties.networkAclBypassResourceIds	string[] (arm-id)		An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Cosmos DB 계정에 대해 구성된 프라이빗 엔드포인트 연결 목록입니다.
properties.provisioningState	string		작업이 호출된 당시 Cosmos DB 계정의 상태입니다. 상태는 다음 중 하나일 수 있습니다. '만들기' – Cosmos DB 계정이 만들어지고 있습니다. 계정이 만들기 상태인 경우 Cosmos DB 계정 만들기 작업에 대한 입력으로 지정된 속성만 반환됩니다. '성공' – Cosmos DB 계정이 활성화되어 있습니다. '업데이트' – Cosmos DB 계정이 업데이트되고 있습니다. '삭제 중' – Cosmos DB 계정이 삭제되고 있습니다. '실패' – Cosmos DB 계정을 만들지 못했습니다. 'DeletionFailed' – Cosmos DB 계정 삭제에 실패했습니다.
properties.publicNetworkAccess	PublicNetworkAccess		Whether requests from Public Network are allowed
properties.readLocations	Location[]		Cosmos DB 계정에 대해 사용하도록 설정된 읽기 위치가 포함된 배열입니다.
properties.restoreParameters	RestoreParameters		Parameters to indicate the information about the restore.
properties.virtualNetworkRules	VirtualNetworkRule[]		List of Virtual Network ACL rules configured for the Cosmos DB account.
properties.writeLocations	Location[]		Cosmos DB 계정에 대한 쓰기 위치를 포함하는 배열입니다.
systemData	systemData		이 리소스와 관련된 시스템 메타 데이터입니다.
tags	object		태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 이러한 태그는 리소스 그룹 전체에서 이 리소스를 보고 그룹화할 때 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 키가 128자 이하이고 값이 256자 이하여야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다.
type	string		Azure 리소스의 유형입니다.

DatabaseAccountKeysMetadata

Object

지정된 Cosmos DB 데이터베이스 계정에 대한 각 액세스 키와 관련된 메타데이터입니다.

Name	형식	Description
primaryMasterKey	AccountKeyMetadata	지정된 Cosmos DB 데이터베이스 계정에 대한 기본 Read-Write 키와 관련된 메타데이터입니다.
primaryReadonlyMasterKey	AccountKeyMetadata	지정된 Cosmos DB 데이터베이스 계정에 대한 기본 Read-Only 키와 관련된 메타데이터입니다.
secondaryMasterKey	AccountKeyMetadata	지정된 Cosmos DB 데이터베이스 계정에 대한 보조 Read-Write 키와 관련된 메타데이터입니다.
secondaryReadonlyMasterKey	AccountKeyMetadata	지정된 Cosmos DB 데이터베이스 계정에 대한 보조 Read-Only 키와 관련된 메타데이터입니다.

DatabaseAccountKind

열거형

Indicates the type of database account. This can only be set at database account creation.

값	Description
GlobalDocumentDB
MongoDB
Parse

DatabaseAccountOfferType

열거형

Cosmos DB 데이터베이스 계정에 대한 제품 유형입니다.

값	Description
Standard

DatabaseAccountUpdateParameters

Object

Azure Cosmos DB 데이터베이스 계정 속성을 패치하기 위한 매개 변수입니다.

Name	형식	Description
identity	ManagedServiceIdentity	Identity for the resource.
___location	string	The ___location of the resource group to which the resource belongs.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	분석 스토리지 관련 속성입니다.
properties.apiProperties	ApiProperties	API specific properties. Currently, supported only for MongoDB API.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy	The object representing the policy for taking backups on an account.
properties.capabilities	Capability[]	List of Cosmos DB capabilities for the account
properties.capacity	Capacity	계정의 용량 적용과 관련된 모든 속성을 나타내는 개체입니다.
properties.connectorOffer	ConnectorOffer	The cassandra connector offer type for the Cosmos DB database C* account.
properties.consistencyPolicy	ConsistencyPolicy	The consistency policy for the Cosmos DB account.
properties.cors	CorsPolicy[]	The CORS policy for the Cosmos DB database account.
properties.customerManagedKeyStatus	string	계정의 고객 관리형 키 기능 상태를 나타냅니다. 오류가 있는 경우 속성은 문제 해결 지침을 제공합니다.
properties.defaultIdentity	string	The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
properties.disableKeyBasedMetadataWriteAccess	boolean	Disable write operations on metadata resources (databases, containers, throughput) via account keys
properties.disableLocalAuth	boolean	로컬 인증을 옵트아웃하고 MSI 및 AAD만 인증에만 사용할 수 있는지 확인합니다.
properties.enableAnalyticalStorage	boolean	Flag to indicate whether to enable storage analytics.
properties.enableAutomaticFailover	boolean	Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
properties.enableBurstCapacity	boolean	계정에서 버스트 용량 기능의 사용/사용 안 함을 나타내는 플래그
properties.enableCassandraConnector	boolean	Enables the cassandra connector on the Cosmos DB C* account
properties.enableFreeTier	boolean	Flag to indicate whether Free Tier is enabled.
properties.enableMultipleWriteLocations	boolean	Enables the account to write in multiple locations
properties.enablePartitionMerge	boolean	계정에서 파티션 병합 기능의 사용/사용 안 함을 나타내는 플래그
properties.enablePerRegionPerPartitionAutoscale	boolean	계정에서 PerRegionPerPartitionAutoscale 기능의 사용/사용 안 함을 나타내는 플래그
properties.ipRules	IpAddressOrRange[]	List of IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Flag to indicate whether to enable/disable Virtual Network ACL rules.
properties.keyVaultKeyUri	string	The URI of the key vault
properties.keysMetadata	DatabaseAccountKeysMetadata	메타데이터가 읽기 전용이므로 이 속성은 업데이트 작업 중에 무시됩니다. 개체는 Cosmos DB 계정의 계정 키에 대한 메타데이터를 나타냅니다.
properties.locations	Location[]	An array that contains the georeplication locations enabled for the Cosmos DB account.
properties.minimalTlsVersion	MinimalTlsVersion	허용되는 최소 Tls 버전을 나타냅니다. 기본값은 Tls 1.2입니다. Cassandra 및 Mongo API는 Tls 1.2에서만 작동합니다.
properties.networkAclBypass	NetworkAclBypass	Indicates what services are allowed to bypass firewall checks.
properties.networkAclBypassResourceIds	string[]	An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
properties.publicNetworkAccess	PublicNetworkAccess	Whether requests from Public Network are allowed
properties.virtualNetworkRules	VirtualNetworkRule[]	List of Virtual Network ACL rules configured for the Cosmos DB account.
tags	object	태그는 리소스를 설명하는 키-값 쌍의 목록입니다. 이러한 태그는 리소스 그룹 전체에서 이 리소스를 보고 그룹화할 때 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 키가 128자 이하이고 값이 256자 이하여야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다.

DatabaseRestoreResource

Object

복원할 특정 데이터베이스입니다.

Name	형식	Description
collectionNames	string[]	The names of the collections available for restore.
databaseName	string	The name of the database available for restore.

DefaultConsistencyLevel

열거형

The default consistency level and configuration settings of the Cosmos DB account.

값	Description
BoundedStaleness
ConsistentPrefix
Eventual
Session
Strong

FailoverPolicy

Object

데이터베이스 계정의 지정된 지역에 대한 장애 조치(failover) 정책입니다.

Name	형식	Description
failoverPriority	integer (int32) minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
id	string	데이터베이스 계정이 복제되는 지역의 고유 식별자입니다. 예: <accountName>- locationName<>.
locationName	string	데이터베이스 계정이 있는 지역의 이름입니다.

GremlinDatabaseRestoreResource

Object

복원할 특정 Gremlin 데이터베이스입니다.

Name	형식	Description
databaseName	string	복원에 사용할 수 있는 gremlin 데이터베이스의 이름입니다.
graphNames	string[]	복원에 사용할 수 있는 그래프의 이름입니다.

IpAddressOrRange

Object

IpAddressOrRange 개체

Name	형식	Description
ipAddressOrRange	string	A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.

Location

Object

Azure Cosmos DB 데이터베이스 계정이 배포되는 지역입니다.

Name	형식	Description
documentEndpoint	string	특정 지역에 대한 연결 엔드포인트입니다. 예: https://<accountName>-<locationName>.documents.azure.com:443/
failoverPriority	integer (int32) minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
id	string	데이터베이스 계정 내 지역의 고유 식별자입니다. 예: <accountName>- locationName<>.
isZoneRedundant	boolean	Flag to indicate whether or not this region is an AvailabilityZone region
locationName	string	The name of the region.
provisioningState	string	작업이 호출된 당시 Cosmos DB 계정의 상태입니다. 상태는 다음 중 하나일 수 있습니다. '만들기' – Cosmos DB 계정이 만들어지고 있습니다. 계정이 만들기 상태인 경우 Cosmos DB 계정 만들기 작업에 대한 입력으로 지정된 속성만 반환됩니다. '성공' – Cosmos DB 계정이 활성화되어 있습니다. '업데이트' – Cosmos DB 계정이 업데이트되고 있습니다. '삭제 중' – Cosmos DB 계정이 삭제되고 있습니다. '실패' – Cosmos DB 계정을 만들지 못했습니다. 'DeletionFailed' – Cosmos DB 계정 삭제에 실패했습니다.

ManagedServiceIdentity

Object

Identity for the resource.

Name	형식	Description
principalId	string	시스템 할당 ID의 보안 주체 ID입니다. 이 속성은 시스템 할당 ID에 대해서만 제공됩니다.
tenantId	string	시스템 할당 ID의 테넌트 ID입니다. 이 속성은 시스템 할당 ID에 대해서만 제공됩니다.
type	ResourceIdentityType	The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
userAssignedIdentities	UserAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

MinimalTlsVersion

열거형

허용되는 최소 Tls 버전을 나타냅니다. 기본값은 Tls 1.2입니다. Cassandra 및 Mongo API는 Tls 1.2에서만 작동합니다.

값	Description
Tls
Tls11
Tls12

NetworkAclBypass

열거형

Indicates what services are allowed to bypass firewall checks.

값	Description
AzureServices
None

PeriodicModeBackupPolicy

Object

주기 모드 백업 정책을 나타내는 개체입니다.

Name	형식	Description
migrationState	BackupPolicyMigrationState	백업 정책 간의 마이그레이션 상태를 나타내는 개체입니다.
periodicModeProperties	PeriodicModeProperties	Configuration values for periodic mode backup
type	string: Periodic	Describes the mode of backups.

PeriodicModeProperties

Object

Configuration values for periodic mode backup

Name	형식	Description
backupIntervalInMinutes	integer (int32) minimum: 0	An integer representing the interval in minutes between two backups
backupRetentionIntervalInHours	integer (int32) minimum: 0	An integer representing the time (in hours) that each backup is retained
backupStorageRedundancy	BackupStorageRedundancy	Enum to indicate type of backup residency

PrivateEndpointConnection

Object

프라이빗 엔드포인트 연결

Name	형식	Description
id	string	Fully qualified resource ID for the resource. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.groupId	string	프라이빗 엔드포인트의 그룹 ID입니다.
properties.privateEndpoint	PrivateEndpointProperty	Private endpoint which the connection belongs to.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Connection State of the Private Endpoint Connection.
properties.provisioningState	string	프라이빗 엔드포인트의 프로비전 상태입니다.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Object

Private endpoint which the connection belongs to.

Name	형식	Description
id	string	Resource id of the private endpoint.

PrivateLinkServiceConnectionStateProperty

Object

Connection State of the Private Endpoint Connection.

Name	형식	Description
actionsRequired	string	기본 워크플로를 넘어서 필요한 모든 작업(승인/거부/연결 끊기)
description	string	The private link service connection description.
status	string	The private link service connection status.

PublicNetworkAccess

열거형

Whether requests from Public Network are allowed

값	Description
Disabled
Enabled
SecuredByPerimeter

ResourceIdentityType

열거형

The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.

값	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

RestoreMode

열거형

Describes the mode of the restore.

값	Description
PointInTime

RestoreParameters

Object

Parameters to indicate the information about the restore.

Name	형식	Description
databasesToRestore	DatabaseRestoreResource[]	List of specific databases available for restore.
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	복원에 사용할 수 있는 특정 gremlin 데이터베이스 목록입니다.
restoreMode	RestoreMode	Describes the mode of the restore.
restoreSource	string	The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{___location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string (date-time)	Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled	boolean	복원이 성공하면 복원된 계정에 Time-To-Live 사용하지 않도록 설정할지 여부를 지정합니다.
tablesToRestore	string[]	복원에 사용할 수 있는 특정 테이블 목록입니다.

ServerVersion

열거형

MongoDB 계정의 버전을 설명합니다.

값	Description
3.2
3.6
4.0
4.2
5.0
6.0
7.0

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

UserAssignedIdentities

Object

The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name	형식	Description

VirtualNetworkRule

Object

Virtual Network ACL 규칙 개체

Name	형식	Description
id	string (arm-id)	Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint	boolean	Create firewall rule before the virtual network has vnet service endpoint enabled.

다음을 통해 공유

Database Accounts - Update

URI 매개 변수

요청 본문

응답

보안

azure_auth

범위

예제

CosmosDBDatabaseAccountPatch

샘플 요청

샘플 응답

정의

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