@azure/arm-search package

クラス

SearchManagementClient

インターフェイス

AdminKeyResult	特定のAzure Cognitive Search サービスのプライマリおよびセカンダリ管理 API キーを含む応答。
AdminKeys	AdminKeys を表すインターフェイス。
AdminKeysGetOptionalParams	省略可能なパラメーター。
AdminKeysRegenerateOptionalParams	省略可能なパラメーター。
AsyncOperationResult	実行時間の長い非同期共有プライベート リンク リソース操作の詳細
CheckNameAvailabilityInput	チェック名前可用性 API の入力。
CheckNameAvailabilityOutput	チェック名前可用性 API の出力。
CloudError	API エラーに関する情報が含まれます。
CloudErrorBody	エラー コードとメッセージを含む特定の API エラーについて説明します。
DataPlaneAadOrApiKeyAuthOption	API キーまたは Azure Active Directory からのアクセス トークンを認証に使用できることを示します。
DataPlaneAuthOptions	Search Serviceのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
EncryptionWithCmk	カスタマー マネージド キーを使用して検索サービス内のリソースを暗号化する方法を決定するポリシーについて説明します。
Identity	リソースの ID。
IpRule	Azure Cognitive Search サービスの IP 制限規則。
ListQueryKeysResult	特定のAzure Cognitive Search サービスのクエリ API キーを含む応答。
NetworkRuleSet	Azure Cognitive Search サービスに到達する方法を決定するネットワーク固有の規則。
Operation	REST API 操作について説明します。
OperationDisplay	操作を記述する オブジェクト。
OperationListResult	REST API 操作を一覧表示する要求の結果。 これには、次の結果セットを取得するための操作の一覧と URL が含まれています。
Operations	操作を表すインターフェイス。
OperationsListOptionalParams	省略可能なパラメーター。
PrivateEndpointConnection	Azure Cognitive Search サービスへの既存のプライベート エンドポイント接続について説明します。
PrivateEndpointConnectionListResult	プライベート エンドポイント接続の一覧を含む応答。
PrivateEndpointConnectionProperties	Azure Cognitive Search サービスへの既存のプライベート エンドポイント接続のプロパティについて説明します。
PrivateEndpointConnectionPropertiesPrivateEndpoint	Microsoft.Network プロバイダーからのプライベート エンドポイント リソース。
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Azure プライベート エンドポイントへの既存のPrivate Link サービス接続の現在の状態について説明します。
PrivateEndpointConnections	PrivateEndpointConnections を表すインターフェイス。
PrivateEndpointConnectionsDeleteOptionalParams	省略可能なパラメーター。
PrivateEndpointConnectionsGetOptionalParams	省略可能なパラメーター。
PrivateEndpointConnectionsListByServiceNextOptionalParams	省略可能なパラメーター。
PrivateEndpointConnectionsListByServiceOptionalParams	省略可能なパラメーター。
PrivateEndpointConnectionsUpdateOptionalParams	省略可能なパラメーター。
PrivateLinkResource	Azure Cognitive Search サービスでサポートされているプライベート リンク リソースについて説明します。
PrivateLinkResourceProperties	Azure Cognitive Search サービスでサポートされているプライベート リンク リソースのプロパティについて説明します。 特定の API バージョンの場合、これは共有プライベート リンク リソースを作成するときの "サポートされている" groupIds を表します。
PrivateLinkResources	PrivateLinkResources を表すインターフェイス。
PrivateLinkResourcesListSupportedOptionalParams	省略可能なパラメーター。
PrivateLinkResourcesResult	サポートされているPrivate Linkリソースの一覧を含む応答。
QueryKey	クエリ操作専用のアクセス許可を持つ特定のAzure Cognitive Search サービスの API キーについて説明します。
QueryKeys	QueryKeys を表すインターフェイス。
QueryKeysCreateOptionalParams	省略可能なパラメーター。
QueryKeysDeleteOptionalParams	省略可能なパラメーター。
QueryKeysListBySearchServiceNextOptionalParams	省略可能なパラメーター。
QueryKeysListBySearchServiceOptionalParams	省略可能なパラメーター。
QuotaUsageResult	Azure Cognitive Searchでサポートされている特定の SKU のクォータ使用量について説明します。
QuotaUsageResultName	Azure Cognitive Searchでサポートされている SKU の名前。
QuotaUsagesListResult	Azure Cognitive Search サービスでサポートされているすべての SKU のクォータ使用量情報を含む応答。
Resource	すべての Azure Resource Manager リソースの応答で返される一般的なフィールド
SearchManagementClientOptionalParams	省略可能なパラメーター。
SearchManagementRequestOptions	パラメーター グループ
SearchService	Azure Cognitive Search サービスとその現在の状態について説明します。
SearchServiceListResult	Azure Cognitive Search サービスの一覧を含む応答。
SearchServiceUpdate	Azure Cognitive Search サービスの更新に使用されるパラメーター。
Services	サービスを表すインターフェイス。
ServicesCheckNameAvailabilityOptionalParams	省略可能なパラメーター。
ServicesCreateOrUpdateOptionalParams	省略可能なパラメーター。
ServicesDeleteOptionalParams	省略可能なパラメーター。
ServicesGetOptionalParams	省略可能なパラメーター。
ServicesListByResourceGroupNextOptionalParams	省略可能なパラメーター。
ServicesListByResourceGroupOptionalParams	省略可能なパラメーター。
ServicesListBySubscriptionNextOptionalParams	省略可能なパラメーター。
ServicesListBySubscriptionOptionalParams	省略可能なパラメーター。
ServicesUpdateOptionalParams	省略可能なパラメーター。
ShareablePrivateLinkResourceProperties	Azure Cognitive Searchでサポートされているプライベート リンク サービスにオンボードされているリソースの種類のプロパティについて説明します。
ShareablePrivateLinkResourceType	Azure Cognitive Searchでサポートされているプライベート リンク サービスにオンボードされているリソースの種類について説明します。
SharedPrivateLinkResource	Azure Cognitive Search サービスによって管理される共有Private Link リソースについて説明します。
SharedPrivateLinkResourceListResult	共有Private Link リソースの一覧を含む応答。
SharedPrivateLinkResourceProperties	Azure Cognitive Search サービスによって管理される既存の共有Private Link リソースのプロパティについて説明します。
SharedPrivateLinkResources	SharedPrivateLinkResources を表すインターフェイス。
SharedPrivateLinkResourcesCreateOrUpdateOptionalParams	省略可能なパラメーター。
SharedPrivateLinkResourcesDeleteOptionalParams	省略可能なパラメーター。
SharedPrivateLinkResourcesGetOptionalParams	省略可能なパラメーター。
SharedPrivateLinkResourcesListByServiceNextOptionalParams	省略可能なパラメーター。
SharedPrivateLinkResourcesListByServiceOptionalParams	省略可能なパラメーター。
Sku	価格レベルと容量の制限を決定するAzure Cognitive Search サービスの SKU を定義します。
TrackedResource	'tags' と 'location' を持つ、Azure Resource Manager追跡される最上位リソースのリソース モデル定義
UsageBySubscriptionSkuOptionalParams	省略可能なパラメーター。
Usages	使用法を表すインターフェイス。
UsagesListBySubscriptionNextOptionalParams	省略可能なパラメーター。
UsagesListBySubscriptionOptionalParams	省略可能なパラメーター。

