DatabaseAccountGetResults interface

Пакет:

@azure/arm-cosmosdb

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

Extends

ARMResourceProperties

Свойства

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

Унаследованные свойства

id	Уникальный идентификатор ресурса ARM. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
location	Расположение группы ресурсов, к которой принадлежит ресурс.
name	Имя ресурса ARM. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать для просмотра и группировки этого ресурса (между группами ресурсов). Для ресурса может быть предоставлено не более 15 тегов. Каждый тег должен иметь ключ не более 128 символов и значения не более 256 символов. Например, интерфейс по умолчанию для типа шаблона задается с параметром defaultExperience: Cassandra. Текущие значения defaultExperience также включают table, Graph, DocumentDB и MongoDB.
type	Тип ресурса Azure. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

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

analyticalStorageConfiguration

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

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

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

AnalyticalStorageConfiguration

apiProperties

Определенные свойства API.

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[]

createMode

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

createMode?: string

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

string

customerManagedKeyStatus

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

customerManagedKeyStatus?: string

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

string

databaseAccountOfferType

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

databaseAccountOfferType?: "Standard"

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

"Standard"

defaultIdentity

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

defaultIdentity?: string

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

string

defaultPriorityLevel

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

defaultPriorityLevel?: string

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

string

disableKeyBasedMetadataWriteAccess

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

disableKeyBasedMetadataWriteAccess?: boolean

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

boolean

disableLocalAuth

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

disableLocalAuth?: boolean

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

boolean

documentEndpoint

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

documentEndpoint?: string

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

string

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

failoverPolicies

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

failoverPolicies?: FailoverPolicy[]

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

FailoverPolicy[]

identity

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

identity?: ManagedServiceIdentity

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

ManagedServiceIdentity

instanceId

Уникальный идентификатор, назначенный учетной записи базы данных ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

instanceId?: string

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

string

ipRules

Список IpRules.

ipRules?: IpAddressOrRange[]

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

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

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

isVirtualNetworkFilterEnabled?: boolean

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

boolean

keysMetadata

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

keysMetadata?: DatabaseAccountKeysMetadata

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

DatabaseAccountKeysMetadata

keyVaultKeyUri

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

keyVaultKeyUri?: string

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

string

keyVaultKeyUriVersion

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

keyVaultKeyUriVersion?: string

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

string

kind

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

kind?: 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[]

privateEndpointConnections

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

privateEndpointConnections?: PrivateEndpointConnection[]

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

PrivateEndpointConnection[]

provisioningState

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

provisioningState?: string

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

string

publicNetworkAccess

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

publicNetworkAccess?: string

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

string

readLocations

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

readLocations?: Location[]

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

Location[]

restoreParameters

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

restoreParameters?: RestoreParameters

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

RestoreParameters

systemData

Системные метаданные, относящиеся к этому ресурсу. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

systemData?: SystemData

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

SystemData

virtualNetworkRules

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

virtualNetworkRules?: VirtualNetworkRule[]

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

VirtualNetworkRule[]

writeLocations

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

writeLocations?: Location[]

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

Location[]

Сведения об унаследованном свойстве

id

Уникальный идентификатор ресурса ARM. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

id?: string

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

string

унаследован отARMResourceProperties.id

location

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

location?: string

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

string

наследуется отARMResourceProperties.location

name

Имя ресурса ARM. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

name?: string

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

string

унаследовано отARMResourceProperties.name

tags

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

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

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

{[propertyName: string]: string}

унаследовано отARMResourceProperties.tags

type

Тип ресурса Azure. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.

type?: string

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

string

Наследуется отARMResourceProperties.type