Database Accounts - Update

サービス:

Cosmos DB Resource Provider

API バージョン:

2024-11-15

既存の Azure Cosmos DB データベース アカウントのプロパティを更新します。

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

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string	Cosmos DB データベース アカウント名。 正規表現パターン: ^[a-z0-9]+(-[a-z0-9]+)*
resourceGroupName	path	True	string	リソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	型	説明
identity	ManagedServiceIdentity	リソースの ID。
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	Cosmos DB データベース C* アカウントの cassandra コネクタ オファーの種類。
properties.consistencyPolicy	ConsistencyPolicy	Cosmos DB アカウントの整合性ポリシー。
properties.cors	CorsPolicy[]	Cosmos DB データベース アカウントの CORS ポリシー。
properties.customerManagedKeyStatus	string	アカウントのカスタマー マネージド キー機能の状態を示します。 エラーが発生した場合、このプロパティはトラブルシューティング のガイダンスを提供します。
properties.defaultIdentity	string	カスタマー マネージド キーなどの機能で使用されるキー コンテナーにアクセスするための既定の ID。 既定の ID は、ユーザーが明示的に設定する必要があります。 "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	Free レベルが有効かどうかを示すフラグ。
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 アカウントで有効になっている georeplication の場所を含む配列。
properties.minimalTlsVersion	MinimalTlsVersion	許可される Tls の最小バージョンを示します。 既定値は Tls 1.2 です。 Cassandra API と Mongo API は Tls 1.2 でのみ機能します。
properties.networkAclBypass	NetworkAclBypass	ファイアウォール チェックをバイパスできるサービスを示します。
properties.networkAclBypassResourceIds	string[]	Cosmos DB アカウントのネットワーク ACL バイパスのリソース ID を含む配列。
properties.publicNetworkAccess	PublicNetworkAccess	パブリック ネットワークからの要求が許可されるかどうか
properties.virtualNetworkRules	VirtualNetworkRule[]	Cosmos DB アカウント用に構成された仮想ネットワーク ACL 規則の一覧。
tags	object	タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグは、(リソース グループ間で) このリソースを表示およびグループ化する場合に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには、128 文字以下のキーと 256 文字以下の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" で設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。

応答

名前	型	説明
200 OK	DatabaseAccountGetResults	データベース アカウントの更新操作は非同期的に完了します。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

CosmosDBDatabaseAccountPatch

要求のサンプル

HTTP

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

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

Java

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

