Database Accounts - Update

Служба:: Cosmos DB Resource Provider

Версия API:: 2026-03-15

Обновляет свойства существующей учетной записи базы данных Azure Cosmos DB.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Имя учетной записи базы данных Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя нечувствительно к регистру.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
identity	ManagedServiceIdentity	Удостоверение ресурса.
location	string	Расположение группы ресурсов, к которой принадлежит ресурс.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Конкретные свойства аналитического хранилища.
properties.apiProperties	ApiProperties	Определенные свойства API. В настоящее время поддерживается только для API MongoDB.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy	Объект, представляющий политику для создания резервных копий в учетной записи.
properties.capabilities	Capability[]	Список возможностей Cosmos DB для учетной записи
properties.capacity	Capacity	Объект, представляющий все свойства, связанные с применением емкости в учетной записи.
properties.connectorOffer	ConnectorOffer	Тип предложения соединителя cassandra для учетной записи базы данных Cosmos DB C*.
properties.consistencyPolicy	ConsistencyPolicy	Политика согласованности для учетной записи Cosmos DB.
properties.cors	CorsPolicy[]	Политика CORS для учетной записи базы данных Cosmos DB.
properties.customerManagedKeyStatus	string	Указывает состояние функции управляемого клиентом ключа в учетной записи. В случае возникновения ошибок свойство предоставляет рекомендации по устранению неполадок.
properties.defaultIdentity	string	Удостоверение по умолчанию для доступа к хранилищу ключей, используемого в таких функциях, как управляемые клиентом ключи. Удостоверение по умолчанию должно быть явно задано пользователями. Это может быть "FirstPartyIdentity", "SystemAssignedIdentity" и многое другое.
properties.defaultPriorityLevel	DefaultPriorityLevel	Перечисление, указывающее уровень приоритета по умолчанию для выполнения на основе приоритета.
properties.disableKeyBasedMetadataWriteAccess	boolean	Отключение операций записи с ресурсами метаданных (базами данных, контейнерами, пропускной способностью) с помощью ключей учетной записи
properties.disableLocalAuth	boolean	Отказ от локальной проверки подлинности и обеспечение использования только MSI и AAD можно использовать исключительно для проверки подлинности.
properties.enableAnalyticalStorage	boolean	Пометка, указывающее, следует ли включить аналитику хранилища.
properties.enableAutomaticFailover	boolean	Включает автоматическую отработку отказа области записи в редких случаях, когда регион недоступен из-за сбоя. Автоматическая отработка отказа приведет к новому региону записи для учетной записи и выбирается на основе приоритетов отработки отказа, настроенных для учетной записи.
properties.enableBurstCapacity	boolean	Флаг, указывающий включение и отключение функции предварительной версии емкости для учетной записи
properties.enableCassandraConnector	boolean	Включает соединитель cassandra в учетной записи Cosmos DB C*
properties.enableFreeTier	boolean	Пометка, чтобы указать, включен ли уровень "Бесплатный".
properties.enableMultipleWriteLocations	boolean	Позволяет учетной записи записывать в нескольких расположениях
properties.enablePartitionMerge	boolean	Флаг, указывающий включение и отключение функции слияния секций в учетной записи
properties.enablePerRegionPerPartitionAutoscale	boolean	Флаг, указывающий включение и отключение Per-Region функции автомасштабирования для секции в учетной записи
properties.enablePriorityBasedExecution	boolean	Флаг, указывающий включение и отключение функции предварительной версии выполнения на основе приоритета в учетной записи
properties.enforceHierarchicalPartitionKeyIdLastLevel	boolean	Флаг, указывающий на включение/отключение иерархического идентификатора ключа раздела на последнем уровне применения аккаунта.
properties.ipRules	IpAddressOrRange[]	Список IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Флаг, указывающий на включение или отключение правил ACL виртуальная сеть.
properties.keyVaultKeyUri	string	Универсальный код ресурса (URI) хранилища ключей
properties.locations	Location[]	Массив, содержащий расположения георепликации, включенные для учетной записи Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion	Указывает минимальную разрешенную версию TLS. По умолчанию используется tls 1.0, за исключением Cassandra и API Mongo, которые работают только с TLS 1.2.
properties.networkAclBypass	NetworkAclBypass	Указывает, какие службы разрешены для обхода проверок брандмауэра.
properties.networkAclBypassResourceIds	string[]	Массив, содержащий идентификаторы ресурсов для обхода сетевого списка для учетной записи Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess	Разрешены ли запросы из общедоступной сети
properties.virtualNetworkRules	VirtualNetworkRule[]	Список правил ACL виртуальная сеть, настроенных для аккаунта Cosmos DB.
tags	object	Теги — это список пар ключ-значение, которые описывают ресурс. Эти теги можно использовать для просмотра и группировки этого ресурса (между группами ресурсов). Для ресурса может быть предоставлено не более 15 тегов. Каждый тег должен иметь ключ не более 128 символов и значения не более 256 символов. Например, взаимодействие по умолчанию для типа шаблона задается с помощью "defaultExperience": "Cassandra". Текущие значения "defaultExperience" также включают "Table", "Graph", "DocumentDB" и "MongoDB".

