你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Database Accounts - Update

服务:

Cosmos DB Resource Provider

API 版本:

2024-11-15

更新现有 Azure Cosmos DB 数据库帐户的属性。

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

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string	Cosmos DB 数据库帐户名称。 正则表达式模式: ^[a-z0-9]+(-[a-z0-9]+)*
resourceGroupName	path	True	string	资源组的名称。 名称不区分大小写。
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	用于此操作的 API 版本。

请求正文

名称	类型	说明
identity	ManagedServiceIdentity	资源的标识。
location	string	资源所属的资源组的位置。
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	分析存储特定属性。
properties.apiProperties	ApiProperties	API 特定属性。 目前，仅 MongoDB API 支持。
properties.backupPolicy	BackupPolicy: PeriodicModeBackupPolicy ContinuousModeBackupPolicy	表示用于在帐户上备份的策略的对象。
properties.capabilities	Capability[]	帐户的 Cosmos DB 功能列表
properties.capacity	Capacity	表示与帐户上的容量强制实施相关的所有属性的对象。
properties.connectorOffer	ConnectorOffer	cassandra 连接器为 Cosmos DB 数据库 C* 帐户提供类型。
properties.consistencyPolicy	ConsistencyPolicy	Cosmos DB 帐户的一致性策略。
properties.cors	CorsPolicy[]	Cosmos DB 数据库帐户的 CORS 策略。
properties.customerManagedKeyStatus	string	指示帐户上客户管理的密钥功能的状态。 如果出现错误，该属性将提供故障排除指南。
properties.defaultIdentity	string	用于访问客户托管密钥等功能中使用的密钥保管库的默认标识。 用户需要显式设置默认标识。 它可以是“FirstPartyIdentity”、“SystemAssignedIdentity”等。
properties.disableKeyBasedMetadataWriteAccess	boolean	通过帐户密钥对元数据资源（数据库、容器、吞吐量）禁用写入操作
properties.disableLocalAuth	boolean	选择退出本地身份验证，并确保只能将 MSI 和 AAD 用于身份验证。
properties.enableAnalyticalStorage	boolean	用于指示是否启用存储分析的标志。
properties.enableAutomaticFailover	boolean	在极少数情况下启用写入区域的自动故障转移，因为服务中断导致该区域不可用。 自动故障转移将导致帐户的新写入区域，并根据为帐户配置的故障转移优先级进行选择。
properties.enableBurstCapacity	boolean	指示在帐户上启用/禁用突发容量功能的标志
properties.enableCassandraConnector	boolean	在 Cosmos DB C* 帐户上启用 cassandra 连接器
properties.enableFreeTier	boolean	用于指示是否启用免费层的标志。
properties.enableMultipleWriteLocations	boolean	使帐户能够在多个位置写入
properties.enablePartitionMerge	boolean	用于指示在帐户上启用/禁用分区合并功能的标志
properties.enablePerRegionPerPartitionAutoscale	boolean	用于指示在帐户上启用/禁用 PerRegionPerPartitionAutoscale 功能的标志
properties.ipRules	IpAddressOrRange[]	IpRules 列表。
properties.isVirtualNetworkFilterEnabled	boolean	用于指示是否启用/禁用虚拟网络 ACL 规则的标志。
properties.keyVaultKeyUri	string	密钥保管库的 URI
properties.locations	Location[]	一个数组，其中包含为 Cosmos DB 帐户启用的地理复制位置。
properties.minimalTlsVersion	MinimalTlsVersion	指示允许的最低 Tls 版本。 默认值为 Tls 1.2。 Cassandra 和 Mongo API 仅适用于 Tls 1.2。
properties.networkAclBypass	NetworkAclBypass	指示允许哪些服务绕过防火墙检查。
properties.networkAclBypassResourceIds	string[]	一个数组，其中包含 Cosmos DB 帐户的网络 Acl 绕过的资源 ID。
properties.publicNetworkAccess	PublicNetworkAccess	是否允许来自公用网络的请求
properties.virtualNetworkRules	VirtualNetworkRule[]	为 Cosmos DB 帐户配置的虚拟网络 ACL 规则列表。
tags	object	标记是描述资源的键值对的列表。 这些标记可用于查看和分组此资源（跨资源组）。 最多可为资源提供 15 个标记。 每个标记必须具有不超过 128 个字符的键，且值不超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。