/**
 * Samples for DatabaseAccounts Update.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/
     * CosmosDBDatabaseAccountPatch.json
     */
    /**
     * Sample code: CosmosDBDatabaseAccountPatch.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBDatabaseAccountPatch(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getDatabaseAccounts().update("rg1", "ddb1",
            new DatabaseAccountUpdateParameters().withTags(mapOf("dept", "finance")).withLocation("westus")
                .withIdentity(new ManagedServiceIdentity().withType(ResourceIdentityType.SYSTEM_ASSIGNED_USER_ASSIGNED)
                    .withUserAssignedIdentities(mapOf(
                        "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1",
                        new ManagedServiceIdentityUserAssignedIdentities())))
                .withConsistencyPolicy(
                    new ConsistencyPolicy().withDefaultConsistencyLevel(DefaultConsistencyLevel.BOUNDED_STALENESS)
                        .withMaxStalenessPrefix(200L).withMaxIntervalInSeconds(10))
                .withIpRules(Arrays.asList(new IpAddressOrRange().withIpAddressOrRange("23.43.230.120"),
                    new IpAddressOrRange().withIpAddressOrRange("110.12.240.0/12")))
                .withIsVirtualNetworkFilterEnabled(true)
                .withVirtualNetworkRules(Arrays.asList(new VirtualNetworkRule().withId(
                    "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1")
                    .withIgnoreMissingVNetServiceEndpoint(false)))
                .withDefaultIdentity("FirstPartyIdentity").withEnableFreeTier(false).withEnableAnalyticalStorage(true)
                .withAnalyticalStorageConfiguration(
                    new AnalyticalStorageConfiguration().withSchemaType(AnalyticalStorageSchemaType.WELL_DEFINED))
                .withBackupPolicy(new PeriodicModeBackupPolicy().withPeriodicModeProperties(new PeriodicModeProperties()
                    .withBackupIntervalInMinutes(240).withBackupRetentionIntervalInHours(720)
                    .withBackupStorageRedundancy(BackupStorageRedundancy.LOCAL)))
                .withNetworkAclBypass(NetworkAclBypass.AZURE_SERVICES)
                .withNetworkAclBypassResourceIds(Arrays.asList(
                    "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"))
                .withCapacity(new Capacity().withTotalThroughputLimit(2000)).withEnablePartitionMerge(true)
                .withMinimalTlsVersion(MinimalTlsVersion.TLS).withEnableBurstCapacity(true)
                .withEnablePerRegionPerPartitionAutoscale(true),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

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

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


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

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


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBDatabaseAccountPatch.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcosmos_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ded6306d00ae294c24211e5069c1f56b15ba8ef5/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBDatabaseAccountPatch.json
func ExampleDatabaseAccountsClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDatabaseAccountsClient().BeginUpdate(ctx, "rg1", "ddb1", armcosmos.DatabaseAccountUpdateParameters{
		Identity: &armcosmos.ManagedServiceIdentity{
			Type: to.Ptr(armcosmos.ResourceIdentityTypeSystemAssignedUserAssigned),
			UserAssignedIdentities: map[string]*armcosmos.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
				"/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
			},
		},
		Location: to.Ptr("westus"),
		Properties: &armcosmos.DatabaseAccountUpdateProperties{
			AnalyticalStorageConfiguration: &armcosmos.AnalyticalStorageConfiguration{
				SchemaType: to.Ptr(armcosmos.AnalyticalStorageSchemaTypeWellDefined),
			},
			BackupPolicy: &armcosmos.PeriodicModeBackupPolicy{
				Type: to.Ptr(armcosmos.BackupPolicyTypePeriodic),
				PeriodicModeProperties: &armcosmos.PeriodicModeProperties{
					BackupIntervalInMinutes:        to.Ptr[int32](240),
					BackupRetentionIntervalInHours: to.Ptr[int32](720),
					BackupStorageRedundancy:        to.Ptr(armcosmos.BackupStorageRedundancyLocal),
				},
			},
			Capacity: &armcosmos.Capacity{
				TotalThroughputLimit: to.Ptr[int32](2000),
			},
			ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
				DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelBoundedStaleness),
				MaxIntervalInSeconds:    to.Ptr[int32](10),
				MaxStalenessPrefix:      to.Ptr[int64](200),
			},
			DefaultIdentity:                      to.Ptr("FirstPartyIdentity"),
			EnableAnalyticalStorage:              to.Ptr(true),
			EnableBurstCapacity:                  to.Ptr(true),
			EnableFreeTier:                       to.Ptr(false),
			EnablePartitionMerge:                 to.Ptr(true),
			EnablePerRegionPerPartitionAutoscale: to.Ptr(true),
			IPRules: []*armcosmos.IPAddressOrRange{
				{
					IPAddressOrRange: to.Ptr("23.43.230.120"),
				},
				{
					IPAddressOrRange: to.Ptr("110.12.240.0/12"),
				}},
			IsVirtualNetworkFilterEnabled: to.Ptr(true),
			MinimalTLSVersion:             to.Ptr(armcosmos.MinimalTLSVersionTLS),
			NetworkACLBypass:              to.Ptr(armcosmos.NetworkACLBypassAzureServices),
			NetworkACLBypassResourceIDs: []*string{
				to.Ptr("/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName")},
			VirtualNetworkRules: []*armcosmos.VirtualNetworkRule{
				{
					ID:                               to.Ptr("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"),
					IgnoreMissingVNetServiceEndpoint: to.Ptr(false),
				}},
		},
		Tags: map[string]*string{
			"dept": to.Ptr("finance"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DatabaseAccountGetResults = armcosmos.DatabaseAccountGetResults{
	// 	Name: to.Ptr("ddb1"),
	// 	Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"dept": to.Ptr("finance"),
	// 	},
	// 	Identity: &armcosmos.ManagedServiceIdentity{
	// 		Type: to.Ptr(armcosmos.ResourceIdentityTypeSystemAssignedUserAssigned),
	// 		PrincipalID: to.Ptr("52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656"),
	// 		TenantID: to.Ptr("33e01921-4d64-4f8c-a055-5bdaffd5e33d"),
	// 		UserAssignedIdentities: map[string]*armcosmos.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
	// 			"/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &armcosmos.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
	// 				ClientID: to.Ptr("fbe75b66-01c5-4f87-a220-233af3270436"),
	// 				PrincipalID: to.Ptr("33e01921-4d64-4f8c-a055-5bdaffd5e33d"),
	// 			},
	// 		},
	// 	},
	// 	Kind: to.Ptr(armcosmos.DatabaseAccountKindGlobalDocumentDB),
	// 	Properties: &armcosmos.DatabaseAccountGetProperties{
	// 		AnalyticalStorageConfiguration: &armcosmos.AnalyticalStorageConfiguration{
	// 			SchemaType: to.Ptr(armcosmos.AnalyticalStorageSchemaTypeWellDefined),
	// 		},
	// 		APIProperties: &armcosmos.APIProperties{
	// 		},
	// 		BackupPolicy: &armcosmos.PeriodicModeBackupPolicy{
	// 			Type: to.Ptr(armcosmos.BackupPolicyTypePeriodic),
	// 			PeriodicModeProperties: &armcosmos.PeriodicModeProperties{
	// 				BackupIntervalInMinutes: to.Ptr[int32](240),
	// 				BackupRetentionIntervalInHours: to.Ptr[int32](720),
	// 				BackupStorageRedundancy: to.Ptr(armcosmos.BackupStorageRedundancyLocal),
	// 			},
	// 		},
	// 		Capacity: &armcosmos.Capacity{
	// 			TotalThroughputLimit: to.Ptr[int32](2000),
	// 		},
	// 		ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
	// 			DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelBoundedStaleness),
	// 			MaxIntervalInSeconds: to.Ptr[int32](10),
	// 			MaxStalenessPrefix: to.Ptr[int64](200),
	// 		},
	// 		Cors: []*armcosmos.CorsPolicy{
	// 		},
	// 		DatabaseAccountOfferType: to.Ptr("Standard"),
	// 		DefaultIdentity: to.Ptr("FirstPartyIdentity"),
	// 		DisableKeyBasedMetadataWriteAccess: to.Ptr(false),
	// 		DocumentEndpoint: to.Ptr("https://ddb1.documents.azure.com:443/"),
	// 		EnableAnalyticalStorage: to.Ptr(true),
	// 		EnableBurstCapacity: to.Ptr(true),
	// 		EnableFreeTier: to.Ptr(false),
	// 		EnablePartitionMerge: to.Ptr(true),
	// 		FailoverPolicies: []*armcosmos.FailoverPolicy{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-eastus"),
	// 				LocationName: to.Ptr("East US"),
	// 		}},
	// 		IPRules: []*armcosmos.IPAddressOrRange{
	// 			{
	// 				IPAddressOrRange: to.Ptr("23.43.230.120"),
	// 			},
	// 			{
	// 				IPAddressOrRange: to.Ptr("110.12.240.0/12"),
	// 		}},
	// 		IsVirtualNetworkFilterEnabled: to.Ptr(true),
	// 		KeysMetadata: &armcosmos.DatabaseAccountKeysMetadata{
	// 			PrimaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
	// 			},
	// 			PrimaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
	// 			},
	// 			SecondaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
	// 			},
	// 			SecondaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-25T20:30:11.000Z"); return t}()),
	// 			},
	// 		},
	// 		Locations: []*armcosmos.Location{
	// 			{
	// 				DocumentEndpoint: to.Ptr("https://ddb1-eastus.documents.azure.com:443/"),
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-eastus"),
	// 				LocationName: to.Ptr("East US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 		MinimalTLSVersion: to.Ptr(armcosmos.MinimalTLSVersionTLS),
	// 		NetworkACLBypass: to.Ptr(armcosmos.NetworkACLBypassAzureServices),
	// 		NetworkACLBypassResourceIDs: []*string{
	// 			to.Ptr("/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName")},
	// 			PrivateEndpointConnections: []*armcosmos.PrivateEndpointConnection{
	// 				{
	// 					ID: to.Ptr("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1"),
	// 					Properties: &armcosmos.PrivateEndpointConnectionProperties{
	// 						PrivateEndpoint: &armcosmos.PrivateEndpointProperty{
	// 							ID: to.Ptr("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1"),
	// 						},
	// 						PrivateLinkServiceConnectionState: &armcosmos.PrivateLinkServiceConnectionStateProperty{
	// 							ActionsRequired: to.Ptr("None"),
	// 							Status: to.Ptr("Approved"),
	// 						},
	// 					},
	// 			}},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			ReadLocations: []*armcosmos.Location{
	// 				{
	// 					DocumentEndpoint: to.Ptr("https://ddb1-eastus.documents.azure.com:443/"),
	// 					FailoverPriority: to.Ptr[int32](0),
	// 					ID: to.Ptr("ddb1-eastus"),
	// 					LocationName: to.Ptr("East US"),
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 			}},
	// 			VirtualNetworkRules: []*armcosmos.VirtualNetworkRule{
	// 				{
	// 					ID: to.Ptr("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"),
	// 					IgnoreMissingVNetServiceEndpoint: to.Ptr(false),
	// 			}},
	// 			WriteLocations: []*armcosmos.Location{
	// 				{
	// 					DocumentEndpoint: to.Ptr("https://ddb1-eastus.documents.azure.com:443/"),
	// 					FailoverPriority: to.Ptr[int32](0),
	// 					ID: to.Ptr("ddb1-eastus"),
	// 					LocationName: to.Ptr("East US"),
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 			}},
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

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

/**
 * This sample demonstrates how to Updates the properties of an existing Azure Cosmos DB database account.
 *
 * @summary Updates the properties of an existing Azure Cosmos DB database account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBDatabaseAccountPatch.json
 */
