Services - Get

リファレンス

サービス:: Search Management

API バージョン:: 2023-11-01

指定されたリソースグループ内の指定された名前を持つ検索サービスを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}?api-version=2023-11-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	現在のサブスクリプション内のリソースグループの名前。この値は、Azure Resource Manager API またはポータルから取得できます。
searchServiceName	path	True	string	指定したリソースグループに関連付けられている検索サービスの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションの一意識別子。この値は、Azure Resource Manager API、コマンドラインツール、またはポータルから取得できます。
api-version	query	True	string	各要求に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string (uuid)	この要求を識別するクライアントによって生成される GUID 値。指定した場合、これは要求を追跡する方法として応答情報に含まれます。

応答

名前	型	説明
200 OK	SearchService	検索サービス定義が正常に取得され、応答中です。プロビジョニングまたはスケール操作の完了をポーリングする場合は、provisioningState プロパティを使用してその状態を確認できます。
Other Status Codes	CloudError	HTTP 404 (見つかりません): サブスクリプション、リソースグループ、または検索サービス名が見つかりませんでした。

セキュリティ

azure_auth

Microsoft Entra ID OAuth2 承認フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

SearchGetService

要求のサンプル

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01


/**
 * Samples for Services GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.json
     */
    /**
     * Sample code: SearchGetService.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void searchGetService(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getServices().getByResourceGroupWithResponse("rg1",
            "mysearchservice", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python search_get_service.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SearchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.services.get(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.json
func ExampleServicesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewServicesClient().Get(ctx, "rg1", "mysearchservice", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Service = armsearch.Service{
	// 	Name: to.Ptr("mysearchservice"),
	// 	Type: to.Ptr("Microsoft.Search/searchServices"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"app-name": to.Ptr("My e-commerce app"),
	// 	},
	// 	Properties: &armsearch.ServiceProperties{
	// 		HostingMode: to.Ptr(armsearch.HostingModeDefault),
	// 		NetworkRuleSet: &armsearch.NetworkRuleSet{
	// 			IPRules: []*armsearch.IPRule{
	// 			},
	// 		},
	// 		PartitionCount: to.Ptr[int32](1),
	// 		PrivateEndpointConnections: []*armsearch.PrivateEndpointConnection{
	// 		},
	// 		ProvisioningState: to.Ptr(armsearch.ProvisioningStateSucceeded),
	// 		PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessEnabled),
	// 		ReplicaCount: to.Ptr[int32](3),
	// 		Status: to.Ptr(armsearch.SearchServiceStatusRunning),
	// 		StatusDetails: to.Ptr(""),
	// 	},
	// 	SKU: &armsearch.SKU{
	// 		Name: to.Ptr(armsearch.SKUNameStandard),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the search service with the given name in the given resource group.
 *
 * @summary Gets the search service with the given name in the given resource group.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.json
 */
async function searchGetService() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.services.get(resourceGroupName, searchServiceName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.json
// this example is just showing the usage of "Services_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);

// invoke the operation
SearchServiceResource result = await searchService.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "privateEndpointConnections": []
  }
}

定義

