Database Accounts - Update

Referens

Tjänst:: Cosmos DB Resource Provider

API-version:: 2024-11-15

Uppdaterar egenskaperna för ett befintligt Azure Cosmos DB-databaskonto.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
accountName	path	True	string	Cosmos DB-databaskontonamn. Reguljärt uttrycksmönster: `^[a-z0-9]+(-[a-z0-9]+)*`
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
identity	ManagedServiceIdentity	Identitet för resursen.
location	string	Platsen för den resursgrupp som resursen tillhör.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Specifika egenskaper för analyslagring.
properties.apiProperties	ApiProperties	API-specifika egenskaper. För närvarande stöds endast för MongoDB API.
properties.backupPolicy	BackupPolicy: PeriodicModeBackupPolicy ContinuousModeBackupPolicy	Objektet som representerar principen för att ta säkerhetskopior på ett konto.
properties.capabilities	Capability[]	Lista över Cosmos DB-funktioner för kontot
properties.capacity	Capacity	Objektet som representerar alla egenskaper som är relaterade till kapacitetsframtvingande för ett konto.
properties.connectorOffer	ConnectorOffer	Erbjudandetypen cassandra connector för Cosmos DB-databasens C*-konto.
properties.consistencyPolicy	ConsistencyPolicy	Konsekvensprincipen för Cosmos DB-kontot.
properties.cors	CorsPolicy[]	CORS-principen för Cosmos DB-databaskontot.
properties.customerManagedKeyStatus	string	Anger status för funktionen Kundhanterad nyckel för kontot. Om det finns fel ger egenskapen felsökningsvägledning.
properties.defaultIdentity	string	Standardidentiteten för åtkomst till nyckelvalv som används i funktioner som kundhanterade nycklar. Standardidentiteten måste uttryckligen anges av användarna. Det kan vara "FirstPartyIdentity", "SystemAssignedIdentity" med mera.
properties.disableKeyBasedMetadataWriteAccess	boolean	Inaktivera skrivåtgärder för metadataresurser (databaser, containrar, dataflöde) via kontonycklar
properties.disableLocalAuth	boolean	Välj bort lokal autentisering och se till att endast MSI och AAD kan användas uteslutande för autentisering.
properties.enableAnalyticalStorage	boolean	Flagga för att ange om lagringsanalys ska aktiveras.
properties.enableAutomaticFailover	boolean	Aktiverar automatisk redundans för skrivregionen i den sällsynta händelsen att regionen inte är tillgänglig på grund av ett avbrott. Automatisk redundans resulterar i en ny skrivregion för kontot och väljs baserat på de redundansprioriteringar som konfigurerats för kontot.
properties.enableBurstCapacity	boolean	Flagga för att ange aktivering/inaktivering av burst-kapacitetsfunktionen på kontot
properties.enableCassandraConnector	boolean	Aktiverar cassandra-anslutningsappen på Cosmos DB C*-kontot
properties.enableFreeTier	boolean	Flagga för att ange om den kostnadsfria nivån är aktiverad.
properties.enableMultipleWriteLocations	boolean	Gör att kontot kan skriva på flera platser
properties.enablePartitionMerge	boolean	Flagga för att ange aktivering/inaktivering av funktionen För sammanfogning av partition på kontot
properties.enablePerRegionPerPartitionAutoscale	boolean	Flagga för att ange aktivering/inaktivering av funktionen PerRegionPerPartitionAutoscale på kontot
properties.ipRules	IpAddressOrRange[]	Lista över IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Flagga för att ange om du vill aktivera/inaktivera ACL-regler för virtuellt nätverk.
properties.keyVaultKeyUri	string	URI för nyckelvalvet
properties.locations	Location[]	En matris som innehåller de georeplikeringsplatser som är aktiverade för Cosmos DB-kontot.
properties.minimalTlsVersion	MinimalTlsVersion	Anger den lägsta tillåtna Tls-versionen. Standardvärdet är Tls 1.2. Api:er för Cassandra och Mongo fungerar bara med Tls 1.2.
properties.networkAclBypass	NetworkAclBypass	Anger vilka tjänster som tillåts kringgå brandväggskontroller.
properties.networkAclBypassResourceIds	string[]	En matris som innehåller resurs-ID:n för Network Acl Bypass för Cosmos DB-kontot.
properties.publicNetworkAccess	PublicNetworkAccess	Om begäranden från offentliga nätverk tillåts
properties.virtualNetworkRules	VirtualNetworkRule[]	Lista över ACL-regler för virtuellt nätverk som konfigurerats för Cosmos DB-kontot.
tags	object	Taggar är en lista över nyckel/värde-par som beskriver resursen. Dessa taggar kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB".