async function cosmosDbDatabaseAccountPatch() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const updateParameters = {
    analyticalStorageConfiguration: { schemaType: "WellDefined" },
    backupPolicy: {
      type: "Periodic",
      periodicModeProperties: {
        backupIntervalInMinutes: 240,
        backupRetentionIntervalInHours: 720,
        backupStorageRedundancy: "Local",
      },
    },
    capacity: { totalThroughputLimit: 2000 },
    consistencyPolicy: {
      defaultConsistencyLevel: "BoundedStaleness",
      maxIntervalInSeconds: 10,
      maxStalenessPrefix: 200,
    },
    defaultIdentity: "FirstPartyIdentity",
    enableAnalyticalStorage: true,
    enableBurstCapacity: true,
    enableFreeTier: false,
    enablePartitionMerge: true,
    enablePerRegionPerPartitionAutoscale: true,
    identity: {
      type: "SystemAssigned,UserAssigned",
      userAssignedIdentities: {
        "/subscriptions/fa5fc227A624475eB696Cdd604c735bc/resourceGroups/eu2cgroup/providers/MicrosoftManagedIdentity/userAssignedIdentities/id1":
          {},
      },
    },
    ipRules: [{ ipAddressOrRange: "23.43.230.120" }, { ipAddressOrRange: "110.12.240.0/12" }],
    isVirtualNetworkFilterEnabled: true,
    location: "westus",
    minimalTlsVersion: "Tls",
    networkAclBypass: "AzureServices",
    networkAclBypassResourceIds: [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName",
    ],
    tags: { dept: "finance" },
    virtualNetworkRules: [
      {
        id: "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        ignoreMissingVNetServiceEndpoint: false,
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.databaseAccounts.beginUpdateAndWait(
    resourceGroupName,
    accountName,
    updateParameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
  "name": "ddb1",
  "location": "West US",
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "kind": "GlobalDocumentDB",
  "tags": {
    "dept": "finance"
  },
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656",
    "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d",
    "userAssignedIdentities": {
      "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "fbe75b66-01c5-4f87-a220-233af3270436",
        "principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d"
      }
    }
  },
  "properties": {
    "provisioningState": "Succeeded",
    "documentEndpoint": "https://ddb1.documents.azure.com:443/",
    "databaseAccountOfferType": "Standard",
    "ipRules": [
      {
        "ipAddressOrRange": "23.43.230.120"
      },
      {
        "ipAddressOrRange": "110.12.240.0/12"
      }
    ],
    "isVirtualNetworkFilterEnabled": true,
    "disableKeyBasedMetadataWriteAccess": false,
    "consistencyPolicy": {
      "defaultConsistencyLevel": "BoundedStaleness",
      "maxIntervalInSeconds": 10,
      "maxStalenessPrefix": 200
    },
    "writeLocations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "readLocations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "locations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "failoverPolicies": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "failoverPriority": 0
      }
    ],
    "virtualNetworkRules": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "ignoreMissingVNetServiceEndpoint": false
      }
    ],
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "actionsRequired": "None"
          }
        }
      }
    ],
    "cors": [],
    "defaultIdentity": "FirstPartyIdentity",
    "enableFreeTier": false,
    "apiProperties": {},
    "enableAnalyticalStorage": true,
    "enableBurstCapacity": true,
    "analyticalStorageConfiguration": {
      "schemaType": "WellDefined"
    },
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 720,
        "backupStorageRedundancy": "Local"
      }
    },
    "networkAclBypass": "AzureServices",
    "networkAclBypassResourceIds": [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
    ],
    "capacity": {
      "totalThroughputLimit": 2000
    },
    "keysMetadata": {
      "primaryMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "secondaryMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "primaryReadonlyMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "secondaryReadonlyMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      }
    },
    "enablePartitionMerge": true,
    "minimalTlsVersion": "Tls"
  }
}

