Database Accounts - Create Or Update

Dienst:

Cosmos DB Resource Provider

API-Version:

2025-04-15

Erstellt oder aktualisiert ein Azure Cosmos DB-Datenbankkonto. Die "Update"-Methode wird bevorzugt, wenn Updates für ein Konto ausgeführt werden.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Name des Cosmos DB-Datenbankkontos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.databaseAccountOfferType	True	DatabaseAccountOfferType	The offer type for the database
properties.locations	True	Location[]	An array that contains the georeplication locations enabled for the Cosmos DB account.
identity		ManagedServiceIdentity	Identity for the resource.
kind		DatabaseAccountKind	Indicates the type of database account. This can only be set at database account creation.
location		string	The location of the resource group to which the resource belongs.
properties.analyticalStorageConfiguration		AnalyticalStorageConfiguration	Analytische Speicherspezifische Eigenschaften.
properties.apiProperties		ApiProperties	API specific properties. Currently, supported only for MongoDB API.
properties.backupPolicy		BackupPolicy: PeriodicModeBackupPolicy ContinuousModeBackupPolicy	The object representing the policy for taking backups on an account.
properties.capabilities		Capability[]	List of Cosmos DB capabilities for the account
properties.capacity		Capacity	Das Objekt, das alle Eigenschaften im Zusammenhang mit der Kapazitätserzwingung für ein Konto darstellt.
properties.connectorOffer		ConnectorOffer	The cassandra connector offer type for the Cosmos DB database C* account.
properties.consistencyPolicy		ConsistencyPolicy	The consistency policy for the Cosmos DB account.
properties.cors		CorsPolicy[]	The CORS policy for the Cosmos DB database account.
properties.createMode		CreateMode	Enum to indicate the mode of account creation.
properties.customerManagedKeyStatus		string	Gibt den Status des Features "Vom Kunden verwalteter Schlüssel" für das Konto an. Falls Fehler auftreten, bietet die Eigenschaft Anleitungen zur Problembehandlung.
properties.defaultIdentity		string	The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
properties.disableKeyBasedMetadataWriteAccess		boolean	Disable write operations on metadata resources (databases, containers, throughput) via account keys
properties.disableLocalAuth		boolean	Deaktivieren Sie die lokale Authentifizierung, und stellen Sie sicher, dass nur MSI und AAD ausschließlich für die Authentifizierung verwendet werden können.
properties.enableAnalyticalStorage		boolean	Flag to indicate whether to enable storage analytics.
properties.enableAutomaticFailover		boolean	Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
properties.enableBurstCapacity		boolean	Flag zum Aktivieren/Deaktivieren der Funktion "Burst Capacity" auf dem Konto
properties.enableCassandraConnector		boolean	Enables the cassandra connector on the Cosmos DB C* account
properties.enableFreeTier		boolean	Flag to indicate whether Free Tier is enabled.
properties.enableMultipleWriteLocations		boolean	Enables the account to write in multiple locations
properties.enablePartitionMerge		boolean	Flag zum Aktivieren/Deaktivieren der Partitionszusammenführungsfunktion für das Konto
properties.enablePerRegionPerPartitionAutoscale		boolean	Flag zum Aktivieren/Deaktivieren des PerRegionPerPartitionAutoscale-Features für das Konto
properties.ipRules		IpAddressOrRange[]	List of IpRules.
properties.isVirtualNetworkFilterEnabled		boolean	Flag to indicate whether to enable/disable Virtual Network ACL rules.
properties.keyVaultKeyUri		string	The URI of the key vault
properties.minimalTlsVersion		MinimalTlsVersion	Gibt die mindestens zulässige Tls-Version an. Der Standardwert ist Tls 1.2. Cassandra- und Mongo-APIs funktionieren nur mit Tls 1.2.
properties.networkAclBypass		NetworkAclBypass	Indicates what services are allowed to bypass firewall checks.
properties.networkAclBypassResourceIds		string[]	An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
properties.publicNetworkAccess		PublicNetworkAccess	Whether requests from Public Network are allowed
properties.restoreParameters		RestoreParameters	Parameters to indicate the information about the restore.
properties.virtualNetworkRules		VirtualNetworkRule[]	List of Virtual Network ACL rules configured for the Cosmos DB account.
tags		object	Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können zum Anzeigen und Gruppieren dieser Ressource (über Ressourcengruppen hinweg) verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Jedes Tag muss einen Schlüssel haben, der nicht größer als 128 Zeichen ist, und der Wert darf maximal 256 Zeichen lang sein. Beispielsweise wird die Standardoberfläche für einen Vorlagentyp mit "defaultExperience": "Cassandra" festgelegt. Aktuelle "defaultExperience"-Werte enthalten auch "Table", "Graph", "DocumentDB" und "MongoDB".

Antworten

Name	Typ	Beschreibung
200 OK	DatabaseAccountGetResults	Der Datenbankkonto-Erstellungs- oder Aktualisierungsvorgang wird asynchron abgeschlossen.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

CosmosDBDatabaseAccountCreateMax

CosmosDBDatabaseAccountCreateMin

CosmosDBRestoreDatabaseAccountCreateUpdate.json

CosmosDBDatabaseAccountCreateMax

Beispielanforderung

HTTP

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

{
  "location": "westus",
  "tags": {},
  "kind": "MongoDB",
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  },
  "properties": {
    "databaseAccountOfferType": "Standard",
    "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
      }
    ],
    "publicNetworkAccess": "Enabled",
    "locations": [
      {
        "failoverPriority": 0,
        "locationName": "southcentralus",
        "isZoneRedundant": false
      },
      {
        "failoverPriority": 1,
        "locationName": "eastus",
        "isZoneRedundant": false
      }
    ],
    "consistencyPolicy": {
      "defaultConsistencyLevel": "BoundedStaleness",
      "maxIntervalInSeconds": 10,
      "maxStalenessPrefix": 200
    },
    "keyVaultKeyUri": "https://myKeyVault.vault.azure.net",
    "defaultIdentity": "FirstPartyIdentity",
    "enableFreeTier": false,
    "apiProperties": {
      "serverVersion": "3.2"
    },
    "enableAnalyticalStorage": true,
    "enableBurstCapacity": true,
    "enablePerRegionPerPartitionAutoscale": true,
    "analyticalStorageConfiguration": {
      "schemaType": "WellDefined"
    },
    "createMode": "Default",
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 8,
        "backupStorageRedundancy": "Geo"
      }
    },
    "cors": [
      {
        "allowedOrigins": "https://test"
      }
    ],
    "networkAclBypass": "AzureServices",
    "networkAclBypassResourceIds": [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
    ],
    "capacity": {
      "totalThroughputLimit": 2000
    },
    "minimalTlsVersion": "Tls12"
  }
}

Java

