ServiceFabricClientGetClusterHealthUsingPolicyOptionalParams interface

패키지:

@azure/servicefabric

선택적 매개 변수입니다.

Extends

RequestOptionsBase

속성

applicationsHealthStateFilter	상태 상태에 따라 클러스터 상태 쿼리의 결과로 반환된 애플리케이션 상태 개체를 필터링할 수 있습니다. 이 매개 변수의 가능한 값에는 멤버에서 가져온 정수 값이나 HealthStateFilter 열거형의 멤버에 대한 비트 연산이 포함됩니다. 필터와 일치하는 애플리케이션만 반환됩니다. 모든 애플리케이션은 집계된 상태를 평가하는 데 사용됩니다. 지정하지 않으면 모든 항목이 반환됩니다. 상태 값은 플래그 기반 열거형이므로 값은 비트 OR 연산자를 사용하여 얻은 이러한 값의 조합일 수 있습니다. 예를 들어 제공된 값이 6이면 HealthState 값이 OK(2) 및 Warning(4)인 애플리케이션의 상태가 반환됩니다. 기본값 - 기본값입니다. HealthState와 일치합니다. 값이 0입니다. 없음 - HealthState 값과 일치하지 않는 필터입니다. 지정된 상태 컬렉션에 대한 결과를 반환하지 않는 데 사용됩니다. 값은 1입니다. Ok - HealthState 값 Ok와 입력과 일치하는 필터입니다. 값은 2입니다. 경고 - HealthState 값 경고와 입력과 일치하는 필터입니다. 값은 4입니다. 오류 - HealthState 값 오류와 입력과 일치하는 필터입니다. 값은 8입니다. All - HealthState 값과 입력을 일치시키는 필터입니다. 값은 65535입니다. 기본값: 0.
clusterHealthPolicies	클러스터 상태를 평가하는 데 사용되는 상태 정책을 설명합니다. 상태 평가가 없는 경우 클러스터 매니페스트 또는 기본 클러스터 상태 정책에 정의된 클러스터 상태 정책을 사용합니다. 기본적으로 매니페스트에 정의된 정책이 없는 경우 각 애플리케이션은 애플리케이션 매니페스트 또는 기본 상태 정책에 정의된 특정 애플리케이션 상태 정책을 사용하여 평가됩니다. 애플리케이션 상태 정책 맵이 지정되고 애플리케이션에 대한 항목이 있는 경우 지정된 애플리케이션 상태 정책을 사용하여 애플리케이션 상태를 평가합니다.
eventsHealthStateFilter	상태 상태에 따라 반환된 HealthEvent 개체의 컬렉션을 필터링할 수 있습니다. 이 매개 변수의 가능한 값에는 다음 상태 중 하나의 정수 값이 포함됩니다. 필터와 일치하는 이벤트만 반환됩니다. 모든 이벤트는 집계된 상태를 평가하는 데 사용됩니다. 지정하지 않으면 모든 항목이 반환됩니다. 상태 값은 플래그 기반 열거형이므로 값은 비트 'OR' 연산자를 사용하여 가져온 이러한 값의 조합일 수 있습니다. 예를 들어 제공된 값이 6이면 HealthState 값이 OK(2) 및 Warning(4)인 모든 이벤트가 반환됩니다. 기본값 - 기본값입니다. HealthState와 일치합니다. 값이 0입니다. 없음 - HealthState 값과 일치하지 않는 필터입니다. 지정된 상태 컬렉션에 대한 결과를 반환하지 않는 데 사용됩니다. 값은 1입니다. Ok - HealthState 값 Ok와 입력과 일치하는 필터입니다. 값은 2입니다. 경고 - HealthState 값 경고와 입력과 일치하는 필터입니다. 값은 4입니다. 오류 - HealthState 값 오류와 입력과 일치하는 필터입니다. 값은 8입니다. All - HealthState 값과 입력을 일치시키는 필터입니다. 값은 65535입니다. 기본값: 0.
excludeHealthStatistics	상태 통계를 쿼리 결과의 일부로 반환해야 하는지 여부를 나타냅니다. 기본적으로 False입니다. 통계는 상태 확인, 경고 및 오류의 자식 엔터티 수를 보여 줍니다. 기본값: false.
includeSystemApplicationHealthStatistics	상태 통계에 fabric:/System 애플리케이션 상태 통계가 포함되어야 하는지 여부를 나타냅니다. 기본적으로 False입니다. IncludeSystemApplicationHealthStatistics가 true로 설정된 경우 상태 통계에는 패브릭:/System 애플리케이션에 속하는 엔터티가 포함됩니다. 그렇지 않으면 쿼리 결과에는 사용자 애플리케이션에 대한 상태 통계만 포함됩니다. 이 매개 변수를 적용하려면 상태 통계를 쿼리 결과에 포함해야 합니다. 기본값: false.
nodesHealthStateFilter	상태 상태에 따라 클러스터 상태 쿼리의 결과로 반환된 노드 상태 개체를 필터링할 수 있습니다. 이 매개 변수의 가능한 값에는 다음 상태 중 하나의 정수 값이 포함됩니다. 필터와 일치하는 노드만 반환됩니다. 모든 노드는 집계된 상태를 평가하는 데 사용됩니다. 지정하지 않으면 모든 항목이 반환됩니다. 상태 값은 플래그 기반 열거형이므로 값은 비트 OR 연산자를 사용하여 얻은 이러한 값의 조합일 수 있습니다. 예를 들어 제공된 값이 6이면 HealthState 값이 OK(2) 및 Warning(4)인 노드의 상태가 반환됩니다. 기본값 - 기본값입니다. HealthState와 일치합니다. 값이 0입니다. 없음 - HealthState 값과 일치하지 않는 필터입니다. 지정된 상태 컬렉션에 대한 결과를 반환하지 않는 데 사용됩니다. 값은 1입니다. Ok - HealthState 값 Ok와 입력과 일치하는 필터입니다. 값은 2입니다. 경고 - HealthState 값 경고와 입력과 일치하는 필터입니다. 값은 4입니다. 오류 - HealthState 값 오류와 입력과 일치하는 필터입니다. 값은 8입니다. All - HealthState 값과 입력을 일치시키는 필터입니다. 값은 65535입니다. 기본값: 0.
timeoutParameter	작업을 수행하기 위한 서버 시간 제한(초)입니다. 이 시간 제한은 클라이언트가 요청된 작업이 완료되기를 기다리는 기간을 지정합니다. 이 매개 변수의 기본값은 60초입니다. 기본값: 60.

