Database Accounts - Update

服務:: Cosmos DB Resource Provider

API 版本:: 2025-10-15

更新現有 Azure Cosmos DB 資料庫帳戶的屬性。

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

URI 參數

名稱	位於	必要	類型	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	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	類型	Description
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.defaultPriorityLevel	DefaultPriorityLevel	列舉，表示優先順序型執行的預設優先順序層級要求。
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.enablePriorityBasedExecution	boolean	旗標，表示在帳戶上啟用/停用優先順序式執行預覽功能
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 略過資源識別碼。
properties.publicNetworkAccess	PublicNetworkAccess	是否允許來自公用網路的要求
properties.virtualNetworkRules	VirtualNetworkRule[]	為 Cosmos DB 帳戶設定的虛擬網路 ACL 規則清單。
tags	object	標籤是描述資源的索引鍵值組清單。這些標籤可用於檢視和群組此資源（跨資源群組）。最多可為資源提供15個標籤。每個標記的索引鍵不得大於 128 個字元，且值不大於 256 個字元。例如，範本類型的預設體驗是使用 “defaultExperience”： “Cassandra” 設定。目前的 “defaultExperience” 值也包括 “Table”、“Graph”、“DocumentDB” 和 “MongoDB”。

回應

名稱	類型	Description
200 OK	DatabaseAccountGetResults	資料庫帳戶更新作業將會以非同步方式完成。

安全性

azure_auth

Azure Active Directory OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

CosmosDBDatabaseAccountPatch

範例要求

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1?api-version=2025-10-15

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

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",
                "defaultPriorityLevel": "Low",
                "enableAnalyticalStorage": True,
                "enableBurstCapacity": True,
                "enableFreeTier": False,
                "enablePartitionMerge": True,
                "enablePerRegionPerPartitionAutoscale": True,
                "enablePriorityBasedExecution": 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/DocumentDB/stable/2025-10-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/8b53f9cfc1fdb24dbfa28e311d3be4c645169297/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-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"),
			DefaultPriorityLevel:                 to.Ptr(armcosmos.DefaultPriorityLevelLow),
			EnableAnalyticalStorage:              to.Ptr(true),
			EnableBurstCapacity:                  to.Ptr(true),
			EnableFreeTier:                       to.Ptr(false),
			EnablePartitionMerge:                 to.Ptr(true),
			EnablePerRegionPerPartitionAutoscale: to.Ptr(true),
			EnablePriorityBasedExecution:         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"),
	// 		DefaultPriorityLevel: to.Ptr(armcosmos.DefaultPriorityLevelLow),
	// 		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),
	// 		EnablePriorityBasedExecution: 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/DocumentDB/stable/2025-10-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",
    defaultPriorityLevel: "Low",
    enableAnalyticalStorage: true,
    enableBurstCapacity: true,
    enableFreeTier: false,
    enablePartitionMerge: true,
    enablePerRegionPerPartitionAutoscale: true,
    enablePriorityBasedExecution: 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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.CosmosDB.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.CosmosDB;

// Generated from example definition: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/CosmosDBDatabaseAccountPatch.json
// this example is just showing the usage of "DatabaseAccounts_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CosmosDBAccountResource created on azure
// for more information of creating CosmosDBAccountResource, please refer to the document of CosmosDBAccountResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string accountName = "ddb1";
ResourceIdentifier cosmosDBAccountResourceId = CosmosDBAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
CosmosDBAccountResource cosmosDBAccount = client.GetCosmosDBAccountResource(cosmosDBAccountResourceId);

