你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/arm-search package

SearchManagementClient

接口

AdminKeyResult

包含给定 Azure 认知搜索服务的主管理员 API 密钥和辅助管理员 API 密钥的响应。

AdminKeys

表示 AdminKeys 的接口。

AdminKeysGetOptionalParams

可选参数。

AdminKeysRegenerateOptionalParams

可选参数。

AsyncOperationResult

长时间运行的异步共享专用链接资源作的详细信息

CheckNameAvailabilityInput

检查名称可用性 API 的输入。

CheckNameAvailabilityOutput

检查名称可用性 API 的输出。

CloudError

包含有关 API 错误的信息。

CloudErrorBody

描述具有错误代码和消息的特定 API 错误。

DataPlaneAadOrApiKeyAuthOption

指示可以使用 Azure Active Directory 中的 API 密钥或访问令牌进行身份验证。

DataPlaneAuthOptions

定义搜索服务的数据平面 API 如何对请求进行身份验证的选项。 如果“disableLocalAuth”设置为 true,则无法设置此项。

EncryptionWithCmk

描述一个策略,该策略确定如何使用客户托管密钥对搜索服务中的资源进行加密。

Identity

资源的标识。

IpRule

Azure 认知搜索服务的 IP 限制规则。

ListQueryKeysResult

包含给定 Azure 认知搜索服务的查询 API 密钥的响应。

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 版本,这表示创建共享专用链接资源时“支持的”groupId。

PrivateLinkResources

表示 PrivateLinkResources 的接口。

PrivateLinkResourcesListSupportedOptionalParams

可选参数。

PrivateLinkResourcesResult

包含支持的专用链接资源列表的响应。

QueryKey

描述给定的 Azure 认知搜索服务的 API 密钥,该服务仅具有查询作的权限。

QueryKeys

表示 QueryKeys 的接口。

QueryKeysCreateOptionalParams

可选参数。

QueryKeysDeleteOptionalParams

可选参数。

QueryKeysListBySearchServiceNextOptionalParams

可选参数。

QueryKeysListBySearchServiceOptionalParams

可选参数。

QuotaUsageResult

介绍 Azure 认知搜索支持的特定 SKU 的配额使用情况。

QuotaUsageResultName

Azure 认知搜索支持的 SKU 的名称。

QuotaUsagesListResult

包含 Azure 认知搜索服务所有支持的 SKU 的配额使用情况信息的响应。

Resource

所有 Azure 资源管理器资源的响应中返回的常见字段

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

定义 Azure 认知搜索服务的 SKU,用于确定价格层和容量限制。

TrackedResource

Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源

UsageBySubscriptionSkuOptionalParams

可选参数。

Usages

表示 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 可与 UnavailableNameReason 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

无效:搜索服务名称与命名要求不匹配。
AlreadyExists:搜索服务名称已分配给其他搜索服务。

UsageBySubscriptionSkuResponse

包含 usageBySubscriptionSku作的响应数据。

UsagesListBySubscriptionNextResponse

包含 listBySubscriptionNext作的响应数据。

UsagesListBySubscriptionResponse

包含 listBySubscription作的响应数据。

枚举

KnownPrivateLinkServiceConnectionProvisioningState

PrivateLinkServiceConnectionProvisioningState 服务的已知值。

KnownSearchSemanticSearch

SearchSemanticSearch 服务的已知值。

KnownSharedPrivateLinkResourceAsyncOperationResult

SharedPrivateLinkResourceAsyncOperationResult 服务的已知值。

KnownUnavailableNameReason

服务接受的 UnavailableNameReason 的已知值。

函数

getContinuationToken(unknown)

给定由 byPage 迭代器生成的最后一个 .value,返回一个延续标记,该标记可用于稍后开始分页。

函数详细信息

getContinuationToken(unknown)

给定由 byPage 迭代器生成的最后一个 .value,返回一个延续标记,该标记可用于稍后开始分页。

function getContinuationToken(page: unknown): string | undefined

参数

page

unknown

byPage 迭代器访问 IteratorResult 上的 value 的对象。

返回

string | undefined

可在将来调用期间传递到 byPage() 的延续标记。