Database Accounts - Update

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Aktualizace vlastnosti existujícího účtu databáze Azure Cosmos DB.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
accountName	path	True	string	Název databázového účtu služby Cosmos DB. Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
identity	ManagedServiceIdentity	Identita prostředku.
location	string	Umístění skupiny prostředků, do které prostředek patří.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Vlastnosti specifické pro analytické úložiště.
properties.apiProperties	ApiProperties	Vlastnosti specifické pro rozhraní API. V současné době se podporuje jenom pro rozhraní MongoDB API.
properties.backupPolicy	BackupPolicy: PeriodicModeBackupPolicy ContinuousModeBackupPolicy	Objekt představující zásadu pro vytváření záloh na účtu.
properties.capabilities	Capability[]	Seznam možností služby Cosmos DB pro účet
properties.capacity	Capacity	Objekt, který představuje všechny vlastnosti související s vynucení kapacity na účtu.
properties.connectorOffer	ConnectorOffer	Typ nabídky konektoru Cassandra pro účet C* databáze Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy	Zásady konzistence pro účet služby Cosmos DB.
properties.cors	CorsPolicy[]	Zásady CORS pro účet databáze Cosmos DB.
properties.customerManagedKeyStatus	string	Označuje stav funkce klíč spravovaný zákazníkem na účtu. V případě chyb poskytuje vlastnost pokyny k řešení potíží.
properties.defaultIdentity	string	Výchozí identita pro přístup k trezoru klíčů používaná ve funkcích, jako jsou klíče spravované zákazníkem. Výchozí identitu musí uživatelé explicitně nastavit. Může to být FirstPartyIdentity, SystemAssignedIdentity a další.
properties.disableKeyBasedMetadataWriteAccess	boolean	Zakázání operací zápisu prostředků metadat (databází, kontejnerů, propustnosti) prostřednictvím klíčů účtu
properties.disableLocalAuth	boolean	Odhlaste místní ověřování a zajistěte, aby pro ověřování bylo možné používat výhradně jenom MSI a AAD.
properties.enableAnalyticalStorage	boolean	Příznak označující, jestli se má povolit analýza úložiště.
properties.enableAutomaticFailover	boolean	Povolí automatické převzetí služeb při selhání oblasti zápisu ve výjimečném případě, kdy je oblast nedostupná z důvodu výpadku. Automatické převzetí služeb při selhání bude mít za následek novou oblast zápisu pro účet a zvolí se na základě priorit převzetí služeb při selhání nakonfigurovaných pro účet.
properties.enableBurstCapacity	boolean	Příznak označující povolení nebo zakázání funkce Shlukové kapacity Preview v účtu
properties.enableCassandraConnector	boolean	Povolí konektor Cassandra v účtu Cosmos DB C*
properties.enableFreeTier	boolean	Příznak označující, jestli je povolená úroveň Free.
properties.enableMultipleWriteLocations	boolean	Umožňuje účtu psát na více místech.
properties.enablePartitionMerge	boolean	Příznak označující povolení nebo zakázání funkce sloučení oddílů v účtu
properties.ipRules	IpAddressOrRange[]	Seznam pravidel IpRules
properties.isVirtualNetworkFilterEnabled	boolean	Příznak označující, jestli se mají povolit nebo zakázat pravidla seznamu ACL Virtual Network.
properties.keyVaultKeyUri	string	Identifikátor URI trezoru klíčů
properties.locations	Location[]	Pole, které obsahuje umístění geografické replikace povolená pro účet služby Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion	Označuje minimální povolenou verzi protokolu TLS. Výchozí hodnota je Tls 1.2. Rozhraní API Cassandra a Mongo fungují jenom s protokolem TLS 1.2.
properties.networkAclBypass	NetworkAclBypass	Určuje, které služby můžou obejít kontroly brány firewall.
properties.networkAclBypassResourceIds	string[]	Pole, které obsahuje ID prostředků pro vynechání seznamu ACL sítě pro účet služby Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess	Jestli jsou povolené požadavky z veřejné sítě
properties.virtualNetworkRules	VirtualNetworkRule[]	Seznam pravidel seznamu ACL nakonfigurovaných pro účet služby Cosmos DB Virtual Network
tags	object	Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč, který nesmí být delší než 128 znaků a hodnota nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: Cassandra. Aktuální hodnoty defaultExperience také zahrnují "Table", "Graph", "DocumentDB" a "MongoDB".