import com.azure.resourcemanager.cosmos.models.AnalyticalStorageConfiguration;
import com.azure.resourcemanager.cosmos.models.AnalyticalStorageSchemaType;
import com.azure.resourcemanager.cosmos.models.ApiProperties;
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.CorsPolicy;
import com.azure.resourcemanager.cosmos.models.CreateMode;
import com.azure.resourcemanager.cosmos.models.DatabaseAccountCreateUpdateParameters;
import com.azure.resourcemanager.cosmos.models.DatabaseAccountKind;
import com.azure.resourcemanager.cosmos.models.DefaultConsistencyLevel;
import com.azure.resourcemanager.cosmos.models.IpAddressOrRange;
import com.azure.resourcemanager.cosmos.models.Location;
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.PublicNetworkAccess;
import com.azure.resourcemanager.cosmos.models.ResourceIdentityType;
import com.azure.resourcemanager.cosmos.models.ServerVersion;
import com.azure.resourcemanager.cosmos.models.VirtualNetworkRule;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for DatabaseAccounts CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBDatabaseAccountCreateMax.json
     */
    /**
     * Sample code: CosmosDBDatabaseAccountCreateMax.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBDatabaseAccountCreateMax(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getDatabaseAccounts().createOrUpdate("rg1", "ddb1",
            new DatabaseAccountCreateUpdateParameters().withLocation("westus").withTags(mapOf())
                .withKind(DatabaseAccountKind.MONGO_DB)
                .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))
                .withLocations(Arrays.asList(
                    new Location().withLocationName("southcentralus").withFailoverPriority(0)
                        .withIsZoneRedundant(false),
                    new Location().withLocationName("eastus").withFailoverPriority(1).withIsZoneRedundant(false)))
                .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)))
                .withKeyVaultKeyUri("fakeTokenPlaceholder").withDefaultIdentity("FirstPartyIdentity")
                .withPublicNetworkAccess(PublicNetworkAccess.ENABLED).withEnableFreeTier(false)
                .withApiProperties(new ApiProperties().withServerVersion(ServerVersion.THREE_TWO))
                .withEnableAnalyticalStorage(true)
                .withAnalyticalStorageConfiguration(
                    new AnalyticalStorageConfiguration().withSchemaType(AnalyticalStorageSchemaType.WELL_DEFINED))
                .withCreateMode(CreateMode.DEFAULT)
                .withBackupPolicy(new PeriodicModeBackupPolicy().withPeriodicModeProperties(
                    new PeriodicModeProperties().withBackupIntervalInMinutes(240).withBackupRetentionIntervalInHours(8)
                        .withBackupStorageRedundancy(BackupStorageRedundancy.GEO)))
                .withCors(Arrays.asList(new CorsPolicy().withAllowedOrigins("https://test")))
                .withNetworkAclBypass(NetworkAclBypass.AZURE_SERVICES)
                .withNetworkAclBypassResourceIds(Arrays.asList(
                    "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"))
                .withCapacity(new Capacity().withTotalThroughputLimit(2000))
                .withMinimalTlsVersion(MinimalTlsVersion.TLS12).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_create_max.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_create_or_update(
        resource_group_name="rg1",
        account_name="ddb1",
        create_update_parameters={
            "identity": {
                "type": "SystemAssigned,UserAssigned",
                "userAssignedIdentities": {
                    "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
                },
            },
            "kind": "MongoDB",
            "location": "westus",
            "properties": {
                "analyticalStorageConfiguration": {"schemaType": "WellDefined"},
                "apiProperties": {"serverVersion": "3.2"},
                "backupPolicy": {
                    "periodicModeProperties": {
                        "backupIntervalInMinutes": 240,
                        "backupRetentionIntervalInHours": 8,
                        "backupStorageRedundancy": "Geo",
                    },
                    "type": "Periodic",
                },
                "capacity": {"totalThroughputLimit": 2000},
                "consistencyPolicy": {
                    "defaultConsistencyLevel": "BoundedStaleness",
                    "maxIntervalInSeconds": 10,
                    "maxStalenessPrefix": 200,
                },
                "cors": [{"allowedOrigins": "https://test"}],
                "createMode": "Default",
                "databaseAccountOfferType": "Standard",
                "defaultIdentity": "FirstPartyIdentity",
                "enableAnalyticalStorage": True,
                "enableBurstCapacity": True,
                "enableFreeTier": False,
                "enablePerRegionPerPartitionAutoscale": True,
                "ipRules": [{"ipAddressOrRange": "23.43.230.120"}, {"ipAddressOrRange": "110.12.240.0/12"}],
                "isVirtualNetworkFilterEnabled": True,
                "keyVaultKeyUri": "https://myKeyVault.vault.azure.net",
                "locations": [
                    {"failoverPriority": 0, "isZoneRedundant": False, "locationName": "southcentralus"},
                    {"failoverPriority": 1, "isZoneRedundant": False, "locationName": "eastus"},
                ],
                "minimalTlsVersion": "Tls12",
                "networkAclBypass": "AzureServices",
                "networkAclBypassResourceIds": [
                    "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
                ],
                "publicNetworkAccess": "Enabled",
                "virtualNetworkRules": [
                    {
                        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
                        "ignoreMissingVNetServiceEndpoint": False,
                    }
                ],
            },
            "tags": {},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBDatabaseAccountCreateMax.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/011ecc5633300a5eefe43dde748f269d39e96458/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBDatabaseAccountCreateMax.json
func ExampleDatabaseAccountsClient_BeginCreateOrUpdate_cosmosDbDatabaseAccountCreateMax() {
	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().BeginCreateOrUpdate(ctx, "rg1", "ddb1", armcosmos.DatabaseAccountCreateUpdateParameters{
		Location: to.Ptr("westus"),
		Tags:     map[string]*string{},
		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": {},
			},
		},
		Kind: to.Ptr(armcosmos.DatabaseAccountKindMongoDB),
		Properties: &armcosmos.DatabaseAccountCreateUpdateProperties{
			AnalyticalStorageConfiguration: &armcosmos.AnalyticalStorageConfiguration{
				SchemaType: to.Ptr(armcosmos.AnalyticalStorageSchemaTypeWellDefined),
			},
			APIProperties: &armcosmos.APIProperties{
				ServerVersion: to.Ptr(armcosmos.ServerVersionThree2),
			},
			BackupPolicy: &armcosmos.PeriodicModeBackupPolicy{
				Type: to.Ptr(armcosmos.BackupPolicyTypePeriodic),
				PeriodicModeProperties: &armcosmos.PeriodicModeProperties{
					BackupIntervalInMinutes:        to.Ptr[int32](240),
					BackupRetentionIntervalInHours: to.Ptr[int32](8),
					BackupStorageRedundancy:        to.Ptr(armcosmos.BackupStorageRedundancyGeo),
				},
			},
			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{
				{
					AllowedOrigins: to.Ptr("https://test"),
				}},
			CreateMode:                           to.Ptr(armcosmos.CreateModeDefault),
			DatabaseAccountOfferType:             to.Ptr("Standard"),
			DefaultIdentity:                      to.Ptr("FirstPartyIdentity"),
			EnableAnalyticalStorage:              to.Ptr(true),
			EnableBurstCapacity:                  to.Ptr(true),
			EnableFreeTier:                       to.Ptr(false),
			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),
			KeyVaultKeyURI:                to.Ptr("https://myKeyVault.vault.azure.net"),
			Locations: []*armcosmos.Location{
				{
					FailoverPriority: to.Ptr[int32](0),
					IsZoneRedundant:  to.Ptr(false),
					LocationName:     to.Ptr("southcentralus"),
				},
				{
					FailoverPriority: to.Ptr[int32](1),
					IsZoneRedundant:  to.Ptr(false),
					LocationName:     to.Ptr("eastus"),
				}},
			MinimalTLSVersion: to.Ptr(armcosmos.MinimalTLSVersionTls12),
			NetworkACLBypass:  to.Ptr(armcosmos.NetworkACLBypassAzureServices),
			NetworkACLBypassResourceIDs: []*string{
				to.Ptr("/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName")},
			PublicNetworkAccess: to.Ptr(armcosmos.PublicNetworkAccessEnabled),
			VirtualNetworkRules: []*armcosmos.VirtualNetworkRule{
				{
					ID:                               to.Ptr("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"),
					IgnoreMissingVNetServiceEndpoint: to.Ptr(false),
				}},
		},
	}, 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{
	// 	},
	// 	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.DatabaseAccountKindMongoDB),
	// 	Properties: &armcosmos.DatabaseAccountGetProperties{
	// 		AnalyticalStorageConfiguration: &armcosmos.AnalyticalStorageConfiguration{
	// 			SchemaType: to.Ptr(armcosmos.AnalyticalStorageSchemaTypeWellDefined),
	// 		},
	// 		APIProperties: &armcosmos.APIProperties{
	// 			ServerVersion: to.Ptr(armcosmos.ServerVersionThree2),
	// 		},
	// 		BackupPolicy: &armcosmos.PeriodicModeBackupPolicy{
	// 			Type: to.Ptr(armcosmos.BackupPolicyTypePeriodic),
	// 			PeriodicModeProperties: &armcosmos.PeriodicModeProperties{
	// 				BackupIntervalInMinutes: to.Ptr[int32](240),
	// 				BackupRetentionIntervalInHours: to.Ptr[int32](8),
	// 				BackupStorageRedundancy: to.Ptr(armcosmos.BackupStorageRedundancyGeo),
	// 			},
	// 		},
	// 		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{
	// 			{
	// 				AllowedOrigins: to.Ptr("https://test"),
	// 		}},
	// 		CreateMode: to.Ptr(armcosmos.CreateModeDefault),
	// 		DatabaseAccountOfferType: to.Ptr("Standard"),
	// 		DefaultIdentity: to.Ptr("FirstPartyIdentity"),
	// 		DisableKeyBasedMetadataWriteAccess: to.Ptr(false),
	// 		EnableAnalyticalStorage: to.Ptr(true),
	// 		EnableBurstCapacity: to.Ptr(true),
	// 		EnableFreeTier: to.Ptr(false),
	// 		FailoverPolicies: []*armcosmos.FailoverPolicy{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				LocationName: to.Ptr("South Central US"),
	// 			},
	// 			{
	// 				FailoverPriority: to.Ptr[int32](1),
	// 				ID: to.Ptr("ddb1-eastus"),
	// 				LocationName: to.Ptr("East US"),
	// 		}},
	// 		InstanceID: to.Ptr("d9b26648-2f53-4541-b3d8-3044f4f9810d"),
	// 		IPRules: []*armcosmos.IPAddressOrRange{
	// 			{
	// 				IPAddressOrRange: to.Ptr("23.43.230.120"),
	// 			},
	// 			{
	// 				IPAddressOrRange: to.Ptr("110.12.240.0/12"),
	// 		}},
	// 		IsVirtualNetworkFilterEnabled: to.Ptr(true),
	// 		KeyVaultKeyURI: to.Ptr("https://myKeyVault.vault.azure.net"),
	// 		KeysMetadata: &armcosmos.DatabaseAccountKeysMetadata{
	// 			PrimaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 			PrimaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 			SecondaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 			SecondaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 		},
	// 		Locations: []*armcosmos.Location{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("South Central US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 			},
	// 			{
	// 				FailoverPriority: to.Ptr[int32](1),
	// 				ID: to.Ptr("ddb1-eastus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("East US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 		MinimalTLSVersion: to.Ptr(armcosmos.MinimalTLSVersionTls12),
	// 		NetworkACLBypass: to.Ptr(armcosmos.NetworkACLBypassAzureServices),
	// 		NetworkACLBypassResourceIDs: []*string{
	// 			to.Ptr("/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName")},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			PublicNetworkAccess: to.Ptr(armcosmos.PublicNetworkAccessEnabled),
	// 			ReadLocations: []*armcosmos.Location{
	// 				{
	// 					FailoverPriority: to.Ptr[int32](0),
	// 					ID: to.Ptr("ddb1-southcentralus"),
	// 					IsZoneRedundant: to.Ptr(false),
	// 					LocationName: to.Ptr("South Central US"),
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 				},
	// 				{
	// 					FailoverPriority: to.Ptr[int32](1),
	// 					ID: to.Ptr("ddb1-eastus"),
	// 					IsZoneRedundant: to.Ptr(false),
	// 					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"),
	// 			}},
	// 			WriteLocations: []*armcosmos.Location{
	// 				{
	// 					FailoverPriority: to.Ptr[int32](0),
	// 					ID: to.Ptr("ddb1-southcentralus"),
	// 					IsZoneRedundant: to.Ptr(false),
	// 					LocationName: to.Ptr("South Central US"),
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 			}},
	// 		},
	// 		SystemData: &armcosmos.SystemData{
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 		},
	// 	}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
 *
 * @summary Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBDatabaseAccountCreateMax.json
 */
