Services - Get

參考

服務:: Search Management

API 版本:: 2024-03-01-preview

取得在指定資源群組中具有指定名稱的搜尋服務。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	目前訂用帳戶內的資源組名。您可以從 Azure Resource Manager API 或入口網站取得此值。
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	與指定資源群組相關聯的 Azure AI 搜尋服務名稱。
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	SearchService	搜尋服務定義已成功擷取，且在回應中。如果您要輪詢布建或調整作業完成，您可以透過 provisioningState 屬性檢查其狀態。
Other Status Codes	CloudError	HTTP 404 （找不到）：找不到訂用帳戶、資源群組或搜尋服務名稱。

安全性

azure_auth

指定Microsoft身分識別平台上支援的隱含授與流程。

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

範圍

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

範例

SearchGetService

範例要求

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

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/preview/2024-03-01-preview/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/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/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{
	// 		AuthOptions: &armsearch.DataPlaneAuthOptions{
	// 			APIKeyOnly: map[string]any{
	// 			},
	// 		},
	// 		DisableLocalAuth: to.Ptr(false),
	// 		DisabledDataExfiltrationOptions: []*armsearch.SearchDisabledDataExfiltrationOption{
	// 		},
	// 		EncryptionWithCmk: &armsearch.EncryptionWithCmk{
	// 			EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
	// 			Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkUnspecified),
	// 		},
	// 		HostingMode: to.Ptr(armsearch.HostingModeDefault),
	// 		NetworkRuleSet: &armsearch.NetworkRuleSet{
	// 			Bypass: to.Ptr(armsearch.SearchBypassNone),
	// 			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),
	// 		SharedPrivateLinkResources: []*armsearch.SharedPrivateLinkResource{
	// 		},
	// 		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/preview/2024-03-01-preview/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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/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 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
string searchServiceName = "mysearchservice";
NullableResponse<SearchServiceResource> response = await collection.GetIfExistsAsync(searchServiceName);
SearchServiceResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

定義

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

AadAuthFailureMode

列舉型別

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

值	Description
http401WithBearerChallenge	指出失敗驗證的要求應呈現為 401 的 HTTP 狀態代碼（未經授權），並呈現持有人挑戰。
http403	指出失敗驗證的要求應該會顯示 HTTP 狀態代碼 403（禁止）。

ApiKeyOnly

Object

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

CloudError

Object

包含 API 錯誤的相關信息。

名稱	類型	Description
error	CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。
message	string	錯誤簡短描述，其中提示發生錯誤的原因（如需詳細數據/偵錯資訊，請參閱 'error.message' 屬性。

CloudErrorBody

Object

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

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

DataPlaneAadOrApiKeyAuthOption

Object

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

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

DataPlaneAuthOptions

Object

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

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

EncryptionWithCmk

Object

描述一個原則，決定搜尋服務內的資源如何以客戶管理的密鑰加密。

名稱	類型	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	傳回與非 CMK 加密物件相關的搜尋服務合規性狀態。如果服務有多個未加密的物件，且已啟用強制，服務會標示為不符合規範。
enforcement	SearchEncryptionWithCmk	描述搜尋服務在找到未使用客戶管理密鑰加密的物件時，應如何強制執行合規性。

HostingMode

列舉型別

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

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

Identity

Object

搜尋服務身分識別的詳細數據。 Null 值表示搜尋服務未指派任何身分識別。

名稱	類型	Description
principalId	string	搜尋服務系統指派身分識別的主體標識碼。
tenantId	string	搜尋服務系統指派身分識別的租用戶標識碼。
type	IdentityType	用於資源的身分識別類型。類型 'SystemAssigned， UserAssigned' 包含系統所建立的身分識別和一組使用者指派的身分識別。類型『None』會從服務中移除所有身分識別。
userAssignedIdentities	<string, UserAssignedManagedIdentity>	與資源相關聯的使用者身分識別清單。用戶識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

IdentityType

列舉型別

用於資源的身分識別類型。類型 'SystemAssigned， UserAssigned' 包含系統所建立的身分識別和一組使用者指派的身分識別。類型『None』會從服務中移除所有身分識別。

值	Description
None	表示必須移除與搜尋服務相關聯的任何身分識別。
SystemAssigned	表示會啟用搜尋服務的系統指派身分識別。
SystemAssigned, UserAssigned	指出搜尋服務的系統指派身分識別將會啟用，以及指派一或多個使用者指派的身分識別。
UserAssigned	指出將一或多個使用者指派的身分識別指派給搜尋服務。

IpRule

Object

Azure AI 搜尋服務的IP限制規則。

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

NetworkRuleSet

Object

決定如何觸達 Azure AI 搜尋服務的網路特定規則。

名稱	類型	Description
bypass	SearchBypass	可略過『ipRules』區段中所定義規則之輸入流量的可能來源。
ipRules	IpRule[]	IP 限制規則清單，定義允許存取搜尋服務端點的輸入網路。同時，所有其他公用IP網路都會遭到防火牆封鎖。只有在搜尋服務的 'publicNetworkAccess' 已啟用時，才會套用這些限制規則;否則，即使有任何公用IP規則，也不允許透過公用介面的流量，而私人端點聯機會是獨佔存取方法。

PrivateEndpoint

Object

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

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

PrivateEndpointConnection

Object

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

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

PrivateEndpointConnectionProperties

Object

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

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

PrivateLinkServiceConnectionProvisioningState

列舉型別

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

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

PrivateLinkServiceConnectionState

Object

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

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

PrivateLinkServiceConnectionStatus

列舉型別

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

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

ProvisioningState

列舉型別

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

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

PublicNetworkAccess

列舉型別

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

值	Description
disabled	搜尋服務無法從源自公用因特網的流量存取。只有透過核准的私人端點連線才允許存取。
enabled	搜尋服務可從源自公用因特網的流量存取。

SearchBypass

列舉型別

可略過『ipRules』區段中所定義規則之輸入流量的可能來源。

值	Description
AzurePortal	指出源自 Azure 入口網站的要求可以略過『ipRules』區段中定義的規則。
None	表示沒有任何來源可以略過『ipRules』區段中定義的規則。這是預設值。

SearchDisabledDataExfiltrationOption

列舉型別

明確不允許搜尋服務的數據外流案例清單。目前，唯一支援的值是『All』，以停用所有可能的數據匯出案例，並針對未來規劃更精細的控制。

值	Description
All	表示所有數據外流案例都已停用。

SearchEncryptionComplianceStatus

列舉型別

傳回與非 CMK 加密物件相關的搜尋服務合規性狀態。如果服務有多個未加密的物件，且已啟用強制，服務會標示為不符合規範。

值	Description
Compliant	指出搜尋服務符合規範，可能是因為非 CMK 加密的物件數目為零，或是停用強制。
NonCompliant	表示搜尋服務有多個非 CMK 加密的物件。

SearchEncryptionWithCmk

列舉型別

描述搜尋服務在找到未使用客戶管理密鑰加密的物件時，應如何強制執行合規性。

值	Description
Disabled	不會強制執行客戶管理的金鑰加密。只會使用內建服務管理的加密。
Enabled	如果一或多個物件未使用客戶管理的密鑰加密，搜尋服務將會標示為不符合規範。
Unspecified	未明確指定強制原則，其行為與設定為「已停用」的行為相同。

SearchSemanticSearch

列舉型別

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

值	Description
disabled	表示搜尋服務已停用語意重新調整工具。這是預設值。
free	在搜尋服務上啟用語意重新編製工具，並指出其將在免費方案的限制內使用。免費方案會限制語意排名要求的數量，並免費提供。這是新布建搜尋服務的預設值。
standard	啟用搜尋服務上的語意重新執行器做為可計費功能，並具有較高的輸送量和語意重新調整查詢數量。

SearchService

Object

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

名稱	類型	預設值	Description
id	string		資源的完整資源標識碼。例如 - /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.disabledDataExfiltrationOptions	SearchDisabledDataExfiltrationOption[]		明確不允許搜尋服務的數據外流案例清單。目前，唯一支援的值是『All』，以停用所有可能的數據匯出案例，並針對未來規劃更精細的控制。
properties.eTag	string		系統產生的屬性，表示服務 etag，可在更新期間進行開放式並行控制。
properties.encryptionWithCmk	EncryptionWithCmk		指定在搜尋服務中使用客戶經理密鑰加密資源（例如索引）的任何原則。
properties.hostingMode	HostingMode	default	僅適用於 standard3 SKU。您可以設定此屬性來啟用最多 3 個高密度分割區，允許最多 1000 個索引，這遠高於任何其他 SKU 允許的最大索引。針對 standard3 SKU，此值為 'default' 或 'highDensity'。對於所有其他 SKU，此值必須是 'default'。
properties.networkRuleSet	NetworkRuleSet		決定如何觸達 Azure AI 搜尋服務的網路特定規則。
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[]		Azure AI 搜尋服務的私人端點連線清單。
properties.provisioningState	ProvisioningState		在搜尋服務上執行的最後一個布建作業狀態。布建是在建立服務容量時發生的中繼狀態。設定容量之後，provisioningState 會變更為「成功」或「失敗」。用戶端應用程式可以使用取得搜尋服務作業，來輪詢布建狀態（建議的輪詢間隔是從 30 秒到 1 分鐘），以查看作業何時完成。如果您使用免費服務，此值通常會直接在呼叫建立搜尋服務時回復為「成功」。這是因為免費服務會使用已設定的容量。
properties.publicNetworkAccess	PublicNetworkAccess	enabled	此值可以設定為「已啟用」，以避免現有客戶資源和範本發生重大變更。如果設定為『disabled』，則不允許透過公用介面的流量，而私人端點聯機會是獨佔存取方法。
properties.replicaCount	integer (int32) minimum: 1 maximum: 12	1	搜尋服務中的複本數目。如果指定，它必須是標準 SKU 的 1 到 12 之間的值，或基本 SKU 的 1 到 3 之間。
properties.semanticSearch	SearchSemanticSearch		設定控制語意搜尋可用性的選項。此設定僅適用於特定位置的特定 Azure AI 搜尋 SKU。
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Azure AI 搜尋服務所管理的共用私人鏈接資源清單。
properties.status	SearchServiceStatus		搜尋服務的狀態。可能的值包括：「執行中」：搜尋服務正在執行，且未進行任何布建作業。「布建」：正在布建或相應增加或相應減少搜尋服務。 'delete'：正在刪除搜尋服務。「已降級」：搜尋服務已降級。當基礎搜尋單位狀況不良時，就會發生這種情況。搜尋服務最有可能運作，但效能可能很慢，而且可能會捨棄某些要求。 'disabled'：已停用搜尋服務。在此狀態下，服務會拒絕所有 API 要求。 'error'：搜尋服務處於錯誤狀態。「已停止」：搜尋服務位於已停用的訂用帳戶中。如果您的服務處於降級、停用或錯誤狀態，表示 Azure AI 搜尋小組正在積極調查根本問題。這些狀態中的專用服務仍會根據布建的搜尋單位數目收費。
properties.statusDetails	string		搜尋服務狀態的詳細數據。
sku	Sku		搜尋服務的 SKU，決定價格區間和容量限制。建立新的搜尋服務時，需要這個屬性。
tags	object		資源標籤。
type	string		資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

SearchServiceStatus

列舉型別

搜尋服務的狀態。可能的值包括：「執行中」：搜尋服務正在執行，且未進行任何布建作業。「布建」：正在布建或相應增加或相應減少搜尋服務。 'delete'：正在刪除搜尋服務。「已降級」：搜尋服務已降級。當基礎搜尋單位狀況不良時，就會發生這種情況。搜尋服務最有可能運作，但效能可能很慢，而且可能會捨棄某些要求。 'disabled'：已停用搜尋服務。在此狀態下，服務會拒絕所有 API 要求。 'error'：搜尋服務處於錯誤狀態。「已停止」：搜尋服務位於已停用的訂用帳戶中。如果您的服務處於降級、停用或錯誤狀態，表示 Azure AI 搜尋小組正在積極調查根本問題。這些狀態中的專用服務仍會根據布建的搜尋單位數目收費。

值	Description
degraded	搜尋服務已降級，因為基礎搜尋單位狀況不佳。
deleting	正在刪除搜尋服務。
disabled	搜尋服務已停用，而且所有 API 要求都會遭到拒絕。
error	搜尋服務處於錯誤狀態，表示無法布建或刪除。
provisioning	正在布建或相應增加或減少搜尋服務。
running	搜尋服務正在執行，且未進行任何布建作業。
stopped	搜尋服務位於已停用的訂用帳戶中。

SharedPrivateLinkResource

Object

描述 Azure AI 搜尋服務所管理的共用私人鏈接資源。

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

SharedPrivateLinkResourceProperties

Object

描述 Azure AI 搜尋服務所管理之現有共用私人鏈接資源的屬性。

名稱	類型	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	共用的私人鏈接資源正在刪除。
Failed	無法布建或刪除共用的私人鏈接資源。
Incomplete	已接受共用私人鏈接資源的布建要求，但尚未開始建立程式。
Succeeded	共用的私人鏈接資源已完成布建，並已準備好進行核准。
Updating	共用私人鏈接資源正與其他資源一起建立，使其功能正常運作。

SharedPrivateLinkResourceStatus

列舉型別

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

值	Description
Approved	共用的私人鏈接資源已核准且可供使用。
Disconnected	共用的私人鏈接資源已從服務中移除。
Pending	已建立共用私人鏈接資源，且正在等待核准。
Rejected	共用的私人鏈接資源已遭到拒絕，且無法使用。

Sku

Object

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

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

SkuName

列舉型別

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

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

UserAssignedManagedIdentity

Object

指派給搜尋服務之使用者指派受控識別的詳細數據。

名稱	類型	Description
clientId	string	使用者指派身分識別的用戶端標識碼。
principalId	string	使用者指派身分識別的主體標識碼。

共用方式為

Services - Get

URI 參數

要求標頭

回應

安全性

azure_auth

範圍

範例

SearchGetService

範例要求

範例回覆

定義

AadAuthFailureMode

ApiKeyOnly

CloudError

CloudErrorBody

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

HostingMode

Identity

IdentityType

IpRule

NetworkRuleSet

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionProvisioningState

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

SearchBypass

SearchDisabledDataExfiltrationOption

SearchEncryptionComplianceStatus

SearchEncryptionWithCmk

SearchSemanticSearch

SearchService

SearchServiceStatus

SharedPrivateLinkResource

SharedPrivateLinkResourceProperties

SharedPrivateLinkResourceProvisioningState

SharedPrivateLinkResourceStatus

Sku

SkuName

UserAssignedManagedIdentity

其他資源