Database Accounts - Update

Služba:

Cosmos DB Resource Provider

Verze rozhraní API:

2025-10-15

Aktualizuje 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=2025-10-15

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Název účtu databáze Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	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 zálohování úč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 u účtu.
properties.connectorOffer	ConnectorOffer	Typ nabídky konektoru Cassandra pro účet C* databáze Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy	Zásady konzistence pro účet Cosmos DB.
properties.cors	CorsPolicy[]	Zásady CORS pro účet databáze Cosmos DB.
properties.customerManagedKeyStatus	string	Označuje stav funkce klíče spravovaného zákazníkem v účtu. V případě chyb tato vlastnost poskytuje pokyny k řešení potíží.
properties.defaultIdentity	string	Výchozí identita pro přístup k trezoru klíčů používaným 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.defaultPriorityLevel	DefaultPriorityLevel	Výčet označující výchozí úroveň priority požadavku pro spouštění na základě priority.
properties.disableKeyBasedMetadataWriteAccess	boolean	Zakázání operací zápisu u prostředků metadat (databáze, kontejnery, propustnost) prostřednictvím klíčů účtu
properties.disableLocalAuth	boolean	Odhlaste se od místního ověřování a ujistěte se, že se k ověřování dají používat jenom MSI a AAD.
properties.enableAnalyticalStorage	boolean	Příznak označující, jestli se má povolit analýza úložiště.
properties.enableAutomaticFailover	boolean	Umožňuje automatické převzetí služeb při selhání oblasti zápisu ve výjimečných událostech, že oblast není dostupná kvůli 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 burstové kapacity v úč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 zapisovat do více umístění.
properties.enablePartitionMerge	boolean	Příznak označující povolení nebo zakázání funkce sloučení oddílů v účtu
properties.enablePerRegionPerPartitionAutoscale	boolean	Příznak označující povolení nebo zakázání funkce PerRegionPerPartitionAutoscale v účtu
properties.enablePriorityBasedExecution	boolean	Příznak označující povolení nebo zakázání funkce Náhledu na základě priority v účtu
properties.ipRules	IpAddressOrRange[]	Seznam iprules
properties.isVirtualNetworkFilterEnabled	boolean	Příznak označující, jestli se mají povolit nebo zakázat pravidla seznamu ACL virtuální sítě.
properties.keyVaultKeyUri	string	Identifikátor URI trezoru klíčů
properties.locations	Location[]	Pole obsahující umístění geografického odstranění duplicitních dat povolená pro účet 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	Označuje, které služby mají povoleno obejít kontroly brány firewall.
properties.networkAclBypassResourceIds	string[]	Pole obsahující ID prostředků pro vynechání seznamu Acl sítě pro účet Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess	Jestli jsou povolené požadavky z veřejné sítě
properties.virtualNetworkRules	VirtualNetworkRule[]	Seznam pravidel seznamu ACL virtuálních sítí nakonfigurovaných pro účet služby Cosmos DB
tags	object	Značky jsou seznamem párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupování 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íč maximálně 128 znaků a nesmí mít hodnotu větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastaveno na "defaultExperience": "Cassandra". Aktuální hodnoty "defaultExperience" zahrnují také "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

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

CosmosDBDatabaseAccountPatch

Ukázkový požadavek

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1?api-version=2025-10-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,
    "enablePriorityBasedExecution": true,
    "defaultPriorityLevel": "Low",
    "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"
  }
}

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",
                "defaultPriorityLevel": "Low",
                "enableAnalyticalStorage": True,
                "enableBurstCapacity": True,
                "enableFreeTier": False,
                "enablePartitionMerge": True,
                "enablePerRegionPerPartitionAutoscale": True,
                "enablePriorityBasedExecution": 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/DocumentDB/stable/2025-10-15/examples/CosmosDBDatabaseAccountPatch.json
if __name__ == "__main__":
    main()

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

Go

package armcosmos_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/8b53f9cfc1fdb24dbfa28e311d3be4c645169297/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-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"),
			DefaultPriorityLevel:                 to.Ptr(armcosmos.DefaultPriorityLevelLow),
			EnableAnalyticalStorage:              to.Ptr(true),
			EnableBurstCapacity:                  to.Ptr(true),
			EnableFreeTier:                       to.Ptr(false),
			EnablePartitionMerge:                 to.Ptr(true),
			EnablePerRegionPerPartitionAutoscale: to.Ptr(true),
			EnablePriorityBasedExecution:         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"),
	// 		DefaultPriorityLevel: to.Ptr(armcosmos.DefaultPriorityLevelLow),
	// 		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),
	// 		EnablePriorityBasedExecution: 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");