async function cosmosDbDatabaseAccountCreateMax() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const createUpdateParameters = {
    analyticalStorageConfiguration: { schemaType: "WellDefined" },
    apiProperties: { serverVersion: "3.2" },
    backupPolicy: {
      type: "Periodic",
      periodicModeProperties: {
        backupIntervalInMinutes: 240,
        backupRetentionIntervalInHours: 8,
        backupStorageRedundancy: "Geo",
      },
    },
    capacity: { totalThroughputLimit: 2000 },
    consistencyPolicy: {
      defaultConsistencyLevel: "BoundedStaleness",
      maxIntervalInSeconds: 10,
      maxStalenessPrefix: 200,
    },
    cors: [{ allowedOrigins: "https://test" }],
    createMode: "Default",
    databaseAccountOfferType: "Standard",
    defaultIdentity: "FirstPartyIdentity",
    enableAnalyticalStorage: true,
    enableBurstCapacity: true,
    enableFreeTier: false,
    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,
    keyVaultKeyUri: "https://myKeyVault.vault.azure.net",
    kind: "MongoDB",
    location: "westus",
    locations: [
      {
        failoverPriority: 0,
        isZoneRedundant: false,
        locationName: "southcentralus",
      },
      { failoverPriority: 1, isZoneRedundant: false, locationName: "eastus" },
    ],
    minimalTlsVersion: "Tls12",
    networkAclBypass: "AzureServices",
    networkAclBypassResourceIds: [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName",
    ],
    publicNetworkAccess: "Enabled",
    tags: {},
    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.beginCreateOrUpdateAndWait(
    resourceGroupName,
    accountName,
    createUpdateParameters,
  );
  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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
  "name": "ddb1",
  "location": "West US",
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "kind": "MongoDB",
  "tags": {},
  "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": "Initializing",
    "isVirtualNetworkFilterEnabled": true,
    "databaseAccountOfferType": "Standard",
    "disableKeyBasedMetadataWriteAccess": false,
    "consistencyPolicy": {
      "defaultConsistencyLevel": "BoundedStaleness",
      "maxIntervalInSeconds": 10,
      "maxStalenessPrefix": 200
    },
    "writeLocations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      }
    ],
    "readLocations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      },
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "provisioningState": "Initializing",
        "failoverPriority": 1,
        "isZoneRedundant": false
      }
    ],
    "locations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      },
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "provisioningState": "Initializing",
        "failoverPriority": 1,
        "isZoneRedundant": false
      }
    ],
    "failoverPolicies": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "failoverPriority": 0
      },
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "failoverPriority": 1
      }
    ],
    "virtualNetworkRules": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"
      }
    ],
    "publicNetworkAccess": "Enabled",
    "keyVaultKeyUri": "https://myKeyVault.vault.azure.net",
    "defaultIdentity": "FirstPartyIdentity",
    "enableFreeTier": false,
    "ipRules": [
      {
        "ipAddressOrRange": "23.43.230.120"
      },
      {
        "ipAddressOrRange": "110.12.240.0/12"
      }
    ],
    "apiProperties": {
      "serverVersion": "3.2"
    },
    "enableAnalyticalStorage": true,
    "enableBurstCapacity": true,
    "analyticalStorageConfiguration": {
      "schemaType": "WellDefined"
    },
    "createMode": "Default",
    "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d",
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 8,
        "backupStorageRedundancy": "Geo"
      }
    },
    "cors": [
      {
        "allowedOrigins": "https://test"
      }
    ],
    "networkAclBypass": "AzureServices",
    "networkAclBypassResourceIds": [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
    ],
    "capacity": {
      "totalThroughputLimit": 2000
    },
    "keysMetadata": {
      "primaryMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      },
      "secondaryMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      },
      "primaryReadonlyMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      },
      "secondaryReadonlyMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      }
    },
    "minimalTlsVersion": "Tls12"
  },
  "systemData": {
    "createdAt": "2021-03-12T22:05:09Z"
  }
}

CosmosDBDatabaseAccountCreateMin

Beispielanforderung

HTTP

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

{
  "location": "westus",
  "properties": {
    "databaseAccountOfferType": "Standard",
    "createMode": "Default",
    "locations": [
      {
        "failoverPriority": 0,
        "locationName": "southcentralus",
        "isZoneRedundant": false
      }
    ]
  }
}

Java

import com.azure.resourcemanager.cosmos.models.CreateMode;
import com.azure.resourcemanager.cosmos.models.DatabaseAccountCreateUpdateParameters;
import com.azure.resourcemanager.cosmos.models.Location;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for DatabaseAccounts CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBDatabaseAccountCreateMin.json
     */
    /**
     * Sample code: CosmosDBDatabaseAccountCreateMin.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBDatabaseAccountCreateMin(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getDatabaseAccounts().createOrUpdate("rg1", "ddb1",
            new DatabaseAccountCreateUpdateParameters().withLocation("westus").withLocations(Arrays.asList(
                new Location().withLocationName("southcentralus").withFailoverPriority(0).withIsZoneRedundant(false)))
                .withCreateMode(CreateMode.DEFAULT),
            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_create_min.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_create_or_update(
        resource_group_name="rg1",
        account_name="ddb1",
        create_update_parameters={
            "location": "westus",
            "properties": {
                "createMode": "Default",
                "databaseAccountOfferType": "Standard",
                "locations": [{"failoverPriority": 0, "isZoneRedundant": False, "locationName": "southcentralus"}],
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBDatabaseAccountCreateMin.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/011ecc5633300a5eefe43dde748f269d39e96458/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBDatabaseAccountCreateMin.json
func ExampleDatabaseAccountsClient_BeginCreateOrUpdate_cosmosDbDatabaseAccountCreateMin() {
	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().BeginCreateOrUpdate(ctx, "rg1", "ddb1", armcosmos.DatabaseAccountCreateUpdateParameters{
		Location: to.Ptr("westus"),
		Properties: &armcosmos.DatabaseAccountCreateUpdateProperties{
			CreateMode:               to.Ptr(armcosmos.CreateModeDefault),
			DatabaseAccountOfferType: to.Ptr("Standard"),
			Locations: []*armcosmos.Location{
				{
					FailoverPriority: to.Ptr[int32](0),
					IsZoneRedundant:  to.Ptr(false),
					LocationName:     to.Ptr("southcentralus"),
				}},
		},
	}, 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{
	// 	},
	// 	Kind: to.Ptr(armcosmos.DatabaseAccountKindGlobalDocumentDB),
	// 	Properties: &armcosmos.DatabaseAccountGetProperties{
	// 		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.BackupStorageRedundancyGeo),
	// 			},
	// 		},
	// 		ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
	// 			DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelSession),
	// 			MaxIntervalInSeconds: to.Ptr[int32](5),
	// 			MaxStalenessPrefix: to.Ptr[int64](100),
	// 		},
	// 		Cors: []*armcosmos.CorsPolicy{
	// 		},
	// 		CreateMode: to.Ptr(armcosmos.CreateModeDefault),
	// 		DatabaseAccountOfferType: to.Ptr("Standard"),
	// 		DisableKeyBasedMetadataWriteAccess: to.Ptr(false),
	// 		EnableAnalyticalStorage: to.Ptr(false),
	// 		EnableFreeTier: to.Ptr(false),
	// 		FailoverPolicies: []*armcosmos.FailoverPolicy{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				LocationName: to.Ptr("South Central US"),
	// 		}},
	// 		InstanceID: to.Ptr("d9b26648-2f53-4541-b3d8-3044f4f9810d"),
	// 		IPRules: []*armcosmos.IPAddressOrRange{
	// 		},
	// 		KeysMetadata: &armcosmos.DatabaseAccountKeysMetadata{
	// 			PrimaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 			PrimaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 			SecondaryMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 			SecondaryReadonlyMasterKey: &armcosmos.AccountKeyMetadata{
	// 				GenerationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 			},
	// 		},
	// 		Locations: []*armcosmos.Location{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("South Central US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 		MinimalTLSVersion: to.Ptr(armcosmos.MinimalTLSVersionTLS),
	// 		NetworkACLBypass: to.Ptr(armcosmos.NetworkACLBypassNone),
	// 		NetworkACLBypassResourceIDs: []*string{
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ReadLocations: []*armcosmos.Location{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("South Central US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 		WriteLocations: []*armcosmos.Location{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("South Central US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 	},
	// 	SystemData: &armcosmos.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 	},
	// }
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
 *
 * @summary Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBDatabaseAccountCreateMin.json
 */