// invoke the operation
CosmosDBAccountPatch patch = new CosmosDBAccountPatch
{
    Tags =
    {
    ["dept"] = "finance"
    },
    Location = new AzureLocation("westus"),
    Identity = new ManagedServiceIdentity("SystemAssigned,UserAssigned")
    {
        UserAssignedIdentities =
        {
        [new ResourceIdentifier("/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1")] = new UserAssignedIdentity()
        },
    },
    ConsistencyPolicy = new ConsistencyPolicy(DefaultConsistencyLevel.BoundedStaleness)
    {
        MaxStalenessPrefix = 200L,
        MaxIntervalInSeconds = 10,
    },
    IPRules = {new CosmosDBIPAddressOrRange
    {
    IPAddressOrRange = "23.43.230.120",
    }, new CosmosDBIPAddressOrRange
    {
    IPAddressOrRange = "110.12.240.0/12",
    }},
    IsVirtualNetworkFilterEnabled = true,
    VirtualNetworkRules = {new CosmosDBVirtualNetworkRule
    {
    Id = new ResourceIdentifier("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"),
    IgnoreMissingVnetServiceEndpoint = false,
    }},
    DefaultIdentity = "FirstPartyIdentity",
    IsFreeTierEnabled = false,
    IsAnalyticalStorageEnabled = true,
    AnalyticalStorageSchemaType = AnalyticalStorageSchemaType.WellDefined,
    BackupPolicy = new PeriodicModeBackupPolicy
    {
        PeriodicModeProperties = new PeriodicModeProperties
        {
            BackupIntervalInMinutes = 240,
            BackupRetentionIntervalInHours = 720,
            BackupStorageRedundancy = CosmosDBBackupStorageRedundancy.Local,
        },
    },
    NetworkAclBypass = NetworkAclBypass.AzureServices,
    NetworkAclBypassResourceIds = { new ResourceIdentifier("/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName") },
    CapacityTotalThroughputLimit = 2000,
    EnablePartitionMerge = true,
    MinimalTlsVersion = CosmosDBMinimalTlsVersion.Tls,
    EnableBurstCapacity = true,
    EnablePerRegionPerPartitionAutoscale = true,
    EnablePriorityBasedExecution = true,
    DefaultPriorityLevel = DefaultPriorityLevel.Low,
};
ArmOperation<CosmosDBAccountResource> lro = await cosmosDBAccount.UpdateAsync(WaitUntil.Completed, patch);
CosmosDBAccountResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
CosmosDBAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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,
    "enablePriorityBasedExecution": true,
    "defaultPriorityLevel": "Low",
    "analyticalStorageConfiguration": {
      "schemaType": "WellDefined"
    },
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 720,
        "backupStorageRedundancy": "Local"
      }
    },
    "networkAclBypass": "AzureServices",
    "networkAclBypassResourceIds": [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
    ],
    "capacity": {
      "totalThroughputLimit": 2000
    },
    "keysMetadata": {
      "primaryMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "secondaryMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "primaryReadonlyMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "secondaryReadonlyMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      }
    },
    "enablePartitionMerge": true,
    "minimalTlsVersion": "Tls"
  }
}

定義

名稱	Description
AccountKeyMetadata	與指定資料庫帳戶的存取金鑰相關的中繼資料。
AnalyticalStorageConfiguration	分析記憶體特定屬性。
AnalyticalStorageSchemaType	描述分析記憶體的架構類型。
ApiProperties
BackupPolicyMigrationState	物件，表示備份原則之間移轉的狀態。
BackupPolicyMigrationStatus	描述備份原則類型之間的移轉狀態。
BackupPolicyType	描述備份模式。
BackupStorageRedundancy	列舉以指出備份儲存備援的類型。
Capability	Cosmos DB 功能物件
Capacity	物件，表示帳戶上與容量強制執行相關的所有屬性。
ConnectorOffer	Cosmos DB C* 資料庫帳戶的 cassandra 連接器供應專案類型。
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 帳戶的預設一致性層級和組態設定。
DefaultPriorityLevel	列舉以指出預設優先順序Level
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 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
VirtualNetworkRule	虛擬網路 ACL 規則物件

AccountKeyMetadata

Object

與指定資料庫帳戶的存取金鑰相關的中繼資料。

名稱	類型	Description
generationTime	string (date-time)	ISO-8601 格式金鑰的產生時間（UTC）。如果物件中缺少該值，則表示在 2022-06-18 之前觸發了最後一次金鑰重新產生。

AnalyticalStorageConfiguration

Object

分析記憶體特定屬性。

名稱	類型	Description
schemaType	AnalyticalStorageSchemaType	描述分析記憶體的架構類型。

AnalyticalStorageSchemaType

列舉型別

描述分析記憶體的架構類型。

值	Description
WellDefined
FullFidelity

ApiProperties

Object

名稱	類型	Description
serverVersion	ServerVersion	描述 MongoDB 帳戶的版本。

BackupPolicyMigrationState

Object

物件，表示備份原則之間移轉的狀態。

名稱	類型	Description
startTime	string (date-time)	備份原則移轉開始的時間（ISO-8601 格式）。
status	BackupPolicyMigrationStatus	描述備份原則類型之間的移轉狀態。
targetType	BackupPolicyType	描述備份原則移轉的目標備份原則類型。

BackupPolicyMigrationStatus