名前	説明
AadAuthFailureMode	認証に失敗した要求に対して検索サービスのデータプレーン API が送信する応答について説明します。
ApiKeyOnly	認証に使用できるのは API キーだけであることを示します。
CloudError	API エラーに関する情報が含まれています。
CloudErrorBody	エラーコードとメッセージを含む特定の API エラーについて説明します。
DataPlaneAadOrApiKeyAuthOption	認証には、API キーまたは Microsoft Entra ID テナントからのアクセストークンを使用できることを示します。
DataPlaneAuthOptions	検索サービスがデータプレーン要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
EncryptionWithCmk	検索サービス内のリソースを customer=managed keys で暗号化する方法を決定するポリシーについて説明します。
HostingMode	Standard3 SKU にのみ適用されます。このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。他のすべての SKU の場合、この値は 'default' である必要があります。
Identity	リソースの ID。
IdentityType	ID の種類。
IpRule	検索サービスの IP 制限規則。
NetworkRuleSet	検索サービスに到達する方法を決定するネットワーク固有のルール。
PrivateEndpoint	Microsoft.Network プロバイダーからのプライベートエンドポイントリソース。
PrivateEndpointConnection	検索サービスへの既存のプライベートエンドポイント接続について説明します。
PrivateEndpointConnectionProperties	検索サービスへの既存のプライベートエンドポイント接続のプロパティについて説明します。
PrivateLinkServiceConnectionProvisioningState	プライベートリンクサービス接続のプロビジョニング状態。有効な値は、更新、削除、失敗、成功、または不完全です
PrivateLinkServiceConnectionState	Azure プライベートエンドポイントへの既存の Private Link サービス接続の現在の状態について説明します。
PrivateLinkServiceConnectionStatus	プライベートリンクサービス接続の状態。有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。
ProvisioningState	検索サービスで最後に実行されたプロビジョニング操作の状態。プロビジョニングは、サービス容量の確立中に発生する中間状態です。容量が設定されると、provisioningState が "succeeded" または "failed" に変わります。クライアントアプリケーションは、Search Service の取得操作を使用して、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングして、操作が完了したタイミングを確認できます。無料サービスを使用している場合、この値は検索サービスの作成の呼び出しで直接 "成功" として返される傾向があります。これは、無料サービスで既に設定されている容量が使用されるためです。
PublicNetworkAccess	この値を "有効" に設定すると、既存の顧客リソースとテンプレートの重大な変更を回避できます。 "無効" に設定すると、パブリックインターフェイス経由のトラフィックは許可されず、プライベートエンドポイント接続は排他アクセス方式になります。
SearchEncryptionComplianceStatus	顧客が暗号化していないリソースを持つことに関して、検索サービスが準拠しているかどうかについて説明します。サービスに複数の非顧客暗号化リソースがあり、"強制" が "有効" の場合、サービスは "非準拠" としてマークされます。
SearchEncryptionWithCmk	顧客が暗号化していない 1 つ以上のリソースを検索サービスで強制する方法について説明します。
SearchSemanticSearch	セマンティック検索の可用性を制御するオプションを設定します。この構成は、特定の場所にある特定の検索 SKU に対してのみ可能です。
SearchService	検索サービスとその現在の状態について説明します。
SearchServiceStatus	検索サービスの状態。可能な値は次のとおりです:"running": 検索サービスは実行中であり、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。これは、基になる検索単位が正常でない場合に発生する可能性があります。検索サービスは動作している可能性が最も高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスが無効になっています。この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。サービスが機能低下状態、無効状態、またはエラー状態の場合、Microsoft は基になる問題を積極的に調査しています。これらの状態の専用サービスは、プロビジョニングされた検索ユニットの数に基づいて引き続き課金されます。
SharedPrivateLinkResource	検索サービスによって管理される Shared Private Link リソースについて説明します。
SharedPrivateLinkResourceProperties	検索サービスによって管理されている既存の Shared Private Link リソースのプロパティについて説明します。
SharedPrivateLinkResourceProvisioningState	共有プライベートリンクリソースのプロビジョニング状態。有効な値は、更新、削除、失敗、成功、または不完全です。
SharedPrivateLinkResourceStatus	共有プライベートリンクリソースの状態。有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。
Sku	課金レートと容量の制限を決定する検索サービスの SKU を定義します。
SkuName	検索サービスの SKU。有効な値には、'free': 共有サービスが含まれます。 "basic": 最大 3 つのレプリカを含む専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': 標準に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを備えた最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、インデックスが多い最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートします。

AadAuthFailureMode

列挙

認証に失敗した要求に対して検索サービスのデータプレーン API が送信する応答について説明します。

値	説明
http401WithBearerChallenge	認証に失敗した要求に HTTP 状態コード 401 (未承認) を提示し、ベアラーチャレンジを提示する必要があることを示します。
http403	認証に失敗した要求に HTTP 状態コード 403 (禁止) を表示する必要があることを示します。

