@azure/arm-search package

類別

SearchManagementClient

介面

AdminKeyResult

回應,其中包含指定之Azure 認知搜尋服務的主要和次要系統管理員 API 金鑰。

AdminKeys

表示 AdminKeys 的介面。

AdminKeysGetOptionalParams

選用參數。

AdminKeysRegenerateOptionalParams

選用參數。

AsyncOperationResult

長時間執行非同步共用私人連結資源作業的詳細資料

CheckNameAvailabilityInput

檢查名稱可用性 API 的輸入。

CheckNameAvailabilityOutput

檢查名稱可用性 API 的輸出。

CloudError

包含 API 錯誤的相關資訊。

CloudErrorBody

描述具有錯誤碼和訊息的特定 API 錯誤。

DataPlaneAadOrApiKeyAuthOption

指出 API 金鑰或來自 Azure Active Directory 的存取權杖可用於驗證。

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 私人端點之現有Private Link服務連線的目前狀態。

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

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

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

包含共用Private Link資源的回應。

SharedPrivateLinkResourceProperties

描述由 Azure 認知搜尋 服務管理的現有共用Private Link資源屬性。

SharedPrivateLinkResources

代表 SharedPrivateLinkResources 的介面。

SharedPrivateLinkResourcesCreateOrUpdateOptionalParams

選用參數。

SharedPrivateLinkResourcesDeleteOptionalParams

選用參數。

SharedPrivateLinkResourcesGetOptionalParams

選用參數。

SharedPrivateLinkResourcesListByServiceNextOptionalParams

選用參數。

SharedPrivateLinkResourcesListByServiceOptionalParams

選用參數。

Sku

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

TrackedResource

Azure Resource Manager追蹤的最上層資源的資源模型定義,其具有 'tags' 和 'location'

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

服務支援的已知值

disabled:指出已停用搜尋服務的語意搜尋。
免費:在搜尋服務上啟用語意搜尋,並指出它必須在免費層的限制內使用。 這會限制語意搜尋要求的數量,且不需額外費用。 這是新布建的搜尋服務預設值。
標準:以較高的輸送量和語意搜尋查詢數量,在搜尋服務上啟用語意搜尋服務作為計費功能。

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

從反覆運算器存取 value IteratorResult byPage 的物件。

傳回

string | undefined

未來呼叫期間可以傳入 byPage () 的接續權杖。