async function cosmosDbDatabaseAccountCreateMin() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const createUpdateParameters = {
    createMode: "Default",
    databaseAccountOfferType: "Standard",
    location: "westus",
    locations: [
      {
        failoverPriority: 0,
        isZoneRedundant: false,
        locationName: "southcentralus",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.databaseAccounts.beginCreateOrUpdateAndWait(
    resourceGroupName,
    accountName,
    createUpdateParameters,
  );
  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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
  "name": "ddb1",
  "location": "West US",
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "kind": "GlobalDocumentDB",
  "tags": {},
  "properties": {
    "provisioningState": "Initializing",
    "ipRules": [],
    "databaseAccountOfferType": "Standard",
    "disableKeyBasedMetadataWriteAccess": false,
    "consistencyPolicy": {
      "defaultConsistencyLevel": "Session",
      "maxIntervalInSeconds": 5,
      "maxStalenessPrefix": 100
    },
    "writeLocations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      }
    ],
    "readLocations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      }
    ],
    "locations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      }
    ],
    "failoverPolicies": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "failoverPriority": 0
      }
    ],
    "cors": [],
    "enableFreeTier": false,
    "apiProperties": {},
    "enableAnalyticalStorage": false,
    "analyticalStorageConfiguration": null,
    "networkAclBypass": "None",
    "networkAclBypassResourceIds": [],
    "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d",
    "createMode": "Default",
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 720,
        "backupStorageRedundancy": "Geo"
      }
    },
    "keysMetadata": {
      "primaryMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      },
      "secondaryMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      },
      "primaryReadonlyMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      },
      "secondaryReadonlyMasterKey": {
        "generationTime": "2021-03-12T22:05:09Z"
      }
    },
    "minimalTlsVersion": "Tls"
  },
  "systemData": {
    "createdAt": "2021-03-12T22:05:09Z"
  }
}

CosmosDBRestoreDatabaseAccountCreateUpdate.json

Beispielanforderung

HTTP

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

{
  "location": "westus",
  "tags": {},
  "kind": "GlobalDocumentDB",
  "properties": {
    "databaseAccountOfferType": "Standard",
    "locations": [
      {
        "failoverPriority": 0,
        "locationName": "southcentralus",
        "isZoneRedundant": false
      }
    ],
    "createMode": "Restore",
    "restoreParameters": {
      "restoreMode": "PointInTime",
      "restoreSource": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc",
      "restoreTimestampInUtc": "2021-03-11T22:05:09Z",
      "restoreWithTtlDisabled": false,
      "databasesToRestore": [
        {
          "databaseName": "db1",
          "collectionNames": [
            "collection1",
            "collection2"
          ]
        },
        {
          "databaseName": "db2",
          "collectionNames": [
            "collection3",
            "collection4"
          ]
        }
      ]
    },
    "backupPolicy": {
      "type": "Continuous",
      "continuousModeProperties": {
        "tier": "Continuous30Days"
      }
    },
    "consistencyPolicy": {
      "defaultConsistencyLevel": "BoundedStaleness",
      "maxIntervalInSeconds": 10,
      "maxStalenessPrefix": 200
    },
    "keyVaultKeyUri": "https://myKeyVault.vault.azure.net",
    "enableFreeTier": false,
    "apiProperties": {
      "serverVersion": "3.2"
    },
    "enableAnalyticalStorage": true,
    "minimalTlsVersion": "Tls"
  }
}

Java