定義

名前	説明
AccountKeyMetadata	特定のデータベース アカウントのアクセス キーに関連するメタデータ。
AnalyticalStorageConfiguration	分析ストレージ固有のプロパティ。
AnalyticalStorageSchemaType	分析ストレージのスキーマの種類について説明します。
ApiProperties
BackupPolicyMigrationState	バックアップ ポリシー間の移行の状態を表すオブジェクト。
BackupPolicyMigrationStatus	バックアップ ポリシーの種類間の移行の状態について説明します。
BackupPolicyType	バックアップのモードについて説明します。
BackupStorageRedundancy	バックアップ ストレージの冗長性の種類を示す列挙型。
Capability	Cosmos DB 機能オブジェクト
Capacity	アカウントの容量の適用に関連するすべてのプロパティを表すオブジェクト。
ConnectorOffer	Cosmos DB C* データベース アカウントの cassandra コネクタ オファーの種類。
ConsistencyPolicy	Cosmos DB データベース アカウントの整合性ポリシー。
ContinuousModeBackupPolicy	連続モードのバックアップ ポリシーを表すオブジェクト。
ContinuousModeProperties	定期モード バックアップの構成値
ContinuousTier	継続的バックアップ層の種類を示す列挙型。
CorsPolicy	Cosmos DB データベース アカウントの CORS ポリシー。
createdByType	リソースを作成した ID の種類。
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	リソースの ID。
MinimalTlsVersion	許可される Tls の最小バージョンを示します。 既定値は Tls 1.2 です。 Cassandra API と Mongo API は Tls 1.2 でのみ機能します。
NetworkAclBypass	ファイアウォール チェックをバイパスできるサービスを示します。
PeriodicModeBackupPolicy	定期的なモードのバックアップ ポリシーを表すオブジェクト。
PeriodicModeProperties	定期モード バックアップの構成値
PrivateEndpointConnection	プライベート エンドポイント接続
PrivateEndpointProperty	接続が属するプライベート エンドポイント。
PrivateLinkServiceConnectionStateProperty	プライベート エンドポイント接続の接続状態。
PublicNetworkAccess	パブリック ネットワークからの要求が許可されるかどうか
ResourceIdentityType	リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。
RestoreMode	復元のモードについて説明します。
RestoreParameters	復元に関する情報を示すパラメーター。
ServerVersion	MongoDB アカウントのバージョンについて説明します。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserAssignedIdentities	リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。
VirtualNetworkRule	Virtual Network ACL Rule オブジェクト