상속된 속성

abortSignal	요청을 중단하는 데 사용할 수 있는 신호입니다.
customHeaders	요청을 보내기 전에 적용할 사용자 정의 사용자 지정 요청 헤더입니다.
onDownloadProgress	다운로드 진행 시 발생하는 콜백입니다.
onUploadProgress	업로드 진행률에 따라 발생하는 콜백입니다.
timeout	요청이 자동으로 종료되기 전에 걸릴 수 있는 시간(밀리초)입니다.

속성 세부 정보

applicationsHealthStateFilter

상태 상태에 따라 클러스터 상태 쿼리의 결과로 반환된 애플리케이션 상태 개체를 필터링할 수 있습니다. 이 매개 변수의 가능한 값에는 멤버에서 가져온 정수 값이나 HealthStateFilter 열거형의 멤버에 대한 비트 연산이 포함됩니다. 필터와 일치하는 애플리케이션만 반환됩니다. 모든 애플리케이션은 집계된 상태를 평가하는 데 사용됩니다. 지정하지 않으면 모든 항목이 반환됩니다. 상태 값은 플래그 기반 열거형이므로 값은 비트 OR 연산자를 사용하여 얻은 이러한 값의 조합일 수 있습니다. 예를 들어 제공된 값이 6이면 HealthState 값이 OK(2) 및 Warning(4)인 애플리케이션의 상태가 반환됩니다.

• 기본값 - 기본값입니다. HealthState와 일치합니다. 값이 0입니다.
• 없음 - HealthState 값과 일치하지 않는 필터입니다. 지정된 상태 컬렉션에 대한 결과를 반환하지 않는 데 사용됩니다. 값은 1입니다.
• Ok - HealthState 값 Ok와 입력과 일치하는 필터입니다. 값은 2입니다.
• 경고 - HealthState 값 경고와 입력과 일치하는 필터입니다. 값은 4입니다.
• 오류 - HealthState 값 오류와 입력과 일치하는 필터입니다. 값은 8입니다.
• All - HealthState 값과 입력을 일치시키는 필터입니다. 값은 65535입니다. 기본값: 0.

applicationsHealthStateFilter?: number

속성 값

number

clusterHealthPolicies

클러스터 상태를 평가하는 데 사용되는 상태 정책을 설명합니다. 상태 평가가 없는 경우 클러스터 매니페스트 또는 기본 클러스터 상태 정책에 정의된 클러스터 상태 정책을 사용합니다. 기본적으로 매니페스트에 정의된 정책이 없는 경우 각 애플리케이션은 애플리케이션 매니페스트 또는 기본 상태 정책에 정의된 특정 애플리케이션 상태 정책을 사용하여 평가됩니다. 애플리케이션 상태 정책 맵이 지정되고 애플리케이션에 대한 항목이 있는 경우 지정된 애플리케이션 상태 정책을 사용하여 애플리케이션 상태를 평가합니다.

clusterHealthPolicies?: ClusterHealthPolicies

속성 값

ClusterHealthPolicies

eventsHealthStateFilter

상태 상태에 따라 반환된 HealthEvent 개체의 컬렉션을 필터링할 수 있습니다. 이 매개 변수의 가능한 값에는 다음 상태 중 하나의 정수 값이 포함됩니다. 필터와 일치하는 이벤트만 반환됩니다. 모든 이벤트는 집계된 상태를 평가하는 데 사용됩니다. 지정하지 않으면 모든 항목이 반환됩니다. 상태 값은 플래그 기반 열거형이므로 값은 비트 'OR' 연산자를 사용하여 가져온 이러한 값의 조합일 수 있습니다. 예를 들어 제공된 값이 6이면 HealthState 값이 OK(2) 및 Warning(4)인 모든 이벤트가 반환됩니다.