Odpovědi

Name	Typ	Description
200 OK	DatabaseAccountGetResults	Operace aktualizace databázového účtu se dokončí asynchronně.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Příklady

CosmosDBDatabaseAccountPatch

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1?api-version=2023-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,
    "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/2023-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),
            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,
                "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/2023-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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-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),
			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/2023-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,
    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

Sample Response

Status code:

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

Definice

Name	Description
AccountKeyMetadata	Metadata související s přístupovým klíčem pro daný databázový účet.
AnalyticalStorageConfiguration	Vlastnosti specifické pro analytické úložiště.
AnalyticalStorageSchemaType	Popisuje typy schématu pro analytické úložiště.
ApiProperties
BackupPolicyMigrationState	Objekt představující stav migrace mezi zásadami zálohování.
BackupPolicyMigrationStatus	Popisuje stav migrace mezi typy zásad zálohování.
BackupPolicyType	Popisuje režim zálohování.
BackupStorageRedundancy	Výčet označující typ redundance úložiště zálohování
Capability	Objekt schopností služby Cosmos DB
Capacity	Objekt, který představuje všechny vlastnosti související s vynucení kapacity na účtu.
ConnectorOffer	Typ nabídky konektoru cassandra pro účet databáze Cosmos DB C*
ConsistencyPolicy	Zásady konzistence pro účet databáze Cosmos DB.
ContinuousModeBackupPolicy	Objekt představující zásady průběžného zálohování.
ContinuousModeProperties	Hodnoty konfigurace pro zálohování v pravidelném režimu
ContinuousTier	Výčet označující typ úrovně průběžného zálohování
CorsPolicy	Zásady CORS pro účet databáze Cosmos DB.
createdByType	Typ identity, která prostředek vytvořila.
CreateMode	Výčet označující režim vytváření účtu.
DatabaseAccountGetResults	Účet databáze Azure Cosmos DB.
DatabaseAccountKeysMetadata	Metadata související s každým přístupovým klíčem pro daný účet databáze Cosmos DB.
DatabaseAccountKind	Označuje typ databázového účtu. Tuto možnost je možné nastavit pouze při vytváření účtu databáze.
DatabaseAccountOfferType	Typ nabídky pro účet databáze Cosmos DB.
DatabaseAccountUpdateParameters	Parametry pro opravy vlastností účtu databáze Azure Cosmos DB
DatabaseRestoreResource	Konkrétní databáze, které se mají obnovit.
DefaultConsistencyLevel	Výchozí úroveň konzistence a nastavení konfigurace účtu služby Cosmos DB.
FailoverPolicy	Zásady převzetí služeb při selhání pro danou oblast databázového účtu.
GremlinDatabaseRestoreResource	Konkrétní databáze Gremlin k obnovení
IpAddressOrRange	Objekt IpAddressOrRange
Location	Oblast, ve které je nasazený účet databáze Azure Cosmos DB.
ManagedServiceIdentity	Identita prostředku.
MinimalTlsVersion	Označuje minimální povolenou verzi protokolu TLS. Výchozí hodnota je Tls 1.2. Rozhraní API Cassandra a Mongo fungují jenom s protokolem TLS 1.2.
NetworkAclBypass	Určuje, které služby můžou obejít kontroly brány firewall.
PeriodicModeBackupPolicy	Objekt představující zásady zálohování v periodickém režimu.
PeriodicModeProperties	Hodnoty konfigurace pro zálohování v pravidelném režimu
PrivateEndpointConnection	Připojení privátního koncového bodu
PrivateEndpointProperty	Privátní koncový bod, ke kterému připojení patří.
PrivateLinkServiceConnectionStateProperty	Stav připojení privátního koncového bodu.
PublicNetworkAccess	Jestli jsou povolené požadavky z veřejné sítě
ResourceIdentityType	Typ identity použitý pro prostředek. Typ SystemAssigned,UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.
RestoreMode	Popisuje režim obnovení.
RestoreParameters	Parametry označující informace o obnovení.
ServerVersion	Popisuje ServerVersion účtu MongoDB.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
UserAssignedIdentities	Seznam identit uživatelů přidružených k prostředku. Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
VirtualNetworkRule	Virtual Network objekt pravidla seznamu ACL