Ответы

Имя	Тип	Описание
200 OK	DatabaseAccountGetResults	Запрос выполнен успешно. Заголовки Location: string
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

DatabaseAccountGetResults

Запрос выполнен успешно.

Заголовки

Location: string

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	выдать себя за учетную запись пользователя

Примеры

CosmosDBDatabaseAccountPatch

Образец запроса

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1?api-version=2026-03-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,
    "enforceHierarchicalPartitionKeyIdLastLevel": false,
    "minimalTlsVersion": "Tls"
  }
}

Пример ответа

Код состояния:: 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,
    "enforceHierarchicalPartitionKeyIdLastLevel": false,
    "minimalTlsVersion": "Tls"
  }
}

Определения

Имя	Описание
AccountKeyMetadata	Метаданные, относящиеся к ключу доступа для данной учетной записи базы данных.
AnalyticalStorageConfiguration	Конкретные свойства аналитического хранилища.
AnalyticalStorageSchemaType	Описывает типы схемы для аналитического хранилища.
ApiProperties
BackupPolicyMigrationState	Объект, представляющий состояние миграции между политиками резервного копирования.
BackupPolicyMigrationStatus	Описывает состояние миграции между типами политик резервного копирования.
BackupPolicyType	Описывает режим резервных копий.
BackupStorageRedundancy	Enum для указания типа избыточности хранилища резервных копий.
Capability	Объект возможностей Cosmos DB
Capacity	Объект, представляющий все свойства, связанные с применением емкости в учетной записи.
ConnectorOffer	Тип предложения соединителя cassandra для учетной записи базы данных Cosmos DB C*.
ConsistencyPolicy	Политика согласованности для учетной записи базы данных Cosmos DB.
ContinuousModeBackupPolicy	Объект, представляющий политику резервного копирования в непрерывном режиме.
ContinuousModeProperties	Значения конфигурации для периодического резервного копирования в режиме
ContinuousTier	Enum, чтобы указать тип уровня непрерывного резервного копирования.
CorsPolicy	Политика CORS для учетной записи базы данных Cosmos DB.
createdByType	Тип учётной записи, создавшей ресурс.
CreateMode	Перечисление, указывающее режим создания учетной записи.
DatabaseAccountGetResults	Учетная запись базы данных Azure Cosmos DB.
DatabaseAccountKeysMetadata	Метаданные, относящиеся к каждому ключу доступа для данной учетной записи базы данных Cosmos DB.
DatabaseAccountKind	Указывает тип учетной записи базы данных. Это можно задать только при создании учетной записи базы данных.
DatabaseAccountUpdateParameters	Параметры для исправления свойств учетной записи базы данных Azure Cosmos DB.
DatabaseRestoreResource	Конкретные базы данных для восстановления.
DefaultConsistencyLevel	Уровень согласованности по умолчанию и параметры конфигурации учетной записи Cosmos DB.
DefaultPriorityLevel	Перечисление для указания приоритета по умолчаниюУровень запросов
ErrorResponse	Реакция на ошибку.
FailoverPolicy	Политика отработки отказа для заданного региона учетной записи базы данных.
GremlinDatabaseRestoreResource	Конкретные базы данных Gremlin для восстановления.
IpAddressOrRange	Объект IpAddressOrRange
Location	Регион, в котором развернута учетная запись базы данных Azure Cosmos DB.
ManagedServiceIdentity	Удостоверение ресурса.
ManagedServiceIdentityUserAssignedIdentities
MinimalTlsVersion	Указывает минимальную разрешенную версию TLS. По умолчанию используется tls 1.0, за исключением Cassandra и API Mongo, которые работают только с TLS 1.2.
NetworkAclBypass	Указывает, какие службы разрешены для обхода проверок брандмауэра.
PeriodicModeBackupPolicy	Объект, представляющий политику периодического резервного копирования.
PeriodicModeProperties	Значения конфигурации для периодического резервного копирования в режиме
PrivateEndpointConnection	Подключение к частной конечной точке
PrivateEndpointProperty	Частная конечная точка, к которой принадлежит подключение.
PrivateLinkServiceConnectionStateProperty	Состояние подключения подключения к частной конечной точке.
PublicNetworkAccess	Разрешены ли запросы из общедоступной сети
ResourceIdentityType	Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы.
RestoreMode	Описывает режим восстановления.
RestoreParameters	Параметры для указания сведений о восстановлении.
ServerVersion	Описывает версию учетной записи MongoDB.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
VirtualNetworkRule	Объект правила ACL виртуальной сети

