CosmosClientOptions interface

Пакет:

@azure/cosmos

Свойства

aadCredentials	Маркер AAD из @azure/identity получить объект учетных данных, создав объект учетных данных @azure/identity, затем мы будем использовать объект учетных данных и URL-адрес области (конечная точка cosmos db) для проверки подлинности запросов в Cosmos
agent	Необязательный пользовательский агент http(s) для использования в средах NodeJS Используйте агент, например, https://github.com/TooTallNate/node-proxy-agent если вам нужно подключиться к Cosmos через прокси-сервер
clientEncryptionOptions	Политика шифрования для операций, связанных с шифрованием, должна быть задана на клиенте, если используется шифрование на стороне клиента Смотрите ClientEncryptionOptions
connectionPolicy	Экземпляр класса ConnectionPolicy. Этот параметр является необязательным, и значение по умолчанию connectionPolicy будет использоваться при опущении.
connectionString	Необязательный параметр, представляющий строку подключения. Строку подключения к базе данных можно найти на портале Azure.
consistencyLevel	Необязательный параметр, представляющий уровень согласованности. Оно может принимать любое значение из ConsistencyLevel.
defaultHeaders
diagnosticLevel
endpoint	Конечная точка службы, используемая для создания клиента.
httpClient	Необязательная настраиваемая HttpClient фигура для настройки того, как запросы выполняются конвейером HTTP. Дополнительные сведения о реализации этого интерфейса см. в @azure/core-rest-pipeline.
key	Главный или чтение ключа учетной записи
permissionFeed	Массив объектов разрешения.
resourceTokens	Объект, содержащий маркеры ресурсов. Ключи для объекта — это идентификаторы ресурсов и значения— маркеры ресурсов.
throughputBucket	Необязательный параметр для установки номера контейнера пропускной способности. Это значение можно переопределить на уровне запроса Дополнительные сведения см. в разделе Сегментирование пропускной способности Cosmos DB.
tokenProvider	Пользователь предоставил функцию для разрешения маркеров авторизации заголовка. Позволяет пользователям создавать собственные маркеры проверки подлинности, потенциально используя отдельную службу.
userAgentSuffix	Настраиваемая строка для добавления к агенту пользователя пакета SDK по умолчанию.

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

aadCredentials

Маркер AAD из @azure/identity получить объект учетных данных, создав объект учетных данных @azure/identity, затем мы будем использовать объект учетных данных и URL-адрес области (конечная точка cosmos db) для проверки подлинности запросов в Cosmos

aadCredentials?: TokenCredential

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

TokenCredential

agent

Необязательный пользовательский агент http(s) для использования в средах NodeJS Используйте агент, например, https://github.com/TooTallNate/node-proxy-agent если вам нужно подключиться к Cosmos через прокси-сервер

agent?: Agent

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

Agent

clientEncryptionOptions

Политика шифрования для операций, связанных с шифрованием, должна быть задана на клиенте, если используется шифрование на стороне клиента

Смотрите ClientEncryptionOptions

clientEncryptionOptions?: ClientEncryptionOptions

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

ClientEncryptionOptions

connectionPolicy

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

connectionPolicy?: ConnectionPolicy

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

ConnectionPolicy

connectionString

Необязательный параметр, представляющий строку подключения. Строку подключения к базе данных можно найти на портале Azure.

connectionString?: string

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

string

consistencyLevel

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

consistencyLevel?: "Strong" | "BoundedStaleness" | "Session" | "Eventual" | "ConsistentPrefix"

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

"Strong" | "BoundedStaleness" | "Session" | "Eventual" | "ConsistentPrefix"

defaultHeaders

defaultHeaders?: CosmosHeaders

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

CosmosHeaders

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

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

CosmosDbDiagnosticLevel

endpoint

Конечная точка службы, используемая для создания клиента.

endpoint?: string

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

string

httpClient

Необязательная настраиваемая HttpClient фигура для настройки того, как запросы выполняются конвейером HTTP. Дополнительные сведения о реализации этого интерфейса см. в @azure/core-rest-pipeline.

httpClient?: HttpClient

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

HttpClient

key

Главный или чтение ключа учетной записи

key?: string

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

string

permissionFeed

Массив объектов разрешения.

permissionFeed?: PermissionDefinition[]

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

PermissionDefinition[]

resourceTokens

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

resourceTokens?: {[resourcePath: string]: string}

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

{[resourcePath: string]: string}

throughputBucket

Необязательный параметр для установки номера контейнера пропускной способности. Это значение можно переопределить на уровне запроса Дополнительные сведения см. в разделе Сегментирование пропускной способности Cosmos DB.

throughputBucket?: number

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

number

tokenProvider

Пользователь предоставил функцию для разрешения маркеров авторизации заголовка. Позволяет пользователям создавать собственные маркеры проверки подлинности, потенциально используя отдельную службу.

tokenProvider?: TokenProvider

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

TokenProvider

userAgentSuffix

Настраиваемая строка для добавления к агенту пользователя пакета SDK по умолчанию.

userAgentSuffix?: string

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

string