型エイリアス

AadAuthFailureMode	AadAuthFailureMode の値を定義します。
AdminKeyKind	AdminKeyKind の値を定義します。
AdminKeysGetResponse	get 操作の応答データが含まれます。
AdminKeysRegenerateResponse	再生成操作の応答データを格納します。
HostingMode	HostingMode の値を定義します。
IdentityType	IdentityType の値を定義します。
OperationsListResponse	リスト操作の応答データが含まれます。
PrivateEndpointConnectionsDeleteResponse	削除操作の応答データが含まれます。
PrivateEndpointConnectionsGetResponse	get 操作の応答データが含まれます。
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: 検索サービスでセマンティック検索が無効になっていることを示します。 free: 検索サービスでセマンティック検索を有効にし、Free レベルの制限内で使用されることを示します。 これにより、セマンティック検索要求の量が上限となり、追加料金なしで提供されます。 これは、新しくプロビジョニングされた検索サービスの既定値です。 standard: より高いスループットと大量のセマンティック検索クエリを使用して、課金対象の機能として検索サービスでセマンティック検索を有効にします。
SearchServiceStatus	SearchServiceStatus の値を定義します。
ServicesCheckNameAvailabilityResponse	checkNameAvailability 操作の応答データが含まれています。
ServicesCreateOrUpdateResponse	createOrUpdate 操作の応答データが含まれます。
ServicesGetResponse	get 操作の応答データが含まれます。
ServicesListByResourceGroupNextResponse	listByResourceGroupNext 操作の応答データが含まれます。
ServicesListByResourceGroupResponse	listByResourceGroup 操作の応答データが含まれます。
ServicesListBySubscriptionNextResponse	listBySubscriptionNext 操作の応答データを格納します。
ServicesListBySubscriptionResponse	listBySubscription 操作の応答データが含まれます。
ServicesUpdateResponse	更新操作の応答データが含まれます。
SharedPrivateLinkResourceAsyncOperationResult	SharedPrivateLinkResourceAsyncOperationResult の値を定義します。 KnownSharedPrivateLinkResourceAsyncOperationResult は SharedPrivateLinkResourceAsyncOperationResult と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 実行中 Succeeded Failed
SharedPrivateLinkResourceProvisioningState	SharedPrivateLinkResourceProvisioningState の値を定義します。
SharedPrivateLinkResourceStatus	SharedPrivateLinkResourceStatus の値を定義します。
SharedPrivateLinkResourcesCreateOrUpdateResponse	createOrUpdate 操作の応答データが含まれます。
SharedPrivateLinkResourcesGetResponse	get 操作の応答データが含まれます。
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

反復子から IteratorResult にアクセス value する byPage オブジェクト。

戻り値

string | undefined

今後の呼び出し中に byPage() に渡すことができる継続トークン。