AccountKeyMetadata

Объект

Метаданные, относящиеся к ключу доступа для данной учетной записи базы данных.

Имя	Тип	Описание
generationTime	string (date-time)	Время генерации в UTC ключа в формате ISO-8601. Если значение отсутствует в объекте, это означает, что последняя регенерация ключа была сработала до 18.06.2022.

AnalyticalStorageConfiguration

Объект

Конкретные свойства аналитического хранилища.

Имя	Тип	Описание
schemaType	AnalyticalStorageSchemaType	Описывает типы схемы для аналитического хранилища.

AnalyticalStorageSchemaType

Перечисление

Описывает типы схемы для аналитического хранилища.

Значение	Описание
WellDefined
FullFidelity

ApiProperties

Объект

Имя	Тип	Описание
serverVersion	ServerVersion	Описывает версию учетной записи MongoDB.

BackupPolicyMigrationState

Объект

Объект, представляющий состояние миграции между политиками резервного копирования.

Имя	Тип	Описание
startTime	string (date-time)	Время начала миграции политики резервного копирования (формат ISO-8601).
status	BackupPolicyMigrationStatus	Описывает состояние миграции между типами политик резервного копирования.
targetType	BackupPolicyType	Описывает тип целевой политики резервного копирования миграции политики резервного копирования.

BackupPolicyMigrationStatus

Перечисление

Описывает состояние миграции между типами политик резервного копирования.

Значение	Описание
Invalid
InProgress
Completed
Failed

BackupPolicyType

Перечисление

Описывает режим резервных копий.

Значение	Описание
Periodic
Continuous

BackupStorageRedundancy

Перечисление

Enum для указания типа избыточности хранилища резервных копий.

Значение	Описание
Geo
Local
Zone

Capability

Объект

Объект возможностей Cosmos DB

Имя	Тип	Описание
name	string	Имя возможности Cosmos DB. Например, "name": "EnableCassandra". Текущие значения также включают EnableTable и EnableGremlin.

Capacity

Объект

Объект, представляющий все свойства, связанные с применением емкости в учетной записи.

Имя	Тип	Описание
totalThroughputLimit	integer (int32) minimum: -1	Общее ограничение пропускной способности, установленное для учетной записи. Общий объем пропускной способности 2000 года в 2000 году накладывает строгий предел максимальной пропускной способности, который может быть подготовлен для этой учетной записи в 2000 году. Общий объем -1 -1 не ограничивает подготовку пропускной способности.

ConnectorOffer

Перечисление

Тип предложения соединителя cassandra для учетной записи базы данных Cosmos DB C*.

Значение	Описание
Small

ConsistencyPolicy

Объект

Политика согласованности для учетной записи базы данных Cosmos DB.

Имя	Тип	Описание
defaultConsistencyLevel	DefaultConsistencyLevel	Уровень согласованности по умолчанию и параметры конфигурации учетной записи Cosmos DB.
maxIntervalInSeconds	integer (int32) minimum: 5 maximum: 86400	При использовании с уровнем согласованности с ограниченной устаревшей степенью согласованности это значение представляет допустимое время устаревания (в секундах). Допустимый диапазон для этого значения составляет 5 – 86400. Требуется, если для defaultConsistencyPolicy задано значение BoundedStaleness.
maxStalenessPrefix	integer (int64) minimum: 1 maximum: 2147483647	При использовании с уровнем согласованности с ограниченной устаревшим состоянием это значение представляет количество устаревших запросов, допустимых. Допустимый диапазон для этого значения составляет 1 – 2 147 483 647. Требуется, если для defaultConsistencyPolicy задано значение BoundedStaleness.