import com.azure.resourcemanager.cosmos.models.ApiProperties;
import com.azure.resourcemanager.cosmos.models.ConsistencyPolicy;
import com.azure.resourcemanager.cosmos.models.ContinuousModeBackupPolicy;
import com.azure.resourcemanager.cosmos.models.ContinuousModeProperties;
import com.azure.resourcemanager.cosmos.models.ContinuousTier;
import com.azure.resourcemanager.cosmos.models.CreateMode;
import com.azure.resourcemanager.cosmos.models.DatabaseAccountCreateUpdateParameters;
import com.azure.resourcemanager.cosmos.models.DatabaseAccountKind;
import com.azure.resourcemanager.cosmos.models.DatabaseRestoreResource;
import com.azure.resourcemanager.cosmos.models.DefaultConsistencyLevel;
import com.azure.resourcemanager.cosmos.models.Location;
import com.azure.resourcemanager.cosmos.models.MinimalTlsVersion;
import com.azure.resourcemanager.cosmos.models.RestoreMode;
import com.azure.resourcemanager.cosmos.models.RestoreParameters;
import com.azure.resourcemanager.cosmos.models.ServerVersion;
import java.time.OffsetDateTime;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for DatabaseAccounts CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBRestoreDatabaseAccountCreateUpdate.json
     */
    /**
     * Sample code: CosmosDBRestoreDatabaseAccountCreateUpdate.json.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        cosmosDBRestoreDatabaseAccountCreateUpdateJson(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getDatabaseAccounts().createOrUpdate("rg1", "ddb1",
            new DatabaseAccountCreateUpdateParameters().withLocation("westus").withTags(mapOf())
                .withKind(DatabaseAccountKind.GLOBAL_DOCUMENT_DB)
                .withConsistencyPolicy(
                    new ConsistencyPolicy().withDefaultConsistencyLevel(DefaultConsistencyLevel.BOUNDED_STALENESS)
                        .withMaxStalenessPrefix(200L).withMaxIntervalInSeconds(10))
                .withLocations(Arrays.asList(new Location().withLocationName("southcentralus").withFailoverPriority(0)
                    .withIsZoneRedundant(false)))
                .withKeyVaultKeyUri("fakeTokenPlaceholder").withEnableFreeTier(false)
                .withApiProperties(new ApiProperties().withServerVersion(ServerVersion.THREE_TWO))
                .withEnableAnalyticalStorage(true).withCreateMode(CreateMode.RESTORE)
                .withBackupPolicy(new ContinuousModeBackupPolicy().withContinuousModeProperties(
                    new ContinuousModeProperties().withTier(ContinuousTier.CONTINUOUS30DAYS)))
                .withRestoreParameters(new RestoreParameters().withRestoreSource(
                    "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc")
                    .withRestoreTimestampInUtc(OffsetDateTime.parse("2021-03-11T22:05:09Z"))
                    .withRestoreWithTtlDisabled(false).withRestoreMode(RestoreMode.POINT_IN_TIME)
                    .withDatabasesToRestore(Arrays.asList(
                        new DatabaseRestoreResource().withDatabaseName("db1")
                            .withCollectionNames(Arrays.asList("collection1", "collection2")),
                        new DatabaseRestoreResource().withDatabaseName("db2")
                            .withCollectionNames(Arrays.asList("collection3", "collection4")))))
                .withMinimalTlsVersion(MinimalTlsVersion.TLS),
            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_restore_database_account_create_update.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_create_or_update(
        resource_group_name="rg1",
        account_name="ddb1",
        create_update_parameters={
            "kind": "GlobalDocumentDB",
            "location": "westus",
            "properties": {
                "apiProperties": {"serverVersion": "3.2"},
                "backupPolicy": {"continuousModeProperties": {"tier": "Continuous30Days"}, "type": "Continuous"},
                "consistencyPolicy": {
                    "defaultConsistencyLevel": "BoundedStaleness",
                    "maxIntervalInSeconds": 10,
                    "maxStalenessPrefix": 200,
                },
                "createMode": "Restore",
                "databaseAccountOfferType": "Standard",
                "enableAnalyticalStorage": True,
                "enableFreeTier": False,
                "keyVaultKeyUri": "https://myKeyVault.vault.azure.net",
                "locations": [{"failoverPriority": 0, "isZoneRedundant": False, "locationName": "southcentralus"}],
                "minimalTlsVersion": "Tls",
                "restoreParameters": {
                    "databasesToRestore": [
                        {"collectionNames": ["collection1", "collection2"], "databaseName": "db1"},
                        {"collectionNames": ["collection3", "collection4"], "databaseName": "db2"},
                    ],
                    "restoreMode": "PointInTime",
                    "restoreSource": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc",
                    "restoreTimestampInUtc": "2021-03-11T22:05:09Z",
                    "restoreWithTtlDisabled": False,
                },
            },
            "tags": {},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBRestoreDatabaseAccountCreateUpdate.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"

	"time"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/011ecc5633300a5eefe43dde748f269d39e96458/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json
func ExampleDatabaseAccountsClient_BeginCreateOrUpdate_cosmosDbRestoreDatabaseAccountCreateUpdateJson() {
	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().BeginCreateOrUpdate(ctx, "rg1", "ddb1", armcosmos.DatabaseAccountCreateUpdateParameters{
		Location: to.Ptr("westus"),
		Tags:     map[string]*string{},
		Kind:     to.Ptr(armcosmos.DatabaseAccountKindGlobalDocumentDB),
		Properties: &armcosmos.DatabaseAccountCreateUpdateProperties{
			APIProperties: &armcosmos.APIProperties{
				ServerVersion: to.Ptr(armcosmos.ServerVersionThree2),
			},
			BackupPolicy: &armcosmos.ContinuousModeBackupPolicy{
				Type: to.Ptr(armcosmos.BackupPolicyTypeContinuous),
				ContinuousModeProperties: &armcosmos.ContinuousModeProperties{
					Tier: to.Ptr(armcosmos.ContinuousTierContinuous30Days),
				},
			},
			ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
				DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelBoundedStaleness),
				MaxIntervalInSeconds:    to.Ptr[int32](10),
				MaxStalenessPrefix:      to.Ptr[int64](200),
			},
			CreateMode:               to.Ptr(armcosmos.CreateModeRestore),
			DatabaseAccountOfferType: to.Ptr("Standard"),
			EnableAnalyticalStorage:  to.Ptr(true),
			EnableFreeTier:           to.Ptr(false),
			KeyVaultKeyURI:           to.Ptr("https://myKeyVault.vault.azure.net"),
			Locations: []*armcosmos.Location{
				{
					FailoverPriority: to.Ptr[int32](0),
					IsZoneRedundant:  to.Ptr(false),
					LocationName:     to.Ptr("southcentralus"),
				}},
			MinimalTLSVersion: to.Ptr(armcosmos.MinimalTLSVersionTLS),
			RestoreParameters: &armcosmos.RestoreParameters{
				RestoreSource:          to.Ptr("/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc"),
				RestoreTimestampInUTC:  to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-11T22:05:09.000Z"); return t }()),
				RestoreWithTTLDisabled: to.Ptr(false),
				DatabasesToRestore: []*armcosmos.DatabaseRestoreResource{
					{
						CollectionNames: []*string{
							to.Ptr("collection1"),
							to.Ptr("collection2")},
						DatabaseName: to.Ptr("db1"),
					},
					{
						CollectionNames: []*string{
							to.Ptr("collection3"),
							to.Ptr("collection4")},
						DatabaseName: to.Ptr("db2"),
					}},
				RestoreMode: to.Ptr(armcosmos.RestoreModePointInTime),
			},
		},
	}, 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{
	// 	},
	// 	Kind: to.Ptr(armcosmos.DatabaseAccountKindGlobalDocumentDB),
	// 	Properties: &armcosmos.DatabaseAccountGetProperties{
	// 		APIProperties: &armcosmos.APIProperties{
	// 		},
	// 		BackupPolicy: &armcosmos.ContinuousModeBackupPolicy{
	// 			Type: to.Ptr(armcosmos.BackupPolicyTypeContinuous),
	// 			ContinuousModeProperties: &armcosmos.ContinuousModeProperties{
	// 				Tier: to.Ptr(armcosmos.ContinuousTierContinuous30Days),
	// 			},
	// 		},
	// 		ConsistencyPolicy: &armcosmos.ConsistencyPolicy{
	// 			DefaultConsistencyLevel: to.Ptr(armcosmos.DefaultConsistencyLevelSession),
	// 			MaxIntervalInSeconds: to.Ptr[int32](5),
	// 			MaxStalenessPrefix: to.Ptr[int64](100),
	// 		},
	// 		CreateMode: to.Ptr(armcosmos.CreateModeRestore),
	// 		DatabaseAccountOfferType: to.Ptr("Standard"),
	// 		DisableKeyBasedMetadataWriteAccess: to.Ptr(false),
	// 		EnableAnalyticalStorage: to.Ptr(false),
	// 		EnableFreeTier: to.Ptr(false),
	// 		FailoverPolicies: []*armcosmos.FailoverPolicy{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				LocationName: to.Ptr("South Central US"),
	// 		}},
	// 		InstanceID: to.Ptr("d9b26648-2f53-4541-b3d8-3044f4f9810d"),
	// 		IPRules: []*armcosmos.IPAddressOrRange{
	// 		},
	// 		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{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("South Central US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 		MinimalTLSVersion: to.Ptr(armcosmos.MinimalTLSVersionTLS),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ReadLocations: []*armcosmos.Location{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("South Central US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 		WriteLocations: []*armcosmos.Location{
	// 			{
	// 				FailoverPriority: to.Ptr[int32](0),
	// 				ID: to.Ptr("ddb1-southcentralus"),
	// 				IsZoneRedundant: to.Ptr(false),
	// 				LocationName: to.Ptr("South Central US"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 		}},
	// 	},
	// 	SystemData: &armcosmos.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-12T22:05:09.000Z"); return t}()),
	// 	},
	// }
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
 *
 * @summary Creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json
 */
async function cosmosDbRestoreDatabaseAccountCreateUpdateJson() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const createUpdateParameters = {
    apiProperties: { serverVersion: "3.2" },
    backupPolicy: {
      type: "Continuous",
      continuousModeProperties: { tier: "Continuous30Days" },
    },
    consistencyPolicy: {
      defaultConsistencyLevel: "BoundedStaleness",
      maxIntervalInSeconds: 10,
      maxStalenessPrefix: 200,
    },
    createMode: "Restore",
    databaseAccountOfferType: "Standard",
    enableAnalyticalStorage: true,
    enableFreeTier: false,
    keyVaultKeyUri: "https://myKeyVault.vault.azure.net",
    kind: "GlobalDocumentDB",
    location: "westus",
    locations: [
      {
        failoverPriority: 0,
        isZoneRedundant: false,
        locationName: "southcentralus",
      },
    ],
    minimalTlsVersion: "Tls",
    restoreParameters: {
      databasesToRestore: [
        {
          collectionNames: ["collection1", "collection2"],
          databaseName: "db1",
        },
        {
          collectionNames: ["collection3", "collection4"],
          databaseName: "db2",
        },
      ],
      restoreMode: "PointInTime",
      restoreSource:
        "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc",
      restoreTimestampInUtc: new Date("2021-03-11T22:05:09Z"),
      restoreWithTtlDisabled: false,
    },
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.databaseAccounts.beginCreateOrUpdateAndWait(
    resourceGroupName,
    accountName,
    createUpdateParameters,
  );
  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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
  "name": "ddb1",
  "location": "West US",
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "kind": "GlobalDocumentDB",
  "tags": {},
  "properties": {
    "provisioningState": "Initializing",
    "ipRules": [],
    "databaseAccountOfferType": "Standard",
    "disableKeyBasedMetadataWriteAccess": false,
    "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d",
    "createMode": "Restore",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "Session",
      "maxIntervalInSeconds": 5,
      "maxStalenessPrefix": 100
    },
    "writeLocations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      }
    ],
    "readLocations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      }
    ],
    "locations": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "provisioningState": "Initializing",
        "failoverPriority": 0,
        "isZoneRedundant": false
      }
    ],
    "failoverPolicies": [
      {
        "id": "ddb1-southcentralus",
        "locationName": "South Central US",
        "failoverPriority": 0
      }
    ],
    "backupPolicy": {
      "type": "Continuous",
      "continuousModeProperties": {
        "tier": "Continuous30Days"
      }
    },
    "enableFreeTier": false,
    "apiProperties": {},
    "enableAnalyticalStorage": false,
    "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"
      }
    },
    "minimalTlsVersion": "Tls"
  },
  "systemData": {
    "createdAt": "2021-03-12T22:05:09Z"
  }
}

Definitionen

