다음을 통해 공유


SearchService interface

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

Extends

속성

authOptions

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

computeType

기본 컴퓨팅 또는 Azure 기밀 컴퓨팅을 사용하여 검색 서비스를 지원하도록 이 속성을 구성합니다.

dataExfiltrationProtections

검색 서비스에 대해 명시적으로 허용되지 않는 데이터 반출 시나리오 목록입니다. 현재 지원되는 유일한 값은 'All'으로, 향후 더 세분화된 컨트롤을 사용하여 가능한 모든 데이터 내보내기 시나리오를 사용하지 않도록 설정합니다.

disableLocalAuth

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

encryptionWithCmk

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

endpoint

Azure AI Search 서비스의 엔드포인트입니다.

eTag

업데이트 중에 낙관적 동시성 제어에 사용할 수 있는 서비스의 etag를 나타내는 시스템 생성 속성입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

hostingMode

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

identity

리소스의 ID입니다.

networkRuleSet

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

partitionCount

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

privateEndpointConnections

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

provisioningState

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

publicNetworkAccess

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

replicaCount

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

semanticSearch

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

serviceUpgradedAt

검색 서비스가 마지막으로 업그레이드된 날짜 및 시간입니다. 서비스가 처음으로 업그레이드될 때까지 이 필드는 null이 됩니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

sharedPrivateLinkResources

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

sku

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

status

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

statusDetails

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

upgradeAvailable

검색 서비스에 사용 가능한 업그레이드가 있는지를 나타냅니다.

상속된 속성

id

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

location

리소스가 있는 지리적 위치

name

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

systemData

createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

tags

리소스 태그.

type

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

속성 세부 정보

authOptions

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

authOptions?: DataPlaneAuthOptions

속성 값

computeType

기본 컴퓨팅 또는 Azure 기밀 컴퓨팅을 사용하여 검색 서비스를 지원하도록 이 속성을 구성합니다.

computeType?: string

속성 값

string

dataExfiltrationProtections

검색 서비스에 대해 명시적으로 허용되지 않는 데이터 반출 시나리오 목록입니다. 현재 지원되는 유일한 값은 'All'으로, 향후 더 세분화된 컨트롤을 사용하여 가능한 모든 데이터 내보내기 시나리오를 사용하지 않도록 설정합니다.

dataExfiltrationProtections?: string[]

속성 값

string[]

disableLocalAuth

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

disableLocalAuth?: boolean

속성 값

boolean

encryptionWithCmk

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

encryptionWithCmk?: EncryptionWithCmk

속성 값

endpoint

Azure AI Search 서비스의 엔드포인트입니다.

endpoint?: string

속성 값

string

eTag

업데이트 중에 낙관적 동시성 제어에 사용할 수 있는 서비스의 etag를 나타내는 시스템 생성 속성입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

eTag?: string

속성 값

string

hostingMode

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

hostingMode?: HostingMode

속성 값

identity

리소스의 ID입니다.

identity?: Identity

속성 값

networkRuleSet

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

networkRuleSet?: NetworkRuleSet

속성 값

partitionCount

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

partitionCount?: number

속성 값

number

privateEndpointConnections

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

privateEndpointConnections?: PrivateEndpointConnection[]

속성 값

provisioningState

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

provisioningState?: ProvisioningState

속성 값

publicNetworkAccess

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

publicNetworkAccess?: string

속성 값

string

replicaCount

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

replicaCount?: number

속성 값

number

semanticSearch

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

semanticSearch?: string

속성 값

string

serviceUpgradedAt

검색 서비스가 마지막으로 업그레이드된 날짜 및 시간입니다. 서비스가 처음으로 업그레이드될 때까지 이 필드는 null이 됩니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

serviceUpgradedAt?: Date

속성 값

Date

sharedPrivateLinkResources

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

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

속성 값

sku

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

sku?: Sku

속성 값

Sku

status

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

status?: SearchServiceStatus

속성 값

statusDetails

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

statusDetails?: string

속성 값

string

upgradeAvailable

검색 서비스에 사용 가능한 업그레이드가 있는지를 나타냅니다.

upgradeAvailable?: string

속성 값

string

상속된 속성 세부 정보

id

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

id?: string

속성 값

string

TrackedResource.id 상속된

location

리소스가 있는 지리적 위치

location: string

속성 값

string

TrackedResource.location 상속된

name

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

name?: string

속성 값

string

TrackedResource.name 상속된

systemData

createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

systemData?: SystemData

속성 값

TrackedResource.systemData 상속된

tags

리소스 태그.

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

속성 값

{[propertyName: string]: string}

TrackedResource.tags 상속된

type

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

type?: string

속성 값

string

TrackedResource.type 상속된