ContinuousModeBackupPolicy

Объект

Объект, представляющий политику резервного копирования в непрерывном режиме.

Имя	Тип	Описание
continuousModeProperties	ContinuousModeProperties	Значения конфигурации для резервного копирования в непрерывном режиме
migrationState	BackupPolicyMigrationState	Объект, представляющий состояние миграции между политиками резервного копирования.
type	string: Continuous	Описывает режим резервных копий.

ContinuousModeProperties

Объект

Значения конфигурации для периодического резервного копирования в режиме

Имя	Тип	Описание
tier	ContinuousTier	Перечисление для указания типа режима резервного копирования Continuos

ContinuousTier

Перечисление

Enum, чтобы указать тип уровня непрерывного резервного копирования.

Значение	Описание
Continuous7Days
Continuous30Days

CorsPolicy

Объект

Политика CORS для учетной записи базы данных Cosmos DB.

Имя	Тип	Описание
allowedHeaders	string	Заголовки запроса, указанные в исходном домене, могут указываться в запросе CORS.
allowedMethods	string	Методы (команды HTTP-запроса), которые домен-источник может использовать для запроса CORS.
allowedOrigins	string	Домены источника, которые разрешены запрашивать службу через CORS.
exposedHeaders	string	Заголовки ответа, которые могут быть отправлены в ответ на запрос CORS и предоставляются браузером издателю запроса.
maxAgeInSeconds	integer (int64) minimum: 1 maximum: 2147483647	Максимальное время, которое браузер должен кэшировать запрос preflight OPTIONS.

createdByType

Перечисление

Тип учётной записи, создавшей ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

CreateMode

Перечисление

Перечисление, указывающее режим создания учетной записи.

Значение	Описание
Default
Restore

DatabaseAccountGetResults

Объект

Учетная запись базы данных Azure Cosmos DB.