Svar

Name	Typ	Description
200 OK	DatabaseAccountGetResults	Uppdateringsåtgärden för databaskontot slutförs asynkront.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	Personifiera ditt användarkonto

Exempel

CosmosDBDatabaseAccountPatch

Exempelbegäran

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"
  }
}


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

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

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

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

Exempelsvar

Statuskod:: 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"
  }
}

Definitioner

Name	Description
AccountKeyMetadata	Metadata som är relaterade till en åtkomstnyckel för ett visst databaskonto.
AnalyticalStorageConfiguration	Specifika egenskaper för analyslagring.
AnalyticalStorageSchemaType	Beskriver typerna av schema för analyslagring.
ApiProperties
BackupPolicyMigrationState	Objektet som representerar migreringens tillstånd mellan säkerhetskopieringsprinciperna.
BackupPolicyMigrationStatus	Beskriver status för migrering mellan principtyper för säkerhetskopiering.
BackupPolicyType	Beskriver läget för säkerhetskopior.
BackupStorageRedundancy	Räkna upp för att ange typ av redundans för säkerhetskopieringslagring.
Capability	Cosmos DB-funktionsobjekt
Capacity	Objektet som representerar alla egenskaper som är relaterade till kapacitetsframtvingande för ett konto.
ConnectorOffer	Erbjudandetypen cassandra connector för Cosmos DB C*-databaskontot.
ConsistencyPolicy	Konsekvensprincipen för Cosmos DB-databaskontot.
ContinuousModeBackupPolicy	Objektet som representerar säkerhetskopieringsprincipen för kontinuerligt läge.
ContinuousModeProperties	Konfigurationsvärden för säkerhetskopiering i periodiskt läge
ContinuousTier	Uppräkning för att ange typ av kontinuerlig säkerhetskopieringsnivå.
CorsPolicy	CORS-principen för Cosmos DB-databaskontot.
createdByType	Den typ av identitet som skapade resursen.
CreateMode	Uppräkning för att ange läget för kontoskapande.
DatabaseAccountGetResults	Ett Azure Cosmos DB-databaskonto.
DatabaseAccountKeysMetadata	Metadata relaterade till varje åtkomstnyckel för det angivna Cosmos DB-databaskontot.
DatabaseAccountKind	Anger typ av databaskonto. Detta kan bara anges när databaskontot skapas.
DatabaseAccountOfferType	Erbjudandetypen för Cosmos DB-databaskontot.
DatabaseAccountUpdateParameters	Parametrar för att korrigera azure Cosmos DB-databaskontoegenskaper.
DatabaseRestoreResource	Specifika databaser som ska återställas.
DefaultConsistencyLevel	Standardkonsekvensnivån och konfigurationsinställningarna för Cosmos DB-kontot.
FailoverPolicy	Redundansprincipen för en viss region för ett databaskonto.
GremlinDatabaseRestoreResource	Specifika Gremlin-databaser som ska återställas.
IpAddressOrRange	IpAddressOrRange-objekt
Location	En region där Azure Cosmos DB-databaskontot distribueras.
ManagedServiceIdentity	Identitet för resursen.
MinimalTlsVersion	Anger den lägsta tillåtna Tls-versionen. Standardvärdet är Tls 1.2. Api:er för Cassandra och Mongo fungerar bara med Tls 1.2.
NetworkAclBypass	Anger vilka tjänster som tillåts kringgå brandväggskontroller.
PeriodicModeBackupPolicy	Objektet som representerar säkerhetskopieringsprincipen för periodiskt läge.
PeriodicModeProperties	Konfigurationsvärden för säkerhetskopiering i periodiskt läge
PrivateEndpointConnection	En privat slutpunktsanslutning
PrivateEndpointProperty	Privat slutpunkt som anslutningen tillhör.
PrivateLinkServiceConnectionStateProperty	Anslutningstillstånd för den privata slutpunktsanslutningen.
PublicNetworkAccess	Om begäranden från offentliga nätverk tillåts
ResourceIdentityType	Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
RestoreMode	Beskriver återställningsläget.
RestoreParameters	Parametrar som anger information om återställningen.
ServerVersion	Beskriver versionen av MongoDB-kontot.
systemData	Metadata som rör skapande och senaste ändring av resursen.
UserAssignedIdentities	Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
VirtualNetworkRule	ACL-regelobjekt för virtuellt nätverk