require("dotenv/config");

/**
 * 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/DocumentDB/stable/2025-10-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",
    defaultPriorityLevel: "Low",
    enableAnalyticalStorage: true,
    enableBurstCapacity: true,
    enableFreeTier: false,
    enablePartitionMerge: true,
    enablePerRegionPerPartitionAutoscale: true,
    enablePriorityBasedExecution: 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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.CosmosDB.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.CosmosDB;

// Generated from example definition: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/CosmosDBDatabaseAccountPatch.json
// this example is just showing the usage of "DatabaseAccounts_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CosmosDBAccountResource created on azure
// for more information of creating CosmosDBAccountResource, please refer to the document of CosmosDBAccountResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string accountName = "ddb1";
ResourceIdentifier cosmosDBAccountResourceId = CosmosDBAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
CosmosDBAccountResource cosmosDBAccount = client.GetCosmosDBAccountResource(cosmosDBAccountResourceId);

// invoke the operation
CosmosDBAccountPatch patch = new CosmosDBAccountPatch
{
    Tags =
    {
    ["dept"] = "finance"
    },
    Location = new AzureLocation("westus"),
    Identity = new ManagedServiceIdentity("SystemAssigned,UserAssigned")
    {
        UserAssignedIdentities =
        {
        [new ResourceIdentifier("/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1")] = new UserAssignedIdentity()
        },
    },
    ConsistencyPolicy = new ConsistencyPolicy(DefaultConsistencyLevel.BoundedStaleness)
    {
        MaxStalenessPrefix = 200L,
        MaxIntervalInSeconds = 10,
    },
    IPRules = {new CosmosDBIPAddressOrRange
    {
    IPAddressOrRange = "23.43.230.120",
    }, new CosmosDBIPAddressOrRange
    {
    IPAddressOrRange = "110.12.240.0/12",
    }},
    IsVirtualNetworkFilterEnabled = true,
    VirtualNetworkRules = {new CosmosDBVirtualNetworkRule
    {
    Id = new ResourceIdentifier("/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"),
    IgnoreMissingVnetServiceEndpoint = false,
    }},
    DefaultIdentity = "FirstPartyIdentity",
    IsFreeTierEnabled = false,
    IsAnalyticalStorageEnabled = true,
    AnalyticalStorageSchemaType = AnalyticalStorageSchemaType.WellDefined,
    BackupPolicy = new PeriodicModeBackupPolicy
    {
        PeriodicModeProperties = new PeriodicModeProperties
        {
            BackupIntervalInMinutes = 240,
            BackupRetentionIntervalInHours = 720,
            BackupStorageRedundancy = CosmosDBBackupStorageRedundancy.Local,
        },
    },
    NetworkAclBypass = NetworkAclBypass.AzureServices,
    NetworkAclBypassResourceIds = { new ResourceIdentifier("/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName") },
    CapacityTotalThroughputLimit = 2000,
    EnablePartitionMerge = true,
    MinimalTlsVersion = CosmosDBMinimalTlsVersion.Tls,
    EnableBurstCapacity = true,
    EnablePerRegionPerPartitionAutoscale = true,
    EnablePriorityBasedExecution = true,
    DefaultPriorityLevel = DefaultPriorityLevel.Low,
};
ArmOperation<CosmosDBAccountResource> lro = await cosmosDBAccount.UpdateAsync(WaitUntil.Completed, patch);
CosmosDBAccountResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
CosmosDBAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Ukázková odpověď

Stavový kód:

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,
    "enablePriorityBasedExecution": true,
    "defaultPriorityLevel": "Low",
    "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 analytického ú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čuje typ redundance úložiště zálohování.
Capability	Objekt schopnosti Cosmos DB
Capacity	Objekt, který představuje všechny vlastnosti související s vynucení kapacity u účtu.
ConnectorOffer	Typ nabídky konektoru cassandra pro databázový účet Cosmos DB C*.
ConsistencyPolicy	Zásady konzistence pro účet databáze Cosmos DB.
ContinuousModeBackupPolicy	Objekt představující zásady zálohování v nepřetržitém režimu.
ContinuousModeProperties	Hodnoty konfigurace pro pravidelné zálohování v režimu
ContinuousTier	Výčet označuje typ vrstvy 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	Určuje typ databázového účtu. To lze 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	Specifické databáze k obnovení.
DefaultConsistencyLevel	Výchozí úroveň konzistence a nastavení konfigurace účtu cosmos DB.
DefaultPriorityLevel	Výčet pro označení výchozí priorityÚroveň požadavků
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	Označuje, které služby mají povoleno 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 pravidelné zálohování v 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í připojení privátního koncového bodu
PublicNetworkAccess	Jestli jsou povolené požadavky z veřejné sítě
ResourceIdentityType	Typ identity používané 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 verzi úč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íč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
VirtualNetworkRule	Objekt pravidla seznamu ACL virtuální sítě

AccountKeyMetadata

Objekt

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

Name	Typ	Description
generationTime	string (date-time)	Čas generování klíče ve formátu ISO-8601 v UTC. Pokud hodnota v objektu chybí, znamená to, že poslední obnovení klíče bylo spuštěno před 18. 6. 2022.

AnalyticalStorageConfiguration

Objekt

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

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

AnalyticalStorageSchemaType

Výčet

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

Hodnota	Description
WellDefined
FullFidelity

ApiProperties

Objekt

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

BackupPolicyMigrationState

Objekt

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

Name	Typ	Description
startTime	string (date-time)	Čas zahájení 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 zásady cílového zálohování migrace zásad zálohování.

BackupPolicyMigrationStatus

Výčet

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

Hodnota	Description
Invalid
InProgress
Completed
Failed

BackupPolicyType

Výčet

Popisuje režim zálohování.

Hodnota	Description
Periodic
Continuous

BackupStorageRedundancy

Výčet

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

Hodnota	Description
Geo
Local
Zone

Capability

Objekt

Objekt schopnosti 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

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

Name	Typ	Description
totalThroughputLimit	integer (int32) minimum: -1	Celkový limit propustnosti uložený pro účet. TotalThroughputLimit z roku 2000 ukládá striktní limit maximální propustnosti, kterou je možné zřídit na daném účtu na 2000. Hodnota totalThroughputLimit -1 indikuje žádné limity zřizování propustnosti.

ConnectorOffer

Výčet

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

Hodnota	Description
Small

ConsistencyPolicy

Objekt

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

Name	Typ	Description
defaultConsistencyLevel	DefaultConsistencyLevel	Výchozí úroveň konzistence a nastavení konfigurace účtu cosmos DB.
maxIntervalInSeconds	integer (int32) minimum: 5 maximum: 86400	Při použití s úrovní konzistence ohraničené nestarosti představuje tato hodnota časovou prodlevu (v sekundách) snášenou. Akceptovaný rozsah pro tuto hodnotu je 5 až 86400. Požadováno, pokud je výchozí HodnotaConsistencyPolicy nastavena na BoundedStaleness.
maxStalenessPrefix	integer (int64) minimum: 1 maximum: 2147483647	Pokud se používá s úrovní konzistence konzistence s ohraničenou nestarostí, představuje tato hodnota počet zastaralých požadavků, které jsou tolerovány. Přijatý rozsah pro tuto hodnotu je 1 –2 147 483 647. Požadováno, pokud je výchozí HodnotaConsistencyPolicy nastavena na BoundedStaleness.

ContinuousModeBackupPolicy

Objekt

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

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

ContinuousModeProperties

Objekt

Hodnoty konfigurace pro pravidelné zálohování v 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

Výčet označuje typ vrstvy průběžného zálohování.

Hodnota	Description
Continuous7Days
Continuous30Days

CorsPolicy

Objekt

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 pro požadavek CORS.
allowedMethods	string	Metody (příkazy požadavku HTTP), které může původní doména použít pro požadavek CORS.
allowedOrigins	string	Původní domény, které mají oprávnění 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 žádost CORS a zpřístupněny prohlížečem vystaviteli požadavku.
maxAgeInSeconds	integer (int64) minimum: 1 maximum: 2147483647	Maximální doba, po kterou má prohlížeč ukládat předběžný požadavek OPTIONS do mezipaměti.

createdByType

Výčet

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

Hodnota	Description
User
Application
ManagedIdentity
Key

CreateMode

Výčet

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

Hodnota	Description
Default
Restore

DatabaseAccountGetResults

Objekt

Účet databáze Azure Cosmos DB.

Name	Typ	Default value	Description
id	string		Jedinečný identifikátor prostředku ARM.
identity	ManagedServiceIdentity		Identita prostředku
kind	DatabaseAccountKind	GlobalDocumentDB	Určuje typ databázového účtu. To lze nastavit pouze 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 zálohování úč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 u úč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íče spravovaného zákazníkem v účtu. V případě chyb tato vlastnost poskytuje pokyny k řešení potíží.
properties.databaseAccountOfferType	DatabaseAccountOfferType		Typ nabídky pro účet databáze Cosmos DB. Výchozí hodnota: Standard.
properties.defaultIdentity	string		Výchozí identita pro přístup k trezoru klíčů používaným 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.defaultPriorityLevel	DefaultPriorityLevel		Výčet označující výchozí úroveň priority požadavku pro spouštění na základě priority.
properties.disableKeyBasedMetadataWriteAccess	boolean		Zakázání operací zápisu u prostředků metadat (databáze, kontejnery, propustnost) prostřednictvím klíčů účtu
properties.disableLocalAuth	boolean		Odhlaste se od místního ověřování a ujistěte se, že se k ověřování dají používat 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		Umožňuje automatické převzetí služeb při selhání oblasti zápisu ve výjimečných událostech, že oblast není dostupná kvůli 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 burstové kapacity v úč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 zapisovat do více umístění.
properties.enablePartitionMerge	boolean		Příznak označující povolení nebo zakázání funkce sloučení oddílů v účtu
properties.enablePerRegionPerPartitionAutoscale	boolean		Příznak označující povolení nebo zakázání funkce PerRegionPerPartitionAutoscale v účtu
properties.enablePriorityBasedExecution	boolean		Příznak označující povolení nebo zakázání funkce Náhledu na základě priority 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 databázovému účtu
properties.ipRules	IpAddressOrRange[]		Seznam iprules
properties.isVirtualNetworkFilterEnabled	boolean		Příznak označující, jestli se mají povolit nebo zakázat pravidla seznamu ACL virtuální sítě.
properties.keyVaultKeyUri	string		Identifikátor URI trezoru klíčů
properties.keyVaultKeyUriVersion	string		Verze klíče spravovaného zákazníkem, kterou účet aktuálně používá
properties.keysMetadata	DatabaseAccountKeysMetadata		Objekt, který představuje metadata pro klíče účtu účtu Cosmos DB.
properties.locations	Location[]		Pole, které obsahuje všechna umístění povolená pro účet 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		Označuje, které služby mají povoleno obejít kontroly brány firewall.
properties.networkAclBypassResourceIds	string[] (arm-id)		Pole obsahující ID prostředků pro vynechání seznamu Acl sítě pro účet Cosmos DB.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Seznam připojení privátních koncových bodů nakonfigurovaných pro účet Cosmos DB.
properties.provisioningState	string		Stav účtu Cosmos DB v době volání operace. Stav může být jeden z následujících. "Vytváření" – vytváří se účet služby Cosmos DB. Když je účet ve stavu Vytváření, vrátí se pouze vlastnosti, které jsou zadány jako vstup pro operaci Vytvořit účet Cosmos DB. "Úspěch" – účet Cosmos DB je aktivní pro použití. "Aktualizace" – účet Cosmos DB se aktualizuje. "Odstranění" – účet Cosmos DB se odstraňuje. "Nezdařilo se" – vytvoření účtu Cosmos DB se nezdařilo. "DeletionFailed" – odstranění účtu Cosmos DB se nezdařilo.
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 virtuálních sítí nakonfigurovaných pro účet služby Cosmos DB
properties.writeLocations	Location[]		Pole, které obsahuje umístění pro zápis pro účet Cosmos DB.
systemData	systemData		Systémová meta data týkající se tohoto prostředku.
tags	object		Značky jsou seznamem párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupování 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íč maximálně 128 znaků a nesmí mít hodnotu větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastaveno na "defaultExperience": "Cassandra". Aktuální hodnoty "defaultExperience" zahrnují také "Table", "Graph", "DocumentDB" a "MongoDB".
type	string		Typ prostředku Azure.

DatabaseAccountKeysMetadata

Objekt

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

Výčet

Určuje typ databázového účtu. To lze nastavit pouze při vytváření účtu databáze.

Hodnota	Description
GlobalDocumentDB
MongoDB
Parse

DatabaseAccountOfferType

Výčet

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

Hodnota	Description
Standard

DatabaseAccountUpdateParameters

Objekt

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 jenom pro rozhraní MongoDB API.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy	Objekt představující zásadu pro zálohování úč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 u účtu.
properties.connectorOffer	ConnectorOffer	Typ nabídky konektoru Cassandra pro účet C* databáze Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy	Zásady konzistence pro účet Cosmos DB.
properties.cors	CorsPolicy[]	Zásady CORS pro účet databáze Cosmos DB.
properties.customerManagedKeyStatus	string	Označuje stav funkce klíče spravovaného zákazníkem v účtu. V případě chyb tato vlastnost poskytuje pokyny k řešení potíží.
properties.defaultIdentity	string	Výchozí identita pro přístup k trezoru klíčů používaným 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.defaultPriorityLevel	DefaultPriorityLevel	Výčet označující výchozí úroveň priority požadavku pro spouštění na základě priority.
properties.disableKeyBasedMetadataWriteAccess	boolean	Zakázání operací zápisu u prostředků metadat (databáze, kontejnery, propustnost) prostřednictvím klíčů účtu
properties.disableLocalAuth	boolean	Odhlaste se od místního ověřování a ujistěte se, že se k ověřování dají používat jenom MSI a AAD.
properties.enableAnalyticalStorage	boolean	Příznak označující, jestli se má povolit analýza úložiště.
properties.enableAutomaticFailover	boolean	Umožňuje automatické převzetí služeb při selhání oblasti zápisu ve výjimečných událostech, že oblast není dostupná kvůli 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 burstové kapacity v úč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 zapisovat do více umístění.
properties.enablePartitionMerge	boolean	Příznak označující povolení nebo zakázání funkce sloučení oddílů v účtu
properties.enablePerRegionPerPartitionAutoscale	boolean	Příznak označující povolení nebo zakázání funkce PerRegionPerPartitionAutoscale v účtu
properties.enablePriorityBasedExecution	boolean	Příznak označující povolení nebo zakázání funkce Náhledu na základě priority v účtu
properties.ipRules	IpAddressOrRange[]	Seznam iprules
properties.isVirtualNetworkFilterEnabled	boolean	Příznak označující, jestli se mají povolit nebo zakázat pravidla seznamu ACL virtuální sítě.
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 obsahující umístění geografického odstranění duplicitních dat povolená pro účet 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	Označuje, které služby mají povoleno obejít kontroly brány firewall.
properties.networkAclBypassResourceIds	string[]	Pole obsahující ID prostředků pro vynechání seznamu Acl sítě pro účet Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess	Jestli jsou povolené požadavky z veřejné sítě
properties.virtualNetworkRules	VirtualNetworkRule[]	Seznam pravidel seznamu ACL virtuálních sítí nakonfigurovaných pro účet služby Cosmos DB
tags	object	Značky jsou seznamem párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupování 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íč maximálně 128 znaků a nesmí mít hodnotu větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastaveno na "defaultExperience": "Cassandra". Aktuální hodnoty "defaultExperience" zahrnují také "Table", "Graph", "DocumentDB" a "MongoDB".

DatabaseRestoreResource

Objekt

Specifické databáze k obnovení.

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

DefaultConsistencyLevel

Výčet

Výchozí úroveň konzistence a nastavení konfigurace účtu cosmos DB.

Hodnota	Description
Eventual
Session
BoundedStaleness
Strong
ConsistentPrefix

DefaultPriorityLevel

Výčet

Výčet pro označení výchozí priorityÚroveň požadavků

Hodnota	Description
High
Low

FailoverPolicy

Objekt

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

Name	Typ	Description
failoverPriority	integer (int32) minimum: 0	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 z oblastí, ve kterých existuje databázový účet.
id	string	Jedinečný identifikátor oblasti, do které se účet databáze replikuje. Příklad: <accountName-locationName<>>.
locationName	string	Název oblasti, ve které databázový účet existuje.

GremlinDatabaseRestoreResource

Objekt

Konkrétní databáze Gremlin k obnovení.

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

IpAddressOrRange

Objekt

Objekt IpAddressOrRange

Name	Typ	Description
ipAddressOrRange	string	Jedna adresa IPv4 nebo jeden rozsah adres IPv4 ve formátu CIDR. Zadané IP adresy musí být dobře naformátované a nesmí být obsaženy v jednom 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 vynucovatelné filtrem IP adres. Příklad platných vstupů: "23.40.210.245" nebo "23.40.210.0/8".

Location

Objekt

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 (int32) minimum: 0	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 z oblastí, ve kterých existuje databázový účet.
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ě volání operace. Stav může být jeden z následujících. "Vytváření" – vytváří se účet služby Cosmos DB. Když je účet ve stavu Vytváření, vrátí se pouze vlastnosti, které jsou zadány jako vstup pro operaci Vytvořit účet Cosmos DB. "Úspěch" – účet Cosmos DB je aktivní pro použití. "Aktualizace" – účet Cosmos DB se aktualizuje. "Odstranění" – účet Cosmos DB se odstraňuje. "Nezdařilo se" – vytvoření účtu Cosmos DB se nezdařilo. "DeletionFailed" – odstranění účtu Cosmos DB se nezdařilo.

ManagedServiceIdentity

Objekt

Identita prostředku

Name	Typ	Description
principalId	string	ID objektu zabezpečení přiřazené systému. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
tenantId	string	ID tenanta identity přiřazené systémem. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
type	ResourceIdentityType	Typ identity používané 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íč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

MinimalTlsVersion

Výčet

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.

Hodnota	Description
Tls
Tls11
Tls12

NetworkAclBypass

Výčet

Označuje, které služby mají povoleno obejít kontroly brány firewall.

Hodnota	Description
None
AzureServices

PeriodicModeBackupPolicy

Objekt

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 pravidelné zálohování v režimu
type	string: Periodic	Popisuje režim zálohování.

PeriodicModeProperties

Objekt

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

Name	Typ	Description
backupIntervalInMinutes	integer (int32) minimum: 0	Celé číslo představující interval v minutách mezi dvěma zálohami
backupRetentionIntervalInHours	integer (int32) minimum: 0	Celé číslo představující čas (v hodinách), který každá záloha uchovává
backupStorageRedundancy	BackupStorageRedundancy	Výčet označující typ rezidence zálohování

PrivateEndpointConnection

Objekt

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

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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í 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

Objekt

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

Objekt

Stav připojení 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álit, odmítnout nebo odpojit)
description	string	Popis připojení služby Private Link.
status	string	Stav připojení služby Private Link.

PublicNetworkAccess

Výčet

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

Hodnota	Description
Enabled
Disabled
SecuredByPerimeter

ResourceIdentityType

Výčet

Typ identity používané 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.

Hodnota	Description
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned
None

RestoreMode

Výčet

Popisuje režim obnovení.

Hodnota	Description
PointInTime

RestoreParameters

Objekt

Parametry označující informace o obnovení

Name	Typ	Description
databasesToRestore	DatabaseRestoreResource[]	Seznam konkrétních databází, které jsou k dispozici k obnovení
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	Seznam konkrétních databází Gremlin, které jsou k dispozici k obnovení
restoreMode	RestoreMode	Popisuje režim obnovení.
restoreSource	string	ID obnovovatelného databázového účtu, ze kterého se má obnovení zahájit. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string (date-time)	Čas obnovení účtu (formát ISO-8601)
restoreWithTtlDisabled	boolean	Určuje, jestli obnovený účet bude mít po úspěšném obnovení zakázaný časovýTo-Live.
sourceBackupLocation	string	Zdrojové umístění zálohy pro obnovení.
tablesToRestore	string[]	Seznam konkrétních tabulek, které jsou k dispozici pro obnovení

ServerVersion

Výčet

Popisuje verzi účtu MongoDB.

Hodnota	Description
3.2
3.6
4.0
4.2
5.0
6.0
7.0

systemData

Objekt

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

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

UserAssignedIdentities

Objekt

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

Name	Typ	Description

VirtualNetworkRule

Objekt

Objekt pravidla seznamu ACL virtuální sítě

Name	Typ	Description
id	string (arm-id)	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řed povolením koncového bodu služby virtuální sítě.