Имя	Тип	Default value	Описание
id	string (arm-id)		Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity		Удостоверение ресурса.
kind	DatabaseAccountKind	GlobalDocumentDB	Указывает тип учетной записи базы данных. Это можно задать только при создании учетной записи базы данных.
location	string		Расположение группы ресурсов, к которой принадлежит ресурс.
name	string		Имя ресурса.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Конкретные свойства аналитического хранилища.
properties.apiProperties	ApiProperties		Определенные свойства API.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		Объект, представляющий политику для создания резервных копий в учетной записи.
properties.capabilities	Capability[]		Список возможностей Cosmos DB для учетной записи
properties.capacity	Capacity		Объект, представляющий все свойства, связанные с применением емкости в учетной записи.
properties.connectorOffer	ConnectorOffer		Тип предложения соединителя cassandra для учетной записи базы данных Cosmos DB C*.
properties.consistencyPolicy	ConsistencyPolicy		Политика согласованности для учетной записи базы данных Cosmos DB.
properties.cors	CorsPolicy[]		Политика CORS для учетной записи базы данных Cosmos DB.
properties.createMode	CreateMode	Default	Перечисление, указывающее режим создания учетной записи.
properties.customerManagedKeyStatus	string		Указывает состояние функции управляемого клиентом ключа в учетной записи. В случае возникновения ошибок свойство предоставляет рекомендации по устранению неполадок.
properties.databaseAccountOfferType	enum: Standard		Тип предложения для учетной записи базы данных Cosmos DB. Значение по умолчанию: Стандартное.
properties.defaultIdentity	string		Удостоверение по умолчанию для доступа к хранилищу ключей, используемого в таких функциях, как управляемые клиентом ключи. Удостоверение по умолчанию должно быть явно задано пользователями. Это может быть "FirstPartyIdentity", "SystemAssignedIdentity" и многое другое.
properties.defaultPriorityLevel	DefaultPriorityLevel		Перечисление, указывающее уровень приоритета по умолчанию для выполнения на основе приоритета.
properties.disableKeyBasedMetadataWriteAccess	boolean		Отключение операций записи с ресурсами метаданных (базами данных, контейнерами, пропускной способностью) с помощью ключей учетной записи
properties.disableLocalAuth	boolean		Отказ от локальной проверки подлинности и обеспечение использования только MSI и AAD можно использовать исключительно для проверки подлинности.
properties.documentEndpoint	string		Конечная точка подключения для учетной записи базы данных Cosmos DB.
properties.enableAnalyticalStorage	boolean		Пометка, указывающее, следует ли включить аналитику хранилища.
properties.enableAutomaticFailover	boolean		Включает автоматическую отработку отказа области записи в редких случаях, когда регион недоступен из-за сбоя. Автоматическая отработка отказа приведет к новому региону записи для учетной записи и выбирается на основе приоритетов отработки отказа, настроенных для учетной записи.
properties.enableBurstCapacity	boolean		Флаг, указывающий включение и отключение функции предварительной версии емкости для учетной записи
properties.enableCassandraConnector	boolean		Включает соединитель cassandra в учетной записи Cosmos DB C*
properties.enableFreeTier	boolean		Пометка, чтобы указать, включен ли уровень "Бесплатный".
properties.enableMultipleWriteLocations	boolean		Позволяет учетной записи записывать в нескольких расположениях
properties.enablePartitionMerge	boolean		Флаг, указывающий включение и отключение функции слияния секций в учетной записи
properties.enablePerRegionPerPartitionAutoscale	boolean		Флаг, указывающий включение и отключение Per-Region функции автомасштабирования для секции в учетной записи
properties.enablePriorityBasedExecution	boolean		Флаг, указывающий включение и отключение функции предварительной версии выполнения на основе приоритета в учетной записи
properties.enforceHierarchicalPartitionKeyIdLastLevel	boolean		Флаг, указывающий на включение/отключение иерархического идентификатора ключа раздела на последнем уровне применения аккаунта.
properties.failoverPolicies	FailoverPolicy[]		Массив, содержащий регионы, упорядоченные по приоритетам отработки отказа.
properties.instanceId	string		Уникальный идентификатор, присвоенный учетной записи базы данных
properties.ipRules	IpAddressOrRange[]		Список IpRules.
properties.isVirtualNetworkFilterEnabled	boolean		Флаг, указывающий на включение или отключение правил ACL виртуальная сеть.
properties.keyVaultKeyUri	string		Универсальный код ресурса (URI) хранилища ключей
properties.keyVaultKeyUriVersion	string		Версия ключа, управляемого клиентом, используемая в данный момент учетной записью
properties.keysMetadata	DatabaseAccountKeysMetadata		Объект, представляющий метаданные для ключей учетной записи учетной записи Cosmos DB.
properties.locations	Location[]		Массив, содержащий все расположения, включенные для учетной записи Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion		Указывает минимальную разрешенную версию TLS. По умолчанию используется tls 1.0, за исключением Cassandra и API Mongo, которые работают только с TLS 1.2.
properties.networkAclBypass	NetworkAclBypass		Указывает, какие службы разрешены для обхода проверок брандмауэра.
properties.networkAclBypassResourceIds	string[] (arm-id)		Массив, содержащий идентификаторы ресурсов для обхода сетевого списка для учетной записи Cosmos DB.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Список подключений к частным конечным точкам, настроенных для учетной записи Cosmos DB.
properties.provisioningState	string		Состояние подготовки ресурса.
properties.publicNetworkAccess	PublicNetworkAccess		Разрешены ли запросы из общедоступной сети
properties.readLocations	Location[]		Массив, содержащий места чтения, включенные для учетной записи Cosmos DB.
properties.restoreParameters	RestoreParameters		Параметры для указания сведений о восстановлении.
properties.virtualNetworkRules	VirtualNetworkRule[]		Список правил ACL виртуальная сеть, настроенных для аккаунта Cosmos DB.
properties.writeLocations	Location[]		Массив, содержащий расположение записи для учетной записи Cosmos DB.
systemData	systemData		Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object		Теги — это список пар ключ-значение, которые описывают ресурс. Эти теги можно использовать для просмотра и группировки этого ресурса (между группами ресурсов). Для ресурса может быть предоставлено не более 15 тегов. Каждый тег должен иметь ключ не более 128 символов и значения не более 256 символов. Например, взаимодействие по умолчанию для типа шаблона задается с помощью "defaultExperience": "Cassandra". Текущие значения "defaultExperience" также включают "Table", "Graph", "DocumentDB" и "MongoDB".
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

DatabaseAccountKeysMetadata

Объект

Метаданные, относящиеся к каждому ключу доступа для данной учетной записи базы данных Cosmos DB.

