Services - List By Resource Group

服務:

Search Management

API 版本:

2023-11-01

取得指定資源群組中所有搜尋服務的清單。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	目前訂用帳戶內的資源組名。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
subscriptionId	path	True	string	Microsoft Azure 訂用帳戶的唯一標識符。 您可以從 Azure Resource Manager API、命令行工具或入口網站取得此值。
api-version	query	True	string	要用於每個要求的 API 版本。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string uuid	用戶端產生之可識別此要求的 GUID 值。 如果已指定，則會將回應資訊包含在響應資訊中，以作為追蹤要求的方式。

回應

名稱	類型	Description
200 OK	SearchServiceListResult	作業成功。 回應包含指定資源群組的所有搜尋服務定義清單。
Other Status Codes	CloudError	執行此作業期間發生非預期的錯誤。

安全性

azure_auth

Microsoft Entra ID OAuth2 授權流程。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

SearchListServicesByResourceGroup

範例要求

HTTP

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

Java

/**
 * Samples for Services ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
     * SearchListServicesByResourceGroup.json
     */
    /**
     * Sample code: SearchListServicesByResourceGroup.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void searchListServicesByResourceGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getServices().listByResourceGroup("rg1", 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

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python search_list_services_by_resource_group.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.list_by_resource_group(
        resource_group_name="rg1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListServicesByResourceGroup.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

Go

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/SearchListServicesByResourceGroup.json
func ExampleServicesClient_NewListByResourceGroupPager() {
	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)
	}
	pager := clientFactory.NewServicesClient().NewListByResourceGroupPager("rg1", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ServiceListResult = armsearch.ServiceListResult{
		// 	Value: []*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),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("mysearchservice2"),
		// 			Type: to.Ptr("Microsoft.Search/searchServices"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice2"),
		// 			Location: to.Ptr("eastus"),
		// 			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](1),
		// 				Status: to.Ptr(armsearch.SearchServiceStatusRunning),
		// 				StatusDetails: to.Ptr(""),
		// 			},
		// 			SKU: &armsearch.SKU{
		// 				Name: to.Ptr(armsearch.SKUNameBasic),
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Gets a list of all Search services in the given resource group.
 *
 * @summary Gets a list of all Search services in the given resource group.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListServicesByResourceGroup.json
 */
async function searchListServicesByResourceGroup() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.services.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

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/SearchListServicesByResourceGroup.json
// this example is just showing the usage of "Services_ListByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this SearchServiceResource
SearchServiceCollection collection = resourceGroupResource.GetSearchServices();