AccountKeyMetadata

Metadata související s přístupovým klíčem pro daný databázový účet.

Name	Typ	Description
generationTime	string	Doba generování klíče ve formátu ISO-8601 ve standardu UTC. Pokud hodnota v objektu chybí, znamená to, že poslední regenerace klíče se aktivovala před 18. 6. 2022.

AnalyticalStorageConfiguration

Vlastnosti specifické pro analytické úložiště.

Name	Typ	Description
schemaType	AnalyticalStorageSchemaType	Popisuje typy schématu pro analytické úložiště.

AnalyticalStorageSchemaType

Popisuje typy schématu pro analytické úložiště.

Name	Typ	Description
FullFidelity	string
WellDefined	string

ApiProperties

Name	Typ	Description
serverVersion	ServerVersion	Popisuje ServerVersion účtu MongoDB.

BackupPolicyMigrationState

Objekt představující stav migrace mezi zásadami zálohování.

Name	Typ	Description
startTime	string	Čas, kdy byla zahájena migrace zásad zálohování (formát ISO-8601).
status	BackupPolicyMigrationStatus	Popisuje stav migrace mezi typy zásad zálohování.
targetType	BackupPolicyType	Popisuje typ cílové zásady zálohování migrace zásad zálohování.

BackupPolicyMigrationStatus

Popisuje stav migrace mezi typy zásad zálohování.

Name	Typ	Description
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

Popisuje režim zálohování.

Name	Typ	Description
Continuous	string
Periodic	string

BackupStorageRedundancy

Výčet označující typ redundance úložiště zálohování

Name	Typ	Description
Geo	string
Local	string
Zone	string

Capability

Objekt schopností služby Cosmos DB

Name	Typ	Description
name	string	Název funkce Cosmos DB. Například "name": "EnableCassandra". Mezi aktuální hodnoty patří také "EnableTable" a "EnableGremlin".

Capacity

Objekt, který představuje všechny vlastnosti související s vynucení kapacity na účtu.

Name	Typ	Description
totalThroughputLimit	integer	Celkový limit propustnosti, který je pro účet uložený. TotalThroughputLimit 2000 ukládá přísný limit maximální propustnosti, která může být pro tento účet zřízena na 2000. TotalThroughputLimit -1 indikuje žádná omezení zřizování propustnosti.

ConnectorOffer

Typ nabídky konektoru cassandra pro účet databáze Cosmos DB C*

Name	Typ	Description
Small	string

ConsistencyPolicy

Zásady konzistence pro účet databáze Cosmos DB.

Name	Typ	Description
defaultConsistencyLevel	DefaultConsistencyLevel	Výchozí úroveň konzistence a nastavení konfigurace účtu služby Cosmos DB.
maxIntervalInSeconds	integer	Při použití s úrovní konzistence ohraničené neagreseness představuje tato hodnota množství doby neagrese (v sekundách) tolerované. Akceptovaný rozsah pro tuto hodnotu je 5 až 86400. Vyžaduje se, pokud je defaultConsistencyPolicy nastavená na BoundedStaleness.
maxStalenessPrefix	integer	Při použití s úrovní konzistence omezené nestaralosti představuje tato hodnota počet tolerovaných zastaralých požadavků. Akceptovaná oblast pro tuto hodnotu je 1 – 2 147 483 647. Vyžaduje se, pokud je defaultConsistencyPolicy nastavená na BoundedStaleness.

ContinuousModeBackupPolicy

Objekt představující zásady průběžného zálohování.

Name	Typ	Description
continuousModeProperties	ContinuousModeProperties	Hodnoty konfigurace pro průběžné zálohování
migrationState	BackupPolicyMigrationState	Objekt představující stav migrace mezi zásadami zálohování.
type	string: Continuous	Popisuje režim zálohování.

ContinuousModeProperties

Hodnoty konfigurace pro zálohování v pravidelném režimu