Имя	Тип	Описание
primaryMasterKey	AccountKeyMetadata	Метаданные, связанные с первичным ключом Read-Write для указанной учетной записи базы данных Cosmos DB.
primaryReadonlyMasterKey	AccountKeyMetadata	Метаданные, связанные с первичным ключом Read-Only для указанной учетной записи базы данных Cosmos DB.
secondaryMasterKey	AccountKeyMetadata	Метаданные, связанные с ключом вторичной Read-Write для указанной учетной записи базы данных Cosmos DB.
secondaryReadonlyMasterKey	AccountKeyMetadata	Метаданные, связанные с ключом вторичной Read-Only для указанной учетной записи базы данных Cosmos DB.

DatabaseAccountKind

Перечисление

Указывает тип учетной записи базы данных. Это можно задать только при создании учетной записи базы данных.

Значение	Описание
GlobalDocumentDB
MongoDB
Parse

DatabaseAccountUpdateParameters

Объект

Параметры для исправления свойств учетной записи базы данных Azure Cosmos DB.

Имя	Тип	Описание
identity	ManagedServiceIdentity	Удостоверение ресурса.
location	string	Расположение группы ресурсов, к которой принадлежит ресурс.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Конкретные свойства аналитического хранилища.
properties.apiProperties	ApiProperties	Определенные свойства API. В настоящее время поддерживается только для API MongoDB.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy	Объект, представляющий политику для создания резервных копий в учетной записи.
properties.capabilities	Capability[]	Список возможностей Cosmos DB для учетной записи
properties.capacity	Capacity	Объект, представляющий все свойства, связанные с применением емкости в учетной записи.
properties.connectorOffer	ConnectorOffer	Тип предложения соединителя cassandra для учетной записи базы данных Cosmos DB C*.
properties.consistencyPolicy	ConsistencyPolicy	Политика согласованности для учетной записи Cosmos DB.
properties.cors	CorsPolicy[]	Политика CORS для учетной записи базы данных Cosmos DB.
properties.customerManagedKeyStatus	string	Указывает состояние функции управляемого клиентом ключа в учетной записи. В случае возникновения ошибок свойство предоставляет рекомендации по устранению неполадок.
properties.defaultIdentity	string	Удостоверение по умолчанию для доступа к хранилищу ключей, используемого в таких функциях, как управляемые клиентом ключи. Удостоверение по умолчанию должно быть явно задано пользователями. Это может быть "FirstPartyIdentity", "SystemAssignedIdentity" и многое другое.
properties.defaultPriorityLevel	DefaultPriorityLevel	Перечисление, указывающее уровень приоритета по умолчанию для выполнения на основе приоритета.
properties.disableKeyBasedMetadataWriteAccess	boolean	Отключение операций записи с ресурсами метаданных (базами данных, контейнерами, пропускной способностью) с помощью ключей учетной записи
properties.disableLocalAuth	boolean	Отказ от локальной проверки подлинности и обеспечение использования только MSI и AAD можно использовать исключительно для проверки подлинности.
properties.enableAnalyticalStorage	boolean	Пометка, указывающее, следует ли включить аналитику хранилища.
properties.enableAutomaticFailover	boolean	Включает автоматическую отработку отказа области записи в редких случаях, когда регион недоступен из-за сбоя. Автоматическая отработка отказа приведет к новому региону записи для учетной записи и выбирается на основе приоритетов отработки отказа, настроенных для учетной записи.
properties.enableBurstCapacity	boolean	Флаг, указывающий включение и отключение функции предварительной версии емкости для учетной записи
properties.enableCassandraConnector	boolean	Включает соединитель cassandra в учетной записи Cosmos DB C*
properties.enableFreeTier	boolean	Пометка, чтобы указать, включен ли уровень "Бесплатный".
properties.enableMultipleWriteLocations	boolean	Позволяет учетной записи записывать в нескольких расположениях
properties.enablePartitionMerge	boolean	Флаг, указывающий включение и отключение функции слияния секций в учетной записи
properties.enablePerRegionPerPartitionAutoscale	boolean	Флаг, указывающий включение и отключение Per-Region функции автомасштабирования для секции в учетной записи
properties.enablePriorityBasedExecution	boolean	Флаг, указывающий включение и отключение функции предварительной версии выполнения на основе приоритета в учетной записи
properties.enforceHierarchicalPartitionKeyIdLastLevel	boolean	Флаг, указывающий на включение/отключение иерархического идентификатора ключа раздела на последнем уровне применения аккаунта.
properties.ipRules	IpAddressOrRange[]	Список IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Флаг, указывающий на включение или отключение правил ACL виртуальная сеть.
properties.keyVaultKeyUri	string	Универсальный код ресурса (URI) хранилища ключей
properties.keysMetadata	DatabaseAccountKeysMetadata	Это свойство игнорируется во время операции обновления, так как метаданные доступны только для чтения. Объект представляет метаданные для ключей учетной записи Cosmos DB.
properties.locations	Location[]	Массив, содержащий расположения георепликации, включенные для учетной записи Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion	Указывает минимальную разрешенную версию TLS. По умолчанию используется tls 1.0, за исключением Cassandra и API Mongo, которые работают только с TLS 1.2.
properties.networkAclBypass	NetworkAclBypass	Указывает, какие службы разрешены для обхода проверок брандмауэра.
properties.networkAclBypassResourceIds	string[]	Массив, содержащий идентификаторы ресурсов для обхода сетевого списка для учетной записи Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess	Разрешены ли запросы из общедоступной сети
properties.virtualNetworkRules	VirtualNetworkRule[]	Список правил ACL виртуальная сеть, настроенных для аккаунта Cosmos DB.
tags	object	Теги — это список пар ключ-значение, которые описывают ресурс. Эти теги можно использовать для просмотра и группировки этого ресурса (между группами ресурсов). Для ресурса может быть предоставлено не более 15 тегов. Каждый тег должен иметь ключ не более 128 символов и значения не более 256 символов. Например, взаимодействие по умолчанию для типа шаблона задается с помощью "defaultExperience": "Cassandra". Текущие значения "defaultExperience" также включают "Table", "Graph", "DocumentDB" и "MongoDB".