响应

名称	类型	说明
200 OK	DatabaseAccountGetResults	数据库帐户更新操作将异步完成。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

CosmosDBDatabaseAccountPatch

示例请求

HTTP

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"
  }
}

Java

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

/**
 * Samples for DatabaseAccounts Update.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

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

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


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.database_accounts.begin_update(
        resource_group_name="rg1",
        account_name="ddb1",
        update_parameters={
            "identity": {
                "type": "SystemAssigned,UserAssigned",
                "userAssignedIdentities": {
                    "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
                },
            },
            "location": "westus",
            "properties": {
                "analyticalStorageConfiguration": {"schemaType": "WellDefined"},
                "backupPolicy": {
                    "periodicModeProperties": {
                        "backupIntervalInMinutes": 240,
                        "backupRetentionIntervalInHours": 720,
                        "backupStorageRedundancy": "Local",
                    },
                    "type": "Periodic",
                },
                "capacity": {"totalThroughputLimit": 2000},
                "consistencyPolicy": {
                    "defaultConsistencyLevel": "BoundedStaleness",
                    "maxIntervalInSeconds": 10,
                    "maxStalenessPrefix": 200,
                },
                "defaultIdentity": "FirstPartyIdentity",
                "enableAnalyticalStorage": True,
                "enableBurstCapacity": True,
                "enableFreeTier": False,
                "enablePartitionMerge": True,
                "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

Go

package armcosmos_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/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

JavaScript

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

/**
 * This sample demonstrates how to Updates the properties of an existing Azure Cosmos DB database account.
 *
 * @summary Updates the properties of an existing Azure Cosmos DB database account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/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

示例响应

状态代码:

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"
  }
}

定义

名称	说明
AccountKeyMetadata	与给定数据库帐户的访问密钥相关的元数据。
AnalyticalStorageConfiguration	分析存储特定属性。
AnalyticalStorageSchemaType	描述分析存储的架构类型。
ApiProperties
BackupPolicyMigrationState	表示备份策略之间迁移状态的对象。
BackupPolicyMigrationStatus	描述备份策略类型之间的迁移状态。
BackupPolicyType	描述备份模式。
BackupStorageRedundancy	枚举以指示备份存储冗余的类型。
Capability	Cosmos DB 功能对象
Capacity	表示与帐户上的容量强制实施相关的所有属性的对象。
ConnectorOffer	Cassandra 连接器为 Cosmos DB C* 数据库帐户提供类型。
ConsistencyPolicy	Cosmos DB 数据库帐户的一致性策略。
ContinuousModeBackupPolicy	表示连续模式备份策略的对象。
ContinuousModeProperties	定期模式备份的配置值
ContinuousTier	枚举以指示连续备份层的类型。
CorsPolicy	Cosmos DB 数据库帐户的 CORS 策略。
createdByType	创建资源的标识的类型。
CreateMode	枚举以指示帐户创建模式。
DatabaseAccountGetResults	Azure Cosmos DB 数据库帐户。
DatabaseAccountKeysMetadata	与给定 Cosmos DB 数据库帐户的每个访问密钥相关的元数据。
DatabaseAccountKind	指示数据库帐户的类型。 只能在创建数据库帐户时设置此设置。
DatabaseAccountOfferType	Cosmos DB 数据库帐户的产品/服务类型。
DatabaseAccountUpdateParameters	用于修补 Azure Cosmos DB 数据库帐户属性的参数。
DatabaseRestoreResource	要还原的特定数据库。
DefaultConsistencyLevel	Cosmos DB 帐户的默认一致性级别和配置设置。
FailoverPolicy	数据库帐户的给定区域的故障转移策略。
GremlinDatabaseRestoreResource	要还原的特定 Gremlin 数据库。
IpAddressOrRange	IpAddressOrRange 对象
Location	在其中部署 Azure Cosmos DB 数据库帐户的区域。
ManagedServiceIdentity	资源的标识。
MinimalTlsVersion	指示允许的最低 Tls 版本。 默认值为 Tls 1.2。 Cassandra 和 Mongo API 仅适用于 Tls 1.2。
NetworkAclBypass	指示允许哪些服务绕过防火墙检查。
PeriodicModeBackupPolicy	表示定期模式备份策略的对象。
PeriodicModeProperties	定期模式备份的配置值
PrivateEndpointConnection	专用终结点连接
PrivateEndpointProperty	连接所属的专用终结点。
PrivateLinkServiceConnectionStateProperty	专用终结点连接的连接状态。
PublicNetworkAccess	是否允许来自公用网络的请求
ResourceIdentityType	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。
RestoreMode	描述还原模式。
RestoreParameters	用于指示还原信息的参数。
ServerVersion	描述 MongoDB 帐户的版本。
systemData	与创建和上次修改资源相关的元数据。
UserAssignedIdentities	与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
VirtualNetworkRule	虚拟网络 ACL 规则对象

AccountKeyMetadata

与给定数据库帐户的访问密钥相关的元数据。

名称	类型	说明
generationTime	string	采用 ISO-8601 格式的密钥的 UTC 生成时间。 如果对象中缺少该值，则表示在 2022-06-18 之前触发了最后一个键重新生成。

AnalyticalStorageConfiguration

分析存储特定属性。

名称	类型	说明
schemaType	AnalyticalStorageSchemaType	描述分析存储的架构类型。

AnalyticalStorageSchemaType

描述分析存储的架构类型。

名称	类型	说明
FullFidelity	string
WellDefined	string

ApiProperties

名称	类型	说明
serverVersion	ServerVersion	描述 MongoDB 帐户的版本。

BackupPolicyMigrationState

表示备份策略之间迁移状态的对象。

名称	类型	说明
startTime	string	备份策略迁移开始的时间（ISO-8601 格式）。
status	BackupPolicyMigrationStatus	描述备份策略类型之间的迁移状态。
targetType	BackupPolicyType	描述备份策略迁移的目标备份策略类型。

BackupPolicyMigrationStatus

描述备份策略类型之间的迁移状态。

名称	类型	说明
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

描述备份模式。

名称	类型	说明
Continuous	string
Periodic	string

BackupStorageRedundancy

枚举以指示备份存储冗余的类型。

名称	类型	说明
Geo	string
Local	string
Zone	string

Capability

Cosmos DB 功能对象

名称	类型	说明
name	string	Cosmos DB 功能的名称。 例如，“name”：“EnableCassandra”。 当前值还包括“EnableTable”和“EnableGremlin”。

Capacity

表示与帐户上的容量强制实施相关的所有属性的对象。

名称	类型	说明
totalThroughputLimit	integer	对帐户施加的总吞吐量限制。 totalThroughputLimit 为 2000，对可以预配到 2000 的帐户的最大吞吐量施加严格限制。 -1 totalThroughputLimit 表示对预配吞吐量没有限制。

ConnectorOffer

Cassandra 连接器为 Cosmos DB C* 数据库帐户提供类型。

名称	类型	说明
Small	string

ConsistencyPolicy

Cosmos DB 数据库帐户的一致性策略。

名称	类型	说明
defaultConsistencyLevel	DefaultConsistencyLevel	Cosmos DB 帐户的默认一致性级别和配置设置。
maxIntervalInSeconds	integer	与有限过期一致性级别一起使用时，此值表示容忍的过期时间量（以秒为单位）。 此值的接受范围为 5 - 86400。 当 defaultConsistencyPolicy 设置为“BoundedStaleness”时必需。
maxStalenessPrefix	integer	与有限过期一致性级别一起使用时，此值表示允许的过时请求数。 此值的接受范围为 1 – 2,147,483,647。 当 defaultConsistencyPolicy 设置为“BoundedStaleness”时必需。

ContinuousModeBackupPolicy

表示连续模式备份策略的对象。

名称	类型	说明
continuousModeProperties	ContinuousModeProperties	连续模式备份的配置值
migrationState	BackupPolicyMigrationState	表示备份策略之间迁移状态的对象。
type	string: Continuous	描述备份模式。

ContinuousModeProperties

定期模式备份的配置值

名称	类型	说明
tier	ContinuousTier	枚举以指示连续备份模式的类型

ContinuousTier

枚举以指示连续备份层的类型。

名称	类型	说明
Continuous30Days	string
Continuous7Days	string

CorsPolicy

Cosmos DB 数据库帐户的 CORS 策略。

名称	类型	说明
allowedHeaders	string	源域可以在 CORS 请求上指定的请求标头。
allowedMethods	string	源域可用于 CORS 请求的方法（HTTP 请求谓词）。
allowedOrigins	string	允许通过 CORS 针对服务发出请求的源域。
exposedHeaders	string	响应标头，这些标头可能在响应 CORS 请求中发送，并由浏览器向请求颁发者公开。
maxAgeInSeconds	integer	浏览器应缓存预检 OPTIONS 请求的最大时间。

createdByType

创建资源的标识的类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

枚举以指示帐户创建模式。

名称	类型	说明
Default	string
Restore	string

DatabaseAccountGetResults

Azure Cosmos DB 数据库帐户。

名称	类型	默认值	说明
id	string		ARM 资源的唯一资源标识符。
identity	ManagedServiceIdentity		资源的标识。
kind	DatabaseAccountKind	GlobalDocumentDB	指示数据库帐户的类型。 只能在创建数据库帐户时设置此设置。
location	string		资源所属的资源组的位置。
name	string		ARM 资源的名称。
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		分析存储特定属性。
properties.apiProperties	ApiProperties		API 特定属性。
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		表示用于在帐户上备份的策略的对象。
properties.capabilities	Capability[]		帐户的 Cosmos DB 功能列表
properties.capacity	Capacity		表示与帐户上的容量强制实施相关的所有属性的对象。
properties.connectorOffer	ConnectorOffer		cassandra 连接器为 Cosmos DB 数据库 C* 帐户提供类型。
properties.consistencyPolicy	ConsistencyPolicy		Cosmos DB 数据库帐户的一致性策略。
properties.cors	CorsPolicy[]		Cosmos DB 数据库帐户的 CORS 策略。
properties.createMode	CreateMode	Default	枚举以指示帐户创建模式。
properties.customerManagedKeyStatus	string		指示帐户上客户管理的密钥功能的状态。 如果出现错误，该属性将提供故障排除指南。
properties.databaseAccountOfferType	DatabaseAccountOfferType		Cosmos DB 数据库帐户的产品/服务类型。 默认值：标准。
properties.defaultIdentity	string		用于访问客户托管密钥等功能中使用的密钥保管库的默认标识。 用户需要显式设置默认标识。 它可以是“FirstPartyIdentity”、“SystemAssignedIdentity”等。
properties.disableKeyBasedMetadataWriteAccess	boolean		通过帐户密钥对元数据资源（数据库、容器、吞吐量）禁用写入操作
properties.disableLocalAuth	boolean		选择退出本地身份验证，并确保只能将 MSI 和 AAD 用于身份验证。
properties.documentEndpoint	string		Cosmos DB 数据库帐户的连接终结点。
properties.enableAnalyticalStorage	boolean		用于指示是否启用存储分析的标志。
properties.enableAutomaticFailover	boolean		在极少数情况下启用写入区域的自动故障转移，因为服务中断导致该区域不可用。 自动故障转移将导致帐户的新写入区域，并根据为帐户配置的故障转移优先级进行选择。
properties.enableBurstCapacity	boolean		指示在帐户上启用/禁用突发容量功能的标志
properties.enableCassandraConnector	boolean		在 Cosmos DB C* 帐户上启用 cassandra 连接器
properties.enableFreeTier	boolean		用于指示是否启用免费层的标志。
properties.enableMultipleWriteLocations	boolean		使帐户能够在多个位置写入
properties.enablePartitionMerge	boolean		用于指示在帐户上启用/禁用分区合并功能的标志
properties.enablePerRegionPerPartitionAutoscale	boolean		用于指示在帐户上启用/禁用 PerRegionPerPartitionAutoscale 功能的标志
properties.failoverPolicies	FailoverPolicy[]		包含按故障转移优先级排序的区域的数组。
properties.instanceId	string		分配给数据库帐户的唯一标识符
properties.ipRules	IpAddressOrRange[]		IpRules 列表。
properties.isVirtualNetworkFilterEnabled	boolean		用于指示是否启用/禁用虚拟网络 ACL 规则的标志。
properties.keyVaultKeyUri	string		密钥保管库的 URI
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		指示允许哪些服务绕过防火墙检查。
properties.networkAclBypassResourceIds	string[]		一个数组，其中包含 Cosmos DB 帐户的网络 Acl 绕过的资源 ID。
properties.privateEndpointConnections	PrivateEndpointConnection[]		为 Cosmos DB 帐户配置的专用终结点连接列表。
properties.provisioningState	string		调用操作时 Cosmos DB 帐户的状态。 状态可以是下列状态之一。 “正在创建”- 正在创建 Cosmos DB 帐户。 当帐户处于“创建”状态时，仅返回指定为创建 Cosmos DB 帐户操作输入的属性。 “Succeeded”– Cosmos DB 帐户处于活动状态以供使用。 “正在更新”- 正在更新 Cosmos DB 帐户。 “正在删除”- 正在删除 Cosmos DB 帐户。 “Failed”– Cosmos DB 帐户创建失败。 “DeletionFailed”– Cosmos DB 帐户删除失败。
properties.publicNetworkAccess	PublicNetworkAccess		是否允许来自公用网络的请求
properties.readLocations	Location[]		一个数组，其中包含为 Cosmos DB 帐户启用的读取位置。
properties.restoreParameters	RestoreParameters		用于指示还原信息的参数。
properties.virtualNetworkRules	VirtualNetworkRule[]		为 Cosmos DB 帐户配置的虚拟网络 ACL 规则列表。
properties.writeLocations	Location[]		包含 Cosmos DB 帐户的写入位置的数组。
systemData	systemData		与此资源相关的系统元数据。
tags	object		标记是描述资源的键值对的列表。 这些标记可用于查看和分组此资源（跨资源组）。 最多可为资源提供 15 个标记。 每个标记必须具有不超过 128 个字符的键，且值不超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。
type	string		Azure 资源的类型。

DatabaseAccountKeysMetadata

与给定 Cosmos DB 数据库帐户的每个访问密钥相关的元数据。

名称	类型	说明
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

指示数据库帐户的类型。 只能在创建数据库帐户时设置此设置。

名称	类型	说明
GlobalDocumentDB	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

Cosmos DB 数据库帐户的产品/服务类型。

名称	类型	说明
Standard	string

DatabaseAccountUpdateParameters

用于修补 Azure Cosmos DB 数据库帐户属性的参数。

名称	类型	说明
identity	ManagedServiceIdentity	资源的标识。
location	string	资源所属的资源组的位置。
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	分析存储特定属性。
properties.apiProperties	ApiProperties	API 特定属性。 目前，仅 MongoDB API 支持。
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy	表示用于在帐户上备份的策略的对象。
properties.capabilities	Capability[]	帐户的 Cosmos DB 功能列表
properties.capacity	Capacity	表示与帐户上的容量强制实施相关的所有属性的对象。
properties.connectorOffer	ConnectorOffer	cassandra 连接器为 Cosmos DB 数据库 C* 帐户提供类型。
properties.consistencyPolicy	ConsistencyPolicy	Cosmos DB 帐户的一致性策略。
properties.cors	CorsPolicy[]	Cosmos DB 数据库帐户的 CORS 策略。
properties.customerManagedKeyStatus	string	指示帐户上客户管理的密钥功能的状态。 如果出现错误，该属性将提供故障排除指南。
properties.defaultIdentity	string	用于访问客户托管密钥等功能中使用的密钥保管库的默认标识。 用户需要显式设置默认标识。 它可以是“FirstPartyIdentity”、“SystemAssignedIdentity”等。
properties.disableKeyBasedMetadataWriteAccess	boolean	通过帐户密钥对元数据资源（数据库、容器、吞吐量）禁用写入操作
properties.disableLocalAuth	boolean	选择退出本地身份验证，并确保只能将 MSI 和 AAD 用于身份验证。
properties.enableAnalyticalStorage	boolean	用于指示是否启用存储分析的标志。
properties.enableAutomaticFailover	boolean	在极少数情况下启用写入区域的自动故障转移，因为服务中断导致该区域不可用。 自动故障转移将导致帐户的新写入区域，并根据为帐户配置的故障转移优先级进行选择。
properties.enableBurstCapacity	boolean	指示在帐户上启用/禁用突发容量功能的标志
properties.enableCassandraConnector	boolean	在 Cosmos DB C* 帐户上启用 cassandra 连接器
properties.enableFreeTier	boolean	用于指示是否启用免费层的标志。
properties.enableMultipleWriteLocations	boolean	使帐户能够在多个位置写入
properties.enablePartitionMerge	boolean	用于指示在帐户上启用/禁用分区合并功能的标志
properties.enablePerRegionPerPartitionAutoscale	boolean	用于指示在帐户上启用/禁用 PerRegionPerPartitionAutoscale 功能的标志
properties.ipRules	IpAddressOrRange[]	IpRules 列表。
properties.isVirtualNetworkFilterEnabled	boolean	用于指示是否启用/禁用虚拟网络 ACL 规则的标志。
properties.keyVaultKeyUri	string	密钥保管库的 URI
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	指示允许哪些服务绕过防火墙检查。
properties.networkAclBypassResourceIds	string[]	一个数组，其中包含 Cosmos DB 帐户的网络 Acl 绕过的资源 ID。
properties.publicNetworkAccess	PublicNetworkAccess	是否允许来自公用网络的请求
properties.virtualNetworkRules	VirtualNetworkRule[]	为 Cosmos DB 帐户配置的虚拟网络 ACL 规则列表。
tags	object	标记是描述资源的键值对的列表。 这些标记可用于查看和分组此资源（跨资源组）。 最多可为资源提供 15 个标记。 每个标记必须具有不超过 128 个字符的键，且值不超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。

DatabaseRestoreResource

要还原的特定数据库。

名称	类型	说明
collectionNames	string[]	可用于还原的集合的名称。
databaseName	string	可用于还原的数据库的名称。

DefaultConsistencyLevel

Cosmos DB 帐户的默认一致性级别和配置设置。

名称	类型	说明
BoundedStaleness	string
ConsistentPrefix	string
Eventual	string
Session	string
Strong	string

FailoverPolicy

数据库帐户的给定区域的故障转移策略。

名称	类型	说明
failoverPriority	integer	区域的故障转移优先级。 故障转移优先级为 0 表示写入区域。 故障转移优先级的最大值 = （区域总数 - 1）。 故障转移优先级值对于数据库帐户所在的每个区域必须是唯一的。
id	string	数据库帐户复制到的区域的唯一标识符。 示例：<accountName>-<locationName>。
locationName	string	数据库帐户所在的区域的名称。

GremlinDatabaseRestoreResource

要还原的特定 Gremlin 数据库。

名称	类型	说明
databaseName	string	可用于还原的 gremlin 数据库的名称。
graphNames	string[]	可用于还原的图形的名称。

IpAddressOrRange

IpAddressOrRange 对象

名称	类型	说明
ipAddressOrRange	string	单个 IPv4 地址或 CIDR 格式的单个 IPv4 地址范围。 提供的 IP 格式必须正确，并且不能包含在以下范围之一：10.0.0.0/8、100.64.0.0/10、172.16.0.0/12、192.168.0.0/16，因为这些 IP 地址筛选器不可强制执行。 有效输入的示例：“23.40.210.245”或“23.40.210.0/8”。

Location

在其中部署 Azure Cosmos DB 数据库帐户的区域。

名称	类型	说明
documentEndpoint	string	特定区域的连接终结点。 示例：https://<accountName>-<locationName>.documents.azure.com:443/
failoverPriority	integer	区域的故障转移优先级。 故障转移优先级为 0 表示写入区域。 故障转移优先级的最大值 = （区域总数 - 1）。 故障转移优先级值对于数据库帐户所在的每个区域必须是唯一的。
id	string	数据库帐户中区域的唯一标识符。 示例：<accountName>-<locationName>。
isZoneRedundant	boolean	用于指示此区域是否为 AvailabilityZone 区域的标志
locationName	string	区域的名称。
provisioningState	string	调用操作时 Cosmos DB 帐户的状态。 状态可以是下列状态之一。 “正在创建”- 正在创建 Cosmos DB 帐户。 当帐户处于“创建”状态时，仅返回指定为创建 Cosmos DB 帐户操作输入的属性。 “Succeeded”– Cosmos DB 帐户处于活动状态以供使用。 “正在更新”- 正在更新 Cosmos DB 帐户。 “正在删除”- 正在删除 Cosmos DB 帐户。 “Failed”– Cosmos DB 帐户创建失败。 “DeletionFailed”– Cosmos DB 帐户删除失败。

ManagedServiceIdentity

资源的标识。

名称	类型	说明
principalId	string	系统分配标识的主体 ID。 此属性仅针对系统分配的标识提供。
tenantId	string	系统分配标识的租户 ID。 此属性仅针对系统分配的标识提供。
type	ResourceIdentityType	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。
userAssignedIdentities	UserAssignedIdentities	与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

MinimalTlsVersion

指示允许的最低 Tls 版本。 默认值为 Tls 1.2。 Cassandra 和 Mongo API 仅适用于 Tls 1.2。

名称	类型	说明
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

指示允许哪些服务绕过防火墙检查。

名称	类型	说明
AzureServices	string
None	string

PeriodicModeBackupPolicy

表示定期模式备份策略的对象。

名称	类型	说明
migrationState	BackupPolicyMigrationState	表示备份策略之间迁移状态的对象。
periodicModeProperties	PeriodicModeProperties	定期模式备份的配置值
type	string: Periodic	描述备份模式。

PeriodicModeProperties

定期模式备份的配置值

名称	类型	说明
backupIntervalInMinutes	integer	一个整数，表示两次备份之间的间隔（以分钟为单位）
backupRetentionIntervalInHours	integer	一个整数，表示保留每个备份的时间（以小时为单位）
backupStorageRedundancy	BackupStorageRedundancy	用于指示备份驻留类型的枚举

PrivateEndpointConnection

专用终结点连接

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.groupId	string	专用终结点的组 ID。
properties.privateEndpoint	PrivateEndpointProperty	连接所属的专用终结点。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	专用终结点连接的连接状态。
properties.provisioningState	string	专用终结点的预配状态。
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateEndpointProperty

连接所属的专用终结点。

名称	类型	说明
id	string	专用终结点的资源 ID。

PrivateLinkServiceConnectionStateProperty

专用终结点连接的连接状态。

名称	类型	说明
actionsRequired	string	除基本工作流之外所需的任何操作（批准/拒绝/断开连接）
description	string	专用链接服务连接说明。
status	string	专用链接服务连接状态。

PublicNetworkAccess

是否允许来自公用网络的请求

名称	类型	说明
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。

名称	类型	说明
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

描述还原模式。

名称	类型	说明
PointInTime	string

RestoreParameters

用于指示还原信息的参数。

名称	类型	说明
databasesToRestore	DatabaseRestoreResource[]	可用于还原的特定数据库的列表。
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	可用于还原的特定 gremlin 数据库的列表。
restoreMode	RestoreMode	描述还原模式。
restoreSource	string	必须从中启动还原的可还原数据库帐户的 ID。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	帐户必须还原到的时间（ISO-8601 格式）。
restoreWithTtlDisabled	boolean	指定还原的帐户是否在成功还原时禁用时间To-Live。
tablesToRestore	string[]	可用于还原的特定表的列表。

ServerVersion

描述 MongoDB 帐户的版本。

名称	类型	说明
3.2	string
3.6	string
4.0	string
4.2	string
5.0	string
6.0	string
7.0	string

systemData

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

UserAssignedIdentities

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

名称	类型	说明

VirtualNetworkRule

虚拟网络 ACL 规则对象

名称	类型	说明
id	string	子网的资源 ID，例如：/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}。
ignoreMissingVNetServiceEndpoint	boolean	在虚拟网络启用 vnet 服务终结点之前创建防火墙规则。