Database Accounts - Update

Service:

Cosmos DB Resource Provider

API-versie:

2024-11-15

Hiermee worden de eigenschappen van een bestaand Azure Cosmos DB-databaseaccount bijgewerkt.

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

URI-parameters

Name	In	Vereist	Type	Description
accountName	path	True	string	Naam van cosmos DB-databaseaccount. Regex-patroon: ^[a-z0-9]+(-[a-z0-9]+)*
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
identity	ManagedServiceIdentity	Identiteit voor de resource.
location	string	De locatie van de resourcegroep waartoe de resource behoort.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Specifieke eigenschappen voor analytische opslag.
properties.apiProperties	ApiProperties	API-specifieke eigenschappen. Momenteel wordt alleen ondersteund voor mongoDB-API.
properties.backupPolicy	BackupPolicy: PeriodicModeBackupPolicy ContinuousModeBackupPolicy	Het object dat het beleid vertegenwoordigt voor het maken van back-ups voor een account.
properties.capabilities	Capability[]	Lijst met Cosmos DB-mogelijkheden voor het account
properties.capacity	Capacity	Het object dat alle eigenschappen vertegenwoordigt die betrekking hebben op het afdwingen van capaciteit voor een account.
properties.connectorOffer	ConnectorOffer	De cassandra-connectoraanbiedingstype voor het Cosmos DB-database-C*-account.
properties.consistencyPolicy	ConsistencyPolicy	Het consistentiebeleid voor het Cosmos DB-account.
properties.cors	CorsPolicy[]	Het CORS-beleid voor het Cosmos DB-databaseaccount.
properties.customerManagedKeyStatus	string	Geeft de status aan van de functie Door klant beheerde sleutel in het account. Als er fouten zijn, biedt de eigenschap richtlijnen voor probleemoplossing.
properties.defaultIdentity	string	De standaardidentiteit voor toegang tot de sleutelkluis die wordt gebruikt in functies zoals door de klant beheerde sleutels. De standaardidentiteit moet expliciet worden ingesteld door de gebruikers. Het kan FirstPartyIdentity, SystemAssignedIdentity en meer zijn.
properties.disableKeyBasedMetadataWriteAccess	boolean	Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels
properties.disableLocalAuth	boolean	Meld u af voor lokale verificatie en zorg ervoor dat alleen MSI en AAD uitsluitend voor verificatie kunnen worden gebruikt.
properties.enableAnalyticalStorage	boolean	Vlag om aan te geven of opslaganalyse moet worden ingeschakeld.
properties.enableAutomaticFailover	boolean	Maakt automatische failover van de schrijfregio mogelijk in de zeldzame gebeurtenis dat de regio niet beschikbaar is vanwege een storing. Automatische failover resulteert in een nieuwe schrijfregio voor het account en wordt gekozen op basis van de failoverprioriteiten die voor het account zijn geconfigureerd.
properties.enableBurstCapacity	boolean	Vlag om aan te geven dat de functie Burst Capacity voor het account is ingeschakeld/uitgeschakeld
properties.enableCassandraConnector	boolean	Hiermee schakelt u de Cassandra-connector in het Cosmos DB C*-account in
properties.enableFreeTier	boolean	Vlag om aan te geven of de gratis laag is ingeschakeld.
properties.enableMultipleWriteLocations	boolean	Hiermee kan het account op meerdere locaties schrijven
properties.enablePartitionMerge	boolean	Vlag om aan te geven dat de functie Partition Merge voor het account is ingeschakeld/uitgeschakeld
properties.enablePerRegionPerPartitionAutoscale	boolean	Vlag om aan te geven dat de functie PerRegionPerPartitionAutoscale voor het account is ingeschakeld/uitgeschakeld
properties.ipRules	IpAddressOrRange[]	Lijst met IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Vlag om aan te geven of virtuele netwerk-ACL-regels moeten worden ingeschakeld/uitgeschakeld.
properties.keyVaultKeyUri	string	De URI van de sleutelkluis
properties.locations	Location[]	Een matrix die de georeplicatielocaties bevat die zijn ingeschakeld voor het Cosmos DB-account.
properties.minimalTlsVersion	MinimalTlsVersion	Geeft de minimaal toegestane Tls-versie aan. De standaardwaarde is Tls 1.2. Cassandra- en Mongo-API's werken alleen met Tls 1.2.
properties.networkAclBypass	NetworkAclBypass	Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen.
properties.networkAclBypassResourceIds	string[]	Een matrix die de resource-id's voor netwerk-Acl bypass voor het Cosmos DB-account bevat.
properties.publicNetworkAccess	PublicNetworkAccess	Of aanvragen van openbaar netwerk zijn toegestaan
properties.virtualNetworkRules	VirtualNetworkRule[]	Lijst met ACL-regels voor virtueel netwerk die zijn geconfigureerd voor het Cosmos DB-account.
tags	object	Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt voor het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben van maximaal 128 tekens en een waarde van maximaal 256 tekens. De standaardervaring voor een sjabloontype wordt bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige 'defaultExperience'-waarden bevatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'.