Name	Beschreibung
AccountKeyMetadata	Die Metadaten im Zusammenhang mit einem Zugriffsschlüssel für ein bestimmtes Datenbankkonto.
AnalyticalStorageConfiguration	Analytische Speicherspezifische Eigenschaften.
AnalyticalStorageSchemaType	Beschreibt die Schematypen für die analytische Speicherung.
ApiProperties
BackupPolicyMigrationState	Das Objekt, das den Status der Migration zwischen den Sicherungsrichtlinien darstellt.
BackupPolicyMigrationStatus	Beschreibt den Status der Migration zwischen Sicherungsrichtlinientypen.
BackupPolicyType	Describes the mode of backups.
BackupStorageRedundancy	Aufzählung, um den Typ der Sicherungsspeicherredundanz anzugeben.
Capability	Cosmos DB-Funktionsobjekt
Capacity	Das Objekt, das alle Eigenschaften im Zusammenhang mit der Kapazitätserzwingung für ein Konto darstellt.
ConnectorOffer	Der Cassandra Connector-Angebotstyp für das Cosmos DB C*-Datenbankkonto.
ConsistencyPolicy	Die Konsistenzrichtlinie für das Cosmos DB-Datenbankkonto.
ContinuousModeBackupPolicy	Das Objekt, das die Sicherungsrichtlinie für den fortlaufenden Modus darstellt.
ContinuousModeProperties	Configuration values for periodic mode backup
ContinuousTier	Aufzählung, um den Typ der fortlaufenden Sicherungsebene anzugeben.
CorsPolicy	The CORS policy for the Cosmos DB database account.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CreateMode	Enum to indicate the mode of account creation.
DatabaseAccountCreateUpdateParameters	Parameter zum Erstellen und Aktualisieren von Cosmos DB-Datenbankkonten.
DatabaseAccountGetResults	Ein Azure Cosmos DB-Datenbankkonto.
DatabaseAccountKeysMetadata	Die Metadaten für jeden Zugriffsschlüssel für das angegebene Cosmos DB-Datenbankkonto.
DatabaseAccountKind	Indicates the type of database account. This can only be set at database account creation.
DatabaseAccountOfferType	Der Angebotstyp für das Cosmos DB-Datenbankkonto.
DatabaseRestoreResource	Bestimmte Datenbanken, die wiederhergestellt werden sollen.
DefaultConsistencyLevel	The default consistency level and configuration settings of the Cosmos DB account.
FailoverPolicy	Die Failoverrichtlinie für eine bestimmte Region eines Datenbankkontos.
GremlinDatabaseRestoreResource	Spezifische Gremlin-Datenbanken, die wiederhergestellt werden sollen.
IpAddressOrRange	IpAddressOrRange-Objekt
Location	Eine Region, in der das Azure Cosmos DB-Datenbankkonto bereitgestellt wird.
ManagedServiceIdentity	Identity for the resource.
MinimalTlsVersion	Gibt die mindestens zulässige Tls-Version an. Der Standardwert ist Tls 1.2. Cassandra- und Mongo-APIs funktionieren nur mit Tls 1.2.
NetworkAclBypass	Indicates what services are allowed to bypass firewall checks.
PeriodicModeBackupPolicy	Das Objekt, das die Sicherungsrichtlinie für den regelmäßigen Modus darstellt.
PeriodicModeProperties	Configuration values for periodic mode backup
PrivateEndpointConnection	Eine private Endpunktverbindung
PrivateEndpointProperty	Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionStateProperty	Connection State of the Private Endpoint Connection.
PublicNetworkAccess	Whether requests from Public Network are allowed
ResourceIdentityType	The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
RestoreMode	Describes the mode of the restore.
RestoreParameters	Parameters to indicate the information about the restore.
ServerVersion	Beschreibt die Version des MongoDB-Kontos.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
VirtualNetworkRule	Virtual Network ACL Rule-Objekt

AccountKeyMetadata

Objekt

Die Metadaten im Zusammenhang mit einem Zugriffsschlüssel für ein bestimmtes Datenbankkonto.

Name	Typ	Beschreibung
generationTime	string (date-time)	Generationszeit in UTC des Schlüssels im ISO-8601-Format. Wenn der Wert im Objekt fehlt, bedeutet dies, dass die letzte Schlüsselregenerierung vor 2022-06-18 ausgelöst wurde.

AnalyticalStorageConfiguration

Objekt

Analytische Speicherspezifische Eigenschaften.

Name	Typ	Beschreibung
schemaType	AnalyticalStorageSchemaType	Beschreibt die Schematypen für die analytische Speicherung.

AnalyticalStorageSchemaType

Enumeration

Beschreibt die Schematypen für die analytische Speicherung.

Wert	Beschreibung
FullFidelity
WellDefined

ApiProperties

Objekt

Name	Typ	Beschreibung
serverVersion	ServerVersion	Beschreibt die Version des MongoDB-Kontos.

BackupPolicyMigrationState

Objekt

Das Objekt, das den Status der Migration zwischen den Sicherungsrichtlinien darstellt.

Name	Typ	Beschreibung
startTime	string (date-time)	Zeitpunkt, zu dem die Migration der Sicherungsrichtlinie gestartet wurde (ISO-8601-Format).
status	BackupPolicyMigrationStatus	Beschreibt den Status der Migration zwischen Sicherungsrichtlinientypen.
targetType	BackupPolicyType	Beschreibt den Ziel-Sicherungsrichtlinientyp der Migration der Sicherungsrichtlinie.

BackupPolicyMigrationStatus

Enumeration

Beschreibt den Status der Migration zwischen Sicherungsrichtlinientypen.

Wert	Beschreibung
Completed
Failed
InProgress
Invalid

BackupPolicyType

Enumeration

Describes the mode of backups.

Wert	Beschreibung
Continuous
Periodic

BackupStorageRedundancy

Enumeration

Aufzählung, um den Typ der Sicherungsspeicherredundanz anzugeben.

Wert	Beschreibung
Geo
Local
Zone

Capability

Objekt

Cosmos DB-Funktionsobjekt

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

Capacity

Objekt

Das Objekt, das alle Eigenschaften im Zusammenhang mit der Kapazitätserzwingung für ein Konto darstellt.

Name	Typ	Beschreibung
totalThroughputLimit	integer (int32) minimum: -1	Die für das Konto auferlegte Gesamtdurchsatzgrenze. Ein TotalThroughputLimit von 2000 legt einen strengen Grenzwert für den maximalen Durchsatz fest, der für dieses Konto auf 2000 bereitgestellt werden kann. Ein totalthroughputLimit von -1 gibt keine Grenzwerte für die Bereitstellung des Durchsatzes an.

ConnectorOffer

Enumeration

Der Cassandra Connector-Angebotstyp für das Cosmos DB C*-Datenbankkonto.

Wert	Beschreibung
Small

ConsistencyPolicy

Objekt

Die Konsistenzrichtlinie für das Cosmos DB-Datenbankkonto.

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

ContinuousModeBackupPolicy

Objekt

Das Objekt, das die Sicherungsrichtlinie für den fortlaufenden Modus darstellt.

Name	Typ	Beschreibung
continuousModeProperties	ContinuousModeProperties	Konfigurationswerte für die Sicherung des fortlaufenden Modus
migrationState	BackupPolicyMigrationState	Das Objekt, das den Status der Migration zwischen den Sicherungsrichtlinien darstellt.
type	string: Continuous	Describes the mode of backups.

ContinuousModeProperties

Objekt

Configuration values for periodic mode backup

Name	Typ	Beschreibung
tier	ContinuousTier	Enumeration zur Angabe des Typs des fortlaufenden Sicherungsmodus

ContinuousTier

Enumeration

Aufzählung, um den Typ der fortlaufenden Sicherungsebene anzugeben.

Wert	Beschreibung
Continuous30Days
Continuous7Days

CorsPolicy

Objekt

The CORS policy for the Cosmos DB database account.

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

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

CreateMode

Enumeration

Enum to indicate the mode of account creation.

Wert	Beschreibung
Default
Restore

DatabaseAccountCreateUpdateParameters

Objekt

Parameter zum Erstellen und Aktualisieren von Cosmos DB-Datenbankkonten.

