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


CosmosClientOptions interface

Свойства

aadCredentials

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

agent

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

connectionPolicy

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

consistencyLevel

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

defaultHeaders
diagnosticLevel
endpoint

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

key

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

permissionFeed

Массив объектов Permission .

resourceTokens

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

tokenProvider

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

userAgentSuffix

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

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

aadCredentials

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

aadCredentials?: TokenCredential

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

agent

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

agent?: Agent

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

connectionPolicy

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

connectionPolicy?: ConnectionPolicy

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

consistencyLevel

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

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

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

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

defaultHeaders

defaultHeaders?: CosmosHeaders_2

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

CosmosHeaders_2

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

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

endpoint

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

endpoint: string

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

string

key

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

key?: string

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

string

permissionFeed

Массив объектов Permission .

permissionFeed?: PermissionDefinition[]

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

resourceTokens

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

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

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

{[resourcePath: string]: string}

tokenProvider

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

tokenProvider?: TokenProvider

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

userAgentSuffix

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

userAgentSuffix?: string

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

string