Database Accounts - Update

Ссылка

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

Версия API:: 2024-11-15

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

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

Параметры URI

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

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

Имя	Тип	Описание
identity	ManagedServiceIdentity	Удостоверение ресурса.
location	string	Расположение группы ресурсов, к которой принадлежит ресурс.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Конкретные свойства аналитического хранилища.
properties.apiProperties	ApiProperties	Определенные свойства API. В настоящее время поддерживается только для API MongoDB.
properties.backupPolicy	BackupPolicy: PeriodicModeBackupPolicy ContinuousModeBackupPolicy	Объект, представляющий политику для создания резервных копий в учетной записи.
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.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	Флаг, указывающий включение и отключение функции PerRegionPerPartitionAutoscale в учетной записи
properties.ipRules	IpAddressOrRange[]	Список IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Пометка, чтобы указать, следует ли включить или отключить правила ACL виртуальной сети.
properties.keyVaultKeyUri	string	Универсальный код ресурса (URI) хранилища ключей
properties.locations	Location[]	Массив, содержащий расположения георепликации, включенные для учетной записи Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion	Указывает минимальную разрешенную версию TLS. Значение по умолчанию — TLS 1.2. API Cassandra и 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	Операция обновления учетной записи базы данных будет выполняться асинхронно.

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

Имя	Описание
user_impersonation	Олицетворения учетной записи пользователя

Примеры

CosmosDBDatabaseAccountPatch

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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

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

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


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

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


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

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

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

Код состояния:: 200

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

Определения

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

AccountKeyMetadata

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

Имя	Тип	Описание
generationTime	string	Время создания в формате UTC ключа в формате ISO-8601. Если значение отсутствует из объекта, это означает, что до 2022-06-18 была активирована последняя повторность ключа.

AnalyticalStorageConfiguration

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

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

AnalyticalStorageSchemaType

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

Имя	Тип	Описание
FullFidelity	string
WellDefined	string

ApiProperties

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

BackupPolicyMigrationState

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

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

BackupPolicyMigrationStatus

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

Имя	Тип	Описание
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

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

Имя	Тип	Описание
Continuous	string
Periodic	string

BackupStorageRedundancy

Перечисление, указывающее тип избыточности хранилища резервных копий.

Имя	Тип	Описание
Geo	string
Local	string
Zone	string

Capability

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

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

Capacity

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

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

ConnectorOffer

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

Имя	Тип	Описание
Small	string

ConsistencyPolicy

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

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

ContinuousModeBackupPolicy

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

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

ContinuousModeProperties

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

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

ContinuousTier

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

Имя	Тип	Описание
Continuous30Days	string
Continuous7Days	string

CorsPolicy

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

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

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

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

Имя	Тип	Описание
Default	string
Restore	string

DatabaseAccountGetResults

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

Имя	Тип	Default value	Описание
id	string		Уникальный идентификатор ресурса ARM.
identity	ManagedServiceIdentity		Удостоверение ресурса.
kind	DatabaseAccountKind	GlobalDocumentDB	Указывает тип учетной записи базы данных. Это можно задать только при создании учетной записи базы данных.
location	string		Расположение группы ресурсов, к которой принадлежит ресурс.
name	string		Имя ресурса ARM.
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	DatabaseAccountOfferType		Тип предложения для учетной записи базы данных Cosmos DB. Значение по умолчанию: Стандартный.
properties.defaultIdentity	string		Удостоверение по умолчанию для доступа к хранилищу ключей, используемого в таких функциях, как управляемые клиентом ключи. Удостоверение по умолчанию должно быть явно задано пользователями. Это может быть "FirstPartyIdentity", "SystemAssignedIdentity" и многое другое.
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		Флаг, указывающий включение и отключение функции PerRegionPerPartitionAutoscale в учетной записи
properties.failoverPolicies	FailoverPolicy[]		Массив, содержащий регионы, упорядоченные по приоритетам отработки отказа.
properties.instanceId	string		Уникальный идентификатор, назначенный учетной записи базы данных
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.2. API Cassandra и Mongo работают только с TLS 1.2.
properties.networkAclBypass	NetworkAclBypass		Указывает, какие службы разрешены для обхода проверок брандмауэра.
properties.networkAclBypassResourceIds	string[]		Массив, содержащий идентификаторы ресурсов для обхода сетевого списка для учетной записи Cosmos DB.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Список подключений частной конечной точки, настроенных для учетной записи Cosmos DB.
properties.provisioningState	string		Состояние учетной записи Cosmos DB во время вызова операции. Состояние может быть одним из следующих. "Создание" — создается учетная запись Cosmos DB. При создании учетной записи возвращаются только свойства, указанные в качестве входных данных для операции создания учетной записи Cosmos DB. "Успешно" — учетная запись Cosmos DB активна для использования. Обновление — учетная запись Cosmos DB обновляется. "Удаление" — удаляется учетная запись Cosmos DB. "Сбой" — не удалось создать учетную запись Cosmos DB. "УдалениеFailed" — сбой удаления учетной записи Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess		Разрешены ли запросы из общедоступной сети
properties.readLocations	Location[]		Массив, содержащий расположения чтения, включенные для учетной записи Cosmos DB.
properties.restoreParameters	RestoreParameters		Параметры для указания сведений о восстановлении.
properties.virtualNetworkRules	VirtualNetworkRule[]		Список правил ACL виртуальной сети, настроенных для учетной записи Cosmos DB.
properties.writeLocations	Location[]		Массив, содержащий расположение записи для учетной записи Cosmos DB.
systemData	systemData		Системные метаданные, относящиеся к этому ресурсу.
tags	object		Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать для просмотра и группировки этого ресурса (между группами ресурсов). Для ресурса может быть предоставлено не более 15 тегов. Каждый тег должен иметь ключ не более 128 символов и значения не более 256 символов. Например, интерфейс по умолчанию для типа шаблона задается с параметром defaultExperience: Cassandra. Текущие значения defaultExperience также включают table, Graph, DocumentDB и MongoDB.
type	string		Тип ресурса Azure.

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	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

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

