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 參數

名稱	位於	必要	類型	Description
accountName	path	True	string	Cosmos DB 資料庫帳戶名稱。 Regex 模式: ^[a-z0-9]+(-[a-z0-9]+)*
resourceGroupName	path	True	string	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	要用於這項作業的 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.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 略過資源識別碼。
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 Flow

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

範圍

名稱	Description
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"
  }
}

定義

名稱	Description
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 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
VirtualNetworkRule	虛擬網路 ACL 規則物件

AccountKeyMetadata

與指定資料庫帳戶之存取金鑰相關的元數據。

名稱	類型	Description
generationTime	string	以 ISO-8601 格式的金鑰 UTC 產生時間。 如果對象中遺漏值，表示在 2022-06-18 之前觸發了最後一個索引鍵重新產生。

AnalyticalStorageConfiguration

分析記憶體特定屬性。

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

AnalyticalStorageSchemaType

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

名稱	類型	Description
FullFidelity	string
WellDefined	string

ApiProperties

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

BackupPolicyMigrationState

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

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

BackupPolicyMigrationStatus

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

名稱	類型	Description
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

描述備份模式。

名稱	類型	Description
Continuous	string
Periodic	string

BackupStorageRedundancy

列舉，表示備份記憶體備援的類型。

名稱	類型	Description
Geo	string
Local	string
Zone	string

Capability

Cosmos DB 功能物件

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

Capacity

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

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

ConnectorOffer

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

名稱	類型	Description
Small	string

ConsistencyPolicy

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

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

ContinuousModeBackupPolicy

物件，表示連續模式備份原則。

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

ContinuousModeProperties

定期模式備份的組態值

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

ContinuousTier

列舉，表示連續備份層的類型。

名稱	類型	Description
Continuous30Days	string
Continuous7Days	string

CorsPolicy

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

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

createdByType

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

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

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

名稱	類型	Description
Default	string
Restore	string

DatabaseAccountGetResults

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.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 略過資源識別碼。
properties.privateEndpointConnections	PrivateEndpointConnection[]		為 Cosmos DB 帳戶設定的私人端點連線清單。
properties.provisioningState	string		呼叫作業時 Cosmos DB 帳戶的狀態。 狀態可以是下列其中一項。 'Creating' – 正在建立 Cosmos DB 帳戶。 當帳戶處於建立狀態時，只會傳回指定為建立Cosmos DB帳戶作業輸入的屬性。 'Succeeded' – Cosmos DB 帳戶作用中以供使用。 「正在更新」– 正在更新 Cosmos DB 帳戶。 'Delete' – 正在刪除 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 資料庫帳戶之每個存取金鑰相關的元數據。

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

DatabaseAccountOfferType

Cosmos DB 資料庫帳戶的供應項目類型。

名稱	類型	Description
Standard	string

DatabaseAccountUpdateParameters

修補 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.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 略過資源識別碼。
properties.publicNetworkAccess	PublicNetworkAccess	是否允許來自公用網路的要求
properties.virtualNetworkRules	VirtualNetworkRule[]	為 Cosmos DB 帳戶設定的虛擬網路 ACL 規則清單。
tags	object	標籤是描述資源的索引鍵/值組清單。 這些標籤可用於檢視和群組此資源（跨資源群組）。 最多可為資源提供15個標籤。 每個標記的索引鍵不得大於 128 個字元，且值不大於 256 個字元。 例如，範本類型的默認體驗會設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。

DatabaseRestoreResource

要還原的特定資料庫。

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

DefaultConsistencyLevel

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

名稱	類型	Description
BoundedStaleness	string
ConsistentPrefix	string
Eventual	string
Session	string
Strong	string

FailoverPolicy

資料庫帳戶指定區域的故障轉移原則。

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

GremlinDatabaseRestoreResource

要還原的特定 Gremlin 資料庫。

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

IpAddressOrRange

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

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

名稱	類型	Description
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 帳戶的狀態。 狀態可以是下列其中一項。 'Creating' – 正在建立 Cosmos DB 帳戶。 當帳戶處於建立狀態時，只會傳回指定為建立Cosmos DB帳戶作業輸入的屬性。 'Succeeded' – Cosmos DB 帳戶作用中以供使用。 「正在更新」– 正在更新 Cosmos DB 帳戶。 'Delete' – 正在刪除 Cosmos DB 帳戶。 'Failed' – Cosmos DB 帳戶建立失敗。 'DeletionFailed' – Cosmos DB 帳戶刪除失敗。

ManagedServiceIdentity

資源的身分識別。

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

NetworkAclBypass

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

名稱	類型	Description
AzureServices	string
None	string

PeriodicModeBackupPolicy

物件，表示定期模式備份原則。

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

PeriodicModeProperties

定期模式備份的組態值

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

PrivateEndpointConnection

私人端點連線

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

線上所屬的私人端點。

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

PrivateLinkServiceConnectionStateProperty

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

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

PublicNetworkAccess

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

名稱	類型	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

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

名稱	類型	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

描述還原的模式。

名稱	類型	Description
PointInTime	string

RestoreParameters

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

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

ServerVersion

描述 MongoDB 帳戶的版本。

名稱	類型	Description
3.2	string
3.6	string
4.0	string
4.2	string
5.0	string
6.0	string
7.0	string

systemData

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

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

UserAssignedIdentities

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

名稱	類型	Description

VirtualNetworkRule

虛擬網路 ACL 規則物件

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