@azure/arm-search package
インターフェイス
| AccessRule |
ネットワーク セキュリティ境界構成プロファイルのアクセス規則 |
| AccessRuleProperties |
アクセス規則のプロパティ |
| AccessRulePropertiesSubscriptionsItem |
サブスクリプション識別子 |
| AdminKeyResult |
特定の Azure AI Search サービスのプライマリおよびセカンダリ管理者 API キーを含む応答。 |
| AdminKeys |
AdminKeys を表すインターフェイス。 |
| AdminKeysGetOptionalParams |
省略可能なパラメーター。 |
| AdminKeysRegenerateOptionalParams |
省略可能なパラメーター。 |
| AsyncOperationResult |
実行時間の長い非同期共有プライベート リンク リソース操作の詳細。 |
| CheckNameAvailabilityInput |
チェック名可用性 API の入力。 |
| CheckNameAvailabilityOutput |
チェック名可用性 API の出力。 |
| CloudError |
API エラーに関する情報が含まれています。 |
| CloudErrorBody |
エラー コードとメッセージを含む特定の API エラーについて説明します。 |
| DataPlaneAadOrApiKeyAuthOption |
認証には、API キーまたは Microsoft Entra ID テナントからのアクセス トークンを使用できることを示します。 |
| DataPlaneAuthOptions |
検索サービスがデータ プレーン要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。 |
| EncryptionWithCmk |
カスタマー マネージド キーを使用して検索サービス内のリソースを暗号化する方法を決定するポリシーについて説明します。 |
| Identity |
検索サービス ID の詳細。 null 値は、検索サービスに ID が割り当てられていないことを示します。 |
| IpRule |
Azure AI Search サービスの IP 制限規則。 |
| ListQueryKeysResult |
特定の Azure AI Search サービスのクエリ API キーを含む応答。 |
| NetworkRuleSet |
Azure AI Search サービスに到達する方法を決定するネットワーク固有のルール。 |
| NetworkSecurityPerimeter |
ネットワーク セキュリティ境界 (NSP) に関する情報 |
| NetworkSecurityPerimeterConfiguration |
ネットワーク セキュリティ境界 (NSP) 構成リソース |
| NetworkSecurityPerimeterConfigurationListResult |
リスト NSP (ネットワーク セキュリティ境界) 構成要求の結果。 |
| NetworkSecurityPerimeterConfigurationProperties |
ネットワーク セキュリティ構成プロパティ。 |
| NetworkSecurityPerimeterConfigurations |
NetworkSecurityPerimeterConfigurations を表すインターフェイス。 |
| NetworkSecurityPerimeterConfigurationsGetOptionalParams |
省略可能なパラメーター。 |
| NetworkSecurityPerimeterConfigurationsListByServiceNextOptionalParams |
省略可能なパラメーター。 |
| NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams |
省略可能なパラメーター。 |
| NetworkSecurityPerimeterConfigurationsReconcileHeaders |
NetworkSecurityPerimeterConfigurations_reconcile操作のヘッダーを定義します。 |
| NetworkSecurityPerimeterConfigurationsReconcileOptionalParams |
省略可能なパラメーター。 |
| NetworkSecurityProfile |
ネットワーク セキュリティ境界構成プロファイル |
| Operation |
リソース プロバイダー操作 API から返される REST API 操作の詳細 |
| OperationDisplay |
この特定の操作のローカライズされた表示情報。 |
| OperationListResult |
REST API 操作を一覧表示する要求の結果。 これには、操作の一覧と、次の結果セットを取得するための URL が含まれています。 |
| Operations |
操作を表すインターフェイス。 |
| OperationsListOptionalParams |
省略可能なパラメーター。 |
| PrivateEndpointConnection |
Azure AI Search サービスへの既存のプライベート エンドポイント接続について説明します。 |
| PrivateEndpointConnectionListResult |
プライベート エンドポイント接続の一覧を含む応答。 |
| PrivateEndpointConnectionProperties |
検索サービスへの既存のプライベート エンドポイント接続のプロパティについて説明します。 |
| PrivateEndpointConnectionPropertiesPrivateEndpoint |
Microsoft.Network プロバイダーからのプライベート エンドポイント リソース。 |
| PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState |
プライベート エンドポイントへの既存の Azure Private Link サービス接続の現在の状態について説明します。 |
| PrivateEndpointConnections |
PrivateEndpointConnections を表すインターフェイス。 |
| PrivateEndpointConnectionsDeleteOptionalParams |
省略可能なパラメーター。 |
| PrivateEndpointConnectionsGetOptionalParams |
省略可能なパラメーター。 |
| PrivateEndpointConnectionsListByServiceNextOptionalParams |
省略可能なパラメーター。 |
| PrivateEndpointConnectionsListByServiceOptionalParams |
省略可能なパラメーター。 |
| PrivateEndpointConnectionsUpdateOptionalParams |
省略可能なパラメーター。 |
| PrivateLinkResource |
Azure AI Search サービスでサポートされているプライベート リンク リソースについて説明します。 |
| PrivateLinkResourceProperties |
Azure AI Search サービスでサポートされているプライベート リンク リソースのプロパティについて説明します。 特定の API バージョンの場合、これは共有プライベート リンク リソースの作成時に "サポートされている" groupIds を表します。 |
| PrivateLinkResources |
PrivateLinkResources を表すインターフェイス。 |
| PrivateLinkResourcesListSupportedOptionalParams |
省略可能なパラメーター。 |
| PrivateLinkResourcesResult |
サポートされている Private Link リソースの一覧を含む応答。 |
| ProvisioningIssue |
ネットワーク セキュリティ境界構成のプロビジョニングの問題について説明します |
| ProvisioningIssueProperties |
ネットワーク セキュリティ境界 (NSP) 構成のプロビジョニングの問題の詳細。 リソース プロバイダーは、検出された個別の問題ごとに個別のプロビジョニングの問題要素を生成し、意味のある独特の説明と、適切な suggestedResourceIds と suggestedAccessRules を含める必要があります |
| ProxyResource |
Azure Resource Manager プロキシ リソースのリソース モデル定義。 タグと場所はありません |
| QueryKey |
インデックスのドキュメント コレクションに対する読み取り専用アクセス許可を伝達する、特定の Azure AI Search サービスの API キーについて説明します。 |
| QueryKeys |
QueryKeys を表すインターフェイス。 |
| QueryKeysCreateOptionalParams |
省略可能なパラメーター。 |
| QueryKeysDeleteOptionalParams |
省略可能なパラメーター。 |
| QueryKeysListBySearchServiceNextOptionalParams |
省略可能なパラメーター。 |
| QueryKeysListBySearchServiceOptionalParams |
省略可能なパラメーター。 |
| QuotaUsageResult |
特定の SKU のクォータ使用量について説明します。 |
| QuotaUsageResultName |
Azure AI Search でサポートされている SKU の名前。 |
| QuotaUsagesListResult |
Azure AI Search でサポートされているすべての SKU のクォータ使用量情報を含む応答。 |
| Resource |
すべての Azure Resource Manager リソースの応答で返される共通フィールド |
| ResourceAssociation |
リソースの関連付けに関する情報 |
| SearchManagementClientOptionalParams |
省略可能なパラメーター。 |
| SearchManagementRequestOptions |
パラメータグループ |
| SearchService |
Azure AI Search サービスとその現在の状態について説明します。 |
| SearchServiceListResult |
Azure AI Search サービスの一覧を含む応答。 |
| SearchServiceUpdate |
Azure AI Search サービスの更新に使用されるパラメーター。 |
| Services |
サービスを表すインターフェイス。 |
| ServicesCheckNameAvailabilityOptionalParams |
省略可能なパラメーター。 |
| ServicesCreateOrUpdateOptionalParams |
省略可能なパラメーター。 |
| ServicesDeleteOptionalParams |
省略可能なパラメーター。 |
| ServicesGetOptionalParams |
省略可能なパラメーター。 |
| ServicesListByResourceGroupNextOptionalParams |
省略可能なパラメーター。 |
| ServicesListByResourceGroupOptionalParams |
省略可能なパラメーター。 |
| ServicesListBySubscriptionNextOptionalParams |
省略可能なパラメーター。 |
| ServicesListBySubscriptionOptionalParams |
省略可能なパラメーター。 |
| ServicesUpdateOptionalParams |
省略可能なパラメーター。 |
| ServicesUpgradeHeaders |
Services_upgrade操作のヘッダーを定義します。 |
| ServicesUpgradeOptionalParams |
省略可能なパラメーター。 |
| ShareablePrivateLinkResourceProperties |
Azure AI Search でサポートされているプライベート リンク サービスにオンボードされたリソースの種類のプロパティについて説明します。 |
| ShareablePrivateLinkResourceType |
Azure AI Search でサポートされているプライベート リンク サービスにオンボードされたリソースの種類について説明します。 |
| SharedPrivateLinkResource |
Azure AI Search サービスによって管理される共有プライベート リンク リソースについて説明します。 |
| SharedPrivateLinkResourceListResult |
共有プライベート リンク リソースの一覧を含む応答。 |
| SharedPrivateLinkResourceProperties |
Azure AI Search サービスによって管理されている既存の共有プライベート リンク リソースのプロパティについて説明します。 |
| SharedPrivateLinkResources |
SharedPrivateLinkResources を表すインターフェイス。 |
| SharedPrivateLinkResourcesCreateOrUpdateOptionalParams |
省略可能なパラメーター。 |
| SharedPrivateLinkResourcesDeleteOptionalParams |
省略可能なパラメーター。 |
| SharedPrivateLinkResourcesGetOptionalParams |
省略可能なパラメーター。 |
| SharedPrivateLinkResourcesListByServiceNextOptionalParams |
省略可能なパラメーター。 |
| SharedPrivateLinkResourcesListByServiceOptionalParams |
省略可能なパラメーター。 |
| Sku |
課金レートと容量の制限を決定する検索サービスの SKU を定義します。 |
| SystemData |
リソースの作成と最後の変更に関連するメタデータ。 |
| TrackedResource |
Azure Resource Manager のリソース モデル定義は、"タグ" と "場所" を持つ最上位リソースを追跡しました |
| UsageBySubscriptionSkuOptionalParams |
省略可能なパラメーター。 |
| Usages |
使用法を表すインターフェイス。 |
| UsagesListBySubscriptionNextOptionalParams |
省略可能なパラメーター。 |
| UsagesListBySubscriptionOptionalParams |
省略可能なパラメーター。 |
| UserAssignedIdentity |
ユーザー割り当て ID プロパティ |
型エイリアス
| AadAuthFailureMode |
AadAuthFailureMode の値を定義します。 |
| AccessRuleDirection |
AccessRuleDirection の値を定義します。 サービスでサポートされている既知の値
受信: セキュリティで保護されたリソースへの受信ネットワーク トラフィックに適用されます。 |
| ActionType |
ActionType の値を定義します。 サービスでサポートされている既知の値Internal |
| AdminKeyKind |
AdminKeyKind の値を定義します。 |
| AdminKeysGetResponse |
取得操作の応答データが含まれています。 |
| AdminKeysRegenerateResponse |
再生成操作の応答データが含まれています。 |
| ComputeType |
ComputeType の値を定義します。 サービスでサポートされている既知の値
default: デフォルト・コンピュートを使用してサービスを作成します。 |
| CreatedByType |
CreatedByType の値を定義します。 サービスでサポートされている既知の値
User |
| HostingMode |
HostingMode の値を定義します。 |
| IdentityType |
IdentityType の値を定義します。 サービスでサポートされている既知の値
なし: 検索サービスに関連付けられている ID を削除する必要があることを示します。 |
| IssueType |
IssueType の値を定義します。 サービスでサポートされている既知の値
不明な: 不明な問題の種類 |
| NetworkSecurityPerimeterConfigurationProvisioningState |
NetworkSecurityPerimeterConfigurationProvisioningState の値を定義します。 サービスでサポートされている既知の値
Succeeded |
| NetworkSecurityPerimeterConfigurationsGetResponse |
取得操作の応答データが含まれています。 |
| NetworkSecurityPerimeterConfigurationsListByServiceNextResponse |
listByServiceNext 操作の応答データを格納します。 |
| NetworkSecurityPerimeterConfigurationsListByServiceResponse |
listByService 操作の応答データを格納します。 |
| NetworkSecurityPerimeterConfigurationsReconcileResponse |
調整操作の応答データが含まれています。 |
| OperationsListResponse |
リスト操作の応答データが含まれています。 |
| Origin |
Origin の値を定義します。 サービスでサポートされている既知の値
user |
| PrivateEndpointConnectionsDeleteResponse |
削除操作の応答データが含まれています。 |
| PrivateEndpointConnectionsGetResponse |
取得操作の応答データが含まれています。 |
| PrivateEndpointConnectionsListByServiceNextResponse |
listByServiceNext 操作の応答データを格納します。 |
| PrivateEndpointConnectionsListByServiceResponse |
listByService 操作の応答データを格納します。 |
| PrivateEndpointConnectionsUpdateResponse |
更新操作の応答データが含まれています。 |
| PrivateLinkResourcesListSupportedResponse |
listSupported 操作の応答データが含まれています。 |
| PrivateLinkServiceConnectionProvisioningState |
PrivateLinkServiceConnectionProvisioningState の値を定義します。 サービスでサポートされている既知の値
の更新: プライベート リンク サービス接続は、他のリソースと共に作成され、完全に機能するように処理中です。 |
| PrivateLinkServiceConnectionStatus |
PrivateLinkServiceConnectionStatus の値を定義します。 |
| ProvisioningState |
ProvisioningState の値を定義します。 |
| PublicNetworkAccess |
PublicNetworkAccess の値を定義します。 サービスでサポートされている既知の値
enabled: 検索サービスには、パブリック インターネットから発信されるトラフィックからアクセスできます。 |
| QueryKeysCreateResponse |
作成操作の応答データが含まれています。 |
| QueryKeysListBySearchServiceNextResponse |
listBySearchServiceNext 操作の応答データを格納します。 |
| QueryKeysListBySearchServiceResponse |
listBySearchService 操作の応答データを格納します。 |
| ResourceAssociationAccessMode |
ResourceAssociationAccessMode の値を定義します。 サービスでサポートされている既知の値
強制: アクセス モードの適用 - アクセス チェックに失敗したリソースへのトラフィックがブロックされる |
| SearchBypass |
SearchBypass の値を定義します。 サービスでサポートされている既知の値
なし: 'ipRules' セクションで定義されたルールをバイパスできないオリジンがないことを示します。 これが既定値です。 |
| SearchDataExfiltrationProtection |
SearchDataExfiltrationProtection の値を定義します。 サービスでサポートされている既知の値BlockAll: すべてのデータ流出シナリオが無効であることを示します。 |
| SearchEncryptionComplianceStatus |
SearchEncryptionComplianceStatus の値を定義します。 |
| SearchEncryptionWithCmk |
SearchEncryptionWithCmk の値を定義します。 |
| SearchSemanticSearch |
SearchSemanticSearch の値を定義します。 サービスでサポートされている既知の値
disabled: 検索サービスに対してセマンティック リランカーが無効になっていることを示します。 これが既定値です。 |
| SearchServiceStatus |
SearchServiceStatus の値を定義します。 |
| ServicesCheckNameAvailabilityResponse |
checkNameAvailability 操作の応答データを格納します。 |
| ServicesCreateOrUpdateResponse |
createOrUpdate 操作の応答データを格納します。 |
| ServicesGetResponse |
取得操作の応答データが含まれています。 |
| ServicesListByResourceGroupNextResponse |
listByResourceGroupNext 操作の応答データを格納します。 |
| ServicesListByResourceGroupResponse |
listByResourceGroup 操作の応答データを格納します。 |
| ServicesListBySubscriptionNextResponse |
listBySubscriptionNext 操作の応答データを格納します。 |
| ServicesListBySubscriptionResponse |
listBySubscription 操作の応答データを格納します。 |
| ServicesUpdateResponse |
更新操作の応答データが含まれています。 |
| ServicesUpgradeResponse |
アップグレード操作の応答データが含まれています。 |
| Severity |
重大度の値を定義します。 サービスでサポートされている既知の値
Warning |
| SharedPrivateLinkResourceAsyncOperationResult |
SharedPrivateLinkResourceAsyncOperationResult の値を定義します。 サービスでサポートされている既知の値
Running |
| SharedPrivateLinkResourceProvisioningState |
SharedPrivateLinkResourceProvisioningState の値を定義します。 サービスでサポートされている既知の値
更新中: 共有プライベート リンク リソースは、完全に機能するために他のリソースとともに作成中です。 |
| SharedPrivateLinkResourceStatus |
SharedPrivateLinkResourceStatus の値を定義します。 サービスでサポートされている既知の値
保留中: 共有プライベート リンク リソースが作成され、承認待ちです。 |
| SharedPrivateLinkResourcesCreateOrUpdateResponse |
createOrUpdate 操作の応答データを格納します。 |
| SharedPrivateLinkResourcesGetResponse |
取得操作の応答データが含まれています。 |
| SharedPrivateLinkResourcesListByServiceNextResponse |
listByServiceNext 操作の応答データを格納します。 |
| SharedPrivateLinkResourcesListByServiceResponse |
listByService 操作の応答データを格納します。 |
| SkuName |
SkuName の値を定義します。 サービスでサポートされている既知の値
無料: SLA 保証がなく、課金対象レベルで提供される機能のサブセットを備えた無料レベル。 |
| UnavailableNameReason |
UnavailableNameReason の値を定義します。 サービスでサポートされている既知の値
無効: 検索サービス名が名前付け要件と一致しません。 |
| UpgradeAvailable |
UpgradeAvailable の値を定義します。 サービスでサポートされている既知の値
notAvailable: 現在、サービスのアップグレードは利用できません。 |
| UsageBySubscriptionSkuResponse |
usageBySubscriptionSku 操作の応答データを格納します。 |
| UsagesListBySubscriptionNextResponse |
listBySubscriptionNext 操作の応答データを格納します。 |
| UsagesListBySubscriptionResponse |
listBySubscription 操作の応答データを格納します。 |
列挙型
関数
| get |
|
関数の詳細
getContinuationToken(unknown)
.value 反復子によって生成された最後の byPage を指定すると、後でその時点からページングを開始するために使用できる継続トークンを返します。
function getContinuationToken(page: unknown): string | undefined
パラメーター
- page
-
unknown
iteratorResult の value に byPage 反復子からアクセスするオブジェクト。
戻り値
string | undefined
今後の呼び出し中に byPage() に渡すことができる継続トークン。