Имя	Тип	Описание
Standard	string

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.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	Флаг, указывающий включение и отключение функции PerRegionPerPartitionAutoscale в учетной записи
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.2. API Cassandra и 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.

Имя	Тип	Описание
BoundedStaleness	string
ConsistentPrefix	string
Eventual	string
Session	string
Strong	string

FailoverPolicy

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

Имя	Тип	Описание
failoverPriority	integer	Приоритет отработки отказа региона. Приоритет отработки отказа 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	Приоритет отработки отказа региона. Приоритет отработки отказа 0 указывает регион записи. Максимальное значение для приоритета отработки отказа = (общее число регионов - 1). Значения приоритета отработки отказа должны быть уникальными для каждого региона, в котором существует учетная запись базы данных.
id	string	Уникальный идентификатор региона в учетной записи базы данных. Пример: <accountName>—<locationName>.
isZoneRedundant	boolean	Флаг, указывающий, является ли этот регион регионом availabilityZone
locationName	string	Имя региона.
provisioningState	string	Состояние учетной записи Cosmos DB во время вызова операции. Состояние может быть одним из следующих. "Создание" — создается учетная запись Cosmos DB. При создании учетной записи возвращаются только свойства, указанные в качестве входных данных для операции создания учетной записи Cosmos DB. "Успешно" — учетная запись Cosmos DB активна для использования. Обновление — учетная запись Cosmos DB обновляется. "Удаление" — удаляется учетная запись Cosmos DB. "Сбой" — не удалось создать учетную запись Cosmos DB. "УдалениеFailed" — сбой удаления учетной записи Cosmos DB.

ManagedServiceIdentity

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

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

MinimalTlsVersion

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

Имя	Тип	Описание
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

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

Имя	Тип	Описание
AzureServices	string
None	string

PeriodicModeBackupPolicy

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

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

PeriodicModeProperties

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

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

PrivateEndpointConnection

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

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

PrivateEndpointProperty

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

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

PrivateLinkServiceConnectionStateProperty

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

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

PublicNetworkAccess

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

Имя	Тип	Описание
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

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

Имя	Тип	Описание
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

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

Имя	Тип	Описание
PointInTime	string

RestoreParameters

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

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

ServerVersion

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

Имя	Тип	Описание
3.2	string
3.6	string
4.0	string
4.2	string
5.0	string
6.0	string
7.0	string

systemData

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

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

UserAssignedIdentities

Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Имя	Тип	Описание

VirtualNetworkRule

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

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

Поделиться через

Database Accounts - Update

Параметры URI

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

Ответы

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

azure_auth

Области

Примеры

CosmosDBDatabaseAccountPatch

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

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

Определения

AccountKeyMetadata

AnalyticalStorageConfiguration

AnalyticalStorageSchemaType

ApiProperties

BackupPolicyMigrationState

BackupPolicyMigrationStatus

BackupPolicyType

BackupStorageRedundancy

Capability

Capacity

ConnectorOffer

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

ContinuousTier

CorsPolicy

createdByType

CreateMode

DatabaseAccountGetResults

DatabaseAccountKeysMetadata

DatabaseAccountKind

DatabaseAccountOfferType

DatabaseAccountUpdateParameters

DatabaseRestoreResource

DefaultConsistencyLevel

FailoverPolicy

GremlinDatabaseRestoreResource

IpAddressOrRange

Location

ManagedServiceIdentity

MinimalTlsVersion

NetworkAclBypass

PeriodicModeBackupPolicy

PeriodicModeProperties

PrivateEndpointConnection

PrivateEndpointProperty

PrivateLinkServiceConnectionStateProperty

PublicNetworkAccess

ResourceIdentityType

RestoreMode

RestoreParameters

ServerVersion

systemData

UserAssignedIdentities

VirtualNetworkRule

Дополнительные ресурсы