列舉型別

描述備份原則類型之間的移轉狀態。

值	Description
Invalid
InProgress
Completed
Failed

BackupPolicyType

列舉型別

描述備份模式。

值	Description
Periodic
Continuous

BackupStorageRedundancy

列舉型別

列舉以指出備份儲存備援的類型。

值	Description
Geo
Local
Zone

Capability

Object

Cosmos DB 功能物件

名稱	類型	Description
name	string	Cosmos DB 功能的名稱。例如，“name”： “EnableCassandra”。目前的值也包括「EnableTable」和「EnableGremlin」。。

Capacity

Object

物件，表示帳戶上與容量強制執行相關的所有屬性。

名稱	類型	Description
totalThroughputLimit	integer (int32) minimum: -1	對帳戶加總輸送量限制。 totalThroughputLimit 為 2000 會強制限制可布建到 2000 的帳戶上的最大輸送量上限。 -1 的 totalThroughputLimit 表示布建輸送量沒有限制。

ConnectorOffer

列舉型別

Cosmos DB C* 資料庫帳戶的 cassandra 連接器供應專案類型。

值	Description
Small

ConsistencyPolicy

Object

Cosmos DB 資料庫帳戶的一致性原則。

名稱	類型	Description
defaultConsistencyLevel	DefaultConsistencyLevel	Cosmos DB 帳戶的預設一致性層級和組態設定。
maxIntervalInSeconds	integer (int32) minimum: 5 maximum: 86400	搭配限定過期一致性層級使用時，這個值代表容許的過期時間量（以秒為單位）。此值的接受範圍是 5 - 86400。當 defaultConsistencyPolicy 設定為 'BoundedStaleness' 時為必要專案。
maxStalenessPrefix	integer (int64) minimum: 1 maximum: 2147483647	搭配限定過期一致性層級使用時，這個值代表容許的過時要求數目。此值的接受範圍是 1 – 2,147,483,647。當 defaultConsistencyPolicy 設定為 'BoundedStaleness' 時為必要專案。

ContinuousModeBackupPolicy

Object

代表連續模式備份原則的物件。

名稱	類型	Description
continuousModeProperties	ContinuousModeProperties	連續模式備份的組態值
migrationState	BackupPolicyMigrationState	物件，表示備份原則之間移轉的狀態。
type	string: Continuous	描述備份模式。

ContinuousModeProperties

Object

定期模式備份的組態值

名稱	類型	Description
tier	ContinuousTier	列舉，表示連續備份模式的類型

ContinuousTier

列舉型別

列舉以指出連續備份層的類型。

值	Description
Continuous7Days
Continuous30Days

CorsPolicy

Object

Cosmos DB 資料庫帳戶的 CORS 原則。

名稱	類型	Description
allowedHeaders	string	原始網域可以在 CORS 要求上指定的要求標頭。
allowedMethods	string	源域可用於 CORS 要求的方法（HTTP 要求動詞）。
allowedOrigins	string	允許透過 CORS 對服務提出要求的來源網域。
exposedHeaders	string	回應標頭，這些標頭可能會在響應中傳送至 CORS 要求，並由瀏覽器向要求簽發者公開。
maxAgeInSeconds	integer (int64) minimum: 1 maximum: 2147483647	瀏覽器應該快取預檢 OPTIONS 要求的最大時間量。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

CreateMode

列舉型別

列舉，表示帳戶建立模式。

值	Description
Default
Restore

DatabaseAccountGetResults

Object

Azure Cosmos DB 資料庫帳戶。

名稱	類型	預設值	Description
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.defaultPriorityLevel	DefaultPriorityLevel		列舉，表示優先順序型執行的預設優先順序層級要求。
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.enablePriorityBasedExecution	boolean		旗標，表示在帳戶上啟用/停用優先順序式執行預覽功能
properties.failoverPolicies	FailoverPolicy[]		包含依容錯移轉優先順序排序的區域的陣列。
properties.instanceId	string		指派給資料庫帳戶的唯一識別碼
properties.ipRules	IpAddressOrRange[]		IpRules 清單。
properties.isVirtualNetworkFilterEnabled	boolean		旗標，指出是否啟用/停用虛擬網路 ACL 規則。
properties.keyVaultKeyUri	string		金鑰保存庫的 URI
properties.keyVaultKeyUriVersion	string		帳戶目前使用的客戶管理金鑰版本
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[] (arm-id)		數位，其中包含Cosmos DB帳戶的網路 Acl 略過資源識別碼。
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		是否允許來自公用網路的要求
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