ApiKeyOnly

Object

認証に使用できるのは API キーだけであることを示します。

CloudError

Object

API エラーに関する情報が含まれています。

名前	型	説明
error	CloudErrorBody	エラーコードとメッセージを含む特定の API エラーについて説明します。

CloudErrorBody

Object

エラーコードとメッセージを含む特定の API エラーについて説明します。

名前	型	説明
code	string	HTTP 状態コードよりも正確にエラー状態を記述するエラーコード。特定のエラーケースをプログラムで処理するために使用できます。
details	CloudErrorBody[]	このエラーに関連する入れ子になったエラーが含まれています。
message	string	エラーの詳細を説明し、デバッグ情報を提供するメッセージ。
target	string	特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。

DataPlaneAadOrApiKeyAuthOption

Object

認証には、API キーまたは Microsoft Entra ID テナントからのアクセストークンを使用できることを示します。

名前	型	説明
aadAuthFailureMode	AadAuthFailureMode	認証に失敗した要求に対して検索サービスのデータプレーン API が送信する応答について説明します。

DataPlaneAuthOptions

Object

検索サービスがデータプレーン要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。

名前	型	説明
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	認証には、API キーまたは Microsoft Entra ID テナントからのアクセストークンを使用できることを示します。
apiKeyOnly	ApiKeyOnly	認証に使用できるのは API キーだけであることを示します。

EncryptionWithCmk

Object

検索サービス内のリソースを customer=managed keys で暗号化する方法を決定するポリシーについて説明します。

名前	型	説明
encryptionComplianceStatus	SearchEncryptionComplianceStatus	顧客が暗号化していないリソースを持つことに関して、検索サービスが準拠しているかどうかについて説明します。サービスに複数の非顧客暗号化リソースがあり、"強制" が "有効" の場合、サービスは "非準拠" としてマークされます。
enforcement	SearchEncryptionWithCmk	顧客が暗号化していない 1 つ以上のリソースを検索サービスで強制する方法について説明します。

HostingMode

列挙

Standard3 SKU にのみ適用されます。このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。他のすべての SKU の場合、この値は 'default' である必要があります。

値	説明
default	インデックス数の制限は、SKU の既定の制限によって決まります。
highDensity	検索サービスに最大 1,000 個のインデックスを含めることができる Standard3 SKU のアプリケーションのみ。

Identity

Object

リソースの ID。

名前	型	説明
principalId	string	検索サービスのシステム割り当て ID のプリンシパル ID。
tenantId	string	検索サービスのシステム割り当て ID のテナント ID。
type	IdentityType	ID の種類。

IdentityType

列挙

ID の種類。

値	説明
None
SystemAssigned

IpRule

Object

検索サービスの IP 制限規則。

名前	型	説明
value	string	1 つの IPv4 アドレス (123.1.2.3 など) または CIDR 形式の IP 範囲 (たとえば、123.1.2.3/24) に対応する値。

NetworkRuleSet

Object

検索サービスに到達する方法を決定するネットワーク固有のルール。

名前	型	説明
ipRules	IpRule[]	IP ファイアウォールに使用される IP 制限規則の一覧。規則に一致しない IP はすべて、ファイアウォールによってブロックされます。これらの規則は、検索サービスの 'publicNetworkAccess' が '有効' の場合にのみ適用されます。

PrivateEndpoint

Object

Microsoft.Network プロバイダーからのプライベートエンドポイントリソース。

名前	型	説明
id	string	Microsoft.Network プロバイダーからのプライベートエンドポイントリソースのリソース ID。

PrivateEndpointConnection

Object

検索サービスへの既存のプライベートエンドポイント接続について説明します。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties	PrivateEndpointConnectionProperties	検索サービスへの既存のプライベートエンドポイント接続のプロパティについて説明します。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Object

検索サービスへの既存のプライベートエンドポイント接続のプロパティについて説明します。