AccountKeyMetadata

特定のデータベース アカウントのアクセス キーに関連するメタデータ。

名前	型	説明
generationTime	string	ISO-8601 形式のキーの UTC での生成時刻。 オブジェクトに値がない場合は、2022-06-18 より前に最後のキーの再生成がトリガーされたことを意味します。

AnalyticalStorageConfiguration

分析ストレージ固有のプロパティ。

名前	型	説明
schemaType	AnalyticalStorageSchemaType	分析ストレージのスキーマの種類について説明します。

AnalyticalStorageSchemaType

分析ストレージのスキーマの種類について説明します。

名前	型	説明
FullFidelity	string
WellDefined	string

ApiProperties

名前	型	説明
serverVersion	ServerVersion	MongoDB アカウントのバージョンについて説明します。

BackupPolicyMigrationState

バックアップ ポリシー間の移行の状態を表すオブジェクト。

名前	型	説明
startTime	string	バックアップ ポリシーの移行が開始された時刻 (ISO-8601 形式)。
status	BackupPolicyMigrationStatus	バックアップ ポリシーの種類間の移行の状態について説明します。
targetType	BackupPolicyType	バックアップ ポリシー移行のターゲット バックアップ ポリシーの種類について説明します。

BackupPolicyMigrationStatus

バックアップ ポリシーの種類間の移行の状態について説明します。

名前	型	説明
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

バックアップのモードについて説明します。

名前	型	説明
Continuous	string
Periodic	string

BackupStorageRedundancy

バックアップ ストレージの冗長性の種類を示す列挙型。

名前	型	説明
Geo	string
Local	string
Zone	string

Capability

Cosmos DB 機能オブジェクト

名前	型	説明
name	string	Cosmos DB 機能の名前。 たとえば、"name": "EnableCassandra" です。 現在の値には、"EnableTable" と "EnableGremlin" も含まれます。

Capacity

アカウントの容量の適用に関連するすべてのプロパティを表すオブジェクト。

名前	型	説明
totalThroughputLimit	integer	アカウントに課される合計スループット制限。 totalThroughputLimit が 2000 の場合、そのアカウントでプロビジョニングできる最大スループットの厳密な制限は 2000 になります。 totalThroughputLimit の -1 は、スループットのプロビジョニングに制限がないことを示します。

ConnectorOffer

Cosmos DB C* データベース アカウントの cassandra コネクタ オファーの種類。

名前	型	説明
Small	string

ConsistencyPolicy

Cosmos DB データベース アカウントの整合性ポリシー。

名前	型	説明
defaultConsistencyLevel	DefaultConsistencyLevel	Cosmos DB アカウントの既定の整合性レベルと構成設定。
maxIntervalInSeconds	integer	有界整合性制約の整合性レベルで使用する場合、この値は許容される制約の時間量 (秒単位) を表します。 この値に使用できる範囲は 5 ~ 86400 です。 defaultConsistencyPolicy が 'BoundedStaleness' に設定されている場合に必要です。
maxStalenessPrefix	integer	有界整合性制約の整合性レベルで使用する場合、この値は許容される古い要求の数を表します。 この値に使用できる範囲は 1 ~ 2,147,483,647 です。 defaultConsistencyPolicy が 'BoundedStaleness' に設定されている場合に必要です。

ContinuousModeBackupPolicy

連続モードのバックアップ ポリシーを表すオブジェクト。

