SearchService interface

패키지:

@azure/arm-search

Azure Cognitive Search 서비스 및 현재 상태를 설명합니다.

Extends

TrackedResource

속성

authOptions	검색 서비스의 데이터 평면 API가 요청을 인증하는 방법에 대한 옵션을 정의합니다. 'disableLocalAuth'가 true로 설정된 경우 설정할 수 없습니다.
disableLocalAuth	true로 설정하면 검색 서비스에 대한 호출이 인증을 위해 API 키를 활용하는 것이 허용되지 않습니다. 'dataPlaneAuthOptions'가 정의된 경우 true로 설정할 수 없습니다.
encryptionWithCmk	검색 서비스 내에서 고객 관리자 키를 사용하여 리소스 암호화(예: 인덱스)에 대한 정책을 지정합니다.
hostingMode	standard3 SKU에만 적용됩니다. 최대 1,000개의 인덱스를 허용하는 최대 3개의 고밀도 파티션을 사용하도록 이 속성을 설정할 수 있습니다. 이는 다른 SKU에 허용되는 최대 인덱스보다 훨씬 높습니다. standard3 SKU의 경우 값은 'default' 또는 'highDensity'입니다. 다른 모든 SKU의 경우 이 값은 'default'여야 합니다.
identity	리소스의 ID입니다.
networkRuleSet	Azure Cognitive Search 서비스에 도달하는 방법을 결정하는 네트워크별 규칙입니다.
partitionCount	검색 서비스의 파티션 수입니다. 지정된 경우 1, 2, 3, 4, 6 또는 12일 수 있습니다. 1보다 큰 값은 표준 SKU에만 유효합니다. hostingMode가 'highDensity'로 설정된 'standard3' 서비스의 경우 허용되는 값은 1에서 3 사이입니다.
privateEndpointConnections	Azure Cognitive Search 서비스에 대한 프라이빗 엔드포인트 연결 목록입니다. 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.
provisioningState	검색 서비스에서 수행된 마지막 프로비전 작업의 상태입니다. 프로비저닝은 서비스 용량을 설정하는 동안 발생하는 중간 상태입니다. 용량이 설정되면 provisioningState가 '성공' 또는 '실패'로 변경됩니다. 클라이언트 애플리케이션은 검색 서비스 가져오기 작업을 사용하여 프로비저닝 상태 폴링할 수 있습니다(권장 폴링 간격은 30초에서 1분). 무료 서비스를 사용하는 경우 이 값은 검색 서비스 만들기 호출에서 직접 '성공'으로 돌아오는 경향이 있습니다. 이는 무료 서비스가 이미 설정된 용량을 사용하기 때문입니다. 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.
publicNetworkAccess	이 값은 기존 고객 리소스 및 템플릿의 호환성이 손상되는 변경을 방지하기 위해 '사용'으로 설정할 수 있습니다. 'disabled'로 설정하면 공용 인터페이스를 통해 트래픽이 허용되지 않으며 프라이빗 엔드포인트 연결은 배타적 액세스 방법이 됩니다.
replicaCount	검색 서비스의 복제본 수입니다. 지정된 경우 표준 SKU의 경우 1에서 12 사이의 값이거나 기본 SKU의 경우 1에서 3 사이의 값이어야 합니다.
semanticSearch	의미 체계 검색의 가용성을 제어하는 옵션을 설정합니다. 이 구성은 특정 위치의 특정 Azure Cognitive Search SKU에 대해서만 가능합니다.
sharedPrivateLinkResources	Azure Cognitive Search 서비스에서 관리하는 공유 프라이빗 링크 리소스 목록입니다. 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.
sku	가격 계층 및 용량 제한을 결정하는 Search Service의 SKU입니다. 이 속성은 새 Search Service를 만들 때 필요합니다.
status	검색 서비스의 상태. 가능한 값으로는 '실행 중': 검색 서비스가 실행 중이며 프로비저닝 작업이 진행 중이 아닙니다. '프로비저닝': 검색 서비스가 프로비전되거나 확장 또는 축소되고 있습니다. '삭제 중': 검색 서비스가 삭제되고 있습니다. '성능 저하': 검색 서비스가 저하되었습니다. 이 문제는 기본 검색 단위가 정상이 아닌 경우에 발생할 수 있습니다. 검색 서비스는 작동 가능성이 가장 높지만 성능이 느려지고 일부 요청이 삭제될 수 있습니다. 'disabled': 검색 서비스를 사용할 수 없습니다. 이 상태에서 서비스는 모든 AP 요청을 거부합니다. 'error': 검색 서비스가 오류 상태입니다. 서비스가 저하, 비활성화 또는 오류 상태인 경우 Azure Cognitive Search 팀이 기본 문제를 적극적으로 조사하고 있다는 의미입니다. 이러한 상태에서도 전용 서비스는 프로비저닝된 검색 단위 수에 따라 여전히 요금을 부과할 수 있습니다. 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.
statusDetails	검색 서비스의 세부 정보는 상태. 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

