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

models 包

类

AdminKeyResult	包含给定Azure 认知搜索服务的主要和辅助管理 API 密钥的响应。 变量仅由服务器填充，发送请求时将被忽略。
AsyncOperationResult	长时间运行的异步共享专用链接资源操作的详细信息。
CheckNameAvailabilityInput	检查名称可用性 API 的输入。 变量仅由服务器填充，发送请求时将被忽略。 必须填充所有必需的参数才能发送到 Azure。
CheckNameAvailabilityOutput	检查名称可用性 API 的输出。 变量仅由服务器填充，发送请求时将被忽略。
CloudErrorBody	使用错误代码和消息描述特定的 API 错误。
DataPlaneAadOrApiKeyAuthOption	指示可以使用 Azure Active Directory 中的 API 密钥或访问令牌进行身份验证。
DataPlaneAuthOptions	定义搜索服务的数据平面 API 如何对请求进行身份验证的选项。 如果“disableLocalAuth”设置为 true，则无法设置此值。
EncryptionWithCmk	描述一个策略，该策略确定如何使用客户管理的密钥加密搜索服务中的资源。 变量仅由服务器填充，发送请求时将被忽略。
Identity	资源的标识。 变量仅由服务器填充，发送请求时将被忽略。 必须填充所有必需的参数才能发送到 Azure。
IpRule	Azure 认知搜索服务的 IP 限制规则。
ListQueryKeysResult	包含给定Azure 认知搜索服务的查询 API 密钥的响应。 变量仅由服务器填充，发送请求时将被忽略。
NetworkRuleSet	确定如何访问Azure 认知搜索服务的网络特定规则。
Operation	描述 REST API 操作。 变量仅由服务器填充，发送请求时将被忽略。
OperationDisplay	描述操作的 对象。 变量仅由服务器填充，发送请求时将被忽略。
OperationListResult	请求列出 REST API 操作的结果。 它包含操作列表和用于获取下一组结果的 URL。 变量仅由服务器填充，发送请求时将被忽略。
PrivateEndpointConnection	描述与Azure 认知搜索服务的现有专用终结点连接。 变量仅由服务器填充，发送请求时将被忽略。
PrivateEndpointConnectionListResult	包含专用终结点连接列表的响应。 变量仅由服务器填充，发送请求时将被忽略。
PrivateEndpointConnectionProperties	描述与Azure 认知搜索服务的现有专用终结点连接的属性。
PrivateEndpointConnectionPropertiesPrivateEndpoint	Microsoft.Network 提供程序中的专用终结点资源。
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	介绍与 Azure 专用终结点的现有专用链接服务连接当前状态。
PrivateLinkResource	介绍Azure 认知搜索服务支持的专用链接资源。 变量仅由服务器填充，发送请求时将被忽略。
PrivateLinkResourceProperties	描述Azure 认知搜索服务支持的专用链接资源的属性。 对于给定的 API 版本，它表示创建共享专用链接资源时的“supported”groupIds。 变量仅由服务器填充，发送请求时将被忽略。
PrivateLinkResourcesResult	包含支持的专用链接资源列表的响应。 变量仅由服务器填充，发送请求时将被忽略。
QueryKey	描述仅对查询操作具有权限的给定Azure 认知搜索服务的 API 密钥。 变量仅由服务器填充，发送请求时将被忽略。
Resource	所有 Azure 资源管理器 资源的响应中返回的常见字段。 变量仅由服务器填充，发送请求时将被忽略。
SearchManagementRequestOptions	参数组。
SearchService	描述Azure 认知搜索服务及其当前状态。 变量仅由服务器填充，发送请求时将被忽略。 必须填充所有必需的参数才能发送到 Azure。
SearchServiceListResult	包含Azure 认知搜索服务列表的响应。 变量仅由服务器填充，发送请求时将被忽略。
SearchServiceUpdate	用于更新Azure 认知搜索服务的参数。 变量仅由服务器填充，发送请求时将被忽略。
ShareablePrivateLinkResourceProperties	描述已载入专用链接服务（受 Azure 认知搜索 支持）的资源类型的属性。 变量仅由服务器填充，发送请求时将被忽略。
ShareablePrivateLinkResourceType	描述已载入专用链接服务（受 Azure 认知搜索 支持）的资源类型。 变量仅由服务器填充，发送请求时将被忽略。
SharedPrivateLinkResource	描述由 Azure 认知搜索 服务管理的共享专用链接资源。 变量仅由服务器填充，发送请求时将被忽略。
SharedPrivateLinkResourceListResult	包含共享专用链接资源列表的响应。 变量仅由服务器填充，发送请求时将被忽略。
SharedPrivateLinkResourceProperties	描述由 Azure 认知搜索 服务管理的现有共享专用链接资源的属性。
Sku	定义Azure 认知搜索服务的 SKU，用于确定价格层和容量限制。
TrackedResource	Azure 的资源模型定义资源管理器跟踪了具有“标记”和“位置”的顶级资源。 变量仅由服务器填充，在发送请求时将被忽略。 必须填充所有必需的参数才能发送到 Azure。