AccountKeyMetadata

Metadata som är relaterade till en åtkomstnyckel för ett visst databaskonto.

Name	Typ	Description
generationTime	string	Genereringstid i UTC för nyckeln i ISO-8601-format. Om värdet saknas i objektet innebär det att den senaste nyckelregenereringen utlöstes före 2022-06-18.

AnalyticalStorageConfiguration

Specifika egenskaper för analyslagring.

Name	Typ	Description
schemaType	AnalyticalStorageSchemaType	Beskriver typerna av schema för analyslagring.

AnalyticalStorageSchemaType

Beskriver typerna av schema för analyslagring.

Name	Typ	Description
FullFidelity	string
WellDefined	string

ApiProperties

Name	Typ	Description
serverVersion	ServerVersion	Beskriver versionen av MongoDB-kontot.

BackupPolicyMigrationState

Objektet som representerar migreringens tillstånd mellan säkerhetskopieringsprinciperna.

Name	Typ	Description
startTime	string	Tidpunkt då migreringen av säkerhetskopieringsprincipen startade (ISO-8601-format).
status	BackupPolicyMigrationStatus	Beskriver status för migrering mellan principtyper för säkerhetskopiering.
targetType	BackupPolicyType	Beskriver målprinciptypen för säkerhetskopieringsprincipen för migreringen av säkerhetskopieringsprinciper.

BackupPolicyMigrationStatus

Beskriver status för migrering mellan principtyper för säkerhetskopiering.

Name	Typ	Description
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

Beskriver läget för säkerhetskopior.

Name	Typ	Description
Continuous	string
Periodic	string

BackupStorageRedundancy

Räkna upp för att ange typ av redundans för säkerhetskopieringslagring.

Name	Typ	Description
Geo	string
Local	string
Zone	string

Capability

Cosmos DB-funktionsobjekt

Name	Typ	Description
name	string	Namnet på Cosmos DB-funktionen. Till exempel "name": "EnableCassandra". Aktuella värden inkluderar även "EnableTable" och "EnableGremlin".

Capacity

Objektet som representerar alla egenskaper som är relaterade till kapacitetsframtvingande för ett konto.

Name	Typ	Description
totalThroughputLimit	integer	Den totala dataflödesgräns som har införts för kontot. Ett totalThroughputLimit på 2000 medför en strikt gräns för maximalt dataflöde som kan etableras på kontot till 2000. Ett totalThroughputLimit av -1 anger inga begränsningar för etablering av dataflöde.

ConnectorOffer

Erbjudandetypen cassandra connector för Cosmos DB C*-databaskontot.

Name	Typ	Description
Small	string

ConsistencyPolicy

Konsekvensprincipen för Cosmos DB-databaskontot.

Name	Typ	Description
defaultConsistencyLevel	DefaultConsistencyLevel	Standardkonsekvensnivån och konfigurationsinställningarna för Cosmos DB-kontot.
maxIntervalInSeconds	integer	När det används med konsekvensnivån Begränsad föråldring representerar det här värdet den tid då inaktuellhet (i sekunder) tolereras. Godkänt intervall för det här värdet är 5–86400. Krävs när defaultConsistencyPolicy är inställt på "BoundedStaleness".
maxStalenessPrefix	integer	När det används med konsekvensnivån Begränsad föråldring representerar det här värdet antalet inaktuella begäranden som tolereras. Godkänt intervall för det här värdet är 1– 2 147 483 647. Krävs när defaultConsistencyPolicy är inställt på "BoundedStaleness".

ContinuousModeBackupPolicy

Objektet som representerar säkerhetskopieringsprincipen för kontinuerligt läge.

Name	Typ	Description
continuousModeProperties	ContinuousModeProperties	Konfigurationsvärden för säkerhetskopiering i kontinuerligt läge
migrationState	BackupPolicyMigrationState	Objektet som representerar migreringens tillstånd mellan säkerhetskopieringsprinciperna.
type	string: Continuous	Beskriver läget för säkerhetskopior.

