@azure/arm-search package

类

SearchManagementClient

接口

AccessRule	网络安全外围配置文件中的访问规则
AccessRuleProperties	访问规则的属性
AccessRulePropertiesSubscriptionsItem	订阅标识符
AdminKeyResult	包含给定 Azure AI 搜索服务的主管理员 API 密钥和辅助管理员 API 密钥的响应。
AdminKeys	表示 AdminKeys 的接口。
AdminKeysGetOptionalParams	可选参数。
AdminKeysRegenerateOptionalParams	可选参数。
AsyncOperationResult	长时间运行的异步共享专用链接资源作的详细信息。
CheckNameAvailabilityInput	检查名称可用性 API 的输入。
CheckNameAvailabilityOutput	检查名称可用性 API 的输出。
CloudError	包含有关 API 错误的信息。
CloudErrorBody	描述具有错误代码和消息的特定 API 错误。
DataPlaneAadOrApiKeyAuthOption	指示 API 密钥或来自 Microsoft Entra ID 租户的访问令牌可用于身份验证。
DataPlaneAuthOptions	定义搜索服务如何对数据平面请求进行身份验证的选项。 如果“disableLocalAuth”设置为 true，则无法设置此项。
EncryptionWithCmk	描述一个策略，该策略确定如何使用客户管理的密钥对搜索服务中的资源进行加密。
Identity	有关搜索服务标识的详细信息。 null 值指示搜索服务未分配标识。
IpRule	Azure AI 搜索服务的 IP 限制规则。
ListQueryKeysResult	包含给定 Azure AI 搜索服务的查询 API 密钥的响应。
NetworkRuleSet	确定如何访问 Azure AI 搜索服务的网络特定规则。
NetworkSecurityPerimeter	有关网络安全外围（NSP）的信息
NetworkSecurityPerimeterConfiguration	网络安全外围 （NSP） 配置资源
NetworkSecurityPerimeterConfigurationListResult	列出 NSP（网络安全外围）配置请求的结果。
NetworkSecurityPerimeterConfigurationProperties	网络安全配置属性。
NetworkSecurityPerimeterConfigurations	表示 NetworkSecurityPerimeterConfigurations 的接口。
NetworkSecurityPerimeterConfigurationsGetOptionalParams	可选参数。
NetworkSecurityPerimeterConfigurationsListByServiceNextOptionalParams	可选参数。
NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams	可选参数。
NetworkSecurityPerimeterConfigurationsReconcileHeaders	定义NetworkSecurityPerimeterConfigurations_reconcile作的标头。
NetworkSecurityPerimeterConfigurationsReconcileOptionalParams	可选参数。
NetworkSecurityProfile	网络安全外围配置文件
Operation	从资源提供程序操作 API 返回的 REST API 操作的详细信息
OperationDisplay	此特定操作的本地化显示信息。
OperationListResult	列出 REST API作的请求的结果。 它包含作列表和 URL，用于获取下一组结果。
Operations	表示作的接口。
OperationsListOptionalParams	可选参数。
PrivateEndpointConnection	描述与 Azure AI 搜索服务的现有专用终结点连接。
PrivateEndpointConnectionListResult	包含专用终结点连接列表的响应。
PrivateEndpointConnectionProperties	描述与搜索服务的现有专用终结点连接的属性。
PrivateEndpointConnectionPropertiesPrivateEndpoint	来自 Microsoft.Network 提供程序的专用终结点资源。
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	描述与专用终结点的现有 Azure 专用链接服务连接的当前状态。
PrivateEndpointConnections	表示 PrivateEndpointConnections 的接口。
PrivateEndpointConnectionsDeleteOptionalParams	可选参数。
PrivateEndpointConnectionsGetOptionalParams	可选参数。
PrivateEndpointConnectionsListByServiceNextOptionalParams	可选参数。
PrivateEndpointConnectionsListByServiceOptionalParams	可选参数。
PrivateEndpointConnectionsUpdateOptionalParams	可选参数。
PrivateLinkResource	介绍 Azure AI 搜索服务支持的专用链接资源。
PrivateLinkResourceProperties	介绍 Azure AI 搜索服务支持的专用链接资源的属性。 对于给定的 API 版本，这表示创建共享专用链接资源时“支持的”groupId。
PrivateLinkResources	表示 PrivateLinkResources 的接口。
PrivateLinkResourcesListSupportedOptionalParams	可选参数。
PrivateLinkResourcesResult	包含支持的专用链接资源列表的响应。
ProvisioningIssue	介绍网络安全外围配置的预配问题
ProvisioningIssueProperties	网络安全外围（NSP）配置的预配问题的详细信息。 资源提供程序应为每个检测到的单独问题生成单独的预配问题元素，并包含有意义的独特说明，以及任何适当的 suggestedResourceIds 和 suggestedAccessRules
ProxyResource	Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置
QueryKey	介绍给定 Azure AI 搜索服务的 API 密钥，该服务传达对索引文档集合的只读权限。
QueryKeys	表示 QueryKeys 的接口。
QueryKeysCreateOptionalParams	可选参数。
QueryKeysDeleteOptionalParams	可选参数。
QueryKeysListBySearchServiceNextOptionalParams	可选参数。
QueryKeysListBySearchServiceOptionalParams	可选参数。
QuotaUsageResult	描述特定 SKU 的配额使用情况。
QuotaUsageResultName	Azure AI 搜索支持的 SKU 的名称。
QuotaUsagesListResult	包含 Azure AI 搜索所有支持的 SKU 配额使用情况信息的响应。
Resource	所有 Azure 资源管理器资源的响应中返回的常见字段
ResourceAssociation	有关资源关联的信息
SearchManagementClientOptionalParams	可选参数。
SearchManagementRequestOptions	参数组
SearchService	介绍 Azure AI 搜索服务及其当前状态。
SearchServiceListResult	包含 Azure AI 搜索服务列表的响应。
SearchServiceUpdate	用于更新 Azure AI 搜索服务的参数。
Services	表示服务的接口。
ServicesCheckNameAvailabilityOptionalParams	可选参数。
ServicesCreateOrUpdateOptionalParams	可选参数。
ServicesDeleteOptionalParams	可选参数。
ServicesGetOptionalParams	可选参数。
ServicesListByResourceGroupNextOptionalParams	可选参数。
ServicesListByResourceGroupOptionalParams	可选参数。
ServicesListBySubscriptionNextOptionalParams	可选参数。
ServicesListBySubscriptionOptionalParams	可选参数。
ServicesUpdateOptionalParams	可选参数。
ServicesUpgradeHeaders	定义Services_upgrade作的标头。
ServicesUpgradeOptionalParams	可选参数。
ShareablePrivateLinkResourceProperties	介绍已载入到专用链接服务的资源类型的属性，由 Azure AI 搜索支持。
ShareablePrivateLinkResourceType	描述已载入到 Azure AI 搜索支持的专用链接服务的资源类型。
SharedPrivateLinkResource	介绍由 Azure AI 搜索服务管理的共享专用链接资源。
SharedPrivateLinkResourceListResult	包含共享专用链接资源列表的响应。
SharedPrivateLinkResourceProperties	介绍由 Azure AI 搜索服务管理的现有共享专用链接资源的属性。
SharedPrivateLinkResources	表示 SharedPrivateLinkResources 的接口。
SharedPrivateLinkResourcesCreateOrUpdateOptionalParams	可选参数。
SharedPrivateLinkResourcesDeleteOptionalParams	可选参数。
SharedPrivateLinkResourcesGetOptionalParams	可选参数。
SharedPrivateLinkResourcesListByServiceNextOptionalParams	可选参数。
SharedPrivateLinkResourcesListByServiceOptionalParams	可选参数。
Sku	定义搜索服务的 SKU，用于确定计费费率和容量限制。
SystemData	与创建和上次修改资源相关的元数据。
TrackedResource	Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源
UsageBySubscriptionSkuOptionalParams	可选参数。
Usages	表示 Usages 的接口。
UsagesListBySubscriptionNextOptionalParams	可选参数。
UsagesListBySubscriptionOptionalParams	可选参数。
UserAssignedIdentity	用户分配的标识属性