Name	Typ	Description
tier	ContinuousTier	Výčet označující typ režimu průběžného zálohování

ContinuousTier

Výčet označující typ úrovně průběžného zálohování

Name	Typ	Description
Continuous30Days	string
Continuous7Days	string

CorsPolicy

Zásady CORS pro účet databáze Cosmos DB.

Name	Typ	Description
allowedHeaders	string	Hlavičky požadavku, které může původní doména zadat v požadavku CORS.
allowedMethods	string	Metody (příkazy požadavku HTTP), které může původní doména používat pro požadavek CORS.
allowedOrigins	string	Původní domény, které mají povoleno podat žádost o službu prostřednictvím CORS.
exposedHeaders	string	Hlavičky odpovědi, které mohou být odeslány v odpovědi na požadavek CORS a zpřístupněny prohlížečem vystaviteli požadavku.
maxAgeInSeconds	integer	Maximální doba, po kterou by měl prohlížeč uložit do mezipaměti předběžný požadavek OPTIONS.

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Výčet označující režim vytváření účtu.

Name	Typ	Description
Default	string
Restore	string

DatabaseAccountGetResults

Účet databáze Azure Cosmos DB.

Name	Typ	Výchozí hodnota	Description
id	string		Jedinečný identifikátor prostředku ARM.
identity	ManagedServiceIdentity		Identita prostředku.
kind	DatabaseAccountKind	GlobalDocumentDB	Označuje typ databázového účtu. To se dá nastavit jenom při vytváření účtu databáze.
location	string		Umístění skupiny prostředků, do které prostředek patří.
name	string		Název prostředku ARM.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Vlastnosti specifické pro analytické úložiště.
properties.apiProperties	ApiProperties		Vlastnosti specifické pro rozhraní API.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		Objekt představující zásadu pro vytváření záloh na účtu.
properties.capabilities	Capability[]		Seznam možností služby Cosmos DB pro účet
properties.capacity	Capacity		Objekt, který představuje všechny vlastnosti související s vynucení kapacity na účtu.
properties.connectorOffer	ConnectorOffer		Typ nabídky konektoru cassandra pro účet C* databáze Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy		Zásady konzistence pro účet databáze Cosmos DB.
properties.cors	CorsPolicy[]		Zásady CORS pro účet databáze Cosmos DB.
properties.createMode	CreateMode	Default	Výčet označující režim vytváření účtu.
properties.customerManagedKeyStatus	string		Označuje stav funkce klíč spravovaný zákazníkem v účtu. V případě, že dojde k chybám, poskytuje tato vlastnost pokyny k řešení potíží.
properties.databaseAccountOfferType	DatabaseAccountOfferType		Typ nabídky pro účet databáze Cosmos DB. Výchozí hodnota: Standardní.
properties.defaultIdentity	string		Výchozí identita pro přístup k trezoru klíčů používaná ve funkcích, jako jsou klíče spravované zákazníkem. Výchozí identitu musí uživatelé explicitně nastavit. Může to být FirstPartyIdentity, SystemAssignedIdentity a další.
properties.disableKeyBasedMetadataWriteAccess	boolean		Zakázání operací zápisu prostředků metadat (databází, kontejnerů, propustnosti) prostřednictvím klíčů účtu
properties.disableLocalAuth	boolean		Odhlaste místní ověřování a zajistěte, aby k ověřování bylo možné používat výhradně jenom MSI a AAD.
properties.documentEndpoint	string		Koncový bod připojení pro účet databáze Cosmos DB.
properties.enableAnalyticalStorage	boolean		Příznak označující, jestli se má povolit analýza úložiště.
properties.enableAutomaticFailover	boolean		Povolí automatické převzetí služeb při selhání oblasti zápisu ve vzácném případě, kdy je oblast nedostupná z důvodu výpadku. Automatické převzetí služeb při selhání způsobí novou oblast zápisu pro účet a zvolí se na základě priorit převzetí služeb při selhání nakonfigurovaných pro účet.
properties.enableBurstCapacity	boolean		Příznak označující povolení nebo zakázání funkce Kapacity shlukového škálování ve verzi Preview na účtu
properties.enableCassandraConnector	boolean		Povolí konektor cassandra v účtu C* služby Cosmos DB.
properties.enableFreeTier	boolean		Příznak označující, jestli je povolená úroveň Free.
properties.enableMultipleWriteLocations	boolean		Umožňuje účtu psát na více místech.
properties.enablePartitionMerge	boolean		Příznak označující povolení nebo zakázání funkce sloučení oddílů v účtu
properties.failoverPolicies	FailoverPolicy[]		Pole, které obsahuje oblasti seřazené podle priorit převzetí služeb při selhání.
properties.instanceId	string		Jedinečný identifikátor přiřazený k účtu databáze
properties.ipRules	IpAddressOrRange[]		Seznam pravidel IpRules
properties.isVirtualNetworkFilterEnabled	boolean		Příznak označující, jestli se mají povolit nebo zakázat Virtual Network pravidla seznamu ACL.
properties.keyVaultKeyUri	string		Identifikátor URI trezoru klíčů
properties.keysMetadata	DatabaseAccountKeysMetadata		Objekt, který představuje metadata pro klíče účtu účtu služby Cosmos DB.
properties.locations	Location[]		Pole, které obsahuje všechna umístění povolená pro účet služby Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion		Označuje minimální povolenou verzi protokolu TLS. Výchozí hodnota je Tls 1.2. Rozhraní API Cassandra a Mongo fungují jenom s protokolem TLS 1.2.
properties.networkAclBypass	NetworkAclBypass		Určuje, které služby můžou obejít kontroly brány firewall.
properties.networkAclBypassResourceIds	string[]		Pole, které obsahuje ID prostředků pro obejití seznamu ACL sítě pro účet služby Cosmos DB.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Seznam Connections privátního koncového bodu nakonfigurovaného pro účet služby Cosmos DB
properties.provisioningState	string		Stav účtu Cosmos DB v době, kdy byla operace volána. Stav může být jeden z následujících. Vytváření – vytváří se účet služby Cosmos DB. Pokud je účet ve stavu Vytváření, vrátí se pouze vlastnosti, které jsou zadané jako vstup pro operaci Vytvoření účtu Cosmos DB. Úspěch – účet služby Cosmos DB je aktivní pro použití. Aktualizuje se – účet služby Cosmos DB se aktualizuje. Odstraňuje se – odstraňuje se účet Cosmos DB. Selhání – vytvoření účtu služby Cosmos DB se nezdařilo. Chyba odstranění – odstranění účtu služby Cosmos DB selhalo.
properties.publicNetworkAccess	PublicNetworkAccess		Jestli jsou povolené požadavky z veřejné sítě
properties.readLocations	Location[]		Pole, které obsahuje umístění pro čtení povolená pro účet Cosmos DB.
properties.restoreParameters	RestoreParameters		Parametry označující informace o obnovení.
properties.virtualNetworkRules	VirtualNetworkRule[]		Seznam pravidel seznamu ACL nakonfigurovaných pro účet služby Cosmos DB Virtual Network
properties.writeLocations	Location[]		Pole, které obsahuje umístění zápisu pro účet služby Cosmos DB.
systemData	systemData		Systémová metadata týkající se tohoto prostředku.
tags	object		Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč, který nesmí být delší než 128 znaků a hodnota nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: Cassandra. Aktuální hodnoty defaultExperience také zahrnují "Table", "Graph", "DocumentDB" a "MongoDB".
type	string		Typ prostředku Azure.