ContinuousModeProperties

Konfigurationsvärden för säkerhetskopiering i periodiskt läge

Name	Typ	Description
tier	ContinuousTier	Uppräkning för att ange typ av läge för kontinuerlig säkerhetskopiering

ContinuousTier

Uppräkning för att ange typ av kontinuerlig säkerhetskopieringsnivå.

Name	Typ	Description
Continuous30Days	string
Continuous7Days	string

CorsPolicy

CORS-principen för Cosmos DB-databaskontot.

Name	Typ	Description
allowedHeaders	string	De begärandehuvuden som ursprungsdomänen kan ange i CORS-begäran.
allowedMethods	string	De metoder (HTTP-begärandeverb) som ursprungsdomänen kan använda för en CORS-begäran.
allowedOrigins	string	De ursprungsdomäner som tillåts göra en begäran mot tjänsten via CORS.
exposedHeaders	string	Svarshuvudena som kan skickas i svaret på CORS-begäran och exponeras av webbläsaren för frågeutfärdaren.
maxAgeInSeconds	integer	Den maximala tid som en webbläsare ska cachelagera begäran om förhandsversionen av ALTERNATIV.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Uppräkning för att ange läget för kontoskapande.

Name	Typ	Description
Default	string
Restore	string

DatabaseAccountGetResults

Ett Azure Cosmos DB-databaskonto.

