DatabaseAccountUpdateParameters interface

Пакет:

@azure/arm-cosmosdb

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

Свойства

analyticalStorageConfiguration	Конкретные свойства аналитического хранилища.
apiProperties	Определенные свойства API. В настоящее время поддерживается только для API MongoDB.
backupPolicy	Объект, представляющий политику для создания резервных копий в учетной записи.
capabilities	Список возможностей Cosmos DB для учетной записи
capacity	Объект, представляющий все свойства, связанные с применением емкости в учетной записи.
connectorOffer	Тип предложения соединителя cassandra для учетной записи базы данных Cosmos DB C*.
consistencyPolicy	Политика согласованности для учетной записи Cosmos DB.
cors	Политика CORS для учетной записи базы данных Cosmos DB.
customerManagedKeyStatus	Указывает состояние функции управляемого клиентом ключа в учетной записи. В случае возникновения ошибок свойство предоставляет рекомендации по устранению неполадок.
defaultIdentity	Удостоверение по умолчанию для доступа к хранилищу ключей, используемого в таких функциях, как управляемые клиентом ключи. Удостоверение по умолчанию должно быть явно задано пользователями. Это может быть "FirstPartyIdentity", "SystemAssignedIdentity" и многое другое.
defaultPriorityLevel	Перечисление, указывающее уровень приоритета по умолчанию для выполнения на основе приоритета.
disableKeyBasedMetadataWriteAccess	Отключение операций записи с ресурсами метаданных (базами данных, контейнерами, пропускной способностью) с помощью ключей учетной записи
disableLocalAuth	Отказ от локальной проверки подлинности и обеспечение использования только MSI и AAD можно использовать исключительно для проверки подлинности.
enableAnalyticalStorage	Пометка, указывающее, следует ли включить аналитику хранилища.
enableAutomaticFailover	Включает автоматическую отработку отказа области записи в редких случаях, когда регион недоступен из-за сбоя. Автоматическая отработка отказа приведет к новому региону записи для учетной записи и выбирается на основе приоритетов отработки отказа, настроенных для учетной записи.
enableBurstCapacity	Флаг, указывающий включение и отключение функции емкости всплеска в учетной записи
enableCassandraConnector	Включает соединитель cassandra в учетной записи Cosmos DB C*
enableFreeTier	Пометка, чтобы указать, включен ли уровень "Бесплатный".
enableMultipleWriteLocations	Позволяет учетной записи записывать в нескольких расположениях
enablePartitionMerge	Флаг, указывающий включение и отключение функции слияния секций в учетной записи
enablePerRegionPerPartitionAutoscale	Флаг, указывающий включение и отключение функции PerRegionPerPartitionAutoscale в учетной записи
enablePriorityBasedExecution	Флаг, указывающий включение и отключение функции предварительной версии выполнения на основе приоритета в учетной записи
identity	Удостоверение ресурса.
ipRules	Список IpRules.
isVirtualNetworkFilterEnabled	Пометка, чтобы указать, следует ли включить или отключить правила ACL виртуальной сети.
keysMetadata	Это свойство игнорируется во время операции обновления, так как метаданные доступны только для чтения. Объект представляет метаданные для ключей учетной записи Cosmos DB. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
keyVaultKeyUri	Универсальный код ресурса (URI) хранилища ключей
location	Расположение группы ресурсов, к которой принадлежит ресурс.
locations	Массив, содержащий расположения георепликации, включенные для учетной записи Cosmos DB.
minimalTlsVersion	Указывает минимальную разрешенную версию TLS. Значение по умолчанию — TLS 1.2. API Cassandra и Mongo работают только с TLS 1.2.
networkAclBypass	Указывает, какие службы разрешены для обхода проверок брандмауэра.
networkAclBypassResourceIds	Массив, содержащий идентификаторы ресурсов для обхода сетевого списка для учетной записи Cosmos DB.
publicNetworkAccess	Разрешены ли запросы из общедоступной сети
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать для просмотра и группировки этого ресурса (между группами ресурсов). Для ресурса может быть предоставлено не более 15 тегов. Каждый тег должен иметь ключ не более 128 символов и значения не более 256 символов. Например, интерфейс по умолчанию для типа шаблона задается с параметром defaultExperience: Cassandra. Текущие значения defaultExperience также включают table, Graph, DocumentDB и MongoDB.
virtualNetworkRules	Список правил ACL виртуальной сети, настроенных для учетной записи Cosmos DB.

Сведения о свойстве

analyticalStorageConfiguration

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

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

Значение свойства

AnalyticalStorageConfiguration

apiProperties

Определенные свойства API. В настоящее время поддерживается только для API MongoDB.

apiProperties?: ApiProperties

Значение свойства

ApiProperties

backupPolicy

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

backupPolicy?: BackupPolicyUnion

Значение свойства

BackupPolicyUnion

capabilities

Список возможностей Cosmos DB для учетной записи

capabilities?: Capability[]

Значение свойства

Capability[]

capacity

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

capacity?: Capacity

Значение свойства

Capacity

connectorOffer

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

connectorOffer?: string

