Поделиться через


@azure/arm-search package

Классы

SearchManagementClient

Интерфейсы

AdminKeyResult

Ответ, содержащий ключи API первичного и дополнительного администратора для данной службы Когнитивного поиска Azure.

AdminKeys

Интерфейс, представляющий adminKeys.

AdminKeysGetOptionalParams

Необязательные параметры.

AdminKeysRegenerateOptionalParams

Необязательные параметры.

AsyncOperationResult

Сведения о длительной асинхронной асинхронной операции ресурса приватного канала

CheckNameAvailabilityInput

Входные данные API доступности имен проверки.

CheckNameAvailabilityOutput

Выходные данные API доступности имен проверки.

CloudError

Содержит сведения об ошибке API.

CloudErrorBody

Описывает определенную ошибку API с кодом ошибки и сообщением.

DataPlaneAadOrApiKeyAuthOption

Указывает, что для проверки подлинности можно использовать ключ API или маркер доступа из Azure Active Directory.

DataPlaneAuthOptions

Определяет параметры того, как API плоскости данных службы поиска выполняет проверку подлинности запросов. Это невозможно задать, если параметр disableLocalAuth имеет значение true.

EncryptionWithCmk

Описывает политику, которая определяет, как ресурсы в службе поиска должны быть зашифрованы с помощью ключей, управляемых клиентом.

Identity

Удостоверение ресурса.

IpRule

Правило ограничения IP-адресов службы Когнитивного поиска Azure.

ListQueryKeysResult

Ответ, содержащий ключи API запросов для определенной службы Когнитивного поиска Azure.

NetworkRuleSet

Правила конкретной сети, определяющие, как может быть достигнута служба Когнитивного поиска Azure.

Operation

Описывает операцию REST API.

OperationDisplay

Объект, описывающий операцию.

OperationListResult

Результат запроса на перечисление операций REST API. Он содержит список операций и URL-адрес для получения следующего набора результатов.

Operations

Интерфейс, представляющий операции.

OperationsListOptionalParams

Необязательные параметры.

PrivateEndpointConnection

Описывает существующее подключение частной конечной точки к службе Когнитивного поиска Azure.

PrivateEndpointConnectionListResult

Ответ, содержащий список подключений к частной конечной точке.

PrivateEndpointConnectionProperties

Описывает свойства существующего подключения частной конечной точки к службе Когнитивного поиска Azure.

PrivateEndpointConnectionPropertiesPrivateEndpoint

Ресурс частной конечной точки от поставщика Microsoft.Network.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Описывает текущее состояние существующего подключения службы приватного канала к частной конечной точке Azure.

PrivateEndpointConnections

Интерфейс, представляющий PrivateEndpointConnections.

PrivateEndpointConnectionsDeleteOptionalParams

Необязательные параметры.

PrivateEndpointConnectionsGetOptionalParams

Необязательные параметры.

PrivateEndpointConnectionsListByServiceNextOptionalParams

Необязательные параметры.

PrivateEndpointConnectionsListByServiceOptionalParams

Необязательные параметры.

PrivateEndpointConnectionsUpdateOptionalParams

Необязательные параметры.

PrivateLinkResource

Описывает поддерживаемый ресурс приватного канала для службы Когнитивного поиска Azure.

PrivateLinkResourceProperties

Описывает свойства поддерживаемого ресурса приватного канала для службы Когнитивного поиска Azure. Для данной версии API это представляет "поддерживаемые" групповые идентификаторы при создании общего ресурса приватного канала.

PrivateLinkResources

Интерфейс, представляющий PrivateLinkResources.

PrivateLinkResourcesListSupportedOptionalParams

Необязательные параметры.

PrivateLinkResourcesResult

Ответ, содержащий список поддерживаемых ресурсов приватного канала.

QueryKey

Описывает ключ API для определенной службы Когнитивного поиска Azure, которая имеет разрешения только для операций запроса.

QueryKeys

Интерфейс, представляющий queryKeys.

QueryKeysCreateOptionalParams

Необязательные параметры.

QueryKeysDeleteOptionalParams

Необязательные параметры.

QueryKeysListBySearchServiceNextOptionalParams

Необязательные параметры.

QueryKeysListBySearchServiceOptionalParams

Необязательные параметры.

QuotaUsageResult

Описывает использование квоты для определенного номера SKU, поддерживаемого Когнитивным поиском Azure.

QuotaUsageResultName

Имя SKU, поддерживаемого Когнитивным поиском Azure.

QuotaUsagesListResult

Ответ, содержащий сведения об использовании квоты для всех поддерживаемых номеров SKU службы Когнитивного поиска Azure.

Resource

Общие поля, возвращаемые в ответе для всех ресурсов Azure Resource Manager

SearchManagementClientOptionalParams