DatabaseAccountKeysMetadata

Metadata související s každým přístupovým klíčem pro daný účet databáze Cosmos DB.

Name	Typ	Description
primaryMasterKey	AccountKeyMetadata	Metadata související s primárním klíčem Read-Write pro daný účet databáze Cosmos DB.
primaryReadonlyMasterKey	AccountKeyMetadata	Metadata související s primárním klíčem Read-Only pro daný účet databáze Cosmos DB.
secondaryMasterKey	AccountKeyMetadata	Metadata související se sekundárním klíčem Read-Write pro daný účet databáze Cosmos DB.
secondaryReadonlyMasterKey	AccountKeyMetadata	Metadata související se sekundárním klíčem Read-Only pro daný účet databáze Cosmos DB.

DatabaseAccountKind

Označuje typ databázového účtu. Tuto možnost je možné nastavit pouze při vytváření účtu databáze.

Name	Typ	Description
GlobalDocumentDB	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

Typ nabídky pro účet databáze Cosmos DB.

Name	Typ	Description
Standard	string

DatabaseAccountUpdateParameters

Parametry pro opravy vlastností účtu databáze Azure Cosmos DB

Name	Typ	Description
identity	ManagedServiceIdentity	Identita prostředku.
location	string	Umístění skupiny prostředků, do které prostředek patří.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Vlastnosti specifické pro analytické úložiště.
properties.apiProperties	ApiProperties	Vlastnosti specifické pro rozhraní API. V současné době se podporuje pouze pro rozhraní MongoDB API.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy	Objekt představující zásadu pro vytváření záloh na účtu.
properties.capabilities	Capability[]	Seznam možností služby Cosmos DB pro účet
properties.capacity	Capacity	Objekt, který představuje všechny vlastnosti související s vynucení kapacity na účtu.
properties.connectorOffer	ConnectorOffer	Typ nabídky konektoru Cassandra pro účet C* databáze Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy	Zásady konzistence pro účet služby Cosmos DB.
properties.cors	CorsPolicy[]	Zásady CORS pro účet databáze Cosmos DB.
properties.customerManagedKeyStatus	string	Označuje stav funkce klíč spravovaný zákazníkem v účtu. V případě, že dojde k chybám, poskytuje tato vlastnost pokyny k řešení potíží.
properties.defaultIdentity	string	Výchozí identita pro přístup k trezoru klíčů používaná ve funkcích, jako jsou klíče spravované zákazníkem. Výchozí identitu musí uživatelé explicitně nastavit. Může to být FirstPartyIdentity, SystemAssignedIdentity a další.
properties.disableKeyBasedMetadataWriteAccess	boolean	Zakázání operací zápisu prostředků metadat (databází, kontejnerů, propustnosti) prostřednictvím klíčů účtu
properties.disableLocalAuth	boolean	Odhlaste místní ověřování a zajistěte, aby k ověřování bylo možné používat výhradně jenom MSI a AAD.
properties.enableAnalyticalStorage	boolean	Příznak označující, jestli se má povolit analýza úložiště.
properties.enableAutomaticFailover	boolean	Povolí automatické převzetí služeb při selhání oblasti zápisu ve výjimečném případě, kdy je oblast nedostupná z důvodu výpadku. Automatické převzetí služeb při selhání bude mít za následek novou oblast zápisu pro účet a zvolí se na základě priorit převzetí služeb při selhání nakonfigurovaných pro účet.
properties.enableBurstCapacity	boolean	Příznak označující povolení nebo zakázání funkce Kapacity shlukového škálování ve verzi Preview na účtu
properties.enableCassandraConnector	boolean	Povolí konektor Cassandra v účtu Cosmos DB C*
properties.enableFreeTier	boolean	Příznak označující, jestli je povolená úroveň Free.
properties.enableMultipleWriteLocations	boolean	Umožňuje účtu psát na více místech.
properties.enablePartitionMerge	boolean	Příznak označující povolení nebo zakázání funkce sloučení oddílů v účtu
properties.ipRules	IpAddressOrRange[]	Seznam pravidel IpRules
properties.isVirtualNetworkFilterEnabled	boolean	Příznak označující, jestli se mají povolit nebo zakázat pravidla seznamu ACL Virtual Network.
properties.keyVaultKeyUri	string	Identifikátor URI trezoru klíčů
properties.keysMetadata	DatabaseAccountKeysMetadata	Tato vlastnost se během operace aktualizace ignoruje, protože metadata jsou jen pro čtení. Objekt představuje metadata pro klíče účtu služby Cosmos DB.
properties.locations	Location[]	Pole, které obsahuje umístění geografické replikace povolená pro účet služby Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion	Označuje minimální povolenou verzi protokolu TLS. Výchozí hodnota je Tls 1.2. Rozhraní API Cassandra a Mongo fungují jenom s protokolem TLS 1.2.
properties.networkAclBypass	NetworkAclBypass	Určuje, které služby můžou obejít kontroly brány firewall.
properties.networkAclBypassResourceIds	string[]	Pole, které obsahuje ID prostředků pro obejití seznamu ACL sítě pro účet služby Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess	Jestli jsou povolené požadavky z veřejné sítě
properties.virtualNetworkRules	VirtualNetworkRule[]	Seznam pravidel seznamu ACL nakonfigurovaných pro účet služby Cosmos DB Virtual Network
tags	object	Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč, který nesmí být delší než 128 znaků a hodnota nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: Cassandra. Aktuální hodnoty defaultExperience také zahrnují "Table", "Graph", "DocumentDB" a "MongoDB".