枚举

AadAuthFailureMode	描述搜索服务的数据平面 API 将为身份验证失败的请求发送的响应。
AdminKeyKind	AdminKeyKind。
HostingMode	仅适用于 standard3 SKU。 可以将此属性设置为启用最多 3 个高密度分区，这些分区最多允许 1000 个索引，这远远高于任何其他 SKU 允许的最大索引数。 对于 standard3 SKU，该值为“default”或“highDensity”。 对于所有其他 SKU，此值必须为“default”。
IdentityType	标识类型。
PrivateLinkServiceConnectionProvisioningState	专用链接服务连接的预配状态。 可以是“正在更新”、“正在删除”、“失败”、“成功”或“不完整”。
PrivateLinkServiceConnectionStatus	专用链接服务连接的状态。 可以是“挂起”、“已批准”、“已拒绝”或“已断开连接”。
ProvisioningState	对搜索服务执行的最后一个预配操作的状态。 “正在设置”是一种中间状态，在建立服务容量时出现。 设置容量后，provisioningState 将更改为“成功”或“失败”。 客户端应用程序可以使用“获取搜索服务”操作查看操作完成时间， (建议的轮询间隔为 30 秒到 1 分钟) 轮询预配状态。 如果使用的是免费服务，则此值往往在调用 Create search service 时直接以“成功”的形式返回。 这是因为免费服务使用了已设置的容量。
PublicNetworkAccess	此值可以设置为“enabled”，以避免对现有客户资源和模板进行中断性变更。 如果设置为“disabled”，则不允许通过公共接口的流量，专用终结点连接将是独占访问方法。
SearchEncryptionComplianceStatus	描述搜索服务在具有非客户加密资源方面是否合规。 如果服务具有多个非客户加密资源，并且“强制”已“已启用”，则该服务将标记为“不符合”。
SearchEncryptionWithCmk	描述搜索服务应如何强制使用一个或多个非客户加密资源。
SearchServiceStatus	搜索服务的状态。 可能的值包括：“running”：搜索服务正在运行，并且没有预配操作正在进行中。 “预配”：正在预配或纵向扩展或缩减搜索服务。 “正在删除”：正在删除搜索服务。 “已降级”：搜索服务已降级。 当基础搜索单元不正常时，可能会发生这种情况。 搜索服务很可能正常运行，但性能可能较慢，并且某些请求可能会被删除。 “disabled”：搜索服务已禁用。 在此状态下，服务将拒绝所有 API 请求。 “error”：搜索服务处于错误状态。 如果服务处于降级、禁用或错误状态，则表示Azure 认知搜索团队正在积极调查根本问题。 这些状态下的专用服务仍根据预配的搜索单位数收费。
SharedPrivateLinkResourceAsyncOperationResult	长时间运行的异步共享专用链接资源操作的当前状态。
SharedPrivateLinkResourceProvisioningState	共享专用链接资源的预配状态。 可以是“正在更新”、“正在删除”、“失败”、“成功”或“不完整”。
SharedPrivateLinkResourceStatus	共享专用链接资源的状态。 可以是“挂起”、“已批准”、“已拒绝”或“已断开连接”。
SkuName	搜索服务的 SKU。 有效值包括：“free”：共享服务。 “basic”：最多包含 3 个副本的专用服务。 “standard”：包含最多 12 个分区和 12 个副本的专用服务。 “standard2”：类似于标准，但每个搜索单位的容量更多。 “standard3”：最大标准产品/服务最多包含 12 个分区和 12 个副本 (或最多 3 个具有更多索引的分区（如果还将 hostingMode 属性设置为“highDensity”) ）。 “storage_optimized_l1”：每个分区支持 1TB，最多支持 12 个分区。 “storage_optimized_l2”：支持每个分区 2TB，最多 12 个分区。
UnavailableNameReason	名称不可用的原因。 “无效”表示提供的名称与命名要求不匹配， (不正确的长度、不支持的字符等) 。 “AlreadyExists”表示该名称已在使用中，因此不可用。