Необязательные параметры.

SearchManagementRequestOptions

Группа параметров

SearchService

Описывает службу Когнитивного поиска Azure и ее текущее состояние.

SearchServiceListResult

Ответ, содержащий список служб Когнитивного поиска Azure.

SearchServiceUpdate

Параметры, используемые для обновления службы Когнитивного поиска Azure.

Services

Интерфейс, представляющий службы.

ServicesCheckNameAvailabilityOptionalParams

Необязательные параметры.

ServicesCreateOrUpdateOptionalParams

Необязательные параметры.

ServicesDeleteOptionalParams

Необязательные параметры.

ServicesGetOptionalParams

Необязательные параметры.

ServicesListByResourceGroupNextOptionalParams

Необязательные параметры.

ServicesListByResourceGroupOptionalParams

Необязательные параметры.

ServicesListBySubscriptionNextOptionalParams

Необязательные параметры.

ServicesListBySubscriptionOptionalParams

Необязательные параметры.

ServicesUpdateOptionalParams

Необязательные параметры.

ShareablePrivateLinkResourceProperties

Описывает свойства типа ресурса, который был подключен к службе приватного канала, поддерживаемой Когнитивным поиском Azure.

ShareablePrivateLinkResourceType

Описывает тип ресурса, который был подключен к службе приватного канала, поддерживаемой Когнитивным поиском Azure.

SharedPrivateLinkResource

Описывает ресурс общего приватного канала, управляемый службой Когнитивного поиска Azure.

SharedPrivateLinkResourceListResult

Ответ, содержащий список ресурсов общего приватного канала.

SharedPrivateLinkResourceProperties

Описывает свойства существующего ресурса общего приватного канала, управляемого службой Когнитивного поиска Azure.

SharedPrivateLinkResources

Интерфейс, представляющий sharedPrivateLinkResources.

SharedPrivateLinkResourcesCreateOrUpdateOptionalParams

Необязательные параметры.

SharedPrivateLinkResourcesDeleteOptionalParams

Необязательные параметры.

SharedPrivateLinkResourcesGetOptionalParams

Необязательные параметры.

SharedPrivateLinkResourcesListByServiceNextOptionalParams

Необязательные параметры.

SharedPrivateLinkResourcesListByServiceOptionalParams

Необязательные параметры.

Sku

Определяет SKU службы Когнитивного поиска Azure, которая определяет ценовую категорию и ограничения емкости.

TrackedResource

Определение модели ресурсов для отслеживаемого ресурса Azure Resource Manager с тегами верхнего уровня и расположением

UsageBySubscriptionSkuOptionalParams

Необязательные параметры.

Usages

Интерфейс, представляющий использование.

UsagesListBySubscriptionNextOptionalParams

Необязательные параметры.

UsagesListBySubscriptionOptionalParams

Необязательные параметры.

Псевдонимы типа

AadAuthFailureMode

Определяет значения для AadAuthFailureMode.

AdminKeyKind

Определяет значения для AdminKeyKind.

AdminKeysGetResponse

Содержит данные ответа для операции получения.

AdminKeysRegenerateResponse

Содержит данные ответа для операции повторного создания.

HostingMode

Определяет значения для HostingMode.

IdentityType

Определяет значения для IdentityType.

OperationsListResponse

Содержит данные ответа для операции списка.

PrivateEndpointConnectionsDeleteResponse

Содержит данные ответа для операции удаления.

PrivateEndpointConnectionsGetResponse

Содержит данные ответа для операции получения.

PrivateEndpointConnectionsListByServiceNextResponse

Содержит данные ответа для операции listByServiceNext.

PrivateEndpointConnectionsListByServiceResponse

Содержит данные ответа для операции listByService.

PrivateEndpointConnectionsUpdateResponse

Содержит данные ответа для операции обновления.

PrivateLinkResourcesListSupportedResponse

Содержит данные ответа для операции listSupported.

PrivateLinkServiceConnectionProvisioningState

Определяет значения для PrivateLinkServiceConnectionProvisioningState.
KnownPrivateLinkServiceConnectionProvisioningState можно использовать взаимозаменяемо с PrivateLinkServiceConnectionProvisioningState, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

обновлении: подключение службы приватного канала находится в процессе создания вместе с другими ресурсами, чтобы он был полностью функциональным.
удаление: подключение службы приватного канала находится в процессе удаления.
сбой: подключение службы приватного канала не удалось подготовить или удалить.
успешно выполнено: подключение службы приватного канала завершило подготовку и готово к утверждению.
неполный: запрос на подготовку ресурса подключения службы приватного канала был принят, но процесс создания еще не начался.
отменено: запрос на подготовку ресурса подключения службы приватного канала был отменен

PrivateLinkServiceConnectionStatus