상속된 속성

id	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.
location	리소스가 있는 지리적 위치
name	리소스의 이름 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.
tags	리소스 태그.
type	리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts" 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

속성 세부 정보

authOptions

검색 서비스의 데이터 평면 API가 요청을 인증하는 방법에 대한 옵션을 정의합니다. 'disableLocalAuth'가 true로 설정된 경우 설정할 수 없습니다.

authOptions?: DataPlaneAuthOptions

속성 값

DataPlaneAuthOptions

disableLocalAuth

true로 설정하면 검색 서비스에 대한 호출이 인증을 위해 API 키를 활용하는 것이 허용되지 않습니다. 'dataPlaneAuthOptions'가 정의된 경우 true로 설정할 수 없습니다.

disableLocalAuth?: boolean

속성 값

boolean

encryptionWithCmk

검색 서비스 내에서 고객 관리자 키를 사용하여 리소스 암호화(예: 인덱스)에 대한 정책을 지정합니다.

encryptionWithCmk?: EncryptionWithCmk

속성 값

EncryptionWithCmk

hostingMode

standard3 SKU에만 적용됩니다. 최대 1,000개의 인덱스를 허용하는 최대 3개의 고밀도 파티션을 사용하도록 이 속성을 설정할 수 있습니다. 이는 다른 SKU에 허용되는 최대 인덱스보다 훨씬 높습니다. standard3 SKU의 경우 값은 'default' 또는 'highDensity'입니다. 다른 모든 SKU의 경우 이 값은 'default'여야 합니다.

hostingMode?: HostingMode

속성 값

HostingMode

identity

리소스의 ID입니다.

identity?: Identity

속성 값

Identity

networkRuleSet

Azure Cognitive Search 서비스에 도달하는 방법을 결정하는 네트워크별 규칙입니다.

networkRuleSet?: NetworkRuleSet

속성 값

NetworkRuleSet

partitionCount

검색 서비스의 파티션 수입니다. 지정된 경우 1, 2, 3, 4, 6 또는 12일 수 있습니다. 1보다 큰 값은 표준 SKU에만 유효합니다. hostingMode가 'highDensity'로 설정된 'standard3' 서비스의 경우 허용되는 값은 1에서 3 사이입니다.

partitionCount?: number

속성 값

number

privateEndpointConnections

Azure Cognitive Search 서비스에 대한 프라이빗 엔드포인트 연결 목록입니다. 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

privateEndpointConnections?: PrivateEndpointConnection[]

속성 값

PrivateEndpointConnection[]

provisioningState