Object

與指定 Cosmos DB 資料庫帳戶之每個存取金鑰相關的中繼資料。

名稱	類型	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

列舉型別

指出資料庫帳戶的類型。這隻能在建立資料庫帳戶時設定。

值	Description
GlobalDocumentDB
MongoDB
Parse

DatabaseAccountOfferType

列舉型別

Cosmos DB 資料庫帳戶的供應專案類型。

值	Description
Standard

DatabaseAccountUpdateParameters

Object

修補 Azure Cosmos DB 資料庫帳戶屬性的參數。

名稱	類型	Description
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.defaultPriorityLevel	DefaultPriorityLevel	列舉，表示優先順序型執行的預設優先順序層級要求。
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.enablePriorityBasedExecution	boolean	旗標，表示在帳戶上啟用/停用優先順序式執行預覽功能
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 略過資源識別碼。
properties.publicNetworkAccess	PublicNetworkAccess	是否允許來自公用網路的要求
properties.virtualNetworkRules	VirtualNetworkRule[]	為 Cosmos DB 帳戶設定的虛擬網路 ACL 規則清單。
tags	object	標籤是描述資源的索引鍵值組清單。這些標籤可用於檢視和群組此資源（跨資源群組）。最多可為資源提供15個標籤。每個標記的索引鍵不得大於 128 個字元，且值不大於 256 個字元。例如，範本類型的預設體驗是使用 “defaultExperience”： “Cassandra” 設定。目前的 “defaultExperience” 值也包括 “Table”、“Graph”、“DocumentDB” 和 “MongoDB”。

DatabaseRestoreResource

Object

要還原的特定資料庫。

名稱	類型	Description
collectionNames	string[]	可用於還原的集合名稱。
databaseName	string	可供還原的資料庫名稱。

DefaultConsistencyLevel

列舉型別

Cosmos DB 帳戶的預設一致性層級和組態設定。

值	Description
Eventual
Session
BoundedStaleness
Strong
ConsistentPrefix

DefaultPriorityLevel

列舉型別

列舉以指出預設優先順序Level

值	Description
High
Low

FailoverPolicy

Object

資料庫帳戶指定區域的容錯移轉原則。

名稱	類型	Description
failoverPriority	integer (int32) minimum: 0	區域的故障轉移優先順序。故障轉移優先順序為 0 表示寫入區域。故障轉移優先順序的最大值 = （區域總數 - 1）。故障轉移優先順序值對於資料庫帳戶所在的每個區域都必須是唯一的。
id	string	資料庫帳戶複寫至之區域的唯一識別碼。範例：<accountName-locationName<>>。
locationName	string	資料庫帳戶所在的區域名稱。

GremlinDatabaseRestoreResource

Object

要還原的特定 Gremlin 資料庫。

名稱	類型	Description
databaseName	string	可用於還原的 gremlin 資料庫名稱。
graphNames	string[]	可供還原的圖形名稱。

IpAddressOrRange

Object

IpAddressOrRange 物件

名稱	類型	Description
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

Object

部署 Azure Cosmos DB 資料庫帳戶的區域。

名稱	類型	Description
documentEndpoint	string	特定區域的連線端點。範例：https://< accountName-locationName.documents.azure.com:443/>><
failoverPriority	integer (int32) minimum: 0	區域的故障轉移優先順序。故障轉移優先順序為 0 表示寫入區域。故障轉移優先順序的最大值 = （區域總數 - 1）。故障轉移優先順序值對於資料庫帳戶所在的每個區域都必須是唯一的。
id	string	資料庫帳戶內區域的唯一識別碼。範例：<accountName-locationName<>>。
isZoneRedundant	boolean	指出此區域是否為 AvailabilityZone 區域的旗標
locationName	string	區域的名稱。
provisioningState	string	呼叫作業時 Cosmos DB 帳戶的狀態。狀態可以是下列其中一項。 '正在建立' – 正在建立 Cosmos DB 帳戶。當帳戶處於 [建立中] 狀態時，只會傳回指定為 [建立 Cosmos DB 帳戶] 作業輸入的屬性。「成功」 – Cosmos DB 帳戶處於作用中狀態，可供使用。「更新中」 – Cosmos DB 帳戶正在更新。「刪除」 – 正在刪除 Cosmos DB 帳戶。「失敗」 – Cosmos DB 帳戶建立失敗。 'DeletionFailed' – Cosmos DB 帳戶刪除失敗。