名前	型	説明
groupId	string	プライベートリンクサービス接続の対象となるリソースのプロバイダーからのグループ ID。
privateEndpoint	PrivateEndpoint	Microsoft.Network プロバイダーからのプライベートエンドポイントリソース。
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Azure プライベートエンドポイントへの既存の Private Link サービス接続の現在の状態について説明します。
provisioningState	PrivateLinkServiceConnectionProvisioningState	プライベートリンクサービス接続のプロビジョニング状態。有効な値は、更新、削除、失敗、成功、または不完全です

PrivateLinkServiceConnectionProvisioningState

列挙

プライベートリンクサービス接続のプロビジョニング状態。有効な値は、更新、削除、失敗、成功、または不完全です

値	説明
Canceled	プライベートリンクサービス接続リソースのプロビジョニング要求が取り消されました
Deleting	プライベートリンクサービス接続は削除中です。
Failed	プライベートリンクサービス接続をプロビジョニングまたは削除できませんでした。
Incomplete	プライベートリンクサービス接続リソースのプロビジョニング要求は受け入れ済みですが、作成プロセスはまだ開始されていません。
Succeeded	プライベートリンクサービス接続のプロビジョニングが完了し、承認の準備が整いました。
Updating	プライベートリンクサービス接続は、他のリソースと共に作成され、完全に機能するように処理中です。

PrivateLinkServiceConnectionState

Object

Azure プライベートエンドポイントへの既存の Private Link サービス接続の現在の状態について説明します。

名前	型	規定値	説明
actionsRequired	string	None	必要になる可能性がある追加のアクションの説明。
description	string		プライベートリンクサービスの接続状態の説明。
status	PrivateLinkServiceConnectionStatus		プライベートリンクサービス接続の状態。有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。

PrivateLinkServiceConnectionStatus

列挙

プライベートリンクサービス接続の状態。有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。

値	説明
Approved	プライベートエンドポイント接続が承認され、使用できる状態になります。
Disconnected	プライベートエンドポイント接続がサービスから削除されました。
Pending	プライベートエンドポイント接続が作成され、承認が保留中です。
Rejected	プライベートエンドポイント接続が拒否され、使用できません。

ProvisioningState

列挙

検索サービスで最後に実行されたプロビジョニング操作の状態。プロビジョニングは、サービス容量の確立中に発生する中間状態です。容量が設定されると、provisioningState が "succeeded" または "failed" に変わります。クライアントアプリケーションは、Search Service の取得操作を使用して、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングして、操作が完了したタイミングを確認できます。無料サービスを使用している場合、この値は検索サービスの作成の呼び出しで直接 "成功" として返される傾向があります。これは、無料サービスで既に設定されている容量が使用されるためです。

値	説明
failed	最後のプロビジョニング操作が失敗しました。
provisioning	検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。
succeeded	最後のプロビジョニング操作が正常に完了しました。

PublicNetworkAccess

列挙

この値を "有効" に設定すると、既存の顧客リソースとテンプレートの重大な変更を回避できます。 "無効" に設定すると、パブリックインターフェイス経由のトラフィックは許可されず、プライベートエンドポイント接続は排他アクセス方式になります。

値	説明
disabled
enabled

SearchEncryptionComplianceStatus

列挙

顧客が暗号化していないリソースを持つことに関して、検索サービスが準拠しているかどうかについて説明します。サービスに複数の非顧客暗号化リソースがあり、"強制" が "有効" の場合、サービスは "非準拠" としてマークされます。

値	説明
Compliant	顧客が暗号化していないリソースの数がゼロであるか、強制が無効になっているため、検索サービスが準拠していることを示します。
NonCompliant	検索サービスに、顧客が暗号化していないリソースが複数存在することを示します。

SearchEncryptionWithCmk

列挙

顧客が暗号化していない 1 つ以上のリソースを検索サービスで強制する方法について説明します。