类型别名

AadAuthFailureMode	定义 AadAuthFailureMode 的值。
AccessRuleDirection	定义 AccessRuleDirection 的值。 KnownAccessRuleDirection 可与 AccessRuleDirection 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 入站：适用于安全资源的入站网络流量。 出站：适用于来自受保护资源的出站网络流量
ActionType	定义 ActionType 的值。 KnownActionType 可以与 ActionType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 Internal
AdminKeyKind	定义 AdminKeyKind 的值。
AdminKeysGetResponse	包含获取作的响应数据。
AdminKeysRegenerateResponse	包含重新生成作的响应数据。
ComputeType	定义 ComputeType 的值。 KnownComputeType 可与 ComputeType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 default：使用默认计算创建服务。 机密：使用 Azure 机密计算创建服务。
CreatedByType	定义 CreatedByType 的值。 KnownCreatedByType 可与 CreatedByType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 User Application ManagedIdentity Key
HostingMode	定义 HostingMode 的值。
IdentityType	定义 IdentityType 的值。 KnownIdentityType 可与 IdentityType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 无：指示需要删除与搜索服务关联的任何标识。 SystemAssigned：指示将启用搜索服务的系统分配标识。 UserAssigned：指示将一个或多个用户分配的标识分配给搜索服务。 SystemAssigned、UserAssigned：指示将启用搜索服务的系统分配标识以及分配一个或多个用户分配的标识。
IssueType	定义 IssueType 的值。 KnownIssueType 可与 IssueType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 未知：未知问题类型 ConfigurationPropagationFailure：应用网络安全外围（NSP）配置时出错。 MissingPerimeterConfiguration：通过向网络安全外围（NSP）添加新资源或通过修改访问规则来解决网络连接问题。 MissingIdentityConfiguration：托管标识尚未与资源关联。 该资源仍能够验证来自网络安全外围（NSP）或匹配入站访问规则的入站流量，但无法将出站访问作为 NSP 的成员执行。
NetworkSecurityPerimeterConfigurationProvisioningState	定义 NetworkSecurityPerimeterConfigurationProvisioningState 的值。 KnownNetworkSecurityPerimeterConfigurationProvisioningState 可与 NetworkSecurityPerimeterConfigurationProvisioningState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 Succeeded Creating Updating Deleting Accepted Failed Canceled
NetworkSecurityPerimeterConfigurationsGetResponse	包含获取作的响应数据。
NetworkSecurityPerimeterConfigurationsListByServiceNextResponse	包含 listByServiceNext作的响应数据。
NetworkSecurityPerimeterConfigurationsListByServiceResponse	包含 listByService作的响应数据。
NetworkSecurityPerimeterConfigurationsReconcileResponse	包含协调作的响应数据。
OperationsListResponse	包含列表作的响应数据。
Origin	定义 Origin 的值。 KnownOrigin 可以与 Origin 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 user system user,system
PrivateEndpointConnectionsDeleteResponse	包含删除作的响应数据。
PrivateEndpointConnectionsGetResponse	包含获取作的响应数据。
PrivateEndpointConnectionsListByServiceNextResponse	包含 listByServiceNext作的响应数据。
PrivateEndpointConnectionsListByServiceResponse	包含 listByService作的响应数据。
PrivateEndpointConnectionsUpdateResponse	包含更新作的响应数据。
PrivateLinkResourcesListSupportedResponse	包含 listSupported作的响应数据。
PrivateLinkServiceConnectionProvisioningState	定义 PrivateLinkServiceConnectionProvisioningState 的值。 KnownPrivateLinkServiceConnectionProvisioningState 可与 PrivateLinkServiceConnectionProvisioningState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 更新：专用链接服务连接正在与其他资源一起创建，以便其功能完全正常运行。 删除：正在删除专用链接服务连接。 失败：无法预配或删除专用链接服务连接。 成功：专用链接服务连接已完成预配，已准备好批准。 不完整：已接受专用链接服务连接资源的预配请求，但尚未开始创建过程。 已取消：专用链接服务连接资源的预配请求已取消。
PrivateLinkServiceConnectionStatus	定义 PrivateLinkServiceConnectionStatus 的值。
ProvisioningState	定义 ProvisioningState 的值。
PublicNetworkAccess	定义 PublicNetworkAccess 的值。 KnownPublicNetworkAccess 可与 PublicNetworkAccess 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 enabled：可从源自公共 Internet 的流量访问搜索服务。 disabled：无法从源自公共 Internet 的流量访问搜索服务。 仅允许通过批准的专用终结点连接进行访问。 securedByPerimeter：网络安全边界配置规则允许或禁止公共网络访问资源。 需要关联的网络安全外围。
QueryKeysCreateResponse	包含创建作的响应数据。
QueryKeysListBySearchServiceNextResponse	包含 listBySearchServiceNext作的响应数据。
QueryKeysListBySearchServiceResponse	包含 listBySearchService作的响应数据。
ResourceAssociationAccessMode	定义 ResourceAssociationAccessMode 的值。 KnownResourceAssociationAccessMode 可与 ResourceAssociationAccessMode 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 强制：强制访问模式 - 阻止访问检查失败的资源的流量 学习：学习访问模式 - 资源流量已启用分析，但未阻止 审核：审核访问模式 - 记录访问检查失败但未阻止的资源的流量
SearchBypass	定义 SearchBypass 的值。 KnownSearchBypass 可以与 SearchBypass 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 无：表示没有源可以绕过“ipRules”部分中定义的规则。 这是默认值。 AzureServices：指示源自 Azure 受信任服务的请求可以绕过“ipRules”部分中定义的规则。
SearchDataExfiltrationProtection	定义 SearchDataExfiltrationProtection 的值。 KnownSearchDataExfiltrationProtection 可以与 SearchDataExfiltrationProtection 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 BlockAll：表示禁用所有数据外泄方案。
SearchEncryptionComplianceStatus	定义 SearchEncryptionComplianceStatus 的值。
SearchEncryptionWithCmk	定义 SearchEncryptionWithCmk 的值。
SearchSemanticSearch	定义 SearchSemanticSearch 的值。 KnownSearchSemanticSearch 可与 SearchSemanticSearch 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 禁用：指示为搜索服务禁用语义重新调用程序。 这是默认值。 免费：在搜索服务上启用语义重排器，并指示它在免费计划的限制内使用。 免费计划将限制语义排名请求的数量，并免费提供。 这是新预配的搜索服务的默认值。 标准：在搜索服务上启用语义重排器作为可计费功能，吞吐量和语义上重新调用的查询量更高。
SearchServiceStatus	定义 SearchServiceStatus 的值。
ServicesCheckNameAvailabilityResponse	包含 checkNameAvailability作的响应数据。
ServicesCreateOrUpdateResponse	包含 createOrUpdate作的响应数据。
ServicesGetResponse	包含获取作的响应数据。
ServicesListByResourceGroupNextResponse	包含 listByResourceGroupNext作的响应数据。
ServicesListByResourceGroupResponse	包含 listByResourceGroup作的响应数据。
ServicesListBySubscriptionNextResponse	包含 listBySubscriptionNext作的响应数据。
ServicesListBySubscriptionResponse	包含 listBySubscription作的响应数据。
ServicesUpdateResponse	包含更新作的响应数据。
ServicesUpgradeResponse	包含升级作的响应数据。
Severity	定义严重性的值。 KnownSeverity 可与 Severity 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 Warning Error
SharedPrivateLinkResourceAsyncOperationResult	定义 SharedPrivateLinkResourceAsyncOperationResult 的值。 KnownSharedPrivateLinkResourceAsyncOperationResult 可与 SharedPrivateLinkResourceAsyncOperationResult 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 Running Succeeded Failed
SharedPrivateLinkResourceProvisioningState	定义 SharedPrivateLinkResourceProvisioningState 的值。 KnownSharedPrivateLinkResourceProvisioningState 可以与 SharedPrivateLinkResourceProvisioningState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 正在更新：共享专用链接资源正在与其他资源一起创建，以使其完全发挥作用。 正在删除：共享私有链接资源正在删除中。 失败：共享专用链接资源预置或删除失败。 成功：共享专用链接资源已完成预配，已准备好进行审批。 未完成：已接受共享专用链接资源的预配请求，但创建过程尚未开始。
SharedPrivateLinkResourceStatus	定义 SharedPrivateLinkResourceStatus 的值。 KnownSharedPrivateLinkResourceStatus 可与 SharedPrivateLinkResourceStatus 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 挂起：共享专用链接资源已创建，正在等待审批。 已批准：共享专用链接资源已批准并可供使用。 已拒绝：共享私有链接资源已被拒绝，无法使用。 已断开连接：共享专用链接资源已从服务中删除。
SharedPrivateLinkResourcesCreateOrUpdateResponse	包含 createOrUpdate作的响应数据。
SharedPrivateLinkResourcesGetResponse	包含获取作的响应数据。
SharedPrivateLinkResourcesListByServiceNextResponse	包含 listByServiceNext作的响应数据。
SharedPrivateLinkResourcesListByServiceResponse	包含 listByService作的响应数据。
SkuName	定义 SkuName 的值。 KnownSkuName 可以与 SkuName 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 免费：免费层，没有 SLA 保证，以及计费层上提供的部分功能。 basic：最多具有 3 个副本的专用服务的计费层。 标准：具有多达 12 个分区和 12 个副本的专用服务的计费层。 standard2：与“standard”类似，但每个搜索单元的容量更大。 standard3：最大的标准产品/服务，最多有 12 个分区和 12 个副本（如果还将 hostingMode 属性设置为“highDensity”，则最多有 3 个具有更多索引的分区）。 storage_optimized_l1：支持每个分区 1TB 的专用服务的计费层，最多支持 12 个分区。 storage_optimized_l2：专用服务的计费层，支持每个分区 2TB，最多 12 个分区。
UnavailableNameReason	定义 UnavailableNameReason 的值。 KnownUnavailableNameReason 可与 UnavailableNameReason 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 无效：搜索服务名称与命名要求不匹配。 AlreadyExists：搜索服务名称已分配给其他搜索服务。
UpgradeAvailable	定义 UpgradeAvailable 的值。 KnownUpgradeAvailable 可以与 UpgradeAvailable 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 notAvailable：该服务当前不可用升级。 available：该服务有可用的升级。
UsageBySubscriptionSkuResponse	包含 usageBySubscriptionSku作的响应数据。
UsagesListBySubscriptionNextResponse	包含 listBySubscriptionNext作的响应数据。
UsagesListBySubscriptionResponse	包含 listBySubscription作的响应数据。

