CosmosClientOptions interface
Свойства
aad |
Маркер AAD из |
agent | Необязательный настраиваемый агент HTTP(s) для использования в enironments NodeJS. Используйте агент, https://github.com/TooTallNate/node-proxy-agent например, если необходимо подключиться к Cosmos через прокси-сервер. |
connection |
Экземпляр класса ConnectionPolicy . Этот параметр является необязательным, и если он опущен, будет использоваться connectionPolicy по умолчанию. |
consistency |
Необязательный параметр, представляющий уровень согласованности. Он может принимать любое значение из ConsistencyLevel. |
default |
|
diagnostic |
|
endpoint | Конечная точка службы, используемая для создания клиента. |
key | Главный ключ учетной записи или ключ только для чтения |
permission |
Массив объектов Permission . |
resource |
Объект , содержащий маркеры ресурсов. Ключи для объекта — это идентификаторы ресурсов, а значения — это маркеры ресурсов. |
token |
Предоставленная пользователем функция для разрешения маркеров авторизации заголовков. Позволяет пользователям создавать собственные маркеры проверки подлинности, потенциально используя отдельную службу. |
user |
Настраиваемая строка, добавляемая к агенту пользователя пакета 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
endpoint
Конечная точка службы, используемая для создания клиента.
endpoint: string
Значение свойства
string
key
Главный ключ учетной записи или ключ только для чтения
key?: string
Значение свойства
string
permissionFeed
resourceTokens
Объект , содержащий маркеры ресурсов. Ключи для объекта — это идентификаторы ресурсов, а значения — это маркеры ресурсов.
resourceTokens?: {[resourcePath: string]: string}
Значение свойства
{[resourcePath: string]: string}
tokenProvider
Предоставленная пользователем функция для разрешения маркеров авторизации заголовков. Позволяет пользователям создавать собственные маркеры проверки подлинности, потенциально используя отдельную службу.
tokenProvider?: TokenProvider
Значение свойства
userAgentSuffix
Настраиваемая строка, добавляемая к агенту пользователя пакета SDK по умолчанию.
userAgentSuffix?: string
Значение свойства
string