名前	型	説明
continuousModeProperties	ContinuousModeProperties	連続モード バックアップの構成値
migrationState	BackupPolicyMigrationState	バックアップ ポリシー間の移行の状態を表すオブジェクト。
type	string: Continuous	バックアップのモードについて説明します。

ContinuousModeProperties

定期モード バックアップの構成値

名前	型	説明
tier	ContinuousTier	連続バックアップ モードの種類を示す列挙型

ContinuousTier

継続的バックアップ層の種類を示す列挙型。

名前	型	説明
Continuous30Days	string
Continuous7Days	string

CorsPolicy

Cosmos DB データベース アカウントの CORS ポリシー。

名前	型	説明
allowedHeaders	string	配信元ドメインが CORS 要求で指定できる要求ヘッダー。
allowedMethods	string	配信元ドメインが CORS 要求に使用できるメソッド (HTTP 要求動詞)。
allowedOrigins	string	CORS 経由でサービスに対して要求を行うことができます。
exposedHeaders	string	CORS 要求への応答で送信され、ブラウザーによって要求発行者に公開される可能性がある応答ヘッダー。
maxAgeInSeconds	integer	ブラウザーがプレフライト OPTIONS 要求をキャッシュする最大時間。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

アカウント作成モードを示す列挙型。

名前	型	説明
Default	string
Restore	string

DatabaseAccountGetResults

Azure Cosmos DB データベース アカウント。

名前	型	規定値	説明
id	string		ARM リソースの一意のリソース識別子。
identity	ManagedServiceIdentity		リソースの ID。
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		Cosmos DB データベース C* アカウントの cassandra コネクタ オファーの種類。
properties.consistencyPolicy	ConsistencyPolicy		Cosmos DB データベース アカウントの整合性ポリシー。
properties.cors	CorsPolicy[]		Cosmos DB データベース アカウントの CORS ポリシー。
properties.createMode	CreateMode	Default	アカウント作成モードを示す列挙型。
properties.customerManagedKeyStatus	string		アカウントのカスタマー マネージド キー機能の状態を示します。 エラーが発生した場合、このプロパティはトラブルシューティング のガイダンスを提供します。
properties.databaseAccountOfferType	DatabaseAccountOfferType		Cosmos DB データベース アカウントのオファーの種類。 既定値: Standard。
properties.defaultIdentity	string		カスタマー マネージド キーなどの機能で使用されるキー コンテナーにアクセスするための既定の ID。 既定の ID は、ユーザーが明示的に設定する必要があります。 "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		Free レベルが有効かどうかを示すフラグ。
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 API と Mongo API は Tls 1.2 でのみ機能します。
properties.networkAclBypass	NetworkAclBypass		ファイアウォール チェックをバイパスできるサービスを示します。
properties.networkAclBypassResourceIds	string[]		Cosmos DB アカウントのネットワーク ACL バイパスのリソース ID を含む配列。
properties.privateEndpointConnections	PrivateEndpointConnection[]		Cosmos DB アカウント用に構成されたプライベート エンドポイント接続の一覧。
properties.provisioningState	string		操作が呼び出されたときの Cosmos DB アカウントの状態。 状態は次のいずれかになります。 "作成中" – Cosmos DB アカウントが作成されています。 アカウントが作成中の状態の場合、Cosmos DB アカウントの作成操作の入力として指定されたプロパティのみが返されます。 "成功" – Cosmos DB アカウントがアクティブに使用されています。 '更新中' – Cosmos DB アカウントが更新中です。 "削除中" – Cosmos DB アカウントが削除されています。 'Failed' – Cosmos DB アカウントの作成に失敗しました。 'DeletionFailed' – Cosmos DB アカウントの削除に失敗しました。
properties.publicNetworkAccess	PublicNetworkAccess		パブリック ネットワークからの要求が許可されるかどうか
properties.readLocations	Location[]		Cosmos DB アカウントで有効になっている読み取り場所を含む配列。
properties.restoreParameters	RestoreParameters		復元に関する情報を示すパラメーター。
properties.virtualNetworkRules	VirtualNetworkRule[]		Cosmos DB アカウント用に構成された仮想ネットワーク ACL 規則の一覧。
properties.writeLocations	Location[]		Cosmos DB アカウントの書き込み場所を含む配列。
systemData	systemData		このリソースに関連するシステム メタデータ。
tags	object		タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグは、(リソース グループ間で) このリソースを表示およびグループ化する場合に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには、128 文字以下のキーと 256 文字以下の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" で設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。
type	string		Azure リソースの種類。

DatabaseAccountKeysMetadata

指定された Cosmos DB データベース アカウントの各アクセス キーに関連するメタデータ。

