CosmosClientOptions interface

패키지:

@azure/cosmos

속성

aadCredentials	@azure/identity AAD 토큰 @azure/identity 자격 증명 개체를 만들어 자격 증명 개체를 가져옵니다. 그러면 자격 증명 개체와 범위 URL(cosmos db 엔드포인트)을 사용하여 Cosmos에 대한 요청을 인증합니다.
agent	NodeJS 환경에서 사용할 선택적 사용자 지정 http(s) 에이전트 프록시를 통해 Cosmos에 연결해야 하는 경우와 https://github.com/TooTallNate/node-proxy-agent 같은 에이전트 사용
clientEncryptionOptions	클라이언트 측 암호화를 사용하는 경우 암호화와 관련된 작업에 대한 암호화 정책을 클라이언트에서 설정해야 합니다. ClientEncryptionOptions를 참조하십시오.
connectionPolicy	ConnectionPolicy 클래스의 인스턴스입니다. 이 매개 변수는 선택 사항이며 생략하면 기본 connectionPolicy가 사용됩니다.
connectionString	연결 문자열을 나타내는 선택적 매개 변수입니다. 데이터베이스 연결 문자열은 Azure Portal에서 찾을 수 있습니다.
consistencyLevel	일관성 수준을 나타내는 선택적 매개 변수입니다. ConsistencyLevel값을 사용할 수 있습니다.
defaultHeaders
diagnosticLevel
endpoint	클라이언트를 만드는 데 사용할 서비스 엔드포인트입니다.
httpClient	HTTP 파이프라인에서 요청을 하는 방법을 사용자 지정하는 선택적 사용자 지정 HttpClient 셰이프입니다. 이 인터페이스를 구현하는 방법에 대한 자세한 내용은 @azure/core-rest-pipeline 참조하세요.
key	계정 마스터 또는 읽기 전용 키
permissionFeed	Permission 개체의 배열입니다.
resourceTokens	리소스 토큰을 포함하는 개체입니다. 개체의 키는 리소스 ID이고 값은 리소스 토큰입니다.
throughputBucket	처리량 버킷 번호를 설정하는 선택적 파라미터입니다. 이 값은 요청 수준에서 재정의할 수 있습니다. 자세한 내용은 Cosmos DB 처리량 버킷팅을 참조하세요.
tokenProvider	헤더 권한 부여 토큰을 확인하기 위한 사용자 제공 함수입니다. 사용자가 별도의 서비스를 사용하여 자체 인증 토큰을 생성할 수 있습니다.
userAgentSuffix	기본 SDK 사용자 에이전트에 추가할 사용자 지정 문자열입니다.

속성 세부 정보

aadCredentials

@azure/identity AAD 토큰 @azure/identity 자격 증명 개체를 만들어 자격 증명 개체를 가져옵니다. 그러면 자격 증명 개체와 범위 URL(cosmos db 엔드포인트)을 사용하여 Cosmos에 대한 요청을 인증합니다.

aadCredentials?: TokenCredential

속성 값

TokenCredential

agent

NodeJS 환경에서 사용할 선택적 사용자 지정 http(s) 에이전트 프록시를 통해 Cosmos에 연결해야 하는 경우와 https://github.com/TooTallNate/node-proxy-agent 같은 에이전트 사용

agent?: Agent

속성 값

Agent

clientEncryptionOptions

클라이언트 측 암호화를 사용하는 경우 암호화와 관련된 작업에 대한 암호화 정책을 클라이언트에서 설정해야 합니다.

ClientEncryptionOptions를 참조하십시오.

clientEncryptionOptions?: ClientEncryptionOptions

속성 값

ClientEncryptionOptions

connectionPolicy

ConnectionPolicy 클래스의 인스턴스입니다. 이 매개 변수는 선택 사항이며 생략하면 기본 connectionPolicy가 사용됩니다.

connectionPolicy?: ConnectionPolicy

속성 값

ConnectionPolicy

connectionString

연결 문자열을 나타내는 선택적 매개 변수입니다. 데이터베이스 연결 문자열은 Azure Portal에서 찾을 수 있습니다.

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

HTTP 파이프라인에서 요청을 하는 방법을 사용자 지정하는 선택적 사용자 지정 HttpClient 셰이프입니다. 이 인터페이스를 구현하는 방법에 대한 자세한 내용은 @azure/core-rest-pipeline 참조하세요.

httpClient?: HttpClient

속성 값

HttpClient

key

계정 마스터 또는 읽기 전용 키

key?: string

속성 값

string

permissionFeed

Permission 개체의 배열입니다.

permissionFeed?: PermissionDefinition[]

속성 값

PermissionDefinition[]

resourceTokens

리소스 토큰을 포함하는 개체입니다. 개체의 키는 리소스 ID이고 값은 리소스 토큰입니다.

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

속성 값

{[resourcePath: string]: string}

throughputBucket

처리량 버킷 번호를 설정하는 선택적 파라미터입니다. 이 값은 요청 수준에서 재정의할 수 있습니다. 자세한 내용은 Cosmos DB 처리량 버킷팅을 참조하세요.

throughputBucket?: number

속성 값

number

tokenProvider

헤더 권한 부여 토큰을 확인하기 위한 사용자 제공 함수입니다. 사용자가 별도의 서비스를 사용하여 자체 인증 토큰을 생성할 수 있습니다.

tokenProvider?: TokenProvider

속성 값

TokenProvider

userAgentSuffix

기본 SDK 사용자 에이전트에 추가할 사용자 지정 문자열입니다.

userAgentSuffix?: string

속성 값

string