DatabaseRestoreResource

Объект

Конкретные базы данных для восстановления.

Имя	Тип	Описание
collectionNames	string[]	Имена коллекций, доступных для восстановления.
databaseName	string	Имя базы данных, доступной для восстановления.

DefaultConsistencyLevel

Перечисление

Уровень согласованности по умолчанию и параметры конфигурации учетной записи Cosmos DB.

Значение	Описание
Eventual
Session
BoundedStaleness
Strong
ConsistentPrefix

DefaultPriorityLevel

Перечисление

Перечисление для указания приоритета по умолчаниюУровень запросов

Значение	Описание
High
Low

ErrorResponse

Объект

Реакция на ошибку.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

FailoverPolicy

Объект

Политика отработки отказа для заданного региона учетной записи базы данных.

Имя	Тип	Описание
failoverPriority	integer (int32) minimum: 0	Приоритет отработки отказа региона. Приоритет отработки отказа 0 указывает регион записи. Максимальное значение для приоритета отработки отказа = (общее число регионов - 1). Значения приоритета отработки отказа должны быть уникальными для каждого региона, в котором существует учетная запись базы данных.
id	string	Уникальный идентификатор региона, в который выполняется репликация учетной записи базы данных. Пример: <accountName-locationName><>.
locationName	string	Название региона, в котором существует учетная запись базы данных.

GremlinDatabaseRestoreResource

Объект

Конкретные базы данных Gremlin для восстановления.

Имя	Тип	Описание
databaseName	string	Имя базы данных gremlin, доступной для восстановления.
graphNames	string[]	Имена графов, доступных для восстановления.

IpAddressOrRange

Объект

Объект IpAddressOrRange

Имя	Тип	Описание
ipAddressOrRange	string	Один IPv4-адрес или один диапазон адресов IPv4 в формате CIDR. Предоставленные IP-адреса должны быть хорошо форматированы и не могут содержаться в одном из следующих диапазонов: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, так как они не применяются фильтром IP-адресов. Пример допустимых входных данных: "23.40.210.245" или "23.40.210.0/8".

Location

Объект

Регион, в котором развернута учетная запись базы данных Azure Cosmos DB.

Имя	Тип	Описание
documentEndpoint	string	Конечная точка подключения для определенного региона. Пример: https://< accountName-locationName.documents.azure.com:443/><>
failoverPriority	integer (int32) minimum: 0	Приоритет отработки отказа региона. Приоритет отработки отказа 0 указывает регион записи. Максимальное значение для приоритета отработки отказа = (общее число регионов - 1). Значения приоритета отработки отказа должны быть уникальными для каждого региона, в котором существует учетная запись базы данных.
id	string	Уникальный идентификатор региона в учетной записи базы данных. Пример: <accountName-locationName><>.
isZoneRedundant	boolean	Флаг, указывающий, является ли этот регион регионом availabilityZone
locationName	string	Имя региона.
provisioningState	string	Состояние подготовки ресурса.

ManagedServiceIdentity

Объект