名前	型	説明
primaryMasterKey	AccountKeyMetadata	指定された Cosmos DB データベース アカウントのプライマリ Read-Write キーに関連するメタデータ。
primaryReadonlyMasterKey	AccountKeyMetadata	指定された Cosmos DB データベース アカウントのプライマリ Read-Only キーに関連するメタデータ。
secondaryMasterKey	AccountKeyMetadata	指定された Cosmos DB データベース アカウントのセカンダリ Read-Write キーに関連するメタデータ。
secondaryReadonlyMasterKey	AccountKeyMetadata	指定された Cosmos DB データベース アカウントのセカンダリ Read-Only キーに関連するメタデータ。

DatabaseAccountKind

データベース アカウントの種類を示します。 これは、データベース アカウントの作成時にのみ設定できます。

名前	型	説明
GlobalDocumentDB	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

Cosmos DB データベース アカウントのオファーの種類。

名前	型	説明
Standard	string

DatabaseAccountUpdateParameters

Azure Cosmos DB データベース アカウントのプロパティに修正プログラムを適用するためのパラメーター。

名前	型	説明
identity	ManagedServiceIdentity	リソースの ID。
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	Cosmos DB データベース C* アカウントの cassandra コネクタ オファーの種類。
properties.consistencyPolicy	ConsistencyPolicy	Cosmos DB アカウントの整合性ポリシー。
properties.cors	CorsPolicy[]	Cosmos DB データベース アカウントの CORS ポリシー。
properties.customerManagedKeyStatus	string	アカウントのカスタマー マネージド キー機能の状態を示します。 エラーが発生した場合、このプロパティはトラブルシューティング のガイダンスを提供します。
properties.defaultIdentity	string	カスタマー マネージド キーなどの機能で使用されるキー コンテナーにアクセスするための既定の ID。 既定の ID は、ユーザーが明示的に設定する必要があります。 "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	Free レベルが有効かどうかを示すフラグ。
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 アカウントで有効になっている georeplication の場所を含む配列。
properties.minimalTlsVersion	MinimalTlsVersion	許可される Tls の最小バージョンを示します。 既定値は Tls 1.2 です。 Cassandra API と Mongo API は Tls 1.2 でのみ機能します。
properties.networkAclBypass	NetworkAclBypass	ファイアウォール チェックをバイパスできるサービスを示します。
properties.networkAclBypassResourceIds	string[]	Cosmos DB アカウントのネットワーク ACL バイパスのリソース ID を含む配列。
properties.publicNetworkAccess	PublicNetworkAccess	パブリック ネットワークからの要求が許可されるかどうか
properties.virtualNetworkRules	VirtualNetworkRule[]	Cosmos DB アカウント用に構成された仮想ネットワーク ACL 規則の一覧。
tags	object	タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグは、(リソース グループ間で) このリソースを表示およびグループ化する場合に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには、128 文字以下のキーと 256 文字以下の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" で設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。

DatabaseRestoreResource

復元する特定のデータベース。

名前	型	説明
collectionNames	string[]	復元に使用できるコレクションの名前。
databaseName	string	復元に使用できるデータベースの名前。

DefaultConsistencyLevel

Cosmos DB アカウントの既定の整合性レベルと構成設定。

名前	型	説明
BoundedStaleness	string
ConsistentPrefix	string
Eventual	string
Session	string
Strong	string

FailoverPolicy

データベース アカウントの特定のリージョンのフェールオーバー ポリシー。

名前	型	説明
failoverPriority	integer	リージョンのフェールオーバーの優先順位。 フェールオーバーの優先度が 0 の場合は、書き込みリージョンを示します。 フェールオーバー優先度の最大値 = (リージョンの合計数 - 1)。 フェールオーバー優先度の値は、データベース アカウントが存在するリージョンごとに一意である必要があります。
id	string	データベース アカウントがレプリケートされるリージョンの一意識別子。 例: <accountName>-<locationName>。
locationName	string	データベース アカウントが存在するリージョンの名前。

GremlinDatabaseRestoreResource

復元する特定の Gremlin データベース。

名前	型	説明
databaseName	string	復元に使用できる gremlin データベースの名前。
graphNames	string[]	復元に使用できるグラフの名前。

IpAddressOrRange

IpAddressOrRange オブジェクト

名前	型	説明
ipAddressOrRange	string	1 つの IPv4 アドレスまたは CIDR 形式の単一の IPv4 アドレス範囲。 IP アドレスは適切な形式である必要があり、10.0.0.0/8、100.64.0.0/10、172.16.0.0/12、192.168.0.0/16 のいずれかの範囲に含めることはできません。IP アドレス フィルターでは適用できないためです。 有効な入力の例: "23.40.210.245" または "23.40.210.0/8"。

Location

Azure Cosmos DB データベース アカウントがデプロイされているリージョン。