DatabaseRestoreResource

Konkrétní databáze, které se mají obnovit.

Name	Typ	Description
collectionNames	string[]	Názvy kolekcí, které jsou k dispozici pro obnovení.
databaseName	string	Název databáze, která je k dispozici pro obnovení.

DefaultConsistencyLevel

Výchozí úroveň konzistence a nastavení konfigurace účtu služby Cosmos DB.

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

FailoverPolicy

Zásady převzetí služeb při selhání pro danou oblast databázového účtu.

Name	Typ	Description
failoverPriority	integer	Priorita převzetí služeb při selhání oblasti. Priorita převzetí služeb při selhání 0 označuje oblast zápisu. Maximální hodnota priority převzetí služeb při selhání = (celkový počet oblastí – 1). Hodnoty priority převzetí služeb při selhání musí být jedinečné pro každou oblast, ve které existuje účet databáze.
id	string	Jedinečný identifikátor oblasti, do které se databázový účet replikuje. Příklad: <accountName-locationName>><.
locationName	string	Název oblasti, ve které existuje účet databáze.

GremlinDatabaseRestoreResource

Konkrétní databáze Gremlin k obnovení

Name	Typ	Description
databaseName	string	Název databáze Gremlin, která je k dispozici pro obnovení.
graphNames	string[]	Názvy grafů, které jsou k dispozici pro obnovení