// invoke the operation and iterate over the result
await foreach (SearchServiceResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

範例回覆

狀態碼:

200

{
  "value": [
    {
      "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": []
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice2",
      "name": "mysearchservice2",
      "location": "eastus",
      "type": "Microsoft.Search/searchServices",
      "tags": {
        "app-name": "My e-commerce app"
      },
      "sku": {
        "name": "basic"
      },
      "properties": {
        "replicaCount": 1,
        "partitionCount": 1,
        "status": "running",
        "statusDetails": "",
        "hostingMode": "default",
        "provisioningState": "succeeded",
        "publicNetworkAccess": "enabled",
        "networkRuleSet": {
          "ipRules": []
        },
        "privateEndpointConnections": []
      }
    }
  ]
}

定義

名稱	Description
AadAuthFailureMode	描述搜尋服務的數據平面 API 針對驗證失敗的要求傳送哪些回應。
ApiKeyOnly	表示只能使用 API 金鑰進行驗證。
CloudError	包含 API 錯誤的相關信息。
CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。
DataPlaneAadOrApiKeyAuthOption	指出 API 金鑰或來自 Microsoft Entra ID 租使用者的存取令牌可用於驗證。
DataPlaneAuthOptions	定義搜尋服務如何驗證數據平面要求的選項。 如果 'disableLocalAuth' 設定為 true，則無法設定此設定。
EncryptionWithCmk	描述原則，決定搜尋服務內的資源如何以 customer=Managed 密鑰加密。
HostingMode	僅適用於 standard3 SKU。 您可以設定此屬性來啟用最多 3 個高密度分割區，允許最多 1000 個索引，這比任何其他 SKU 允許的最大索引還要高。 針對 standard3 SKU，此值為 'default' 或 'highDensity'。 對於所有其他 SKU，此值必須是 'default'。
Identity	資源的身分識別。
IdentityType	識別類型。
IpRule	搜尋服務的IP限制規則。
NetworkRuleSet	決定如何連線到搜尋服務的網路特定規則。
PrivateEndpoint	來自 Microsoft.Network 提供者的私人端點資源。
PrivateEndpointConnection	描述與搜尋服務的現有私人端點連線。
PrivateEndpointConnectionProperties	描述與搜尋服務之現有私人端點連線的屬性。
PrivateLinkServiceConnectionProvisioningState	私人鏈接服務連線的布建狀態。 有效值為 [更新]、[刪除]、[失敗]、[成功] 或 [不完整]
PrivateLinkServiceConnectionState	描述與 Azure 私人端點之現有 Private Link 服務連線的目前狀態。
PrivateLinkServiceConnectionStatus	私人鏈接服務連線的狀態。 有效值為 Pending、Approved、Rejected 或 Disconnected。
ProvisioningState	在搜尋服務上執行之上次布建作業的狀態。 佈建是一種過渡狀態，當服務容量正在建立時發生。 設定容量之後，provisioningState 會變更為「成功」或「失敗」。 用戶端應用程式可以輪詢布建狀態， (建議的輪詢間隔是從 30 秒到一分鐘) ，方法是使用取得搜尋服務作業來查看作業何時完成。 如果您使用免費服務，此值通常會直接在建立搜尋服務的呼叫中回復為「成功」。 這是因為免費服務使用早已設定的容量。
PublicNetworkAccess	此值可以設定為 「已啟用」，以避免現有客戶資源和範本的重大變更。 如果設定為 『disabled』，則不允許透過公用介面的流量，而私人端點聯機會是獨佔存取方法。
SearchEncryptionComplianceStatus	描述搜尋服務是否符合具有非客戶加密資源的規範。 如果服務具有一個以上的非客戶加密資源，且「強制執行」為「已啟用」，則服務將會標示為「不符合規範」。
SearchEncryptionWithCmk	描述搜尋服務應如何強制執行一或多個非客戶加密的資源。
SearchSemanticSearch	設定控制語意搜尋可用性的選項。 此設定僅適用於特定位置中的特定搜尋 SKU。
SearchService	描述搜尋服務及其目前狀態。
SearchServiceListResult	包含搜尋服務清單的回應。
SearchServiceStatus	搜尋服務的狀態。 可能的值包括：「正在執行」：搜尋服務正在執行，且未進行任何布建作業。 「布建」：正在布建或相應增加或縮小搜尋服務。 'delete'：正在刪除搜尋服務。 「已降級」：搜尋服務已降級。 當基礎搜尋單位狀況不良時，可能會發生這種情況。 搜尋服務最有可能運作，但效能可能會變慢，而且可能會卸除某些要求。 'disabled'：已停用搜尋服務。 在此狀態下，此服務將拒絕所有 API 要求。 'error'：搜尋服務處於錯誤狀態。 如果您的服務處於降級、停用或錯誤狀態，Microsoft 會主動調查基礎問題。 根據已佈建的搜尋單位數目，在這些狀態下的專用服務仍需收費。
SharedPrivateLinkResource	描述由搜尋服務管理的共用 Private Link 資源。
SharedPrivateLinkResourceProperties	描述搜尋服務所管理之現有共用 Private Link 資源的屬性。
SharedPrivateLinkResourceProvisioningState	共用私人鏈接資源的布建狀態。 有效值為 [更新]、[刪除]、[失敗]、[成功] 或 [不完整]。
SharedPrivateLinkResourceStatus	共用私人鏈接資源的狀態。 有效值為 Pending、Approved、Rejected 或 Disconnected。
Sku	定義搜尋服務的 SKU，以決定計費率和容量限制。
SkuName	搜尋服務的 SKU。 有效值包括：『free』：共用服務。 'basic'：最多 3 個複本的專用服務。 'standard'：最多 12 個分割區和 12 個復本的專用服務。 'standard2'：類似於標準，但每個搜尋單位具有更多容量。 'standard3'：如果您也將 hostingMode 屬性設定為 'highDensity') ，則最多 12 個分割區和 12 個復本 (或最多 3 個數據分割的標準供應專案。 'storage_optimized_l1'：支援每個分割區 1TB，最多 12 個分割區。 'storage_optimized_l2'：支援每個分割區 2TB，最多 12 個數據分割。」

AadAuthFailureMode

描述搜尋服務的數據平面 API 針對驗證失敗的要求傳送哪些回應。

名稱	類型	Description
http401WithBearerChallenge	string	指出失敗驗證的要求應呈現 HTTP 狀態代碼 401 (未經授權) ，並顯示持有人挑戰。
http403	string	指出失敗驗證的要求應該會顯示 HTTP 狀態代碼 403 (禁止) 。

ApiKeyOnly

表示只能使用 API 金鑰進行驗證。

CloudError

包含 API 錯誤的相關信息。

名稱	類型	Description
error	CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。

CloudErrorBody

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

名稱	類型	Description
code	string	描述錯誤狀況的錯誤碼，比 HTTP 狀態代碼更精確。 可用來以程式設計方式處理特定錯誤案例。
details	CloudErrorBody[]	包含與此錯誤相關的巢狀錯誤。
message	string	描述錯誤的詳細訊息，並提供偵錯資訊。
target	string	例如，特定錯誤的目標 (，錯誤) 中的屬性名稱。

DataPlaneAadOrApiKeyAuthOption

指出 API 金鑰或來自 Microsoft Entra ID 租使用者的存取令牌可用於驗證。

名稱	類型	Description
aadAuthFailureMode	AadAuthFailureMode	描述搜尋服務的數據平面 API 針對驗證失敗的要求傳送哪些回應。

DataPlaneAuthOptions

定義搜尋服務如何驗證數據平面要求的選項。 如果 'disableLocalAuth' 設定為 true，則無法設定此設定。

名稱	類型	Description
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	指出 API 金鑰或來自 Microsoft Entra ID 租使用者的存取令牌可用於驗證。
apiKeyOnly	ApiKeyOnly	表示只能使用 API 金鑰進行驗證。

EncryptionWithCmk

描述原則，決定搜尋服務內的資源如何以 customer=Managed 密鑰加密。

名稱	類型	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	描述搜尋服務是否符合具有非客戶加密資源的規範。 如果服務具有一個以上的非客戶加密資源，且「強制執行」為「已啟用」，則服務將會標示為「不符合規範」。
enforcement	SearchEncryptionWithCmk	描述搜尋服務應如何強制執行一或多個非客戶加密的資源。

HostingMode

僅適用於 standard3 SKU。 您可以設定此屬性來啟用最多 3 個高密度分割區，允許最多 1000 個索引，這比任何其他 SKU 允許的最大索引還要高。 針對 standard3 SKU，此值為 'default' 或 'highDensity'。 對於所有其他 SKU，此值必須是 'default'。

名稱	類型	Description
default	string	索引數目的限制取決於 SKU 的預設限制。
highDensity	string	只有 standard3 SKU 的應用程式，其中搜尋服務最多可以有 1000 個索引。

Identity

資源的身分識別。

名稱	類型	Description
principalId	string	搜尋服務系統指派身分識別的主體標識碼。
tenantId	string	搜尋服務系統指派身分識別的租用戶標識碼。
type	IdentityType	識別類型。

IdentityType

識別類型。

名稱	類型	Description
None	string
SystemAssigned	string

IpRule

搜尋服務的IP限制規則。

名稱	類型	Description
value	string	對應至單一 IPv4 位址的值 (例如 123.1.2.3) 或 CIDR 格式的 IP 範圍 (，例如 123.1.2.3/24) 。

NetworkRuleSet

決定如何連線到搜尋服務的網路特定規則。

名稱	類型	Description
ipRules	IpRule[]	用於IP防火牆的IP限制規則清單。 防火牆會封鎖不符合規則的任何IP。 只有在搜尋服務的 'publicNetworkAccess' 已啟用時，才會套用這些規則。

PrivateEndpoint

來自 Microsoft.Network 提供者的私人端點資源。

名稱	類型	Description
id	string	來自 Microsoft.Network 提供者的私人端點資源資源資源標識碼。

PrivateEndpointConnection

描述與搜尋服務的現有私人端點連線。

名稱	類型	Description
id	string	資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties	PrivateEndpointConnectionProperties	描述與搜尋服務之現有私人端點連線的屬性。
type	string	資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProperties

描述與搜尋服務之現有私人端點連線的屬性。

名稱	類型	Description
groupId	string	私人鏈接服務連線的來源提供者的群組標識碼。
privateEndpoint	PrivateEndpoint	來自 Microsoft.Network 提供者的私人端點資源。
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	描述與 Azure 私人端點之現有 Private Link 服務連線的目前狀態。
provisioningState	PrivateLinkServiceConnectionProvisioningState	私人鏈接服務連線的布建狀態。 有效值為更新、刪除、失敗、成功或不完整

PrivateLinkServiceConnectionProvisioningState

私人鏈接服務連線的布建狀態。 有效值為 [更新]、[刪除]、[失敗]、[成功] 或 [不完整]

名稱	類型	Description
Canceled	string	已取消私人連結服務連線資源的布建要求
Deleting	string	私人鏈接服務連線正在進行刪除。
Failed	string	無法布建或刪除私人連結服務連線。
Incomplete	string	已接受私人連結服務連線資源的布建要求，但尚未開始建立程式。
Succeeded	string	私人鏈接服務連線已完成佈建，且已準備好進行核准。
Updating	string	私人鏈接服務連線正在建立時，與其他資源一起建立，使其功能完整。

PrivateLinkServiceConnectionState

描述與 Azure 私人端點之現有 Private Link 服務連線的目前狀態。

名稱	類型	預設值	Description
actionsRequired	string	None	任何可能需要的額外動作的描述。
description	string		私人鏈接服務連線狀態的描述。
status	PrivateLinkServiceConnectionStatus		私人鏈接服務連線的狀態。 有效值為 Pending、Approved、Rejected 或 Disconnected。

PrivateLinkServiceConnectionStatus

私人鏈接服務連線的狀態。 有效值為 Pending、Approved、Rejected 或 Disconnected。

名稱	類型	Description
Approved	string	私人端點連線已核准並可供使用。
Disconnected	string	私人端點連線已從服務中移除。
Pending	string	已建立私人端點連線，並擱置核准。
Rejected	string	私人端點連線已遭到拒絕且無法使用。

ProvisioningState

在搜尋服務上執行之上次布建作業的狀態。 佈建是一種過渡狀態，當服務容量正在建立時發生。 設定容量之後，provisioningState 會變更為「成功」或「失敗」。 用戶端應用程式可以輪詢布建狀態， (建議的輪詢間隔是從 30 秒到一分鐘) ，方法是使用取得搜尋服務作業來查看作業何時完成。 如果您使用免費服務，此值通常會直接在建立搜尋服務的呼叫中回復為「成功」。 這是因為免費服務使用早已設定的容量。

名稱	類型	Description
failed	string	上次布建作業失敗。
provisioning	string	正在布建或相應增加或相應減少搜尋服務。
succeeded	string	上次布建作業已順利完成。

PublicNetworkAccess

此值可以設定為 「已啟用」，以避免現有客戶資源和範本的重大變更。 如果設定為 『disabled』，則不允許透過公用介面的流量，而私人端點聯機會是獨佔存取方法。

名稱	類型	Description
disabled	string
enabled	string

SearchEncryptionComplianceStatus

描述搜尋服務是否符合具有非客戶加密資源的規範。 如果服務具有一個以上的非客戶加密資源，且「強制執行」為「已啟用」，則服務將會標示為「不符合規範」。

名稱	類型	Description
Compliant	string	表示搜尋服務符合規範，可能是因為非客戶加密的資源數目為零，或停用強制執行。
NonCompliant	string	表示搜尋服務有多個非客戶加密的資源。

SearchEncryptionWithCmk

描述搜尋服務應如何強制執行一或多個非客戶加密的資源。

名稱	類型	Description
Disabled	string	不會強制執行，而且搜尋服務可以有非客戶加密的資源。
Enabled	string	如果有一或多個非客戶加密的資源，搜尋服務 將會標示為不符合規範。
Unspecified	string	未明確指定強制執行原則，其行為與設定為 [已停用] 的行為相同。

SearchSemanticSearch

設定控制語意搜尋可用性的選項。 此設定僅適用於特定位置中的特定搜尋 SKU。

名稱	類型	Description
disabled	string	表示搜尋服務已停用語意排名。
free	string	啟用搜尋服務上的語意排名，並指出它在免費層的限制內使用。 這會限制語意排名要求的數量，而且不需額外費用。 這是新布建的搜尋服務預設值。
standard	string	在搜尋服務上啟用語意排名作為可計費功能，並具有較高的輸送量和語意排名要求量。

SearchService

描述搜尋服務及其目前狀態。

名稱	類型	預設值	Description
id	string		資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		資源的身分識別。
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 個高密度分割區，允許最多 1000 個索引，這比任何其他 SKU 允許的最大索引還要高。 針對 standard3 SKU，此值為 'default' 或 'highDensity'。 對於所有其他 SKU，此值必須是 'default'。
properties.networkRuleSet	NetworkRuleSet		決定如何連線到搜尋服務的網路特定規則。
properties.partitionCount	integer	1	搜尋服務中的數據分割數目;如果指定，它可以是 1、2、3、4、6 或 12。 大於 1 的值僅適用於標準 SKU。 對於 hostingMode 設為 'highDensity' 的 'standard3' 服務，允許的值介於 1 到 3 之間。
properties.privateEndpointConnections	PrivateEndpointConnection[]		搜尋服務的私人端點連線清單。
properties.provisioningState	ProvisioningState		在搜尋服務上執行之上次布建作業的狀態。 佈建是一種過渡狀態，當服務容量正在建立時發生。 設定容量之後，provisioningState 會變更為「成功」或「失敗」。 用戶端應用程式可以輪詢布建狀態， (建議的輪詢間隔是從 30 秒到一分鐘) ，方法是使用取得搜尋服務作業來查看作業何時完成。 如果您使用免費服務，此值通常會直接在建立搜尋服務的呼叫中回復為「成功」。 這是因為免費服務使用早已設定的容量。
properties.publicNetworkAccess	PublicNetworkAccess	enabled	此值可以設定為 「已啟用」，以避免現有客戶資源和範本的重大變更。 如果設定為 『disabled』，則不允許透過公用介面的流量，而私人端點聯機會是獨佔存取方法。
properties.replicaCount	integer	1	搜尋服務中的複本數目。 如果指定，它必須是標準 SKU 介於 1 到 12 之間的值，或基本 SKU 包含 1 到 3 之間的值。
properties.semanticSearch	SearchSemanticSearch		設定控制語意搜尋可用性的選項。 此設定僅適用於特定位置中的特定搜尋 SKU。
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		由搜尋服務管理的共用私人鏈接資源清單。
properties.status	SearchServiceStatus		搜尋服務的狀態。 可能的值包括：「正在執行」：搜尋服務正在執行，且未進行任何布建作業。 「布建」：正在布建或相應增加或縮小搜尋服務。 'delete'：正在刪除搜尋服務。 「已降級」：搜尋服務已降級。 當基礎搜尋單位狀況不良時，可能會發生這種情況。 搜尋服務最有可能運作，但效能可能會變慢，而且可能會卸除某些要求。 'disabled'：已停用搜尋服務。 在此狀態下，此服務將拒絕所有 API 要求。 'error'：搜尋服務處於錯誤狀態。 如果您的服務處於降級、停用或錯誤狀態，Microsoft 會主動調查基礎問題。 根據已佈建的搜尋單位數目，在這些狀態下的專用服務仍需收費。
properties.statusDetails	string		搜尋服務狀態的詳細數據。
sku	Sku		搜尋服務的 SKU，決定計費率和容量限制。 建立新的搜尋服務時，需要這個屬性。
tags	object		資源標籤。
type	string		資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

SearchServiceListResult

包含搜尋服務清單的回應。

名稱	類型	Description
nextLink	string	要求 URL，可用來查詢下一頁的搜尋服務。 當要求的搜尋服務總數超過頁面大小上限時傳回。
value	SearchService[]	搜尋服務的清單。

SearchServiceStatus

搜尋服務的狀態。 可能的值包括：「正在執行」：搜尋服務正在執行，且未進行任何布建作業。 「布建」：正在布建或相應增加或縮小搜尋服務。 'delete'：正在刪除搜尋服務。 「已降級」：搜尋服務已降級。 當基礎搜尋單位狀況不良時，可能會發生這種情況。 搜尋服務最有可能運作，但效能可能會變慢，而且可能會卸除某些要求。 'disabled'：已停用搜尋服務。 在此狀態下，此服務將拒絕所有 API 要求。 'error'：搜尋服務處於錯誤狀態。 如果您的服務處於降級、停用或錯誤狀態，Microsoft 會主動調查基礎問題。 根據已佈建的搜尋單位數目，在這些狀態下的專用服務仍需收費。

名稱	類型	Description
degraded	string	搜尋服務已降級，因為基礎搜尋單位狀況不良。
deleting	string	正在刪除搜尋服務。
disabled	string	搜尋服務已停用，且所有 API 要求都會遭到拒絕。
error	string	搜尋服務處於錯誤狀態，指出布建失敗或要刪除。
provisioning	string	正在布建或相應增加或相應減少搜尋服務。
running	string	搜尋服務正在執行，且未進行任何布建作業。

SharedPrivateLinkResource

描述由搜尋服務管理的共用 Private Link 資源。

名稱	類型	Description
id	string	資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties	SharedPrivateLinkResourceProperties	描述由搜尋服務管理的共用 Private Link 資源屬性。
type	string	資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

SharedPrivateLinkResourceProperties

描述搜尋服務所管理之現有共用 Private Link 資源的屬性。

名稱	類型	Description
groupId	string	共用私人鏈接資源提供者的群組標識碼。
privateLinkResourceId	string	共用私人鏈接資源的資源資源識別碼。
provisioningState	SharedPrivateLinkResourceProvisioningState	共用私人鏈接資源的布建狀態。 有效值為 [更新]、[刪除]、[失敗]、[成功] 或 [不完整]。
requestMessage	string	要求核准共用私人鏈接資源的要求訊息。
resourceRegion	string	選擇性。 可用來指定要建立共用私人連結之資源的 Azure Resource Manager 位置。 只有 DNS 設定為區域 (的資源，例如 Azure Kubernetes Service) ，才需要此專案。
status	SharedPrivateLinkResourceStatus	共用私人鏈接資源的狀態。 有效值為 Pending、Approved、Rejected 或 Disconnected。

SharedPrivateLinkResourceProvisioningState

共用私人鏈接資源的布建狀態。 有效值為 [更新]、[刪除]、[失敗]、[成功] 或 [不完整]。

名稱	類型	Description
Deleting	string
Failed	string
Incomplete	string
Succeeded	string
Updating	string

SharedPrivateLinkResourceStatus

共用私人鏈接資源的狀態。 有效值為 Pending、Approved、Rejected 或 Disconnected。

名稱	類型	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

Sku

定義搜尋服務的 SKU，以決定計費率和容量限制。

名稱	類型	Description
name	SkuName	搜尋服務的 SKU。 有效值包括：『free』：共用服務。 'basic'：最多 3 個複本的專用服務。 'standard'：最多 12 個分割區和 12 個復本的專用服務。 'standard2'：類似於標準，但每個搜尋單位具有更多容量。 'standard3'：如果您也將 hostingMode 屬性設定為 'highDensity') ，則最多 12 個分割區和 12 個復本 (或最多 3 個數據分割的標準供應專案。 'storage_optimized_l1'：支援每個分割區 1TB，最多 12 個分割區。 'storage_optimized_l2'：支援每個分割區 2TB，最多 12 個數據分割。」

SkuName

搜尋服務的 SKU。 有效值包括：『free』：共用服務。 'basic'：最多 3 個複本的專用服務。 'standard'：最多 12 個分割區和 12 個復本的專用服務。 'standard2'：類似於標準，但每個搜尋單位具有更多容量。 'standard3'：如果您也將 hostingMode 屬性設定為 'highDensity') ，則最多 12 個分割區和 12 個復本 (或最多 3 個數據分割的標準供應專案。 'storage_optimized_l1'：支援每個分割區 1TB，最多 12 個分割區。 'storage_optimized_l2'：支援每個分割區 2TB，最多 12 個數據分割。」

名稱	類型	Description
basic	string	專用服務的可計費層最多可有3個複本。
free	string	免費層，沒有 SLA 保證，以及計費層上所提供的功能子集。
standard	string	專用服務的可計費層最多可有12個分割區和12個複本。
standard2	string	類似於「標準」，但每個搜尋單位具有更多容量。
standard3	string	如果您也將 hostingMode 屬性設定為 『highDensity』) ，則具有最多 12 個分割區和 12 個復本的最大標準供應專案 (或最多 3 個數據分割。
storage_optimized_l1	string	每個分割區支援 1TB 的專用服務計費層，最多 12 個數據分割。
storage_optimized_l2	string	每個分割區支援 2TB 的專用服務計費層，最多 12 個數據分割。