共用方式為


@azure/arm-search package

類別

SearchManagementClient

介面

AdminKeyResult

包含指定 Azure 認知搜尋服務之主要和次要系統管理員 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

包含支援的 Private Link 資源清單的回應。

QueryKey

描述指定 Azure 認知搜尋服務的 API 金鑰,此服務僅具有查詢作業的許可權。

QueryKeys

表示 QueryKeys 的介面。

QueryKeysCreateOptionalParams

選擇性參數。

QueryKeysDeleteOptionalParams

選擇性參數。

QueryKeysListBySearchServiceNextOptionalParams

選擇性參數。

QueryKeysListBySearchServiceOptionalParams

選擇性參數。

QuotaUsageResult

描述 Azure 認知搜尋所支援特定 SKU 的配額使用量。

QuotaUsageResultName

Azure 認知搜尋所支援 SKU 的名稱。

QuotaUsagesListResult

包含 Azure 認知搜尋服務所有支援 SKU 配額使用量資訊的回應。

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 認知搜尋服務所管理的共用 Private Link 資源。

SharedPrivateLinkResourceListResult

包含共用私人鏈接資源清單的回應。

SharedPrivateLinkResourceProperties

描述 Azure 認知搜尋服務所管理之現有共用私人鏈接資源的屬性。

SharedPrivateLinkResources

代表 SharedPrivateLinkResources 的介面。

SharedPrivateLinkResourcesCreateOrUpdateOptionalParams

選擇性參數。

SharedPrivateLinkResourcesDeleteOptionalParams

選擇性參數。

SharedPrivateLinkResourcesGetOptionalParams

選擇性參數。

SharedPrivateLinkResourcesListByServiceNextOptionalParams

選擇性參數。

SharedPrivateLinkResourcesListByServiceOptionalParams

選擇性參數。

Sku

定義 Azure 認知搜尋服務的 SKU,以決定價格區間和容量限制。

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 可以與 UnavailableNameReason 交替使用,此列舉包含服務支援的已知值。

服務支援的已知值

無效:搜尋服務名稱不符合命名需求。
已存在:搜尋服務名稱已指派給不同的搜尋服務。

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() 的接續令牌。