値	説明
Disabled	適用は行われず、検索サービスには顧客が暗号化していないリソースを含めることができます。
Enabled	顧客が暗号化していないリソースが 1 つ以上ある場合、Search サービスは非準拠としてマークされます。
Unspecified	強制ポリシーは明示的に指定されていません。動作は、"無効" に設定されている場合と同じです。

SearchSemanticSearch

列挙

セマンティック検索の可用性を制御するオプションを設定します。この構成は、特定の場所にある特定の検索 SKU に対してのみ可能です。

値	説明
disabled	検索サービスのセマンティックランク付けが無効になっていることを示します。
free	検索サービスでセマンティックランク付けを有効にし、Free レベルの制限内で使用されることを示します。これにより、セマンティックランク付け要求の量が上限になり、追加料金なしで提供されます。これは、新しくプロビジョニングされた検索サービスの既定値です。
standard	より高いスループットとセマンティックランク付け要求の量で、課金対象の機能として検索サービスのセマンティックランク付けを有効にします。

SearchService

Object

検索サービスとその現在の状態について説明します。

名前	型	規定値	説明
id	string		リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		リソースの ID。
location	string		リソースが存在する地理的な場所
name	string		リソースの名前
properties.authOptions	DataPlaneAuthOptions		検索サービスのデータプレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
properties.disableLocalAuth	boolean		true に設定すると、検索サービスの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これを true に設定することはできません。
properties.encryptionWithCmk	EncryptionWithCmk		検索サービス内でカスタマーマネージャーキーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。
properties.hostingMode	HostingMode	default	Standard3 SKU にのみ適用されます。このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。他のすべての SKU の場合、この値は 'default' である必要があります。
properties.networkRuleSet	NetworkRuleSet		検索サービスに到達する方法を決定するネットワーク固有のルール。
properties.partitionCount	integer (int32) minimum: 1 maximum: 12	1	検索サービス内のパーティションの数。指定する場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。
properties.privateEndpointConnections	PrivateEndpointConnection[]		検索サービスへのプライベートエンドポイント接続の一覧。
properties.provisioningState	ProvisioningState		検索サービスで最後に実行されたプロビジョニング操作の状態。プロビジョニングは、サービス容量の確立中に発生する中間状態です。容量が設定されると、provisioningState が "succeeded" または "failed" に変わります。クライアントアプリケーションは、Search Service の取得操作を使用して、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングして、操作が完了したタイミングを確認できます。無料サービスを使用している場合、この値は検索サービスの作成の呼び出しで直接 "成功" として返される傾向があります。これは、無料サービスで既に設定されている容量が使用されるためです。
properties.publicNetworkAccess	PublicNetworkAccess	enabled	この値を "有効" に設定すると、既存の顧客リソースとテンプレートの重大な変更を回避できます。 "無効" に設定すると、パブリックインターフェイス経由のトラフィックは許可されず、プライベートエンドポイント接続は排他アクセス方式になります。
properties.replicaCount	integer (int32) minimum: 1 maximum: 12	1	検索サービス内のレプリカの数。指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 ~ 3 の値にする必要があります。
properties.semanticSearch	SearchSemanticSearch		セマンティック検索の可用性を制御するオプションを設定します。この構成は、特定の場所にある特定の検索 SKU に対してのみ可能です。
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		検索サービスによって管理される共有プライベートリンクリソースの一覧。
properties.status	SearchServiceStatus		検索サービスの状態。可能な値は次のとおりです:"running": 検索サービスは実行中であり、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。これは、基になる検索単位が正常でない場合に発生する可能性があります。検索サービスは動作している可能性が最も高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスが無効になっています。この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。サービスが機能低下状態、無効状態、またはエラー状態の場合、Microsoft は基になる問題を積極的に調査しています。これらの状態の専用サービスは、プロビジョニングされた検索ユニットの数に基づいて引き続き課金されます。
properties.statusDetails	string		検索サービスの状態の詳細。
sku	Sku		課金レートと容量の制限を決定する検索サービスの SKU。このプロパティは、新しい検索サービスを作成するときに必要です。
tags	object		リソースタグ。
type	string		リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

