CosmosClientOptions interface
Свойства
aad |
Маркер AAD из |
agent | Необязательный пользовательский агент http(s) для использования в средах NodeJS Используйте агент, например, https://github.com/TooTallNate/node-proxy-agent если вам нужно подключиться к Cosmos через прокси-сервер |
client |
Политика шифрования для операций, связанных с шифрованием, должна быть задана на клиенте, если используется шифрование на стороне клиента Смотрите ClientEncryptionOptions |
connection |
Экземпляр класса ConnectionPolicy. Этот параметр является необязательным, и значение по умолчанию connectionPolicy будет использоваться при опущении. |
connection |
Необязательный параметр, представляющий строку подключения. Строку подключения к базе данных можно найти на портале Azure. |
consistency |
Необязательный параметр, представляющий уровень согласованности. Оно может принимать любое значение из ConsistencyLevel. |
default |
|
diagnostic |
|
endpoint | Конечная точка службы, используемая для создания клиента. |
http |
Необязательная настраиваемая |
key | Главный или чтение ключа учетной записи |
permission |
Массив объектов разрешения. |
resource |
Объект, содержащий маркеры ресурсов. Ключи для объекта — это идентификаторы ресурсов и значения— маркеры ресурсов. |
throughput |
Необязательный параметр для установки номера контейнера пропускной способности. Это значение можно переопределить на уровне запроса Дополнительные сведения см. в разделе Сегментирование пропускной способности Cosmos DB. |
token |
Пользователь предоставил функцию для разрешения маркеров авторизации заголовка. Позволяет пользователям создавать собственные маркеры проверки подлинности, потенциально используя отдельную службу. |
user |
Настраиваемая строка для добавления к агенту пользователя пакета SDK по умолчанию. |
Сведения о свойстве
aadCredentials
Маркер AAD из @azure/identity
получить объект учетных данных, создав объект учетных данных @azure/identity
, затем мы будем использовать объект учетных данных и URL-адрес области (конечная точка cosmos db) для проверки подлинности запросов в Cosmos
aadCredentials?: TokenCredential
Значение свойства
agent
Необязательный пользовательский агент http(s) для использования в средах NodeJS Используйте агент, например, https://github.com/TooTallNate/node-proxy-agent если вам нужно подключиться к Cosmos через прокси-сервер
agent?: Agent
Значение свойства
clientEncryptionOptions
Политика шифрования для операций, связанных с шифрованием, должна быть задана на клиенте, если используется шифрование на стороне клиента
Смотрите ClientEncryptionOptions
clientEncryptionOptions?: ClientEncryptionOptions
Значение свойства
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
endpoint
Конечная точка службы, используемая для создания клиента.
endpoint?: string
Значение свойства
string
httpClient
Необязательная настраиваемая HttpClient
фигура для настройки того, как запросы выполняются конвейером HTTP.
Дополнительные сведения о реализации этого интерфейса см. в @azure/core-rest-pipeline
.
httpClient?: HttpClient
Значение свойства
key
Главный или чтение ключа учетной записи
key?: string
Значение свойства
string
permissionFeed
resourceTokens
Объект, содержащий маркеры ресурсов. Ключи для объекта — это идентификаторы ресурсов и значения— маркеры ресурсов.
resourceTokens?: {[resourcePath: string]: string}
Значение свойства
{[resourcePath: string]: string}
throughputBucket
Необязательный параметр для установки номера контейнера пропускной способности. Это значение можно переопределить на уровне запроса Дополнительные сведения см. в разделе Сегментирование пропускной способности Cosmos DB.
throughputBucket?: number
Значение свойства
number
tokenProvider
Пользователь предоставил функцию для разрешения маркеров авторизации заголовка. Позволяет пользователям создавать собственные маркеры проверки подлинности, потенциально используя отдельную службу.
tokenProvider?: TokenProvider
Значение свойства
userAgentSuffix
Настраиваемая строка для добавления к агенту пользователя пакета SDK по умолчанию.
userAgentSuffix?: string
Значение свойства
string