@azure/arm-search package

類別

SearchManagementClient

介面

AccessRule	網路安全性周邊組態配置檔中的存取規則
AccessRuleProperties	存取規則的屬性
AccessRulePropertiesSubscriptionsItem	訂用帳戶標識碼
AdminKeyResult	包含指定 Azure AI 搜尋服務之主要和次要系統管理員 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 API 傳回的 REST API 作業詳細數據
OperationDisplay	此特定作業的當地語系化顯示資訊。
OperationListResult	列出 REST API 作業的要求結果。 其中包含作業清單和 URL，以取得下一組結果。
Operations	表示作業的介面。
OperationsListOptionalParams	選擇性參數。
PrivateEndpointConnection	描述與 Azure AI 搜尋服務的現有私人端點連線。
PrivateEndpointConnectionListResult	包含私人端點連線清單的回應。
PrivateEndpointConnectionProperties	描述與搜尋服務的現有私人端點連線屬性。
PrivateEndpointConnectionPropertiesPrivateEndpoint	Microsoft.Network 提供者的私人端點資源。
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	描述現有 Azure Private Link 服務連線至私人端點的目前狀態。
PrivateEndpointConnections	表示 PrivateEndpointConnections 的介面。
PrivateEndpointConnectionsDeleteOptionalParams	選擇性參數。
PrivateEndpointConnectionsGetOptionalParams	選擇性參數。
PrivateEndpointConnectionsListByServiceNextOptionalParams	選擇性參數。
PrivateEndpointConnectionsListByServiceOptionalParams	選擇性參數。
PrivateEndpointConnectionsUpdateOptionalParams	選擇性參數。
PrivateLinkResource	描述 Azure AI 搜尋服務支援的私人鏈接資源。
PrivateLinkResourceProperties	描述 Azure AI 搜尋服務所支援私人鏈接資源的屬性。 針對指定的 API 版本，這會代表建立共用私人鏈接資源時的「支援」groupId。
PrivateLinkResources	表示 PrivateLinkResources 的介面。
PrivateLinkResourcesListSupportedOptionalParams	選擇性參數。
PrivateLinkResourcesResult	包含支援的 Private Link 資源清單的回應。
ProvisioningIssue	描述網路安全性周邊設定的布建問題
ProvisioningIssueProperties	網路安全性周邊 （NSP） 設定的布建問題詳細數據。 資源提供者應該為每個偵測到的不同問題產生個別的布建問題元素，並包含有意義且獨特的描述，以及任何適當的建議ResourceIds 和 suggestedAccessRules
ProxyResource	Azure Resource Manager Proxy 資源的資源模型定義。 它不會有標記和位置
QueryKey	描述指定之 Azure AI 搜尋服務的 API 金鑰，此服務會傳達索引檔集合的唯讀許可權。
QueryKeys	表示 QueryKeys 的介面。
QueryKeysCreateOptionalParams	選擇性參數。
QueryKeysDeleteOptionalParams	選擇性參數。
QueryKeysListBySearchServiceNextOptionalParams	選擇性參數。
QueryKeysListBySearchServiceOptionalParams	選擇性參數。
QuotaUsageResult	描述特定 SKU 的配額使用量。
QuotaUsageResultName	Azure AI 搜尋所支援 SKU 的名稱。
QuotaUsagesListResult	包含 Azure AI 搜尋所支援之所有 SKU 配額使用量資訊的回應。
Resource	回應中針對所有 Azure Resource Manager 資源傳回的常見欄位
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 Resource Manager 的資源模型定義已追蹤最上層資源，其具有「標記」和「位置」
UsageBySubscriptionSkuOptionalParams	選擇性參數。
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 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 強制：強制存取模式 - 封鎖存取檢查失敗之資源的流量 Learning：學習存取模式 - 資源的流量已啟用以進行分析，但未封鎖 稽核：稽核存取模式 - 記錄存取檢查失敗但未封鎖之資源的流量
SearchBypass	定義 SearchBypass 的值。 KnownSearchBypass 可以與 SearchBypass 互換使用，此枚舉包含服務支援的已知值。 服務支援的已知值 無：表示沒有源可以繞過「ipRules」部分中定義的規則。 這是預設值。 AzureServices：指示源自 Azure 受信任服務的請求可以繞過“ipRules”部分中定義的規則。
SearchDataExfiltrationProtection	定義 SearchDataExfiltrationProtection 的值。 KnownSearchDataExfiltrationProtection 可以與 SearchDataExfiltrationProtection 互換使用，此枚舉包含服務支援的已知值。 服務支援的已知值 BlockAll：表示禁用所有數據外泄方案。
SearchEncryptionComplianceStatus	定義 SearchEncryptionComplianceStatus 的值。
SearchEncryptionWithCmk	定義 SearchEncryptionWithCmk 的值。
SearchSemanticSearch	定義 SearchSemanticSearch 的值。 KnownSearchSemanticSearch 可以與 SearchSemanticSearch 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 disabled：指示搜索服務禁用語義重新排序器。 這是預設值。 free：在搜索服務上啟用語義重新排序器，並指示將在免費計劃的限制內使用它。 免費方案會限制語意排名要求的數量，並免費提供。 這是新布建搜尋服務的預設值。 standard：在搜索服務上啟用語義重新排序器作為計費功能，具有更高的輸送量和語義重新排序查詢的數量。
SearchServiceStatus	定義 SearchServiceStatus 的值。
ServicesCheckNameAvailabilityResponse	包含 checkNameAvailability 作業的響應數據。
ServicesCreateOrUpdateResponse	包含 createOrUpdate 作業的響應數據。
ServicesGetResponse	包含取得作業的回應數據。
ServicesListByResourceGroupNextResponse	包含 listByResourceGroupNext 作業的響應數據。
ServicesListByResourceGroupResponse	包含 listByResourceGroup 作業的響應數據。
ServicesListBySubscriptionNextResponse	包含 listBySubscriptionNext 作業的響應數據。
ServicesListBySubscriptionResponse	包含 listBySubscription 作業的響應數據。
ServicesUpdateResponse	包含更新作業的回應數據。
ServicesUpgradeResponse	包含升級作業的響應數據。
Severity	定義嚴重性的值。 KnownSeverity 可以與嚴重替使用，此列舉包含服務支援的已知值。 服務支援的已知值 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 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 無效：搜索服務名稱與命名要求不匹配。 已存在：搜尋服務名稱已指派給不同的搜尋服務。
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（） 的接續令牌。