SearchServiceStatus

列挙

検索サービスの状態。可能な値は次のとおりです:"running": 検索サービスは実行中であり、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。これは、基になる検索単位が正常でない場合に発生する可能性があります。検索サービスは動作している可能性が最も高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスが無効になっています。この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。サービスが機能低下状態、無効状態、またはエラー状態の場合、Microsoft は基になる問題を積極的に調査しています。これらの状態の専用サービスは、プロビジョニングされた検索ユニットの数に基づいて引き続き課金されます。

値	説明
degraded	基になる検索ユニットが正常ではないため、検索サービスが低下します。
deleting	検索サービスが削除されています。
disabled	検索サービスは無効になっており、すべての API 要求が拒否されます。
error	検索サービスは、プロビジョニングに失敗したか削除されることを示すエラー状態です。
provisioning	検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。
running	検索サービスが実行されており、プロビジョニング操作は行われません。

SharedPrivateLinkResource

Object

検索サービスによって管理される Shared Private Link リソースについて説明します。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties	SharedPrivateLinkResourceProperties	検索サービスによって管理される Shared Private Link リソースのプロパティについて説明します。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Object

検索サービスによって管理されている既存の Shared Private Link リソースのプロパティについて説明します。

名前	型	説明
groupId	string	共有プライベートリンクリソースの対象となるリソースのプロバイダーのグループ ID。
privateLinkResourceId	string	共有プライベートリンクリソースの対象となるリソースのリソース ID。
provisioningState	SharedPrivateLinkResourceProvisioningState	共有プライベートリンクリソースのプロビジョニング状態。有効な値は、更新、削除、失敗、成功、または不完全です。
requestMessage	string	共有プライベートリンクリソースの承認を要求するための要求メッセージ。
resourceRegion	string	随意。共有プライベートリンクを作成するリソースの Azure Resource Manager の場所を指定するために使用できます。これは、DNS 構成がリージョン (Azure Kubernetes Service など) であるリソースにのみ必要です。
status	SharedPrivateLinkResourceStatus	共有プライベートリンクリソースの状態。有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。

SharedPrivateLinkResourceProvisioningState

列挙

共有プライベートリンクリソースのプロビジョニング状態。有効な値は、更新、削除、失敗、成功、または不完全です。

値	説明
Deleting
Failed
Incomplete
Succeeded
Updating

SharedPrivateLinkResourceStatus

列挙

共有プライベートリンクリソースの状態。有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。

値	説明
Approved
Disconnected
Pending
Rejected

Sku

Object

課金レートと容量の制限を決定する検索サービスの SKU を定義します。

名前	型	説明
name	SkuName	検索サービスの SKU。有効な値には、'free': 共有サービスが含まれます。 "basic": 最大 3 つのレプリカを含む専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': 標準に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを備えた最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、インデックスが多い最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートします。

SkuName

列挙

検索サービスの SKU。有効な値には、'free': 共有サービスが含まれます。 "basic": 最大 3 つのレプリカを含む専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': 標準に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを備えた最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、インデックスが多い最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートします。

値	説明
basic	最大 3 つのレプリカを持つ専用サービスの課金対象レベル。
free	無料レベル。SLA が保証されておらず、課金対象レベルで提供される機能のサブセットも含まれます。
standard	最大 12 個のパーティションと 12 個のレプリカを持つ専用サービスの課金対象レベル。
standard2	"standard" に似ていますが、検索ユニットあたりの容量が多くなります。
standard3	最大 12 個のパーティションと 12 個のレプリカを備えた最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、インデックス数が多い最大 3 つのパーティション)。
storage_optimized_l1	パーティションあたり 1 TB、最大 12 個のパーティションをサポートする専用サービスの課金対象レベル。
storage_optimized_l2	パーティションあたり 2 TB、最大 12 個のパーティションをサポートする専用サービスの課金対象レベル。