Name	Typ	Standardwert	Beschreibung
id	string		Der eindeutige Ressourcenbezeichner der ARM-Ressource.
identity	ManagedServiceIdentity		Identity for the resource.
kind	DatabaseAccountKind	GlobalDocumentDB	Indicates the type of database account. This can only be set at database account creation.
location	string		The location of the resource group to which the resource belongs.
name	string		Der Name der ARM-Ressource.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Analytische Speicherspezifische Eigenschaften.
properties.apiProperties	ApiProperties		API specific properties. Currently, supported only for MongoDB API.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		The object representing the policy for taking backups on an account.
properties.capabilities	Capability[]		List of Cosmos DB capabilities for the account
properties.capacity	Capacity		Das Objekt, das alle Eigenschaften im Zusammenhang mit der Kapazitätserzwingung für ein Konto darstellt.
properties.connectorOffer	ConnectorOffer		The cassandra connector offer type for the Cosmos DB database C* account.
properties.consistencyPolicy	ConsistencyPolicy		The consistency policy for the Cosmos DB account.
properties.cors	CorsPolicy[]		The CORS policy for the Cosmos DB database account.
properties.createMode	CreateMode	Default	Enum to indicate the mode of account creation.
properties.customerManagedKeyStatus	string		Gibt den Status des Features "Vom Kunden verwalteter Schlüssel" für das Konto an. Falls Fehler auftreten, bietet die Eigenschaft Anleitungen zur Problembehandlung.
properties.databaseAccountOfferType	DatabaseAccountOfferType		The offer type for the database
properties.defaultIdentity	string		The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
properties.disableKeyBasedMetadataWriteAccess	boolean		Disable write operations on metadata resources (databases, containers, throughput) via account keys
properties.disableLocalAuth	boolean		Deaktivieren Sie die lokale Authentifizierung, und stellen Sie sicher, dass nur MSI und AAD ausschließlich für die Authentifizierung verwendet werden können.
properties.enableAnalyticalStorage	boolean		Flag to indicate whether to enable storage analytics.
properties.enableAutomaticFailover	boolean		Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
properties.enableBurstCapacity	boolean		Flag zum Aktivieren/Deaktivieren der Funktion "Burst Capacity" auf dem Konto
properties.enableCassandraConnector	boolean		Enables the cassandra connector on the Cosmos DB C* account
properties.enableFreeTier	boolean		Flag to indicate whether Free Tier is enabled.
properties.enableMultipleWriteLocations	boolean		Enables the account to write in multiple locations
properties.enablePartitionMerge	boolean		Flag zum Aktivieren/Deaktivieren der Partitionszusammenführungsfunktion für das Konto
properties.enablePerRegionPerPartitionAutoscale	boolean		Flag zum Aktivieren/Deaktivieren des PerRegionPerPartitionAutoscale-Features für das Konto
properties.ipRules	IpAddressOrRange[]		List of IpRules.
properties.isVirtualNetworkFilterEnabled	boolean		Flag to indicate whether to enable/disable Virtual Network ACL rules.
properties.keyVaultKeyUri	string		The URI of the key vault
properties.keysMetadata	DatabaseAccountKeysMetadata		Diese Eigenschaft wird während des Aktualisierungs-/Erstellungsvorgangs ignoriert, da die Metadaten schreibgeschützt sind. Das Objekt stellt die Metadaten für die Kontoschlüssel des Cosmos DB-Kontos dar.
properties.locations	Location[]		An array that contains the georeplication locations enabled for the Cosmos DB account.
properties.minimalTlsVersion	MinimalTlsVersion		Gibt die mindestens zulässige Tls-Version an. Der Standardwert ist Tls 1.2. Cassandra- und Mongo-APIs funktionieren nur mit Tls 1.2.
properties.networkAclBypass	NetworkAclBypass		Indicates what services are allowed to bypass firewall checks.
properties.networkAclBypassResourceIds	string[]		An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
properties.publicNetworkAccess	PublicNetworkAccess		Whether requests from Public Network are allowed
properties.restoreParameters	RestoreParameters		Parameters to indicate the information about the restore.
properties.virtualNetworkRules	VirtualNetworkRule[]		List of Virtual Network ACL rules configured for the Cosmos DB account.
tags	object		Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können zum Anzeigen und Gruppieren dieser Ressource (über Ressourcengruppen hinweg) verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Jedes Tag muss einen Schlüssel haben, der nicht größer als 128 Zeichen ist, und der Wert darf maximal 256 Zeichen lang sein. Beispielsweise wird die Standardoberfläche für einen Vorlagentyp mit "defaultExperience": "Cassandra" festgelegt. Aktuelle "defaultExperience"-Werte enthalten auch "Table", "Graph", "DocumentDB" und "MongoDB".
type	string		Der Typ der Azure-Ressource.

DatabaseAccountGetResults

Objekt

Ein Azure Cosmos DB-Datenbankkonto.

Name	Typ	Standardwert	Beschreibung
id	string		Der eindeutige Ressourcenbezeichner der ARM-Ressource.
identity	ManagedServiceIdentity		Identity for the resource.
kind	DatabaseAccountKind	GlobalDocumentDB	Indicates the type of database account. This can only be set at database account creation.
location	string		The location of the resource group to which the resource belongs.
name	string		Der Name der ARM-Ressource.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Analytische Speicherspezifische Eigenschaften.
properties.apiProperties	ApiProperties		API specific properties.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		The object representing the policy for taking backups on an account.
properties.capabilities	Capability[]		List of Cosmos DB capabilities for the account
properties.capacity	Capacity		Das Objekt, das alle Eigenschaften im Zusammenhang mit der Kapazitätserzwingung für ein Konto darstellt.
properties.connectorOffer	ConnectorOffer		The cassandra connector offer type for the Cosmos DB database C* account.
properties.consistencyPolicy	ConsistencyPolicy		Die Konsistenzrichtlinie für das Cosmos DB-Datenbankkonto.
properties.cors	CorsPolicy[]		The CORS policy for the Cosmos DB database account.
properties.createMode	CreateMode	Default	Enum to indicate the mode of account creation.
properties.customerManagedKeyStatus	string		Gibt den Status des Features "Vom Kunden verwalteter Schlüssel" für das Konto an. Falls Fehler auftreten, bietet die Eigenschaft Anleitungen zur Problembehandlung.
properties.databaseAccountOfferType	DatabaseAccountOfferType		Der Angebotstyp für das Cosmos DB-Datenbankkonto. Standardwert: Standard.
properties.defaultIdentity	string		The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
properties.disableKeyBasedMetadataWriteAccess	boolean		Disable write operations on metadata resources (databases, containers, throughput) via account keys
properties.disableLocalAuth	boolean		Deaktivieren Sie die lokale Authentifizierung, und stellen Sie sicher, dass nur MSI und AAD ausschließlich für die Authentifizierung verwendet werden können.
properties.documentEndpoint	string		Der Verbindungsendpunkt für das Cosmos DB-Datenbankkonto.
properties.enableAnalyticalStorage	boolean		Flag to indicate whether to enable storage analytics.
properties.enableAutomaticFailover	boolean		Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
properties.enableBurstCapacity	boolean		Flag zum Aktivieren/Deaktivieren der Funktion "Burst Capacity" auf dem Konto
properties.enableCassandraConnector	boolean		Enables the cassandra connector on the Cosmos DB C* account
properties.enableFreeTier	boolean		Flag to indicate whether Free Tier is enabled.
properties.enableMultipleWriteLocations	boolean		Enables the account to write in multiple locations
properties.enablePartitionMerge	boolean		Flag zum Aktivieren/Deaktivieren der Partitionszusammenführungsfunktion für das Konto
properties.enablePerRegionPerPartitionAutoscale	boolean		Flag zum Aktivieren/Deaktivieren des PerRegionPerPartitionAutoscale-Features für das Konto
properties.failoverPolicies	FailoverPolicy[]		Ein Array, das die Regionen enthält, die nach ihren Failoverprioritäten sortiert sind.
properties.instanceId	string		Ein eindeutiger Bezeichner, der dem Datenbankkonto zugewiesen ist
properties.ipRules	IpAddressOrRange[]		List of IpRules.
properties.isVirtualNetworkFilterEnabled	boolean		Flag to indicate whether to enable/disable Virtual Network ACL rules.
properties.keyVaultKeyUri	string		The URI of the key vault
properties.keysMetadata	DatabaseAccountKeysMetadata		Das Objekt, das die Metadaten für die Kontoschlüssel des Cosmos DB-Kontos darstellt.
properties.locations	Location[]		Ein Array, das alle für das Cosmos DB-Konto aktivierten Speicherorte enthält.
properties.minimalTlsVersion	MinimalTlsVersion		Gibt die mindestens zulässige Tls-Version an. Der Standardwert ist Tls 1.2. Cassandra- und Mongo-APIs funktionieren nur mit Tls 1.2.
properties.networkAclBypass	NetworkAclBypass		Indicates what services are allowed to bypass firewall checks.
properties.networkAclBypassResourceIds	string[] (arm-id)		An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Liste der privaten Endpunktverbindungen, die für das Cosmos DB-Konto konfiguriert sind.
properties.provisioningState	string		Der Status des Cosmos DB-Kontos zum Zeitpunkt des Aufrufs des Vorgangs. Der Status kann eine der folgenden Sein: "Creating" – das Cosmos DB-Konto wird erstellt. Wenn sich ein Konto im Zustand "Erstellen" befindet, werden nur Eigenschaften zurückgegeben, die als Eingabe für den Create Cosmos DB-Kontovorgang angegeben werden. "Succeeded" – das Cosmos DB-Konto ist für die Verwendung aktiv. "Aktualisieren" – das Cosmos DB-Konto wird aktualisiert. "Löschen" – das Cosmos DB-Konto wird gelöscht. "Failed" – Das Cosmos DB-Konto konnte nicht erstellt werden. "DeleteFailed" – Fehler beim Löschen des Cosmos DB-Kontos.
properties.publicNetworkAccess	PublicNetworkAccess		Whether requests from Public Network are allowed
properties.readLocations	Location[]		Ein Array mit den für das Cosmos DB-Konto aktivierten Lesespeicherorten.
properties.restoreParameters	RestoreParameters		Parameters to indicate the information about the restore.
properties.virtualNetworkRules	VirtualNetworkRule[]		List of Virtual Network ACL rules configured for the Cosmos DB account.
properties.writeLocations	Location[]		Ein Array, das den Schreibspeicherort für das Cosmos DB-Konto enthält.
systemData	systemData		Die Systemmetadaten, die sich auf diese Ressource beziehen.
tags	object		Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können zum Anzeigen und Gruppieren dieser Ressource (über Ressourcengruppen hinweg) verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Jedes Tag muss einen Schlüssel haben, der nicht größer als 128 Zeichen ist, und der Wert darf maximal 256 Zeichen lang sein. Beispielsweise wird die Standardoberfläche für einen Vorlagentyp mit "defaultExperience": "Cassandra" festgelegt. Aktuelle "defaultExperience"-Werte enthalten auch "Table", "Graph", "DocumentDB" und "MongoDB".
type	string		Der Typ der Azure-Ressource.