Значение свойства

string

consistencyPolicy

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

consistencyPolicy?: ConsistencyPolicy

Значение свойства

ConsistencyPolicy

cors

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

cors?: CorsPolicy[]

Значение свойства

CorsPolicy[]

customerManagedKeyStatus

Указывает состояние функции управляемого клиентом ключа в учетной записи. В случае возникновения ошибок свойство предоставляет рекомендации по устранению неполадок.

customerManagedKeyStatus?: string

Значение свойства

string

defaultIdentity

Удостоверение по умолчанию для доступа к хранилищу ключей, используемого в таких функциях, как управляемые клиентом ключи. Удостоверение по умолчанию должно быть явно задано пользователями. Это может быть "FirstPartyIdentity", "SystemAssignedIdentity" и многое другое.

defaultIdentity?: string

Значение свойства

string

defaultPriorityLevel

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

defaultPriorityLevel?: string

Значение свойства

string

disableKeyBasedMetadataWriteAccess

Отключение операций записи с ресурсами метаданных (базами данных, контейнерами, пропускной способностью) с помощью ключей учетной записи

disableKeyBasedMetadataWriteAccess?: boolean

Значение свойства

boolean

disableLocalAuth

Отказ от локальной проверки подлинности и обеспечение использования только MSI и AAD можно использовать исключительно для проверки подлинности.

disableLocalAuth?: boolean

Значение свойства

boolean

enableAnalyticalStorage

Пометка, указывающее, следует ли включить аналитику хранилища.

enableAnalyticalStorage?: boolean

Значение свойства

boolean

enableAutomaticFailover

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

enableAutomaticFailover?: boolean

Значение свойства

boolean

enableBurstCapacity

Флаг, указывающий включение и отключение функции емкости всплеска в учетной записи

enableBurstCapacity?: boolean

Значение свойства

boolean

enableCassandraConnector

Включает соединитель cassandra в учетной записи Cosmos DB C*

enableCassandraConnector?: boolean

Значение свойства

boolean

enableFreeTier

Пометка, чтобы указать, включен ли уровень "Бесплатный".

enableFreeTier?: boolean

Значение свойства

boolean

enableMultipleWriteLocations

Позволяет учетной записи записывать в нескольких расположениях

enableMultipleWriteLocations?: boolean

Значение свойства

boolean

enablePartitionMerge

Флаг, указывающий включение и отключение функции слияния секций в учетной записи

enablePartitionMerge?: boolean

Значение свойства

boolean

enablePerRegionPerPartitionAutoscale

Флаг, указывающий включение и отключение функции PerRegionPerPartitionAutoscale в учетной записи

enablePerRegionPerPartitionAutoscale?: boolean

Значение свойства

boolean

enablePriorityBasedExecution

Флаг, указывающий включение и отключение функции предварительной версии выполнения на основе приоритета в учетной записи

enablePriorityBasedExecution?: boolean

Значение свойства

boolean

identity

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

identity?: ManagedServiceIdentity

Значение свойства

ManagedServiceIdentity

ipRules

Список IpRules.

ipRules?: IpAddressOrRange[]

Значение свойства

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

Пометка, чтобы указать, следует ли включить или отключить правила ACL виртуальной сети.

isVirtualNetworkFilterEnabled?: boolean

Значение свойства

boolean

keysMetadata

Это свойство игнорируется во время операции обновления, так как метаданные доступны только для чтения. Объект представляет метаданные для ключей учетной записи Cosmos DB. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

keysMetadata?: DatabaseAccountKeysMetadata

Значение свойства

DatabaseAccountKeysMetadata

keyVaultKeyUri

Универсальный код ресурса (URI) хранилища ключей

keyVaultKeyUri?: string

Значение свойства

string

location

Расположение группы ресурсов, к которой принадлежит ресурс.

location?: string

Значение свойства

string

locations

Массив, содержащий расположения георепликации, включенные для учетной записи Cosmos DB.

locations?: Location[]

Значение свойства

Location[]

minimalTlsVersion

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

minimalTlsVersion?: string

Значение свойства

string

networkAclBypass

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

networkAclBypass?: NetworkAclBypass

Значение свойства

NetworkAclBypass

networkAclBypassResourceIds

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

networkAclBypassResourceIds?: string[]

Значение свойства

string[]

publicNetworkAccess

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

publicNetworkAccess?: string

Значение свойства

string

tags

Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать для просмотра и группировки этого ресурса (между группами ресурсов). Для ресурса может быть предоставлено не более 15 тегов. Каждый тег должен иметь ключ не более 128 символов и значения не более 256 символов. Например, интерфейс по умолчанию для типа шаблона задается с параметром defaultExperience: Cassandra. Текущие значения defaultExperience также включают table, Graph, DocumentDB и MongoDB.

tags?: {[propertyName: string]: string}

Значение свойства

{[propertyName: string]: string}

virtualNetworkRules

Список правил ACL виртуальной сети, настроенных для учетной записи Cosmos DB.

virtualNetworkRules?: VirtualNetworkRule[]

Значение свойства

VirtualNetworkRule[]