IpAddressOrRange

Objekt IpAddressOrRange

Name	Typ	Description
ipAddressOrRange	string	Jedna IPv4 adresa nebo jeden rozsah IPv4 adres ve formátu CIDR. Za předpokladu, že IP adresy musí být správně formátované a nesmí být obsaženy v některém z následujících rozsahů: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, protože tyto adresy nejsou vynucovány filtrem IP adres. Příklad platných vstupů: "23.40.210.245" nebo "23.40.210.0/8".

Location

Oblast, ve které je nasazený účet databáze Azure Cosmos DB.

Name	Typ	Description
documentEndpoint	string	Koncový bod připojení pro konkrétní oblast. Příklad: https://< accountName-locationName.documents.azure.com:443/><>
failoverPriority	integer	Priorita převzetí služeb při selhání pro oblast. Priorita převzetí služeb při selhání 0 označuje oblast zápisu. Maximální hodnota priority převzetí služeb při selhání = (celkový počet oblastí – 1). Hodnoty priority převzetí služeb při selhání musí být jedinečné pro každou oblast, ve které existuje účet databáze.
id	string	Jedinečný identifikátor oblasti v rámci databázového účtu. Příklad: <accountName-locationName>><.
isZoneRedundant	boolean	Příznak označující, jestli je tato oblast oblastí AvailabilityZone nebo ne
locationName	string	Název oblasti.
provisioningState	string	Stav účtu Cosmos DB v době, kdy byla operace volána. Stav může být jeden z následujících. Vytváření – vytváří se účet služby Cosmos DB. Pokud je účet ve stavu Vytváření, vrátí se pouze vlastnosti, které jsou zadané jako vstup pro operaci Vytvoření účtu Cosmos DB. Úspěch – účet služby Cosmos DB je aktivní pro použití. Aktualizuje se – účet služby Cosmos DB se aktualizuje. Odstraňuje se – odstraňuje se účet Cosmos DB. Selhání – vytvoření účtu služby Cosmos DB se nezdařilo. Chyba odstranění – odstranění účtu služby Cosmos DB selhalo.

ManagedServiceIdentity

Identita prostředku.