枚举

KnownAccessRuleDirection	服务接受的 AccessRuleDirection 的已知值。
KnownActionType	服务的 ActionType 已知值。
KnownComputeType	服务接受的 ComputeType 的已知值。
KnownCreatedByType	服务的 CreatedByType 的已知值。
KnownIdentityType	IdentityType 服务的已知值。
KnownIssueType	服务接受的 IssueType 的已知值。
KnownNetworkSecurityPerimeterConfigurationProvisioningState	服务的 NetworkSecurityPerimeterConfigurationProvisioningState 的已知值。
KnownOrigin	服务的 Origin 的已知值。
KnownPrivateLinkServiceConnectionProvisioningState	PrivateLinkServiceConnectionProvisioningState 服务的已知值。
KnownPublicNetworkAccess	PublicNetworkAccess 服务的已知值。
KnownResourceAssociationAccessMode	服务接受的 ResourceAssociationAccessMode 的已知值。
KnownSearchBypass	服务接受的 SearchBypass 的已知值。
KnownSearchDataExfiltrationProtection	服务接受的 SearchDataExfiltrationProtection 的已知值。
KnownSearchSemanticSearch	SearchSemanticSearch 服务的已知值。
KnownSeverity	服务的 严重性 已知值。
KnownSharedPrivateLinkResourceAsyncOperationResult	SharedPrivateLinkResourceAsyncOperationResult 服务的已知值。
KnownSharedPrivateLinkResourceProvisioningState	服务接受的 SharedPrivateLinkResourceProvisioningState 的已知值。
KnownSharedPrivateLinkResourceStatus	SharedPrivateLinkResourceStatus 服务的已知值。
KnownSkuName	服务的 SkuName 的已知值。
KnownUnavailableNameReason	服务接受的 UnavailableNameReason 的已知值。
KnownUpgradeAvailable	服务接受的 UpgradeAvailable 的已知值。

函数

getContinuationToken(unknown)

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

函数详细信息

getContinuationToken(unknown)

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

function getContinuationToken(page: unknown): string | undefined

参数

page

unknown

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

返回

string | undefined

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