Name	Typ	Standardvärde	Description
id	string		Den unika resursidentifieraren för ARM-resursen.
identity	ManagedServiceIdentity		Identitet för resursen.
kind	DatabaseAccountKind	GlobalDocumentDB	Anger typ av databaskonto. Detta kan bara anges när databaskontot skapas.
location	string		Platsen för den resursgrupp som resursen tillhör.
name	string		Namnet på ARM-resursen.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Specifika egenskaper för analyslagring.
properties.apiProperties	ApiProperties		API-specifika egenskaper.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		Objektet som representerar principen för att ta säkerhetskopior på ett konto.
properties.capabilities	Capability[]		Lista över Cosmos DB-funktioner för kontot
properties.capacity	Capacity		Objektet som representerar alla egenskaper som är relaterade till kapacitetsframtvingande för ett konto.
properties.connectorOffer	ConnectorOffer		Erbjudandetypen cassandra connector för Cosmos DB-databasens C*-konto.
properties.consistencyPolicy	ConsistencyPolicy		Konsekvensprincipen för Cosmos DB-databaskontot.
properties.cors	CorsPolicy[]		CORS-principen för Cosmos DB-databaskontot.
properties.createMode	CreateMode	Default	Uppräkning för att ange läget för kontoskapande.
properties.customerManagedKeyStatus	string		Anger status för funktionen Kundhanterad nyckel för kontot. Om det finns fel ger egenskapen felsökningsvägledning.
properties.databaseAccountOfferType	DatabaseAccountOfferType		Erbjudandetypen för Cosmos DB-databaskontot. Standardvärde: Standard.
properties.defaultIdentity	string		Standardidentiteten för åtkomst till nyckelvalv som används i funktioner som kundhanterade nycklar. Standardidentiteten måste uttryckligen anges av användarna. Det kan vara "FirstPartyIdentity", "SystemAssignedIdentity" med mera.
properties.disableKeyBasedMetadataWriteAccess	boolean		Inaktivera skrivåtgärder för metadataresurser (databaser, containrar, dataflöde) via kontonycklar
properties.disableLocalAuth	boolean		Välj bort lokal autentisering och se till att endast MSI och AAD kan användas uteslutande för autentisering.
properties.documentEndpoint	string		Anslutningsslutpunkten för Cosmos DB-databaskontot.
properties.enableAnalyticalStorage	boolean		Flagga för att ange om lagringsanalys ska aktiveras.
properties.enableAutomaticFailover	boolean		Aktiverar automatisk redundans för skrivregionen i den sällsynta händelsen att regionen inte är tillgänglig på grund av ett avbrott. Automatisk redundans resulterar i en ny skrivregion för kontot och väljs baserat på de redundansprioriteringar som konfigurerats för kontot.
properties.enableBurstCapacity	boolean		Flagga för att ange aktivering/inaktivering av burst-kapacitetsfunktionen på kontot
properties.enableCassandraConnector	boolean		Aktiverar cassandra-anslutningsappen på Cosmos DB C*-kontot
properties.enableFreeTier	boolean		Flagga för att ange om den kostnadsfria nivån är aktiverad.
properties.enableMultipleWriteLocations	boolean		Gör att kontot kan skriva på flera platser
properties.enablePartitionMerge	boolean		Flagga för att ange aktivering/inaktivering av funktionen För sammanfogning av partition på kontot
properties.enablePerRegionPerPartitionAutoscale	boolean		Flagga för att ange aktivering/inaktivering av funktionen PerRegionPerPartitionAutoscale på kontot
properties.failoverPolicies	FailoverPolicy[]		En matris som innehåller de regioner som sorteras efter deras redundansprioriteringar.
properties.instanceId	string		En unik identifierare som tilldelats databaskontot
properties.ipRules	IpAddressOrRange[]		Lista över IpRules.
properties.isVirtualNetworkFilterEnabled	boolean		Flagga för att ange om du vill aktivera/inaktivera ACL-regler för virtuellt nätverk.
properties.keyVaultKeyUri	string		URI för nyckelvalvet
properties.keysMetadata	DatabaseAccountKeysMetadata		Objektet som representerar metadata för kontonycklarna för Cosmos DB-kontot.
properties.locations	Location[]		En matris som innehåller alla platser som är aktiverade för Cosmos DB-kontot.
properties.minimalTlsVersion	MinimalTlsVersion		Anger den lägsta tillåtna Tls-versionen. Standardvärdet är Tls 1.2. Api:er för Cassandra och Mongo fungerar bara med Tls 1.2.
properties.networkAclBypass	NetworkAclBypass		Anger vilka tjänster som tillåts kringgå brandväggskontroller.
properties.networkAclBypassResourceIds	string[]		En matris som innehåller resurs-ID:n för Network Acl Bypass för Cosmos DB-kontot.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista över privata slutpunktsanslutningar som konfigurerats för Cosmos DB-kontot.
properties.provisioningState	string		Status för Cosmos DB-kontot när åtgärden anropades. Statusen kan vara något av följande. "Skapar" – Cosmos DB-kontot skapas. När ett konto är i läget Skapa returneras endast egenskaper som anges som indata för åtgärden Skapa Cosmos DB-konto. "Lyckades" – Cosmos DB-kontot är aktivt för användning. "Uppdaterar" – Cosmos DB-kontot uppdateras. "Tar bort" – Cosmos DB-kontot tas bort. "Misslyckades" – Cosmos DB-kontot kunde inte skapas. "DeletionFailed" – borttagningen av Cosmos DB-kontot misslyckades.
properties.publicNetworkAccess	PublicNetworkAccess		Om begäranden från offentliga nätverk tillåts
properties.readLocations	Location[]		En matris som innehåller de läsplatser som är aktiverade för Cosmos DB-kontot.
properties.restoreParameters	RestoreParameters		Parametrar som anger information om återställningen.
properties.virtualNetworkRules	VirtualNetworkRule[]		Lista över ACL-regler för virtuellt nätverk som konfigurerats för Cosmos DB-kontot.
properties.writeLocations	Location[]		En matris som innehåller skrivplatsen för Cosmos DB-kontot.
systemData	systemData		Systemmetadata som är relaterade till den här resursen.
tags	object		Taggar är en lista över nyckel/värde-par som beskriver resursen. Dessa taggar kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB".
type	string		Typen av Azure-resurs.

DatabaseAccountKeysMetadata

Metadata relaterade till varje åtkomstnyckel för det angivna Cosmos DB-databaskontot.

Name	Typ	Description
primaryMasterKey	AccountKeyMetadata	Metadata som är relaterade till den primära Read-Write-nyckeln för det angivna Cosmos DB-databaskontot.
primaryReadonlyMasterKey	AccountKeyMetadata	Metadata som är relaterade till den primära Read-Only-nyckeln för det angivna Cosmos DB-databaskontot.
secondaryMasterKey	AccountKeyMetadata	Metadata som är relaterade till den sekundära Read-Write-nyckeln för det angivna Cosmos DB-databaskontot.
secondaryReadonlyMasterKey	AccountKeyMetadata	Metadata som är relaterade till den sekundära Read-Only-nyckeln för det angivna Cosmos DB-databaskontot.

DatabaseAccountKind