• 기본값 - 기본값입니다. HealthState와 일치합니다. 값이 0입니다.
• 없음 - HealthState 값과 일치하지 않는 필터입니다. 지정된 상태 컬렉션에 대한 결과를 반환하지 않는 데 사용됩니다. 값은 1입니다.
• Ok - HealthState 값 Ok와 입력과 일치하는 필터입니다. 값은 2입니다.
• 경고 - HealthState 값 경고와 입력과 일치하는 필터입니다. 값은 4입니다.
• 오류 - HealthState 값 오류와 입력과 일치하는 필터입니다. 값은 8입니다.
• All - HealthState 값과 입력을 일치시키는 필터입니다. 값은 65535입니다. 기본값: 0.

eventsHealthStateFilter?: number

속성 값

number

excludeHealthStatistics

상태 통계를 쿼리 결과의 일부로 반환해야 하는지 여부를 나타냅니다. 기본적으로 False입니다. 통계는 상태 확인, 경고 및 오류의 자식 엔터티 수를 보여 줍니다. 기본값: false.

excludeHealthStatistics?: boolean

속성 값

boolean

includeSystemApplicationHealthStatistics

상태 통계에 fabric:/System 애플리케이션 상태 통계가 포함되어야 하는지 여부를 나타냅니다. 기본적으로 False입니다. IncludeSystemApplicationHealthStatistics가 true로 설정된 경우 상태 통계에는 패브릭:/System 애플리케이션에 속하는 엔터티가 포함됩니다. 그렇지 않으면 쿼리 결과에는 사용자 애플리케이션에 대한 상태 통계만 포함됩니다. 이 매개 변수를 적용하려면 상태 통계를 쿼리 결과에 포함해야 합니다. 기본값: false.

includeSystemApplicationHealthStatistics?: boolean

속성 값

boolean

nodesHealthStateFilter

상태 상태에 따라 클러스터 상태 쿼리의 결과로 반환된 노드 상태 개체를 필터링할 수 있습니다. 이 매개 변수의 가능한 값에는 다음 상태 중 하나의 정수 값이 포함됩니다. 필터와 일치하는 노드만 반환됩니다. 모든 노드는 집계된 상태를 평가하는 데 사용됩니다. 지정하지 않으면 모든 항목이 반환됩니다. 상태 값은 플래그 기반 열거형이므로 값은 비트 OR 연산자를 사용하여 얻은 이러한 값의 조합일 수 있습니다. 예를 들어 제공된 값이 6이면 HealthState 값이 OK(2) 및 Warning(4)인 노드의 상태가 반환됩니다.

• 기본값 - 기본값입니다. HealthState와 일치합니다. 값이 0입니다.
• 없음 - HealthState 값과 일치하지 않는 필터입니다. 지정된 상태 컬렉션에 대한 결과를 반환하지 않는 데 사용됩니다. 값은 1입니다.
• Ok - HealthState 값 Ok와 입력과 일치하는 필터입니다. 값은 2입니다.
• 경고 - HealthState 값 경고와 입력과 일치하는 필터입니다. 값은 4입니다.
• 오류 - HealthState 값 오류와 입력과 일치하는 필터입니다. 값은 8입니다.
• All - HealthState 값과 입력을 일치시키는 필터입니다. 값은 65535입니다. 기본값: 0.

nodesHealthStateFilter?: number

속성 값

number

timeoutParameter

작업을 수행하기 위한 서버 시간 제한(초)입니다. 이 시간 제한은 클라이언트가 요청된 작업이 완료되기를 기다리는 기간을 지정합니다. 이 매개 변수의 기본값은 60초입니다. 기본값: 60.

timeoutParameter?: number

속성 값

number

상속된 속성 세부 정보

abortSignal

요청을 중단하는 데 사용할 수 있는 신호입니다.

abortSignal?: AbortSignalLike

속성 값

AbortSignalLike

msRest.RequestOptionsBase.abortSignal에서 상속된

customHeaders

요청을 보내기 전에 적용할 사용자 정의 사용자 지정 요청 헤더입니다.

customHeaders?: {[key: string]: string}

속성 값

{[key: string]: string}

msRest.RequestOptionsBase.customHeaders에서 상속된

onDownloadProgress

다운로드 진행 시 발생하는 콜백입니다.

onDownloadProgress?: (progress: TransferProgressEvent) => void

속성 값

(progress: TransferProgressEvent) => void

msRest.RequestOptionsBase.onDownloadProgress에서 상속됨

onUploadProgress

업로드 진행률에 따라 발생하는 콜백입니다.

onUploadProgress?: (progress: TransferProgressEvent) => void

속성 값

(progress: TransferProgressEvent) => void

msRest.RequestOptionsBase.onUploadProgress에서 상속된

timeout

요청이 자동으로 종료되기 전에 걸릴 수 있는 시간(밀리초)입니다.

timeout?: number

속성 값

number

msRest.RequestOptionsBase.timeout에서 상속된