Определяет значения для PrivateLinkServiceConnectionStatus.

ProvisioningState

Определяет значения для ProvisioningState.

PublicNetworkAccess

Определяет значения для PublicNetworkAccess.

QueryKeysCreateResponse

Содержит данные ответа для операции создания.

QueryKeysListBySearchServiceNextResponse

Содержит данные ответа для операции listBySearchServiceNext.

QueryKeysListBySearchServiceResponse

Содержит данные ответа для операции listBySearchService.

SearchEncryptionComplianceStatus

Определяет значения для SearchEncryptionComplianceStatus.

SearchEncryptionWithCmk

Определяет значения для SearchEncryptionWithCmk.

SearchSemanticSearch

Определяет значения для SearchSemanticSearch.
KnownSearchSemanticSearch можно использовать взаимозаменяемо с SearchSemanticSearch, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

отключены. Указывает, что семантический поиск отключен для службы поиска.
бесплатный: включает семантический поиск в службе поиска и указывает, что он должен использоваться в пределах свободного уровня. Это приведет к тому, что объем семантических поисковых запросов предлагается без дополнительной платы. Это по умолчанию для недавно подготовленных служб поиска.
стандартной: включает семантический поиск в службе поиска в качестве оплачиваемой функции с более высокой пропускной способностью и объемом семантических запросов поиска.

SearchServiceStatus

Определяет значения для SearchServiceStatus.

ServicesCheckNameAvailabilityResponse

Содержит данные ответа для операции checkNameAvailability.

ServicesCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.

ServicesGetResponse

Содержит данные ответа для операции получения.

ServicesListByResourceGroupNextResponse

Содержит данные ответа для операции listByResourceGroupNext.

ServicesListByResourceGroupResponse

Содержит данные ответа для операции listByResourceGroup.

ServicesListBySubscriptionNextResponse

Содержит данные ответа для операции listBySubscriptionNext.

ServicesListBySubscriptionResponse

Содержит данные ответа для операции listBySubscription.

ServicesUpdateResponse

Содержит данные ответа для операции обновления.

SharedPrivateLinkResourceAsyncOperationResult

Определяет значения для SharedPrivateLinkResourceAsyncOperationResult.
KnownSharedPrivateLinkResourceAsyncOperationResult можно использовать взаимозаменяемо с SharedPrivateLinkResourceAsyncOperationResult, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

выполнение
успешно выполнено
Сбой

SharedPrivateLinkResourceProvisioningState

Определяет значения для SharedPrivateLinkResourceProvisioningState.

SharedPrivateLinkResourceStatus

Определяет значения для SharedPrivateLinkResourceStatus.

SharedPrivateLinkResourcesCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.

SharedPrivateLinkResourcesGetResponse

Содержит данные ответа для операции получения.

SharedPrivateLinkResourcesListByServiceNextResponse

Содержит данные ответа для операции listByServiceNext.

SharedPrivateLinkResourcesListByServiceResponse

Содержит данные ответа для операции listByService.

SkuName

Определяет значения для SkuName.

UnavailableNameReason

Определяет значения для UnavailableNameReason.
KnownUnavailableNameReason можно использовать взаимозаменяемо с НедоступнымNameReason, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

недопустимый: имя службы поиска не соответствует требованиям именования.
AlreadyExists: имя службы поиска уже назначено другой службе поиска.

UsageBySubscriptionSkuResponse

Содержит данные ответа для операции usageBySubscriptionSku.

UsagesListBySubscriptionNextResponse

Содержит данные ответа для операции listBySubscriptionNext.

UsagesListBySubscriptionResponse

Содержит данные ответа для операции listBySubscription.

Перечисления

KnownPrivateLinkServiceConnectionProvisioningState

Известные значения PrivateLinkServiceConnectionProvisioningState, которые принимает служба.

KnownSearchSemanticSearch

Известные значения SearchSemanticSearch, которые служба принимает.

KnownSharedPrivateLinkResourceAsyncOperationResult

Известные значения SharedPrivateLinkResourceAsyncOperationResult, которые служба принимает.

KnownUnavailableNameReason

Известные значения UnavailableNameReason, которые служба принимает.

Функции

getContinuationToken(unknown)

Учитывая последний .value, созданный byPage итератором, возвращает маркер продолжения, который можно использовать для начала разбиения по страницам с этой точки позже.

Сведения о функции

getContinuationToken(unknown)

Учитывая последний .value, созданный byPage итератором, возвращает маркер продолжения, который можно использовать для начала разбиения по страницам с этой точки позже.

function getContinuationToken(page: unknown): string | undefined

Параметры

page

unknown

Объект от доступа к value на итераторе IteratorResult из byPage итератора.

Возвращаемое значение

string | undefined

Маркер продолжения, который можно передать в byPage() во время будущих вызовов.