ManagedServiceIdentity

Object

資源的身分識別。

名稱	類型	Description
principalId	string	系統指派身分的主體識別碼。此屬性只會針對系統指派的身分識別提供。
tenantId	string	系統指派身分識別的租用戶識別碼。此屬性只會針對系統指派的身分識別提供。
type	ResourceIdentityType	用於資源的身分識別類型。類型 'SystemAssigned，UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。類型『None』會從服務中移除任何身分識別。
userAssignedIdentities	UserAssignedIdentities	與資源相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/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

列舉型別

指出允許哪些服務略過防火牆檢查。

值	Description
None
AzureServices

PeriodicModeBackupPolicy

Object

代表定期模式備份原則的物件。

名稱	類型	Description
migrationState	BackupPolicyMigrationState	物件，表示備份原則之間移轉的狀態。
periodicModeProperties	PeriodicModeProperties	定期模式備份的組態值
type	string: Periodic	描述備份模式。

PeriodicModeProperties

Object

定期模式備份的組態值

名稱	類型	Description
backupIntervalInMinutes	integer (int32) minimum: 0	整數，表示兩個備份之間的間隔以分鐘為單位
backupRetentionIntervalInHours	integer (int32) minimum: 0	整數，代表每個備份保留的時間（以小時為單位）
backupStorageRedundancy	BackupStorageRedundancy	指出備份落地類型的列舉

PrivateEndpointConnection

Object

私人端點連線

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.groupId	string	私人端點的群組標識碼。
properties.privateEndpoint	PrivateEndpointProperty	線上所屬的私人端點。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	私人端點連線的連接狀態。
properties.provisioningState	string	布建私人端點的狀態。
type	string	資源的類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

PrivateEndpointProperty

Object

線上所屬的私人端點。

名稱	類型	Description
id	string	私人端點的資源標識碼。

PrivateLinkServiceConnectionStateProperty

Object

私人端點連線的連接狀態。

名稱	類型	Description
actionsRequired	string	基本工作流程以外的任何必要動作（核准/拒絕/中斷連線）
description	string	私人鏈接服務連線描述。
status	string	私人鏈接服務連線狀態。

PublicNetworkAccess

列舉型別

是否允許來自公用網路的要求

值	Description
Enabled
Disabled
SecuredByPerimeter

ResourceIdentityType

列舉型別

用於資源的身分識別類型。類型 'SystemAssigned，UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。類型『None』會從服務中移除任何身分識別。

值	Description
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned
None

RestoreMode

列舉型別

描述還原的模式。

值	Description
PointInTime

RestoreParameters

Object

用來指出還原相關信息的參數。

名稱	類型	Description
databasesToRestore	DatabaseRestoreResource[]	可供還原的特定資料庫清單。
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	可供還原的特定 gremlin 資料庫清單。
restoreMode	RestoreMode	描述還原的模式。
restoreSource	string	必須起始還原的可還原資料庫帳戶標識碼。例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string (date-time)	帳戶必須還原的時間（ISO-8601 格式）。
restoreWithTtlDisabled	boolean	指定還原的帳戶是否會在成功還原時停用時間To-Live。
sourceBackupLocation	string	用於還原的來源備份位置。
tablesToRestore	string[]	可供還原的特定數據表清單。

ServerVersion

列舉型別

描述 MongoDB 帳戶的版本。

值	Description
3.2
3.6
4.0
4.2
5.0
6.0
7.0

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

UserAssignedIdentities

Object

與資源相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

名稱	類型	Description

VirtualNetworkRule

Object

虛擬網路 ACL 規則物件

名稱	類型	Description
id	string (arm-id)	子網的資源標識符，例如：/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}。
ignoreMissingVNetServiceEndpoint	boolean	在虛擬網路啟用 vnet 服務端點之前建立防火牆規則。

共用方式為

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

DefaultPriorityLevel

FailoverPolicy

GremlinDatabaseRestoreResource

IpAddressOrRange

Location

ManagedServiceIdentity

MinimalTlsVersion

NetworkAclBypass

PeriodicModeBackupPolicy

PeriodicModeProperties

PrivateEndpointConnection

PrivateEndpointProperty

PrivateLinkServiceConnectionStateProperty

PublicNetworkAccess

ResourceIdentityType

RestoreMode

RestoreParameters

ServerVersion

systemData

UserAssignedIdentities

VirtualNetworkRule