Anger typ av databaskonto. Detta kan bara anges när databaskontot skapas.

Name	Typ	Description
GlobalDocumentDB	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

Erbjudandetypen för Cosmos DB-databaskontot.

Name	Typ	Description
Standard	string

DatabaseAccountUpdateParameters

Parametrar för att korrigera azure Cosmos DB-databaskontoegenskaper.

Name	Typ	Description
identity	ManagedServiceIdentity	Identitet för resursen.
location	string	Platsen för den resursgrupp som resursen tillhör.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Specifika egenskaper för analyslagring.
properties.apiProperties	ApiProperties	API-specifika egenskaper. För närvarande stöds endast för MongoDB API.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy	Objektet som representerar principen för att ta säkerhetskopior på ett konto.
properties.capabilities	Capability[]	Lista över Cosmos DB-funktioner för kontot
properties.capacity	Capacity	Objektet som representerar alla egenskaper som är relaterade till kapacitetsframtvingande för ett konto.
properties.connectorOffer	ConnectorOffer	Erbjudandetypen cassandra connector för Cosmos DB-databasens C*-konto.
properties.consistencyPolicy	ConsistencyPolicy	Konsekvensprincipen för Cosmos DB-kontot.
properties.cors	CorsPolicy[]	CORS-principen för Cosmos DB-databaskontot.
properties.customerManagedKeyStatus	string	Anger status för funktionen Kundhanterad nyckel för kontot. Om det finns fel ger egenskapen felsökningsvägledning.
properties.defaultIdentity	string	Standardidentiteten för åtkomst till nyckelvalv som används i funktioner som kundhanterade nycklar. Standardidentiteten måste uttryckligen anges av användarna. Det kan vara "FirstPartyIdentity", "SystemAssignedIdentity" med mera.
properties.disableKeyBasedMetadataWriteAccess	boolean	Inaktivera skrivåtgärder för metadataresurser (databaser, containrar, dataflöde) via kontonycklar
properties.disableLocalAuth	boolean	Välj bort lokal autentisering och se till att endast MSI och AAD kan användas uteslutande för autentisering.
properties.enableAnalyticalStorage	boolean	Flagga för att ange om lagringsanalys ska aktiveras.
properties.enableAutomaticFailover	boolean	Aktiverar automatisk redundans för skrivregionen i den sällsynta händelsen att regionen inte är tillgänglig på grund av ett avbrott. Automatisk redundans resulterar i en ny skrivregion för kontot och väljs baserat på de redundansprioriteringar som konfigurerats för kontot.
properties.enableBurstCapacity	boolean	Flagga för att ange aktivering/inaktivering av burst-kapacitetsfunktionen på kontot
properties.enableCassandraConnector	boolean	Aktiverar cassandra-anslutningsappen på Cosmos DB C*-kontot
properties.enableFreeTier	boolean	Flagga för att ange om den kostnadsfria nivån är aktiverad.
properties.enableMultipleWriteLocations	boolean	Gör att kontot kan skriva på flera platser
properties.enablePartitionMerge	boolean	Flagga för att ange aktivering/inaktivering av funktionen För sammanfogning av partition på kontot
properties.enablePerRegionPerPartitionAutoscale	boolean	Flagga för att ange aktivering/inaktivering av funktionen PerRegionPerPartitionAutoscale på kontot
properties.ipRules	IpAddressOrRange[]	Lista över IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Flagga för att ange om du vill aktivera/inaktivera ACL-regler för virtuellt nätverk.
properties.keyVaultKeyUri	string	URI för nyckelvalvet
properties.keysMetadata	DatabaseAccountKeysMetadata	Den här egenskapen ignoreras under uppdateringsåtgärden eftersom metadata är skrivskyddade. Objektet representerar metadata för kontonycklarna för Cosmos DB-kontot.
properties.locations	Location[]	En matris som innehåller de georeplikeringsplatser som är aktiverade för Cosmos DB-kontot.
properties.minimalTlsVersion	MinimalTlsVersion	Anger den lägsta tillåtna Tls-versionen. Standardvärdet är Tls 1.2. Api:er för Cassandra och Mongo fungerar bara med Tls 1.2.
properties.networkAclBypass	NetworkAclBypass	Anger vilka tjänster som tillåts kringgå brandväggskontroller.
properties.networkAclBypassResourceIds	string[]	En matris som innehåller resurs-ID:n för Network Acl Bypass för Cosmos DB-kontot.
properties.publicNetworkAccess	PublicNetworkAccess	Om begäranden från offentliga nätverk tillåts
properties.virtualNetworkRules	VirtualNetworkRule[]	Lista över ACL-regler för virtuellt nätverk som konfigurerats för Cosmos DB-kontot.
tags	object	Taggar är en lista över nyckel/värde-par som beskriver resursen. Dessa taggar kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB".