검색 서비스에서 수행된 마지막 프로비전 작업의 상태입니다. 프로비저닝은 서비스 용량을 설정하는 동안 발생하는 중간 상태입니다. 용량이 설정되면 provisioningState가 '성공' 또는 '실패'로 변경됩니다. 클라이언트 애플리케이션은 검색 서비스 가져오기 작업을 사용하여 프로비저닝 상태 폴링할 수 있습니다(권장 폴링 간격은 30초에서 1분). 무료 서비스를 사용하는 경우 이 값은 검색 서비스 만들기 호출에서 직접 '성공'으로 돌아오는 경향이 있습니다. 이는 무료 서비스가 이미 설정된 용량을 사용하기 때문입니다. 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

provisioningState?: ProvisioningState

속성 값

ProvisioningState

publicNetworkAccess

이 값은 기존 고객 리소스 및 템플릿의 호환성이 손상되는 변경을 방지하기 위해 '사용'으로 설정할 수 있습니다. 'disabled'로 설정하면 공용 인터페이스를 통해 트래픽이 허용되지 않으며 프라이빗 엔드포인트 연결은 배타적 액세스 방법이 됩니다.

publicNetworkAccess?: PublicNetworkAccess

속성 값

PublicNetworkAccess

replicaCount

검색 서비스의 복제본 수입니다. 지정된 경우 표준 SKU의 경우 1에서 12 사이의 값이거나 기본 SKU의 경우 1에서 3 사이의 값이어야 합니다.

replicaCount?: number

속성 값

number

semanticSearch

의미 체계 검색의 가용성을 제어하는 옵션을 설정합니다. 이 구성은 특정 위치의 특정 Azure Cognitive Search SKU에 대해서만 가능합니다.

semanticSearch?: string

속성 값

string

sharedPrivateLinkResources

Azure Cognitive Search 서비스에서 관리하는 공유 프라이빗 링크 리소스 목록입니다. 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

속성 값

SharedPrivateLinkResource[]

sku

가격 계층 및 용량 제한을 결정하는 Search Service의 SKU입니다. 이 속성은 새 Search Service를 만들 때 필요합니다.

sku?: Sku

속성 값

Sku

status

검색 서비스의 상태. 가능한 값으로는 '실행 중': 검색 서비스가 실행 중이며 프로비저닝 작업이 진행 중이 아닙니다. '프로비저닝': 검색 서비스가 프로비전되거나 확장 또는 축소되고 있습니다. '삭제 중': 검색 서비스가 삭제되고 있습니다. '성능 저하': 검색 서비스가 저하되었습니다. 이 문제는 기본 검색 단위가 정상이 아닌 경우에 발생할 수 있습니다. 검색 서비스는 작동 가능성이 가장 높지만 성능이 느려지고 일부 요청이 삭제될 수 있습니다. 'disabled': 검색 서비스를 사용할 수 없습니다. 이 상태에서 서비스는 모든 AP 요청을 거부합니다. 'error': 검색 서비스가 오류 상태입니다. 서비스가 저하, 비활성화 또는 오류 상태인 경우 Azure Cognitive Search 팀이 기본 문제를 적극적으로 조사하고 있다는 의미입니다. 이러한 상태에서도 전용 서비스는 프로비저닝된 검색 단위 수에 따라 여전히 요금을 부과할 수 있습니다. 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

status?: SearchServiceStatus

속성 값

SearchServiceStatus

statusDetails

검색 서비스의 세부 정보는 상태. 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

statusDetails?: string

속성 값

string

상속된 속성 세부 정보

id

리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

id?: string

속성 값

string

상속된TrackedResource.id

location

리소스가 있는 지리적 위치

location: string

속성 값

string

TrackedResource.location에서 상속됨

name

리소스의 이름 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

name?: string

속성 값

string

상속된TrackedResource.name

tags

리소스 태그.

tags?: {[propertyName: string]: string}

속성 값

{[propertyName: string]: string}

TrackedResource.tags에서 상속됨

type

리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts" 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

type?: string

속성 값

string

TrackedResource.type에서 상속됨