Antwoorden

Name	Type	Description
200 OK	DatabaseAccountGetResults	De updatebewerking van het databaseaccount wordt asynchroon voltooid.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

CosmosDBDatabaseAccountPatch

Voorbeeldaanvraag

HTTP

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

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

Java

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

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

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

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

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

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


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

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


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

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

Go

package armcosmos_test

import (
	"context"
	"log"

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

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

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

JavaScript

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

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

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
AccountKeyMetadata	De metagegevens met betrekking tot een toegangssleutel voor een bepaald databaseaccount.
AnalyticalStorageConfiguration	Specifieke eigenschappen voor analytische opslag.
AnalyticalStorageSchemaType	Beschrijft de typen schema's voor analytische opslag.
ApiProperties
BackupPolicyMigrationState	Het object dat de status van de migratie tussen het back-upbeleid weergeeft.
BackupPolicyMigrationStatus	Beschrijft de status van de migratie tussen back-upbeleidstypen.
BackupPolicyType	Beschrijft de modus van back-ups.
BackupStorageRedundancy	Opsomming om het type redundantie van back-upopslag aan te geven.
Capability	Cosmos DB-mogelijkheidsobject
Capacity	Het object dat alle eigenschappen vertegenwoordigt die betrekking hebben op het afdwingen van capaciteit voor een account.
ConnectorOffer	Het aanbiedingstype cassandra-connector voor het Cosmos DB C*-databaseaccount.
ConsistencyPolicy	Het consistentiebeleid voor het Cosmos DB-databaseaccount.
ContinuousModeBackupPolicy	Het object dat het back-upbeleid voor continue modus vertegenwoordigt.
ContinuousModeProperties	Configuratiewaarden voor periodieke back-upmodus
ContinuousTier	Opsomming om het type continue back-uplaag aan te geven.
CorsPolicy	Het CORS-beleid voor het Cosmos DB-databaseaccount.
createdByType	Het type identiteit waarmee de resource is gemaakt.
CreateMode	Opsomming om de modus voor het maken van accounts aan te geven.
DatabaseAccountGetResults	Een Azure Cosmos DB-databaseaccount.
DatabaseAccountKeysMetadata	De metagegevens met betrekking tot elke toegangssleutel voor het opgegeven Cosmos DB-databaseaccount.
DatabaseAccountKind	Geeft het type databaseaccount aan. Dit kan alleen worden ingesteld bij het maken van een databaseaccount.
DatabaseAccountOfferType	Het aanbiedingstype voor het Cosmos DB-databaseaccount.
DatabaseAccountUpdateParameters	Parameters voor het patchen van azure Cosmos DB-databaseaccounteigenschappen.
DatabaseRestoreResource	Specifieke databases die moeten worden hersteld.
DefaultConsistencyLevel	Het standaardconsistentieniveau en de configuratie-instellingen van het Cosmos DB-account.
FailoverPolicy	Het failoverbeleid voor een bepaalde regio van een databaseaccount.
GremlinDatabaseRestoreResource	Specifieke Gremlin-databases die moeten worden hersteld.
IpAddressOrRange	IpAddressOrRange-object
Location	Een regio waarin het Azure Cosmos DB-databaseaccount wordt geïmplementeerd.
ManagedServiceIdentity	Identiteit voor de resource.
MinimalTlsVersion	Geeft de minimaal toegestane Tls-versie aan. De standaardwaarde is Tls 1.2. Cassandra- en Mongo-API's werken alleen met Tls 1.2.
NetworkAclBypass	Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen.
PeriodicModeBackupPolicy	Het object dat het back-upbeleid voor de periodieke modus vertegenwoordigt.
PeriodicModeProperties	Configuratiewaarden voor periodieke back-upmodus
PrivateEndpointConnection	Een privé-eindpuntverbinding
PrivateEndpointProperty	Privé-eindpunt waartoe de verbinding behoort.
PrivateLinkServiceConnectionStateProperty	Verbindingsstatus van de privé-eindpuntverbinding.
PublicNetworkAccess	Of aanvragen van openbaar netwerk zijn toegestaan
ResourceIdentityType	Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.
RestoreMode	Beschrijft de modus van het herstellen.
RestoreParameters	Parameters om de informatie over de herstelbewerking aan te geven.
ServerVersion	Beschrijft de versie van het MongoDB-account.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
UserAssignedIdentities	De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
VirtualNetworkRule	ACL-regelobject voor virtueel netwerk

AccountKeyMetadata

De metagegevens met betrekking tot een toegangssleutel voor een bepaald databaseaccount.

Name	Type	Description
generationTime	string	Generatietijd in UTC van de sleutel in ISO-8601-indeling. Als de waarde ontbreekt in het object, betekent dit dat de laatste sleutelregeneratie is geactiveerd vóór 2022-06-18.

AnalyticalStorageConfiguration

Specifieke eigenschappen voor analytische opslag.

Name	Type	Description
schemaType	AnalyticalStorageSchemaType	Beschrijft de typen schema's voor analytische opslag.

AnalyticalStorageSchemaType

Beschrijft de typen schema's voor analytische opslag.

Name	Type	Description
FullFidelity	string
WellDefined	string

ApiProperties

Name	Type	Description
serverVersion	ServerVersion	Beschrijft de versie van het MongoDB-account.

BackupPolicyMigrationState

Het object dat de status van de migratie tussen het back-upbeleid weergeeft.

Name	Type	Description
startTime	string	Tijdstip waarop de migratie van het back-upbeleid is gestart (ISO-8601-indeling).
status	BackupPolicyMigrationStatus	Beschrijft de status van de migratie tussen back-upbeleidstypen.
targetType	BackupPolicyType	Beschrijft het doelback-upbeleidstype van de migratie van het back-upbeleid.

BackupPolicyMigrationStatus

Beschrijft de status van de migratie tussen back-upbeleidstypen.

Name	Type	Description
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

Beschrijft de modus van back-ups.

Name	Type	Description
Continuous	string
Periodic	string

BackupStorageRedundancy

Opsomming om het type redundantie van back-upopslag aan te geven.

Name	Type	Description
Geo	string
Local	string
Zone	string

Capability

Cosmos DB-mogelijkheidsobject

Name	Type	Description
name	string	Naam van de Cosmos DB-functie. Bijvoorbeeld 'name': 'EnableCassandra'. De huidige waarden omvatten ook 'EnableTable' en 'EnableGremlin'.

Capacity

Het object dat alle eigenschappen vertegenwoordigt die betrekking hebben op het afdwingen van capaciteit voor een account.

Name	Type	Description
totalThroughputLimit	integer	De totale doorvoerlimiet die voor het account is ingesteld. Een totalThroughputLimit van 2000 legt een strikte limiet op voor maximale doorvoer die voor dat account kan worden ingericht voor 2000. Een totalThroughputLimit van -1 geeft geen limieten aan voor het inrichten van doorvoer.

ConnectorOffer

Het aanbiedingstype cassandra-connector voor het Cosmos DB C*-databaseaccount.

Name	Type	Description
Small	string

ConsistencyPolicy

Het consistentiebeleid voor het Cosmos DB-databaseaccount.

Name	Type	Description
defaultConsistencyLevel	DefaultConsistencyLevel	Het standaardconsistentieniveau en de configuratie-instellingen van het Cosmos DB-account.
maxIntervalInSeconds	integer	Bij gebruik met het consistentieniveau Gebonden veroudering vertegenwoordigt deze waarde de tijdsduur van veroudering (in seconden) die wordt getolereerd. Geaccepteerd bereik voor deze waarde is 5 - 86400. Vereist wanneer defaultConsistencyPolicy is ingesteld op 'BoundedStaleness'.
maxStalenessPrefix	integer	Wanneer deze waarde wordt gebruikt met het consistentieniveau Gebonden veroudering, vertegenwoordigt deze waarde het aantal verlopen aanvragen dat wordt getolereerd. Geaccepteerd bereik voor deze waarde is 1 – 2.147.483.647. Vereist wanneer defaultConsistencyPolicy is ingesteld op 'BoundedStaleness'.

ContinuousModeBackupPolicy

Het object dat het back-upbeleid voor continue modus vertegenwoordigt.

Name	Type	Description
continuousModeProperties	ContinuousModeProperties	Configuratiewaarden voor back-up van continue modus
migrationState	BackupPolicyMigrationState	Het object dat de status van de migratie tussen het back-upbeleid weergeeft.
type	string: Continuous	Beschrijft de modus van back-ups.

ContinuousModeProperties

Configuratiewaarden voor periodieke back-upmodus

Name	Type	Description
tier	ContinuousTier	Opsomming om het type continue back-upmodus aan te geven

ContinuousTier

Opsomming om het type continue back-uplaag aan te geven.

Name	Type	Description
Continuous30Days	string
Continuous7Days	string

CorsPolicy

Het CORS-beleid voor het Cosmos DB-databaseaccount.

Name	Type	Description
allowedHeaders	string	De aanvraagheaders die het oorspronkelijke domein kan opgeven voor de CORS-aanvraag.
allowedMethods	string	De methoden (HTTP-aanvraagwoorden) die het oorspronkelijke domein kan gebruiken voor een CORS-aanvraag.
allowedOrigins	string	De oorspronkelijke domeinen die via CORS een aanvraag voor de service mogen indienen.
exposedHeaders	string	De antwoordheaders die kunnen worden verzonden in het antwoord op de CORS-aanvraag en die door de browser worden weergegeven aan de verlener van de aanvraag.
maxAgeInSeconds	integer	De maximale hoeveelheid tijd die een browser moet opslaan in de cache van de preflight OPTIONS-aanvraag.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Opsomming om de modus voor het maken van accounts aan te geven.

Name	Type	Description
Default	string
Restore	string

DatabaseAccountGetResults

Een Azure Cosmos DB-databaseaccount.

Name	Type	Default value	Description
id	string		De unieke resource-id van de ARM-resource.
identity	ManagedServiceIdentity		Identiteit voor de resource.
kind	DatabaseAccountKind	GlobalDocumentDB	Geeft het type databaseaccount aan. Dit kan alleen worden ingesteld bij het maken van een databaseaccount.
location	string		De locatie van de resourcegroep waartoe de resource behoort.
name	string		De naam van de ARM-resource.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Specifieke eigenschappen voor analytische opslag.
properties.apiProperties	ApiProperties		API-specifieke eigenschappen.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		Het object dat het beleid vertegenwoordigt voor het maken van back-ups voor een account.
properties.capabilities	Capability[]		Lijst met Cosmos DB-mogelijkheden voor het account
properties.capacity	Capacity		Het object dat alle eigenschappen vertegenwoordigt die betrekking hebben op het afdwingen van capaciteit voor een account.
properties.connectorOffer	ConnectorOffer		De cassandra-connectoraanbiedingstype voor het Cosmos DB-database-C*-account.
properties.consistencyPolicy	ConsistencyPolicy		Het consistentiebeleid voor het Cosmos DB-databaseaccount.
properties.cors	CorsPolicy[]		Het CORS-beleid voor het Cosmos DB-databaseaccount.
properties.createMode	CreateMode	Default	Opsomming om de modus voor het maken van accounts aan te geven.
properties.customerManagedKeyStatus	string		Geeft de status aan van de functie Door klant beheerde sleutel in het account. Als er fouten zijn, biedt de eigenschap richtlijnen voor probleemoplossing.
properties.databaseAccountOfferType	DatabaseAccountOfferType		Het aanbiedingstype voor het Cosmos DB-databaseaccount. Standaardwaarde: Standaard.
properties.defaultIdentity	string		De standaardidentiteit voor toegang tot de sleutelkluis die wordt gebruikt in functies zoals door de klant beheerde sleutels. De standaardidentiteit moet expliciet worden ingesteld door de gebruikers. Het kan FirstPartyIdentity, SystemAssignedIdentity en meer zijn.
properties.disableKeyBasedMetadataWriteAccess	boolean		Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels
properties.disableLocalAuth	boolean		Meld u af voor lokale verificatie en zorg ervoor dat alleen MSI en AAD uitsluitend voor verificatie kunnen worden gebruikt.
properties.documentEndpoint	string		Het verbindingseindpunt voor het Cosmos DB-databaseaccount.
properties.enableAnalyticalStorage	boolean		Vlag om aan te geven of opslaganalyse moet worden ingeschakeld.
properties.enableAutomaticFailover	boolean		Maakt automatische failover van de schrijfregio mogelijk in de zeldzame gebeurtenis dat de regio niet beschikbaar is vanwege een storing. Automatische failover resulteert in een nieuwe schrijfregio voor het account en wordt gekozen op basis van de failoverprioriteiten die voor het account zijn geconfigureerd.
properties.enableBurstCapacity	boolean		Vlag om aan te geven dat de functie Burst Capacity voor het account is ingeschakeld/uitgeschakeld
properties.enableCassandraConnector	boolean		Hiermee schakelt u de Cassandra-connector in het Cosmos DB C*-account in
properties.enableFreeTier	boolean		Vlag om aan te geven of de gratis laag is ingeschakeld.
properties.enableMultipleWriteLocations	boolean		Hiermee kan het account op meerdere locaties schrijven
properties.enablePartitionMerge	boolean		Vlag om aan te geven dat de functie Partition Merge voor het account is ingeschakeld/uitgeschakeld
properties.enablePerRegionPerPartitionAutoscale	boolean		Vlag om aan te geven dat de functie PerRegionPerPartitionAutoscale voor het account is ingeschakeld/uitgeschakeld
properties.failoverPolicies	FailoverPolicy[]		Een matrix die de regio's bevat die zijn gerangschikt op hun failoverprioriteiten.
properties.instanceId	string		Een unieke id die is toegewezen aan het databaseaccount
properties.ipRules	IpAddressOrRange[]		Lijst met IpRules.
properties.isVirtualNetworkFilterEnabled	boolean		Vlag om aan te geven of virtuele netwerk-ACL-regels moeten worden ingeschakeld/uitgeschakeld.
properties.keyVaultKeyUri	string		De URI van de sleutelkluis
properties.keysMetadata	DatabaseAccountKeysMetadata		Het object dat de metagegevens vertegenwoordigt voor de accountsleutels van het Cosmos DB-account.
properties.locations	Location[]		Een matrix die alle locaties bevat die zijn ingeschakeld voor het Cosmos DB-account.
properties.minimalTlsVersion	MinimalTlsVersion		Geeft de minimaal toegestane Tls-versie aan. De standaardwaarde is Tls 1.2. Cassandra- en Mongo-API's werken alleen met Tls 1.2.
properties.networkAclBypass	NetworkAclBypass		Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen.
properties.networkAclBypassResourceIds	string[]		Een matrix die de resource-id's voor netwerk-Acl bypass voor het Cosmos DB-account bevat.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lijst met privé-eindpuntverbindingen die zijn geconfigureerd voor het Cosmos DB-account.
properties.provisioningState	string		De status van het Cosmos DB-account op het moment dat de bewerking werd aangeroepen. De status kan een van de volgende zijn. 'Maken': het Cosmos DB-account wordt gemaakt. Wanneer een account de status Maken heeft, worden alleen eigenschappen geretourneerd die zijn opgegeven als invoer voor de bewerking Cosmos DB-account maken. Geslaagd: het Cosmos DB-account is actief voor gebruik. 'Bijwerken': het Cosmos DB-account wordt bijgewerkt. 'Verwijderen': het Cosmos DB-account wordt verwijderd. 'Mislukt': het Maken van het Cosmos DB-account is mislukt. 'DeletionFailed': het verwijderen van het Cosmos DB-account is mislukt.
properties.publicNetworkAccess	PublicNetworkAccess		Of aanvragen van openbaar netwerk zijn toegestaan
properties.readLocations	Location[]		Een matrix die de leeslocaties bevat die zijn ingeschakeld voor het Cosmos DB-account.
properties.restoreParameters	RestoreParameters		Parameters om de informatie over de herstelbewerking aan te geven.
properties.virtualNetworkRules	VirtualNetworkRule[]		Lijst met ACL-regels voor virtueel netwerk die zijn geconfigureerd voor het Cosmos DB-account.
properties.writeLocations	Location[]		Een matrix die de schrijflocatie voor het Cosmos DB-account bevat.
systemData	systemData		De systeemmetagegevens met betrekking tot deze resource.
tags	object		Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt voor het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben van maximaal 128 tekens en een waarde van maximaal 256 tekens. De standaardervaring voor een sjabloontype wordt bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige 'defaultExperience'-waarden bevatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'.
type	string		Het type Azure-resource.

DatabaseAccountKeysMetadata

De metagegevens met betrekking tot elke toegangssleutel voor het opgegeven Cosmos DB-databaseaccount.

Name	Type	Description
primaryMasterKey	AccountKeyMetadata	De metagegevens met betrekking tot de primaire Read-Write-sleutel voor het opgegeven Cosmos DB-databaseaccount.
primaryReadonlyMasterKey	AccountKeyMetadata	De metagegevens met betrekking tot de primaire Read-Only-sleutel voor het opgegeven Cosmos DB-databaseaccount.
secondaryMasterKey	AccountKeyMetadata	De metagegevens met betrekking tot de secundaire Read-Write sleutel voor het opgegeven Cosmos DB-databaseaccount.
secondaryReadonlyMasterKey	AccountKeyMetadata	De metagegevens met betrekking tot de secundaire Read-Only sleutel voor het opgegeven Cosmos DB-databaseaccount.

DatabaseAccountKind

Geeft het type databaseaccount aan. Dit kan alleen worden ingesteld bij het maken van een databaseaccount.

Name	Type	Description
GlobalDocumentDB	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

Het aanbiedingstype voor het Cosmos DB-databaseaccount.

Name	Type	Description
Standard	string

DatabaseAccountUpdateParameters

Parameters voor het patchen van azure Cosmos DB-databaseaccounteigenschappen.

Name	Type	Description
identity	ManagedServiceIdentity	Identiteit voor de resource.
location	string	De locatie van de resourcegroep waartoe de resource behoort.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Specifieke eigenschappen voor analytische opslag.
properties.apiProperties	ApiProperties	API-specifieke eigenschappen. Momenteel wordt alleen ondersteund voor mongoDB-API.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy	Het object dat het beleid vertegenwoordigt voor het maken van back-ups voor een account.
properties.capabilities	Capability[]	Lijst met Cosmos DB-mogelijkheden voor het account
properties.capacity	Capacity	Het object dat alle eigenschappen vertegenwoordigt die betrekking hebben op het afdwingen van capaciteit voor een account.
properties.connectorOffer	ConnectorOffer	De cassandra-connectoraanbiedingstype voor het Cosmos DB-database-C*-account.
properties.consistencyPolicy	ConsistencyPolicy	Het consistentiebeleid voor het Cosmos DB-account.
properties.cors	CorsPolicy[]	Het CORS-beleid voor het Cosmos DB-databaseaccount.
properties.customerManagedKeyStatus	string	Geeft de status aan van de functie Door klant beheerde sleutel in het account. Als er fouten zijn, biedt de eigenschap richtlijnen voor probleemoplossing.
properties.defaultIdentity	string	De standaardidentiteit voor toegang tot de sleutelkluis die wordt gebruikt in functies zoals door de klant beheerde sleutels. De standaardidentiteit moet expliciet worden ingesteld door de gebruikers. Het kan FirstPartyIdentity, SystemAssignedIdentity en meer zijn.
properties.disableKeyBasedMetadataWriteAccess	boolean	Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels
properties.disableLocalAuth	boolean	Meld u af voor lokale verificatie en zorg ervoor dat alleen MSI en AAD uitsluitend voor verificatie kunnen worden gebruikt.
properties.enableAnalyticalStorage	boolean	Vlag om aan te geven of opslaganalyse moet worden ingeschakeld.
properties.enableAutomaticFailover	boolean	Maakt automatische failover van de schrijfregio mogelijk in de zeldzame gebeurtenis dat de regio niet beschikbaar is vanwege een storing. Automatische failover resulteert in een nieuwe schrijfregio voor het account en wordt gekozen op basis van de failoverprioriteiten die voor het account zijn geconfigureerd.
properties.enableBurstCapacity	boolean	Vlag om aan te geven dat de functie Burst Capacity voor het account is ingeschakeld/uitgeschakeld
properties.enableCassandraConnector	boolean	Hiermee schakelt u de Cassandra-connector in het Cosmos DB C*-account in
properties.enableFreeTier	boolean	Vlag om aan te geven of de gratis laag is ingeschakeld.
properties.enableMultipleWriteLocations	boolean	Hiermee kan het account op meerdere locaties schrijven
properties.enablePartitionMerge	boolean	Vlag om aan te geven dat de functie Partition Merge voor het account is ingeschakeld/uitgeschakeld
properties.enablePerRegionPerPartitionAutoscale	boolean	Vlag om aan te geven dat de functie PerRegionPerPartitionAutoscale voor het account is ingeschakeld/uitgeschakeld
properties.ipRules	IpAddressOrRange[]	Lijst met IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Vlag om aan te geven of virtuele netwerk-ACL-regels moeten worden ingeschakeld/uitgeschakeld.
properties.keyVaultKeyUri	string	De URI van de sleutelkluis
properties.keysMetadata	DatabaseAccountKeysMetadata	Deze eigenschap wordt genegeerd tijdens de updatebewerking, omdat de metagegevens alleen-lezen zijn. Het object vertegenwoordigt de metagegevens voor de accountsleutels van het Cosmos DB-account.
properties.locations	Location[]	Een matrix die de georeplicatielocaties bevat die zijn ingeschakeld voor het Cosmos DB-account.
properties.minimalTlsVersion	MinimalTlsVersion	Geeft de minimaal toegestane Tls-versie aan. De standaardwaarde is Tls 1.2. Cassandra- en Mongo-API's werken alleen met Tls 1.2.
properties.networkAclBypass	NetworkAclBypass	Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen.
properties.networkAclBypassResourceIds	string[]	Een matrix die de resource-id's voor netwerk-Acl bypass voor het Cosmos DB-account bevat.
properties.publicNetworkAccess	PublicNetworkAccess	Of aanvragen van openbaar netwerk zijn toegestaan
properties.virtualNetworkRules	VirtualNetworkRule[]	Lijst met ACL-regels voor virtueel netwerk die zijn geconfigureerd voor het Cosmos DB-account.
tags	object	Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt voor het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben van maximaal 128 tekens en een waarde van maximaal 256 tekens. De standaardervaring voor een sjabloontype wordt bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige 'defaultExperience'-waarden bevatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'.

DatabaseRestoreResource

Specifieke databases die moeten worden hersteld.

Name	Type	Description
collectionNames	string[]	De namen van de verzamelingen die beschikbaar zijn voor herstel.
databaseName	string	De naam van de database die beschikbaar is voor herstel.

DefaultConsistencyLevel

Het standaardconsistentieniveau en de configuratie-instellingen van het Cosmos DB-account.

Name	Type	Description
BoundedStaleness	string
ConsistentPrefix	string
Eventual	string
Session	string
Strong	string

FailoverPolicy

Het failoverbeleid voor een bepaalde regio van een databaseaccount.

Name	Type	Description
failoverPriority	integer	De failoverprioriteit van de regio. Een failoverprioriteit van 0 geeft een schrijfregio aan. De maximumwaarde voor een failoverprioriteit = (totaal aantal regio's - 1). Failoverprioriteitswaarden moeten uniek zijn voor elk van de regio's waarin het databaseaccount bestaat.
id	string	De unieke id van de regio waarnaar het databaseaccount wordt gerepliceerd. Voorbeeld: <accountName>-<locationName>.
locationName	string	De naam van de regio waarin het databaseaccount bestaat.

GremlinDatabaseRestoreResource

Specifieke Gremlin-databases die moeten worden hersteld.

Name	Type	Description
databaseName	string	De naam van de gremlin-database die beschikbaar is voor herstel.
graphNames	string[]	De namen van de grafieken die beschikbaar zijn voor herstel.

IpAddressOrRange

IpAddressOrRange-object

Name	Type	Description
ipAddressOrRange	string	Eén IPv4-adres of één IPv4-adresbereik in CIDR-indeling. Opgegeven IP-adressen moeten goed zijn opgemaakt en kunnen niet worden opgenomen in een van de volgende bereiken: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, omdat deze niet kunnen worden afgedwongen door het IP-adresfilter. Voorbeeld van geldige invoer: '23.40.210.245' of '23.40.210.0/8'.

Location

Een regio waarin het Azure Cosmos DB-databaseaccount wordt geïmplementeerd.

Name	Type	Description
documentEndpoint	string	Het verbindingseindpunt voor de specifieke regio. Voorbeeld: https://<accountName>-<locationName>.documents.azure.com:443/
failoverPriority	integer	De failoverprioriteit van de regio. Een failoverprioriteit van 0 geeft een schrijfregio aan. De maximumwaarde voor een failoverprioriteit = (totaal aantal regio's - 1). Failoverprioriteitswaarden moeten uniek zijn voor elk van de regio's waarin het databaseaccount bestaat.
id	string	De unieke id van de regio binnen het databaseaccount. Voorbeeld: <accountName>-<locationName>.
isZoneRedundant	boolean	Vlag om aan te geven of deze regio een AvailabilityZone-regio is
locationName	string	De naam van de regio.
provisioningState	string	De status van het Cosmos DB-account op het moment dat de bewerking werd aangeroepen. De status kan een van de volgende zijn. 'Maken': het Cosmos DB-account wordt gemaakt. Wanneer een account de status Maken heeft, worden alleen eigenschappen geretourneerd die zijn opgegeven als invoer voor de bewerking Cosmos DB-account maken. Geslaagd: het Cosmos DB-account is actief voor gebruik. 'Bijwerken': het Cosmos DB-account wordt bijgewerkt. 'Verwijderen': het Cosmos DB-account wordt verwijderd. 'Mislukt': het Maken van het Cosmos DB-account is mislukt. 'DeletionFailed': het verwijderen van het Cosmos DB-account is mislukt.

ManagedServiceIdentity

Identiteit voor de resource.

Name	Type	Description
principalId	string	De principal-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen verstrekt voor een door het systeem toegewezen identiteit.
tenantId	string	De tenant-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen verstrekt voor een door het systeem toegewezen identiteit.
type	ResourceIdentityType	Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.
userAssignedIdentities	UserAssignedIdentities	De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

MinimalTlsVersion

Geeft de minimaal toegestane Tls-versie aan. De standaardwaarde is Tls 1.2. Cassandra- en Mongo-API's werken alleen met Tls 1.2.

Name	Type	Description
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen.

Name	Type	Description
AzureServices	string
None	string

PeriodicModeBackupPolicy

Het object dat het back-upbeleid voor de periodieke modus vertegenwoordigt.

Name	Type	Description
migrationState	BackupPolicyMigrationState	Het object dat de status van de migratie tussen het back-upbeleid weergeeft.
periodicModeProperties	PeriodicModeProperties	Configuratiewaarden voor periodieke back-upmodus
type	string: Periodic	Beschrijft de modus van back-ups.

PeriodicModeProperties

Configuratiewaarden voor periodieke back-upmodus

Name	Type	Description
backupIntervalInMinutes	integer	Een geheel getal dat het interval in minuten tussen twee back-ups aangeeft
backupRetentionIntervalInHours	integer	Een geheel getal dat de tijd (in uren) aangeeft dat elke back-up wordt bewaard
backupStorageRedundancy	BackupStorageRedundancy	Opsomming om het type back-uplocatie aan te geven

PrivateEndpointConnection

Een privé-eindpuntverbinding

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.groupId	string	Groeps-id van het privé-eindpunt.
properties.privateEndpoint	PrivateEndpointProperty	Privé-eindpunt waartoe de verbinding behoort.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Verbindingsstatus van de privé-eindpuntverbinding.
properties.provisioningState	string	Inrichtingsstatus van het privé-eindpunt.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrivateEndpointProperty

Privé-eindpunt waartoe de verbinding behoort.

Name	Type	Description
id	string	Resource-id van het privé-eindpunt.

PrivateLinkServiceConnectionStateProperty

Verbindingsstatus van de privé-eindpuntverbinding.

Name	Type	Description
actionsRequired	string	Elke actie die nodig is buiten de basiswerkstroom (goedkeuren/weigeren/verbreken)
description	string	De beschrijving van de private link-serviceverbinding.
status	string	De verbindingsstatus van de Private Link-service.

PublicNetworkAccess

Of aanvragen van openbaar netwerk zijn toegestaan

Name	Type	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

Beschrijft de modus van het herstellen.

Name	Type	Description
PointInTime	string

RestoreParameters

Parameters om de informatie over de herstelbewerking aan te geven.

Name	Type	Description
databasesToRestore	DatabaseRestoreResource[]	Lijst met specifieke databases die beschikbaar zijn voor herstel.
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	Lijst met specifieke Gremlin-databases die beschikbaar zijn voor herstel.
restoreMode	RestoreMode	Beschrijft de modus van het herstellen.
restoreSource	string	De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Tijd waarop het account moet worden hersteld (ISO-8601-indeling).
restoreWithTtlDisabled	boolean	Hiermee geeft u op of het herstelde account tijd-To-Live uitgeschakeld bij het herstellen.
tablesToRestore	string[]	Lijst met specifieke tabellen die beschikbaar zijn voor herstel.

ServerVersion

Beschrijft de versie van het MongoDB-account.

Name	Type	Description
3.2	string
3.6	string
4.0	string
4.2	string
5.0	string
6.0	string
7.0	string

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

UserAssignedIdentities

De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

Name	Type	Description

VirtualNetworkRule

ACL-regelobject voor virtueel netwerk

Name	Type	Description
id	string	Resource-id van een subnet, bijvoorbeeld: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnetten/{subnetName}.
ignoreMissingVNetServiceEndpoint	boolean	Maak een firewallregel voordat vnet-service-eindpunt is ingeschakeld voor het virtuele netwerk.