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

CosmosClientOptions interface

  • Ссылка
Пакет:
@azure/cosmos

Свойства

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

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

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

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

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

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

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

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

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

aadCredentials

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

aadCredentials?: TokenCredential

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

TokenCredential

agent

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

agent?: Agent

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

Agent

connectionPolicy

Экземпляр класса 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

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

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}

tokenProvider

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

tokenProvider?: TokenProvider

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

TokenProvider

userAgentSuffix

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

userAgentSuffix?: string

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

string