DatabaseRestoreResource

Specifika databaser som ska återställas.

Name	Typ	Description
collectionNames	string[]	Namnen på samlingarna som är tillgängliga för återställning.
databaseName	string	Namnet på databasen som är tillgänglig för återställning.

DefaultConsistencyLevel

Standardkonsekvensnivån och konfigurationsinställningarna för Cosmos DB-kontot.

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

FailoverPolicy

Redundansprincipen för en viss region för ett databaskonto.

Name	Typ	Description
failoverPriority	integer	Redundansprioriteten för regionen. En redundansprioritet på 0 anger en skrivregion. Det maximala värdet för en redundansprioritet = (totalt antal regioner - 1). Prioritetsvärden för redundans måste vara unika för var och en av de regioner där databaskontot finns.
id	string	Den unika identifieraren för den region där databaskontot replikeras till. Exempel: <accountName>–<locationName>.
locationName	string	Namnet på den region där databaskontot finns.

GremlinDatabaseRestoreResource

Specifika Gremlin-databaser som ska återställas.

Name	Typ	Description
databaseName	string	Namnet på den gremlindatabas som är tillgänglig för återställning.
graphNames	string[]	Namnen på graferna som är tillgängliga för återställning.

IpAddressOrRange

IpAddressOrRange-objekt

Name	Typ	Description
ipAddressOrRange	string	En enda IPv4-adress eller ett enda IPv4-adressintervall i CIDR-format. Angivna IP-adresser måste vara välformaterade och kan inte finnas i något av följande intervall: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, eftersom dessa inte kan tillämpas av IP-adressfiltret. Exempel på giltiga indata: "23.40.210.245" eller "23.40.210.0/8".

Location

En region där Azure Cosmos DB-databaskontot distribueras.

Name	Typ	Description
documentEndpoint	string	Anslutningsslutpunkten för den specifika regionen. Exempel: https://<accountName>–<locationName>.documents.azure.com:443/
failoverPriority	integer	Redundansprioriteten för regionen. En redundansprioritet på 0 anger en skrivregion. Det maximala värdet för en redundansprioritet = (totalt antal regioner - 1). Prioritetsvärden för redundans måste vara unika för var och en av de regioner där databaskontot finns.
id	string	Den unika identifieraren för regionen i databaskontot. Exempel: <accountName>–<locationName>.
isZoneRedundant	boolean	Flagga för att ange om den här regionen är en AvailabilityZone-region eller inte
locationName	string	Namnet på regionen.
provisioningState	string	Status för Cosmos DB-kontot när åtgärden anropades. Statusen kan vara något av följande. "Skapar" – Cosmos DB-kontot skapas. När ett konto är i läget Skapa returneras endast egenskaper som anges som indata för åtgärden Skapa Cosmos DB-konto. "Lyckades" – Cosmos DB-kontot är aktivt för användning. "Uppdaterar" – Cosmos DB-kontot uppdateras. "Tar bort" – Cosmos DB-kontot tas bort. "Misslyckades" – Cosmos DB-kontot kunde inte skapas. "DeletionFailed" – borttagningen av Cosmos DB-kontot misslyckades.

ManagedServiceIdentity

Identitet för resursen.

Name	Typ	Description
principalId	string	Huvud-ID:t för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
tenantId	string	Klient-ID:t för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
type	ResourceIdentityType	Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
userAssignedIdentities	UserAssignedIdentities	Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

MinimalTlsVersion

Anger den lägsta tillåtna Tls-versionen. Standardvärdet är Tls 1.2. Api:er för Cassandra och Mongo fungerar bara med Tls 1.2.

Name	Typ	Description
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

Anger vilka tjänster som tillåts kringgå brandväggskontroller.

Name	Typ	Description
AzureServices	string
None	string

PeriodicModeBackupPolicy

Objektet som representerar säkerhetskopieringsprincipen för periodiskt läge.