Удостоверение ресурса.

Имя	Тип	Описание
principalId	string	Основной идентификатор назначенного системой идентификатора. Это свойство будет предоставлено только для назначаемого системой удостоверения.
tenantId	string	Идентификатор клиента назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
type	ResourceIdentityType	Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы.
userAssignedIdentities	<string, ManagedServiceIdentityUserAssignedIdentities>	Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ManagedServiceIdentityUserAssignedIdentities

Объект

Имя	Тип	Описание
clientId	string	Идентификатор клиента назначаемого пользователем удостоверения.
principalId	string	Идентификатор субъекта назначаемого пользователем удостоверения.

MinimalTlsVersion

Перечисление

Указывает минимальную разрешенную версию TLS. По умолчанию используется tls 1.0, за исключением Cassandra и API Mongo, которые работают только с TLS 1.2.

Значение	Описание
Tls
Tls11
Tls12

NetworkAclBypass

Перечисление

Указывает, какие службы разрешены для обхода проверок брандмауэра.

Значение	Описание
None
AzureServices

PeriodicModeBackupPolicy

Объект

Объект, представляющий политику периодического резервного копирования.

Имя	Тип	Описание
migrationState	BackupPolicyMigrationState	Объект, представляющий состояние миграции между политиками резервного копирования.
periodicModeProperties	PeriodicModeProperties	Значения конфигурации для периодического резервного копирования в режиме
type	string: Periodic	Описывает режим резервных копий.

PeriodicModeProperties

Объект

Значения конфигурации для периодического резервного копирования в режиме

Имя	Тип	Описание
backupIntervalInMinutes	integer (int32) minimum: 0	Целое число, представляющее интервал в минутах между двумя резервными копиями
backupRetentionIntervalInHours	integer (int32) minimum: 0	Целое число, представляющее время (в часах), которое сохраняется каждой резервной копии.
backupStorageRedundancy	BackupStorageRedundancy	Перечисление, указывающее тип расположения резервного копирования

PrivateEndpointConnection

Объект

Подключение к частной конечной точке

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса.
properties.groupId	string	Идентификатор группы частной конечной точки.
properties.privateEndpoint	PrivateEndpointProperty	Частная конечная точка, к которой принадлежит подключение.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Состояние подключения подключения к частной конечной точке.
properties.provisioningState	string	Состояние подготовки частной конечной точки.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Объект

Частная конечная точка, к которой принадлежит подключение.

Имя	Тип	Описание
id	string	Идентификатор ресурса частной конечной точки.

PrivateLinkServiceConnectionStateProperty

Объект

Состояние подключения подключения к частной конечной точке.

Имя	Тип	Описание
actionsRequired	string	Любое действие, которое требуется за рамки базового рабочего процесса (утверждение/ отклонение или отключение)
description	string	Описание подключения службы приватного канала.
status	string	Состояние подключения службы приватного канала.

PublicNetworkAccess

Перечисление

Разрешены ли запросы из общедоступной сети

Значение	Описание
Enabled
Disabled
SecuredByPerimeter

ResourceIdentityType

Перечисление

Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы.

Значение	Описание
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned
None

RestoreMode

Перечисление

Описывает режим восстановления.

Значение	Описание
PointInTime

RestoreParameters

Объект

Параметры для указания сведений о восстановлении.

Имя	Тип	Описание
databasesToRestore	DatabaseRestoreResource[]	Список определенных баз данных, доступных для восстановления.
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	Список конкретных баз данных gremlin, доступных для восстановления.
restoreMode	RestoreMode	Описывает режим восстановления.
restoreSource	string	Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft. DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string (date-time)	Время восстановления учетной записи (формат ISO-8601).
restoreWithTtlDisabled	boolean	Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении.
sourceBackupLocation	string	Исходное расположение резервного копирования для восстановления.
tablesToRestore	string[]	Список определенных таблиц, доступных для восстановления.

ServerVersion

Перечисление

Описывает версию учетной записи MongoDB.

Значение	Описание
3.2
3.6
4.0
4.2
5.0
6.0
7.0

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Идентификатор, создавший ресурс.
createdByType	createdByType	Тип учётной записи, создавшей ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

VirtualNetworkRule

Объект

Объект правила ACL виртуальной сети

Имя	Тип	Описание
id	string (arm-id)	Идентификатор ресурса подсети, например: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft. Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint	boolean	Создайте правило брандмауэра до включения конечной точки службы виртуальной сети.