Name	Typ	Description
principalId	string	ID objektu zabezpečení identity přiřazené systémem. Tato vlastnost bude k dispozici pouze pro identitu přiřazenou systémem.
tenantId	string	ID tenanta identity přiřazené systémem. Tato vlastnost bude k dispozici pouze pro identitu přiřazenou systémem.
type	ResourceIdentityType	Typ identity použité pro prostředek Typ SystemAssigned,UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.
userAssignedIdentities	UserAssignedIdentities	Seznam identit uživatelů přidružených k prostředku Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

MinimalTlsVersion

Označuje minimální povolenou verzi protokolu TLS. Výchozí hodnota je Tls 1.2. Rozhraní API Cassandra a Mongo fungují jenom s protokolem TLS 1.2.

Name	Typ	Description
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

Určuje, které služby můžou obejít kontroly brány firewall.

Name	Typ	Description
AzureServices	string
None	string

PeriodicModeBackupPolicy

Objekt představující zásady zálohování v periodickém režimu.

Name	Typ	Description
migrationState	BackupPolicyMigrationState	Objekt představující stav migrace mezi zásadami zálohování.
periodicModeProperties	PeriodicModeProperties	Hodnoty konfigurace pro zálohování v pravidelném režimu
type	string: Periodic	Popisuje režim zálohování.

PeriodicModeProperties

Hodnoty konfigurace pro zálohování v pravidelném režimu

Name	Typ	Description
backupIntervalInMinutes	integer	Celé číslo představující interval mezi dvěma zálohami v minutách
backupRetentionIntervalInHours	integer	Celé číslo představující čas (v hodinách), kdy se jednotlivé zálohy uchovávají
backupStorageRedundancy	BackupStorageRedundancy	Výčet označující typ rezidence zálohování

PrivateEndpointConnection

Připojení privátního koncového bodu

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
name	string	Název prostředku
properties.groupId	string	ID skupiny privátního koncového bodu.
properties.privateEndpoint	PrivateEndpointProperty	Privátní koncový bod, ke kterému připojení patří.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Stav připojení privátního koncového bodu.
properties.provisioningState	string	Stav zřizování privátního koncového bodu.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

PrivateEndpointProperty

Privátní koncový bod, ke kterému připojení patří.

Name	Typ	Description
id	string	ID prostředku privátního koncového bodu

PrivateLinkServiceConnectionStateProperty

Stav připojení privátního koncového bodu.

Name	Typ	Description
actionsRequired	string	Jakákoli akce, která se vyžaduje nad rámec základního pracovního postupu (schválení, odmítnutí nebo odpojení)
description	string	Popis připojení služby Private Link.
status	string	Stav připojení služby Private Link.

PublicNetworkAccess

Jestli jsou povolené požadavky z veřejné sítě

Name	Typ	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

Typ identity použitý pro prostředek. Typ SystemAssigned,UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.

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

RestoreMode

Popisuje režim obnovení.

Name	Typ	Description
PointInTime	string

RestoreParameters

Parametry označující informace o obnovení.

Name	Typ	Description
databasesToRestore	DatabaseRestoreResource[]	Seznam konkrétních databází, které jsou k dispozici pro obnovení
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	Seznam konkrétních databází Gremlin, které jsou k dispozici pro obnovení
restoreMode	RestoreMode	Popisuje režim obnovení.
restoreSource	string	ID obnovitelného databázového účtu, ze kterého se má zahájit obnovení. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Čas, do kterého musí být účet obnoven (formát ISO-8601).
tablesToRestore	string[]	Seznam konkrétních tabulek, které jsou k dispozici pro obnovení

ServerVersion

Popisuje ServerVersion účtu MongoDB.

Name	Typ	Description
3.2	string
3.6	string
4.0	string
4.2	string

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UserAssignedIdentities

Seznam identit uživatelů přidružených k prostředku. Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

Name	Typ	Description

VirtualNetworkRule

Virtual Network objekt pravidla seznamu ACL

Name	Typ	Description
id	string	ID prostředku podsítě, například /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint	boolean	Vytvořte pravidlo brány firewall předtím, než má virtuální síť povolený koncový bod služby virtuální sítě.