DatabaseAccountKeysMetadata

Objekt

Die Metadaten für jeden Zugriffsschlüssel für das angegebene Cosmos DB-Datenbankkonto.

Name	Typ	Beschreibung
primaryMasterKey	AccountKeyMetadata	Die Metadaten im Zusammenhang mit dem primären Read-Write Key für das angegebene Cosmos DB-Datenbankkonto.
primaryReadonlyMasterKey	AccountKeyMetadata	Die Metadaten im Zusammenhang mit dem primären Read-Only Key für das angegebene Cosmos DB-Datenbankkonto.
secondaryMasterKey	AccountKeyMetadata	Die Metadaten im Zusammenhang mit dem sekundären Read-Write Key für das angegebene Cosmos DB-Datenbankkonto.
secondaryReadonlyMasterKey	AccountKeyMetadata	Die Metadaten im Zusammenhang mit dem sekundären Read-Only Key für das angegebene Cosmos DB-Datenbankkonto.

DatabaseAccountKind

Enumeration

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

Wert	Beschreibung
GlobalDocumentDB
MongoDB
Parse

DatabaseAccountOfferType

Enumeration

Der Angebotstyp für das Cosmos DB-Datenbankkonto.

Wert	Beschreibung
Standard

DatabaseRestoreResource

Objekt

Bestimmte Datenbanken, die wiederhergestellt werden sollen.

Name	Typ	Beschreibung
collectionNames	string[]	The names of the collections available for restore.
databaseName	string	The name of the database available for restore.

DefaultConsistencyLevel

Enumeration

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

Wert	Beschreibung
BoundedStaleness
ConsistentPrefix
Eventual
Session
Strong

FailoverPolicy

Objekt

Die Failoverrichtlinie für eine bestimmte Region eines Datenbankkontos.

Name	Typ	Beschreibung
failoverPriority	integer (int32) minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
id	string	Der eindeutige Bezeichner der Region, in der das Datenbankkonto repliziert wird. Beispiel: <accountName>-<locationName>.
locationName	string	Der Name der Region, in der das Datenbankkonto vorhanden ist.

GremlinDatabaseRestoreResource

Objekt

Spezifische Gremlin-Datenbanken, die wiederhergestellt werden sollen.

Name	Typ	Beschreibung
databaseName	string	Der Name der gremlin-Datenbank, die für die Wiederherstellung verfügbar ist.
graphNames	string[]	Die Namen der Diagramme, die für die Wiederherstellung verfügbar sind.

IpAddressOrRange

Objekt

IpAddressOrRange-Objekt

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

Location

Objekt

Eine Region, in der das Azure Cosmos DB-Datenbankkonto bereitgestellt wird.

Name	Typ	Beschreibung
documentEndpoint	string	Der Verbindungsendpunkt für die jeweilige Region. Beispiel: https://<accountName>-<locationName>.documents.azure.com:443/
failoverPriority	integer (int32) minimum: 0	The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
id	string	Der eindeutige Bezeichner der Region innerhalb des Datenbankkontos. Beispiel: <accountName>-<locationName>.
isZoneRedundant	boolean	Flag to indicate whether or not this region is an AvailabilityZone region
locationName	string	The name of the region.
provisioningState	string	Der Status des Cosmos DB-Kontos zum Zeitpunkt des Aufrufs des Vorgangs. Der Status kann eine der folgenden Sein: "Creating" – das Cosmos DB-Konto wird erstellt. Wenn sich ein Konto im Zustand "Erstellen" befindet, werden nur Eigenschaften zurückgegeben, die als Eingabe für den Create Cosmos DB-Kontovorgang angegeben werden. "Succeeded" – das Cosmos DB-Konto ist für die Verwendung aktiv. "Aktualisieren" – das Cosmos DB-Konto wird aktualisiert. "Löschen" – das Cosmos DB-Konto wird gelöscht. "Failed" – Das Cosmos DB-Konto konnte nicht erstellt werden. "DeleteFailed" – Fehler beim Löschen des Cosmos DB-Kontos.

ManagedServiceIdentity

Objekt

Identity for the resource.

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
tenantId	string	Die Mandanten-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
type	ResourceIdentityType	The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
userAssignedIdentities	UserAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

MinimalTlsVersion

Enumeration

Gibt die mindestens zulässige Tls-Version an. Der Standardwert ist Tls 1.2. Cassandra- und Mongo-APIs funktionieren nur mit Tls 1.2.

Wert	Beschreibung
Tls
Tls11
Tls12

NetworkAclBypass

Enumeration

Indicates what services are allowed to bypass firewall checks.

Wert	Beschreibung
AzureServices
None

PeriodicModeBackupPolicy

Objekt

Das Objekt, das die Sicherungsrichtlinie für den regelmäßigen Modus darstellt.

Name	Typ	Beschreibung
migrationState	BackupPolicyMigrationState	Das Objekt, das den Status der Migration zwischen den Sicherungsrichtlinien darstellt.
periodicModeProperties	PeriodicModeProperties	Configuration values for periodic mode backup
type	string: Periodic	Describes the mode of backups.

PeriodicModeProperties

Objekt

Configuration values for periodic mode backup

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

PrivateEndpointConnection

Objekt

Eine private Endpunktverbindung

Name	Typ	Beschreibung
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.groupId	string	Gruppen-ID des privaten Endpunkts.
properties.privateEndpoint	PrivateEndpointProperty	Private endpoint which the connection belongs to.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Connection State of the Private Endpoint Connection.
properties.provisioningState	string	Bereitstellungsstatus des privaten Endpunkts.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Objekt

Private endpoint which the connection belongs to.

Name	Typ	Beschreibung
id	string	Resource id of the private endpoint.

PrivateLinkServiceConnectionStateProperty

Objekt

Connection State of the Private Endpoint Connection.

Name	Typ	Beschreibung
actionsRequired	string	Jede Aktion, die über den grundlegenden Workflow hinaus erforderlich ist (genehmigen/ ablehnen/trennen)
description	string	The private link service connection description.
status	string	The private link service connection status.

PublicNetworkAccess

Enumeration

Whether requests from Public Network are allowed

Wert	Beschreibung
Disabled
Enabled
SecuredByPerimeter

ResourceIdentityType

Enumeration

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

Wert	Beschreibung
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

RestoreMode

Enumeration

Describes the mode of the restore.

Wert	Beschreibung
PointInTime

RestoreParameters

Objekt

Parameters to indicate the information about the restore.

Name	Typ	Beschreibung
databasesToRestore	DatabaseRestoreResource[]	List of specific databases available for restore.
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	Liste der spezifischen Gremlin-Datenbanken, die für die Wiederherstellung verfügbar sind.
restoreMode	RestoreMode	Describes the mode of the restore.
restoreSource	string	The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string (date-time)	Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled	boolean	Gibt an, ob das wiederhergestellte Konto zeit-To-Live bei der erfolgreichen Wiederherstellung deaktiviert ist.
tablesToRestore	string[]	Liste der für die Wiederherstellung verfügbaren spezifischen Tabellen.

ServerVersion

Enumeration

Beschreibt die Version des MongoDB-Kontos.

Wert	Beschreibung
3.2
3.6
4.0
4.2
5.0
6.0
7.0

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserAssignedIdentities

Objekt

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

Name	Typ	Beschreibung

VirtualNetworkRule

Objekt

Virtual Network ACL Rule-Objekt

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