名前	型	説明
documentEndpoint	string	特定のリージョンの接続エンドポイント。 例: https://<accountName>-<locationName>.documents.azure.com:443/
failoverPriority	integer	リージョンのフェールオーバーの優先順位。 フェールオーバーの優先度が 0 の場合は、書き込みリージョンを示します。 フェールオーバー優先度の最大値 = (リージョンの合計数 - 1)。 フェールオーバー優先度の値は、データベース アカウントが存在するリージョンごとに一意である必要があります。
id	string	データベース アカウント内のリージョンの一意識別子。 例: <accountName>-<locationName>。
isZoneRedundant	boolean	このリージョンが AvailabilityZone リージョンかどうかを示すフラグ
locationName	string	リージョンの名前。
provisioningState	string	操作が呼び出されたときの Cosmos DB アカウントの状態。 状態は次のいずれかになります。 "作成中" – Cosmos DB アカウントが作成されています。 アカウントが作成中の状態の場合、Cosmos DB アカウントの作成操作の入力として指定されたプロパティのみが返されます。 "成功" – Cosmos DB アカウントがアクティブに使用されています。 '更新中' – Cosmos DB アカウントが更新中です。 "削除中" – Cosmos DB アカウントが削除されています。 'Failed' – Cosmos DB アカウントの作成に失敗しました。 'DeletionFailed' – Cosmos DB アカウントの削除に失敗しました。

ManagedServiceIdentity

リソースの ID。

名前	型	説明
principalId	string	システム割り当て ID のプリンシパル ID。 このプロパティは、システム割り当て ID にのみ提供されます。
tenantId	string	システム割り当て ID のテナント ID。 このプロパティは、システム割り当て ID にのみ提供されます。
type	ResourceIdentityType	リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。
userAssignedIdentities	UserAssignedIdentities	リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

MinimalTlsVersion

許可される Tls の最小バージョンを示します。 既定値は Tls 1.2 です。 Cassandra API と Mongo API は Tls 1.2 でのみ機能します。

名前	型	説明
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

ファイアウォール チェックをバイパスできるサービスを示します。

名前	型	説明
AzureServices	string
None	string

PeriodicModeBackupPolicy

定期的なモードのバックアップ ポリシーを表すオブジェクト。

名前	型	説明
migrationState	BackupPolicyMigrationState	バックアップ ポリシー間の移行の状態を表すオブジェクト。
periodicModeProperties	PeriodicModeProperties	定期モード バックアップの構成値
type	string: Periodic	バックアップのモードについて説明します。

PeriodicModeProperties

定期モード バックアップの構成値

名前	型	説明
backupIntervalInMinutes	integer	2 つのバックアップ間の間隔を分単位で表す整数
backupRetentionIntervalInHours	integer	各バックアップが保持される時間 (時間単位) を表す整数
backupStorageRedundancy	BackupStorageRedundancy	バックアップの保存場所の種類を示す列挙型

PrivateEndpointConnection

プライベート エンドポイント接続

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.groupId	string	プライベート エンドポイントのグループ ID。
properties.privateEndpoint	PrivateEndpointProperty	接続が属するプライベート エンドポイント。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	プライベート エンドポイント接続の接続状態。
properties.provisioningState	string	プライベート エンドポイントのプロビジョニング状態。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

接続が属するプライベート エンドポイント。

名前	型	説明
id	string	プライベート エンドポイントのリソース ID。

PrivateLinkServiceConnectionStateProperty

プライベート エンドポイント接続の接続状態。

名前	型	説明
actionsRequired	string	基本的なワークフローを超えて必要なアクション (承認/拒否/切断)
description	string	プライベート リンク サービスの接続の説明。
status	string	プライベート リンク サービスの接続状態。

PublicNetworkAccess

パブリック ネットワークからの要求が許可されるかどうか

名前	型	説明
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。

名前	型	説明
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

復元のモードについて説明します。

名前	型	説明
PointInTime	string

RestoreParameters

復元に関する情報を示すパラメーター。

名前	型	説明
databasesToRestore	DatabaseRestoreResource[]	復元に使用できる特定のデータベースの一覧。
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	復元に使用できる特定の gremlin データベースの一覧。
restoreMode	RestoreMode	復元のモードについて説明します。
restoreSource	string	復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	アカウントを復元する必要がある時間 (ISO-8601 形式)。
restoreWithTtlDisabled	boolean	復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。
tablesToRestore	string[]	復元に使用できる特定のテーブルの一覧。

ServerVersion

MongoDB アカウントのバージョンについて説明します。

名前	型	説明
3.2	string
3.6	string
4.0	string
4.2	string
5.0	string
6.0	string
7.0	string

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UserAssignedIdentities

リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

名前	型	説明

VirtualNetworkRule

Virtual Network ACL Rule オブジェクト

名前	型	説明
id	string	サブネットのリソース ID (例: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName})。
ignoreMissingVNetServiceEndpoint	boolean	仮想ネットワークで vnet サービス エンドポイントが有効になる前に、ファイアウォール規則を作成します。