Name	Typ	Description
migrationState	BackupPolicyMigrationState	Objektet som representerar migreringens tillstånd mellan säkerhetskopieringsprinciperna.
periodicModeProperties	PeriodicModeProperties	Konfigurationsvärden för säkerhetskopiering i periodiskt läge
type	string: Periodic	Beskriver läget för säkerhetskopior.

PeriodicModeProperties

Konfigurationsvärden för säkerhetskopiering i periodiskt läge

Name	Typ	Description
backupIntervalInMinutes	integer	Ett heltal som representerar intervallet i minuter mellan två säkerhetskopior
backupRetentionIntervalInHours	integer	Ett heltal som representerar den tid (i timmar) som varje säkerhetskopia behålls
backupStorageRedundancy	BackupStorageRedundancy	Uppräkning för att ange typ av säkerhetskopieringshem

PrivateEndpointConnection

En privat slutpunktsanslutning

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.groupId	string	Grupp-ID för den privata slutpunkten.
properties.privateEndpoint	PrivateEndpointProperty	Privat slutpunkt som anslutningen tillhör.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Anslutningstillstånd för den privata slutpunktsanslutningen.
properties.provisioningState	string	Etableringstillstånd för den privata slutpunkten.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Privat slutpunkt som anslutningen tillhör.

Name	Typ	Description
id	string	Resurs-ID för den privata slutpunkten.

PrivateLinkServiceConnectionStateProperty

Anslutningstillstånd för den privata slutpunktsanslutningen.

Name	Typ	Description
actionsRequired	string	Alla åtgärder som krävs utöver grundläggande arbetsflöde (godkänna/avvisa/koppla från)
description	string	Beskrivning av tjänstanslutningen för privat länk.
status	string	Anslutningsstatus för tjänsten private link.

PublicNetworkAccess

Om begäranden från offentliga nätverk tillåts

Name	Typ	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.

Name	Typ	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

Beskriver återställningsläget.

Name	Typ	Description
PointInTime	string

RestoreParameters

Parametrar som anger information om återställningen.

Name	Typ	Description
databasesToRestore	DatabaseRestoreResource[]	Lista över specifika databaser som är tillgängliga för återställning.
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	Lista över specifika gremlin-databaser som är tillgängliga för återställning.
restoreMode	RestoreMode	Beskriver återställningsläget.
restoreSource	string	ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Till exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Tid då kontot måste återställas (ISO-8601-format).
restoreWithTtlDisabled	boolean	Anger om det återställda kontot kommer att ha time-To-Live inaktiverat vid lyckad återställning.
tablesToRestore	string[]	Lista över specifika tabeller som är tillgängliga för återställning.

ServerVersion

Beskriver versionen av MongoDB-kontot.

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

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UserAssignedIdentities

Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name	Typ	Description

VirtualNetworkRule

ACL-regelobjekt för virtuellt nätverk

Name	Typ	Description
id	string	Resurs-ID för ett undernät, till exempel: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint	boolean	Skapa brandväggsregel innan vnet-tjänstslutpunkten är aktiverad i det virtuella nätverket.

Dela via

Database Accounts - Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

CosmosDBDatabaseAccountPatch

Exempelbegäran

Exempelsvar

Definitioner

AccountKeyMetadata

AnalyticalStorageConfiguration

AnalyticalStorageSchemaType

ApiProperties

BackupPolicyMigrationState

BackupPolicyMigrationStatus

BackupPolicyType

BackupStorageRedundancy

Capability

Capacity

ConnectorOffer

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

ContinuousTier

CorsPolicy

createdByType

CreateMode

DatabaseAccountGetResults

DatabaseAccountKeysMetadata

DatabaseAccountKind

DatabaseAccountOfferType

DatabaseAccountUpdateParameters

DatabaseRestoreResource

DefaultConsistencyLevel

FailoverPolicy

GremlinDatabaseRestoreResource

IpAddressOrRange

Location

ManagedServiceIdentity

MinimalTlsVersion

NetworkAclBypass

PeriodicModeBackupPolicy

PeriodicModeProperties

PrivateEndpointConnection

PrivateEndpointProperty

PrivateLinkServiceConnectionStateProperty

PublicNetworkAccess

ResourceIdentityType

RestoreMode

RestoreParameters

ServerVersion

systemData

UserAssignedIdentities

VirtualNetworkRule

Ytterligare resurser