Services - Get

Служба:: Search Management

Версия API:: 2025-05-01

Возвращает службу поиска с заданным именем в данной группе ресурсов.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Имя службы поиска ИИ Azure, связанной с указанной группой ресурсов.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-request-id		string (uuid)	Значение GUID, созданное клиентом, идентифицирующее этот запрос. Если этот параметр указан, он будет включен в сведения о ответе в качестве способа отслеживания запроса.

Ответы

Имя	Тип	Описание
200 OK	SearchService	Операция Azure успешно завершена.
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

SearchGetService

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

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/v2"
)

// Generated from example definition: 2025-05-01/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("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewServicesClient().Get(ctx, "rg1", "mysearchservice", 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 = armsearch.ServicesClientGetResponse{
	// 	Service: &armsearch.Service{
	// 		Name: to.Ptr("mysearchservice"),
	// 		Type: to.Ptr("Microsoft.Search/searchServices"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice"),
	// 		Location: to.Ptr("westus"),
	// 		Properties: &armsearch.ServiceProperties{
	// 			AuthOptions: &armsearch.DataPlaneAuthOptions{
	// 				APIKeyOnly: map[string]any{
	// 				},
	// 			},
	// 			ComputeType: to.Ptr(armsearch.ComputeTypeDefault),
	// 			DataExfiltrationProtections: []*armsearch.SearchDataExfiltrationProtection{
	// 			},
	// 			DisableLocalAuth: to.Ptr(false),
	// 			EncryptionWithCmk: &armsearch.EncryptionWithCmk{
	// 				EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
	// 				Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkUnspecified),
	// 			},
	// 			Endpoint: to.Ptr("https://mysearchservice.search.windows.net/"),
	// 			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),
	// 			ServiceUpgradedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-05-01T00:00:00Z"); return t}()),
	// 			SharedPrivateLinkResources: []*armsearch.SharedPrivateLinkResource{
	// 			},
	// 			Status: to.Ptr(armsearch.SearchServiceStatusRunning),
	// 			StatusDetails: to.Ptr(""),
	// 			UpgradeAvailable: to.Ptr(armsearch.UpgradeAvailableNotAvailable),
	// 		},
	// 		SKU: &armsearch.SKU{
	// 			Name: to.Ptr(armsearch.SKUNameStandard),
	// 		},
	// 		SystemData: &armsearch.SystemData{
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-01-01T00:00:00Z"); return t}()),
	// 			CreatedBy: to.Ptr("My e-commerce app"),
	// 			CreatedByType: to.Ptr(armsearch.CreatedByTypeApplication),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-11-01T00:00:00Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("fakeuser@contoso.com"),
	// 			LastModifiedByType: to.Ptr(armsearch.CreatedByTypeUser),
	// 		},
	// 		Tags: map[string]*string{
	// 			"app-name": to.Ptr("My e-commerce app"),
	// 		},
	// 	},
	// }
}

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

Пример ответа

Код состояния:: 200

{
  "name": "mysearchservice",
  "type": "Microsoft.Search/searchServices",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "location": "westus",
  "properties": {
    "authOptions": {
      "apiKeyOnly": {}
    },
    "computeType": "Default",
    "dataExfiltrationProtections": [],
    "disableLocalAuth": false,
    "encryptionWithCmk": {
      "encryptionComplianceStatus": "Compliant",
      "enforcement": "Unspecified"
    },
    "endpoint": "https://mysearchservice.search.windows.net/",
    "hostingMode": "Default",
    "networkRuleSet": {
      "bypass": "None",
      "ipRules": []
    },
    "partitionCount": 1,
    "privateEndpointConnections": [],
    "provisioningState": "succeeded",
    "publicNetworkAccess": "Enabled",
    "replicaCount": 3,
    "serviceUpgradedAt": "2025-05-01T00:00:00Z",
    "sharedPrivateLinkResources": [],
    "status": "running",
    "statusDetails": "",
    "upgradeAvailable": "notAvailable"
  },
  "sku": {
    "name": "standard"
  },
  "systemData": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "lastModifiedAt": "2024-11-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {
    "app-name": "My e-commerce app"
  }
}

Определения

Имя	Описание
AadAuthFailureMode	Описывает, какой ответ БУДЕТ отправлять API плоскости данных службы поиска для запросов, которые не удалось выполнить проверку подлинности.
CloudError	Содержит сведения об ошибке API.
CloudErrorBody	Описывает определенную ошибку API с кодом ошибки и сообщением.
ComputeType	Настройте это свойство для поддержки службы поиска с помощью вычислений по умолчанию или конфиденциальных вычислений Azure.
createdByType	Тип удостоверения, создавшего ресурс.
DataPlaneAadOrApiKeyAuthOption	Указывает, что для проверки подлинности можно использовать ключ API или маркер доступа из клиента идентификатора Microsoft Entra ID.
DataPlaneAuthOptions	Определяет параметры проверки подлинности запроса плоскости данных службы поиска. Это невозможно задать, если параметр disableLocalAuth имеет значение true.
EncryptionWithCmk	Описывает политику, которая определяет, как ресурсы в службе поиска должны быть зашифрованы с помощью ключей, управляемых клиентом.
HostingMode	Применимо только для номера SKU standard3. Это свойство можно настроить для включения до 3 секций высокой плотности, которые позволяют до 1000 индексов, что гораздо выше, чем максимальные индексы, разрешенные для любого другого номера SKU. Для номера SKU standard3 используется значение "Default" или "HighDensity". Для всех остальных номеров SKU это значение должно быть "Default".
Identity	Сведения об удостоверении службы поиска. Значение NULL указывает, что служба поиска не назначена удостоверению.
IdentityType	Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как удостоверение, созданное системой, так и набор удостоверений, назначаемых пользователем. Тип "Нет" приведет к удалению всех удостоверений из службы.
IpRule	Правило ограничения IP-адресов службы поиска ИИ Azure.
NetworkRuleSet	Правила конкретной сети, определяющие, как может быть достигнута служба поиска ИИ Azure.
PrivateEndpointConnection	Описывает существующее подключение частной конечной точки к службе поиска ИИ Azure.
PrivateEndpointConnectionProperties	Описывает свойства существующего подключения частной конечной точки к службе поиска.
PrivateEndpointConnectionPropertiesPrivateEndpoint	Ресурс частной конечной точки от поставщика Microsoft.Network.
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Описывает текущее состояние существующего подключения службы Приватного канала Azure к частной конечной точке.
PrivateLinkServiceConnectionProvisioningState	Состояние подготовки подключения службы приватного канала. Допустимые значения: "Обновление", "Удаление", "Сбой", "Успешно", "Неполный" или "Отменено".
PrivateLinkServiceConnectionStatus	Состояние подключения службы приватного канала. Допустимые значения: ожидающие, утвержденные, отклоненные или отключенные.
ProvisioningState	Состояние последней операции подготовки, выполняемой в службе поиска. Подготовка — это промежуточное состояние, которое происходит во время установки емкости службы. После настройки емкости подготовкаstate изменится на "Успешно" или "Сбой". Клиентские приложения могут опрашивать состояние подготовки (рекомендуемый интервал опроса составляет от 30 секунд до одной минуты) с помощью операции Get Search Service, чтобы узнать, когда операция завершена. Если вы используете бесплатную службу, это значение, как правило, возвращается как "Успешно" непосредственно в вызове службы создания поиска. Это связано с тем, что бесплатная служба использует емкость, которая уже настроена.
PublicNetworkAccess	Для этого значения можно установить значение "Включено", чтобы избежать критических изменений на существующих клиентских ресурсах и шаблонах. Если установлено значение «Отключено», трафик через публичный интерфейс не разрешен, а подключения к частным конечным точкам будут эксклюзивным методом доступа.
SearchBypass	Возможные источники входящего трафика, которые могут обойти правила, определенные в разделе ipRules.
SearchDataExfiltrationProtection	Конкретный сценарий извлечения данных, который отключён для сервиса.
SearchEncryptionComplianceStatus	Возвращает состояние соответствия службы поиска требованиям к объектам без шифрования CMK. Если служба имеет несколько незашифрованных объектов и включена принудительное применение, служба помечается как несоответствующая.
SearchEncryptionWithCmk	Описывает, как служба поиска должна обеспечить соответствие требованиям, если он находит объекты, которые не шифруются с помощью ключа, управляемого клиентом.
SearchSemanticSearch	Указывает доступность и план оплаты для семантического поиска в сервисе Azure AI Search. Эта конфигурация доступна только для определённых уровней ценообразования в определённых регионах.
SearchService	Описывает службу поиска ИИ Azure и ее текущее состояние.
SearchServiceStatus	Состояние службы поиска. Возможные значения включают: "выполняется": служба поиска выполняется и не выполняется никаких операций подготовки. "подготовка": служба поиска подготавливается или масштабируется вверх или вниз. "удаление": служба поиска удаляется. "понижено": служба поиска снижается. Это может произойти, если базовые единицы поиска не работоспособны. Служба поиска, скорее всего, работает, но производительность может быть медленной, и некоторые запросы могут быть удалены. "отключено": служба поиска отключена. В этом состоянии служба отклонит все запросы API. "error": служба поиска находится в состоянии ошибки. "остановлено": служба поиска находится в подписке, которая отключена. Если служба находится в состояниях пониженной, отключенной или ошибки, это означает, что группа поиска ИИ Azure активно изучает основную проблему. Выделенные службы в этих состояниях по-прежнему оплачиваются на основе количества подготовленных единиц поиска.
SharedPrivateLinkResource	Описывает общий ресурс приватного канала, управляемый службой поиска ИИ Azure.
SharedPrivateLinkResourceProperties	Описывает свойства существующего ресурса общего приватного канала, управляемого службой поиска ИИ Azure.
SharedPrivateLinkResourceProvisioningState	Состояние подготовки общего ресурса приватного канала. Допустимые значения: обновление, удаление, сбой, успешное или неполное.
SharedPrivateLinkResourceStatus	Состояние ресурса общего приватного канала. Допустимые значения: ожидающие, утвержденные, отклоненные или отключенные.
Sku	Определяет номер SKU службы поиска, который определяет частоту выставления счетов и ограничения емкости.
SkuName	Номер SKU службы поиска. Допустимые значения: "бесплатный": общая служба. "базовый": выделенная служба с 3 репликами. "Стандартный": выделенная служба с 12 секциями и 12 репликами. "standard2": аналогично стандарту, но с большей емкостью на единицу поиска. "Standard3": наибольшее стандартное предложение с до 12 секций и 12 реплик (или до 3 секций с большим количеством индексов, если свойство hostingMode также имеет значение highDensity). "storage_optimized_l1": поддерживает 1TB на секцию до 12 секций. 'storage_optimized_l2': поддерживает 2 ТБ на раздел, до 12 разделов. 'serverless': уровень без сервера с возможностью автомасштабирования.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UpgradeAvailable	Указывает, есть ли у специализированного поиска доступно обновление.
UserAssignedIdentity	Свойства назначаемого пользователем удостоверения

AadAuthFailureMode

Перечисление

Описывает, какой ответ БУДЕТ отправлять API плоскости данных службы поиска для запросов, которые не удалось выполнить проверку подлинности.

Значение	Описание
http403	Указывает, что запросы, которые не удалось выполнить проверку подлинности, должны быть представлены с кодом состояния HTTP 403 (запрещено).
http401WithBearerChallenge	Указывает, что запросы, которые не удалось выполнить проверку подлинности, должны быть представлены с кодом состояния HTTP 401 (несанкционированный) и представлять вызов носителя.

CloudError

Объект

Содержит сведения об ошибке API.

Имя	Тип	Описание
error	CloudErrorBody	Описывает определенную ошибку API с кодом ошибки и сообщением.
message	string	Краткое описание ошибки, которая указывает на то, что пошло не так (для получения сведений или отладки см. свойство error.message).

CloudErrorBody

Объект

Описывает определенную ошибку API с кодом ошибки и сообщением.

Имя	Тип	Описание
code	string	Код ошибки, описывающий условие ошибки точнее, чем код состояния HTTP. Можно использовать для программной обработки конкретных случаев ошибок.
details	CloudErrorBody[]	Содержит вложенные ошибки, связанные с этой ошибкой.
message	string	Сообщение, описывающее ошибку подробно и предоставляющее сведения об отладке.
target	string	Целевой объект конкретной ошибки (например, имя свойства в ошибке).

ComputeType

Перечисление

Настройте это свойство для поддержки службы поиска с помощью вычислений по умолчанию или конфиденциальных вычислений Azure.

Значение	Описание
Default	Создайте службу с помощью вычислений по умолчанию.
Confidential	Создайте специализированный сервис с помощью Azure Confidential Compute.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DataPlaneAadOrApiKeyAuthOption

Объект

Указывает, что для проверки подлинности можно использовать ключ API или маркер доступа из клиента идентификатора Microsoft Entra ID.

Имя	Тип	Описание
aadAuthFailureMode	AadAuthFailureMode	Описывает, какой ответ БУДЕТ отправлять API плоскости данных службы поиска для запросов, которые не удалось выполнить проверку подлинности.

DataPlaneAuthOptions

Объект

Определяет параметры проверки подлинности запроса плоскости данных службы поиска. Это невозможно задать, если параметр disableLocalAuth имеет значение true.

Имя	Тип	Описание
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	Указывает, что для проверки подлинности можно использовать ключ API или маркер доступа из клиента идентификатора Microsoft Entra ID.
apiKeyOnly		Указывает, что для проверки подлинности можно использовать только ключ API.

EncryptionWithCmk

Объект

Описывает политику, которая определяет, как ресурсы в службе поиска должны быть зашифрованы с помощью ключей, управляемых клиентом.

Имя	Тип	Описание
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Возвращает состояние соответствия службы поиска требованиям к объектам без шифрования CMK. Если служба имеет несколько незашифрованных объектов и включена принудительное применение, служба помечается как несоответствующая.
enforcement	SearchEncryptionWithCmk	Описывает, как служба поиска должна обеспечить соответствие требованиям, если он находит объекты, которые не шифруются с помощью ключа, управляемого клиентом.

HostingMode

Перечисление

Применимо только для номера SKU standard3. Это свойство можно настроить для включения до 3 секций высокой плотности, которые позволяют до 1000 индексов, что гораздо выше, чем максимальные индексы, разрешенные для любого другого номера SKU. Для номера SKU standard3 используется значение "Default" или "HighDensity". Для всех остальных номеров SKU это значение должно быть "Default".

Значение	Описание
Default	Максимальный лимит индексов определяется SKU или ценовым уровнем.
HighDensity	Применяется только к SKU Standard3 (S3), где поисковые сервисы могут иметь до 1000 индексов.

Identity

Объект

Сведения об удостоверении службы поиска. Значение NULL указывает, что служба поиска не назначена удостоверению.

Имя	Тип	Описание
principalId	string	Основной идентификатор назначаемого системой удостоверения службы поиска.
tenantId	string	Идентификатор клиента назначаемого системой удостоверения службы поиска.
type	IdentityType	Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как удостоверение, созданное системой, так и набор удостоверений, назначаемых пользователем. Тип "Нет" приведет к удалению всех удостоверений из службы.
userAssignedIdentities	<string, UserAssignedIdentity>	Список удостоверений пользователей, связанных с ресурсом. Ключевые ссылки на словарь удостоверений пользователей будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IdentityType

Перечисление

Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как удостоверение, созданное системой, так и набор удостоверений, назначаемых пользователем. Тип "Нет" приведет к удалению всех удостоверений из службы.

Значение	Описание
None	Указывает, что необходимо удалить любое удостоверение, связанное со службой поиска.
SystemAssigned	Указывает, что назначаемое системой удостоверение для службы поиска будет включено.
UserAssigned	Указывает, что одно или несколько назначенных пользователем удостоверений будут назначены службе поиска.
SystemAssigned, UserAssigned	Указывает, что назначаемое системой удостоверение для службы поиска будет включено вместе с назначением одного или нескольких назначенных пользователем удостоверений.

IpRule

Объект

Правило ограничения IP-адресов службы поиска ИИ Azure.

Имя	Тип	Описание
value	string	Значение, соответствующее одному IPv4-адресу (например, 123.1.2.3) или диапазону IP-адресов в формате CIDR (например, 123.1.2.3/24).

NetworkRuleSet

Объект

Правила конкретной сети, определяющие, как может быть достигнута служба поиска ИИ Azure.

Имя	Тип	Описание
bypass	SearchBypass	Возможные источники входящего трафика, которые могут обойти правила, определенные в разделе ipRules.
ipRules	IpRule[]	Список правил ограничения IP-адресов, определяющих входящие сети с разрешением доступа к конечной точке службы поиска. В то же время все остальные общедоступные IP-сети блокируются брандмауэром. Эти правила ограничения применяются только в том случае, если функция publicNetworkAccess службы поиска включена; в противном случае трафик через общедоступный интерфейс не допускается даже с любыми правилами общедоступного IP-адреса, а подключения к частной конечной точке — монопольным методом доступа.

PrivateEndpointConnection

Объект

Описывает существующее подключение частной конечной точки к службе поиска ИИ Azure.

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties	PrivateEndpointConnectionProperties	Описывает свойства существующего подключения частной конечной точки к службе поиска ИИ Azure.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Объект

Описывает свойства существующего подключения частной конечной точки к службе поиска.

Имя	Тип	Описание
groupId	string	Идентификатор группы ресурса Azure, для которого предназначена служба приватного канала.
privateEndpoint	PrivateEndpointConnectionPropertiesPrivateEndpoint	Ресурс частной конечной точки от поставщика Microsoft.Network.
privateLinkServiceConnectionState	PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Описывает текущее состояние существующего подключения службы Приватного канала Azure к частной конечной точке.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Состояние подготовки подключения службы приватного канала. Допустимые значения: "Обновление", "Удаление", "Сбой", "Успешно", "Неполный" или "Отменено".

PrivateEndpointConnectionPropertiesPrivateEndpoint

Объект

Ресурс частной конечной точки от поставщика Microsoft.Network.

Имя	Тип	Описание
id	string	Идентификатор ресурса частной конечной точки от поставщика Microsoft.Network.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Объект

Описывает текущее состояние существующего подключения службы Приватного канала Azure к частной конечной точке.

Имя	Тип	Default value	Описание
actionsRequired	string	None	Описание дополнительных действий, которые могут потребоваться.
description	string		Описание состояния подключения службы приватного канала.
status	PrivateLinkServiceConnectionStatus		Состояние подключения службы приватного канала. Допустимые значения: ожидающие, утвержденные, отклоненные или отключенные.

PrivateLinkServiceConnectionProvisioningState

Перечисление

Состояние подготовки подключения службы приватного канала. Допустимые значения: "Обновление", "Удаление", "Сбой", "Успешно", "Неполный" или "Отменено".

Значение	Описание
Updating	Подключение службы приватного канала находится в процессе создания вместе с другими ресурсами, чтобы он был полностью функциональным.
Deleting	Подключение службы приватного канала находится в процессе удаления.
Failed	Не удалось подготовить или удалить подключение службы приватного канала.
Succeeded	Подключение службы приватного канала завершило подготовку и готово к утверждению.
Incomplete	Запрос на подготовку ресурса подключения службы приватного канала был принят, но процесс создания еще не начался.
Canceled	Запрос на подготовку ресурса подключения службы приватного канала был отменен.

PrivateLinkServiceConnectionStatus

Перечисление

Состояние подключения службы приватного канала. Допустимые значения: ожидающие, утвержденные, отклоненные или отключенные.

Значение	Описание
Pending	Подключение к частной конечной точке создано и ожидает утверждения.
Approved	Подключение к частной конечной точке утверждено и готово к использованию.
Rejected	Подключение к частной конечной точке было отклонено и не может использоваться.
Disconnected	Подключение к частной конечной точке было удалено из службы.

ProvisioningState

Перечисление

Состояние последней операции подготовки, выполняемой в службе поиска. Подготовка — это промежуточное состояние, которое происходит во время установки емкости службы. После настройки емкости подготовкаstate изменится на "Успешно" или "Сбой". Клиентские приложения могут опрашивать состояние подготовки (рекомендуемый интервал опроса составляет от 30 секунд до одной минуты) с помощью операции Get Search Service, чтобы узнать, когда операция завершена. Если вы используете бесплатную службу, это значение, как правило, возвращается как "Успешно" непосредственно в вызове службы создания поиска. Это связано с тем, что бесплатная служба использует емкость, которая уже настроена.

Значение	Описание
succeeded	Последняя операция подготовки успешно завершена.
provisioning	Служба поиска подготавливается или масштабируется вверх или вниз. Только для специализированных поисковых сервисов.
failed	Последняя операция подготовки завершилась ошибкой.

PublicNetworkAccess

Перечисление

Для этого значения можно установить значение "Включено", чтобы избежать критических изменений на существующих клиентских ресурсах и шаблонах. Если установлено значение «Отключено», трафик через публичный интерфейс не разрешен, а подключения к частным конечным точкам будут эксклюзивным методом доступа.

Значение	Описание
Enabled	Служба поиска доступна из трафика, исходящем из общедоступного Интернета.
Disabled	Служба поиска недоступна из трафика, исходя из общедоступного Интернета. Доступ разрешен только через утвержденные подключения частной конечной точки.
SecuredByPerimeter	Правила конфигурации сетевого периметра разрешают или запрещают доступ общественной сети к ресурсу. Требуется соответствующий сетевой периметр безопасности.

SearchBypass

Перечисление

Возможные источники входящего трафика, которые могут обойти правила, определенные в разделе ipRules.

Значение	Описание
None	Указывает, что источник не может обойти правила, определенные в разделе ipRules. Это значение по умолчанию.
AzureServices	Указывает, что запросы, исходящие из доверенных служб Azure, могут обойти правила, определенные в разделе ipRules.

SearchDataExfiltrationProtection

Перечисление

Конкретный сценарий извлечения данных, который отключён для сервиса.

Значение	Описание
BlockAll	Указывает, что все сценарии кражи данных отключены.

SearchEncryptionComplianceStatus

Перечисление

Возвращает состояние соответствия службы поиска требованиям к объектам без шифрования CMK. Если служба имеет несколько незашифрованных объектов и включена принудительное применение, служба помечается как несоответствующая.

Значение	Описание
Compliant	Указывает, что служба поиска соответствует требованиям, так как число не зашифрованных объектов CMK равно нулю или отключается принудительное применение.
NonCompliant	Указывает, что служба поиска имеет несколько нешифрованных объектов.

SearchEncryptionWithCmk

Перечисление

Описывает, как служба поиска должна обеспечить соответствие требованиям, если он находит объекты, которые не шифруются с помощью ключа, управляемого клиентом.

Значение	Описание
Disabled	Шифрование ключей, управляемых клиентом, не будет выполнено. Используется только встроенное шифрование, управляемое службой.
Enabled	Служба поиска будет помечена как несоответствующее, если один или несколько объектов не шифруются с помощью ключа, управляемого клиентом.
Unspecified	Политика принудительного применения не указана явно, при этом поведение совпадает с значением "Отключено".

SearchSemanticSearch

Перечисление

Указывает доступность и план оплаты для семантического поиска в сервисе Azure AI Search. Эта конфигурация доступна только для определённых уровней ценообразования в определённых регионах.

Значение	Описание
disabled	Указывает, что семантический рерангитель отключен для службы поиска.
free	Включает семантический повторник в службе поиска и указывает, что он должен использоваться в пределах свободного плана. Бесплатный план будет ограничение объема семантических запросов ранжирования и предлагается без дополнительной платы. Это по умолчанию для недавно подготовленных служб поиска. Это значение по умолчанию.
standard	Включает семантический реранжинг в поисковой службе как оплачиваемую функцию после исчерпания свободной квоты, с большей пропускной способностью и объёмом семантически переранжированных запросов.

SearchService

Объект

Описывает службу поиска ИИ Azure и ее текущее состояние.

Имя	Тип	Default value	Описание
id	string (arm-id)		Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	Identity		Удостоверение ресурса.
location	string		Географическое расположение, в котором находится ресурс
name	string		Имя ресурса
properties.authOptions	DataPlaneAuthOptions		Определяет параметры того, как API плоскости данных службы поиска выполняет проверку подлинности запросов. Это невозможно задать, если параметр disableLocalAuth имеет значение true.
properties.computeType	ComputeType		Настройте это свойство для поддержки службы поиска с помощью вычислений по умолчанию или конфиденциальных вычислений Azure.
properties.dataExfiltrationProtections	SearchDataExfiltrationProtection[]		Список сценариев кражи данных, которые явно запрещены для службы поиска. В настоящее время единственным поддерживаемым значением является "Все", чтобы отключить все возможные сценарии экспорта данных с более точными элементами управления, запланированными в будущем.
properties.disableLocalAuth	boolean		Если задано значение true, вызовы службы поиска не будут разрешены использовать ключи API для проверки подлинности. Это не может быть задано значение true, если определен параметр dataPlaneAuthOptions.
properties.eTag	string		Системное созданное свойство, представляющее etag службы, которое может быть для управления оптимистическим параллелизмом во время обновлений.
properties.encryptionWithCmk	EncryptionWithCmk		Указывает любую политику шифрования ресурсов (таких как индексы) с помощью ключей диспетчера клиентов в службе поиска.
properties.endpoint	string (uri)		Конечная точка службы поиска ИИ Azure.
properties.hostingMode	HostingMode	Default	Применимо только для номера SKU standard3. Это свойство можно настроить для включения до 3 секций высокой плотности, которые позволяют до 1000 индексов, что гораздо выше, чем максимальные индексы, разрешенные для любого другого номера SKU. Для номера SKU standard3 используется значение "Default" или "HighDensity". Для всех остальных номеров SKU это значение должно быть "Default".
properties.networkRuleSet	NetworkRuleSet		Правила конкретной сети, определяющие, как может быть достигнута служба поиска ИИ Azure.
properties.partitionCount	integer (int32) minimum: 1 maximum: 12	1	Количество разделов в выделенном поисковом сервисе; если указано, это может быть 1, 2, 3, 4, 6 или 12. Значения, превышающие 1, допустимы только для стандартных номеров SKU. Для служб "standard3" с параметром hostingMode задано значение highDensity, допустимые значения имеют значение от 1 до 3.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Список подключений частной конечной точки к службе поиска ИИ Azure.
properties.provisioningState	ProvisioningState		Состояние последней операции подготовки, выполняемой в службе поиска. Подготовка — это промежуточное состояние, которое происходит во время установки емкости службы. После настройки емкости подготовкаstate изменится на "Успешно" или "Сбой". Клиентские приложения могут опрашивать состояние подготовки (рекомендуемый интервал опроса составляет от 30 секунд до одной минуты) с помощью операции Get Search Service, чтобы узнать, когда операция завершена. Если вы используете бесплатную службу, это значение, как правило, возвращается как "Успешно" непосредственно в вызове службы создания поиска. Это связано с тем, что бесплатная служба использует емкость, которая уже настроена.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Для этого значения можно установить значение "Включено", чтобы избежать критических изменений на существующих клиентских ресурсах и шаблонах. Если установлено значение «Отключено», трафик через публичный интерфейс не разрешен, а подключения к частным конечным точкам будут эксклюзивным методом доступа.
properties.replicaCount	integer (int32) minimum: 1 maximum: 12	1	Количество реплик в специализированном поисковом сервисе. Если задано, оно должно быть значением от 1 до 12 включительно для стандартных номеров SKU или от 1 до 3 включительно для базового номера SKU.
properties.semanticSearch	SearchSemanticSearch		Указывает доступность и план оплаты для семантического поиска в сервисе Azure AI Search. Эта конфигурация доступна только для определённых уровней ценообразования в определённых регионах.
properties.serviceUpgradedAt	string (date-time)		Дата и время последнего обновления службы поиска. Это поле будет иметь значение NULL, пока служба не будет обновлена в первый раз.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Список общих ресурсов приватного канала, управляемых службой поиска ИИ Azure.
properties.status	SearchServiceStatus		Состояние службы поиска. Возможные значения включают: "выполняется": служба поиска выполняется и не выполняется никаких операций подготовки. "подготовка": служба поиска подготавливается или масштабируется вверх или вниз. "удаление": служба поиска удаляется. "понижено": служба поиска снижается. Это может произойти, если базовые единицы поиска не работоспособны. Служба поиска, скорее всего, работает, но производительность может быть медленной, и некоторые запросы могут быть удалены. "отключено": служба поиска отключена. В этом состоянии служба отклонит все запросы API. "error": служба поиска находится в состоянии ошибки. "остановлено": служба поиска находится в подписке, которая отключена. Если служба находится в состояниях пониженной, отключенной или ошибки, это означает, что группа поиска ИИ Azure активно изучает основную проблему. Выделенные службы в этих состояниях по-прежнему оплачиваются на основе количества подготовленных единиц поиска.
properties.statusDetails	string		Сведения о состоянии службы поиска.
properties.upgradeAvailable	UpgradeAvailable		Указывает, доступна ли служба поиска обновление.
sku	Sku		SKU службы поиска, которая определяет ценовую категорию и ограничения емкости. Это свойство необходимо при создании новой службы поиска.
systemData	systemData		Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object		Теги ресурсов.
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

SearchServiceStatus

Перечисление

Состояние службы поиска. Возможные значения включают: "выполняется": служба поиска выполняется и не выполняется никаких операций подготовки. "подготовка": служба поиска подготавливается или масштабируется вверх или вниз. "удаление": служба поиска удаляется. "понижено": служба поиска снижается. Это может произойти, если базовые единицы поиска не работоспособны. Служба поиска, скорее всего, работает, но производительность может быть медленной, и некоторые запросы могут быть удалены. "отключено": служба поиска отключена. В этом состоянии служба отклонит все запросы API. "error": служба поиска находится в состоянии ошибки. "остановлено": служба поиска находится в подписке, которая отключена. Если служба находится в состояниях пониженной, отключенной или ошибки, это означает, что группа поиска ИИ Azure активно изучает основную проблему. Выделенные службы в этих состояниях по-прежнему оплачиваются на основе количества подготовленных единиц поиска.

Значение	Описание
running	Служба поиска выполняется и не выполняется никаких операций подготовки.
provisioning	Служба поиска подготавливается или масштабируется вверх или вниз.
deleting	Служба поиска удаляется.
degraded	Служба поиска снижается, так как базовые единицы поиска не работоспособны.
disabled	Служба поиска отключена, и все запросы API будут отклонены.
error	Служба поиска находится в состоянии ошибки, указывая на сбой подготовки или удаления.
stopped	Служба поиска находится в подписке, которая отключена.

SharedPrivateLinkResource

Объект

Описывает общий ресурс приватного канала, управляемый службой поиска ИИ Azure.

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties	SharedPrivateLinkResourceProperties	Описывает свойства общего ресурса приватного канала, управляемого службой поиска ИИ Azure.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Объект

Описывает свойства существующего ресурса общего приватного канала, управляемого службой поиска ИИ Azure.

Имя	Тип	Описание
groupId	string	Идентификатор группы от поставщика ресурса, для которой используется общий ресурс приватного канала.
privateLinkResourceId	string	Идентификатор ресурса, для которой используется общий ресурс приватного канала.
provisioningState	SharedPrivateLinkResourceProvisioningState	Состояние подготовки общего ресурса приватного канала. Допустимые значения: обновление, удаление, сбой, успешное или неполное.
requestMessage	string	Сообщение о запросе утверждения общего ресурса приватного канала.
resourceRegion	string	Необязательно. Можно использовать для указания расположения Azure Resource Manager ресурса, для которого создается общая приватная ссылка. Это необходимо только для тех ресурсов, конфигурации DNS которых являются региональными (например, служба Azure Kubernetes).
status	SharedPrivateLinkResourceStatus	Состояние ресурса общего приватного канала. Допустимые значения: ожидающие, утвержденные, отклоненные или отключенные.

SharedPrivateLinkResourceProvisioningState

Перечисление

Состояние подготовки общего ресурса приватного канала. Допустимые значения: обновление, удаление, сбой, успешное или неполное.

Значение	Описание
Updating	Общий ресурс приватного канала находится в процессе создания вместе с другими ресурсами, чтобы он был полностью функциональным.
Deleting	Общий ресурс приватного канала находится в процессе удаления.
Failed	Не удалось подготовить или удалить общий ресурс приватного канала.
Succeeded	Общий ресурс приватного канала завершил подготовку и готов к утверждению.
Incomplete	Запрос на подготовку ресурса общего приватного канала был принят, но процесс создания еще не начался.

SharedPrivateLinkResourceStatus

Перечисление

Состояние ресурса общего приватного канала. Допустимые значения: ожидающие, утвержденные, отклоненные или отключенные.

Значение	Описание
Pending	Создан общий ресурс приватного канала и ожидает утверждения.
Approved	Общий ресурс приватного канала утвержден и готов к использованию.
Rejected	Общий ресурс приватного канала был отклонен и не может использоваться.
Disconnected	Общий ресурс приватного канала удален из службы.

Sku

Объект

Определяет номер SKU службы поиска, который определяет частоту выставления счетов и ограничения емкости.

Имя	Тип	Описание
name	SkuName	Номер SKU службы поиска. Допустимые значения: "бесплатный": общая служба. "базовый": выделенная служба с 3 репликами. "Стандартный": выделенная служба с 12 секциями и 12 репликами. "standard2": аналогично стандарту, но с большей емкостью на единицу поиска. "Standard3": наибольшее стандартное предложение с до 12 секций и 12 реплик (или до 3 секций с большим количеством индексов, если свойство hostingMode также имеет значение highDensity). "storage_optimized_l1": поддерживает 1TB на секцию до 12 секций. 'storage_optimized_l2': поддерживает 2 ТБ на раздел, до 12 разделов. 'serverless': уровень без сервера с возможностью автомасштабирования.

SkuName

Перечисление

Номер SKU службы поиска. Допустимые значения: "бесплатный": общая служба. "базовый": выделенная служба с 3 репликами. "Стандартный": выделенная служба с 12 секциями и 12 репликами. "standard2": аналогично стандарту, но с большей емкостью на единицу поиска. "Standard3": наибольшее стандартное предложение с до 12 секций и 12 реплик (или до 3 секций с большим количеством индексов, если свойство hostingMode также имеет значение highDensity). "storage_optimized_l1": поддерживает 1TB на секцию до 12 секций. 'storage_optimized_l2': поддерживает 2 ТБ на раздел, до 12 разделов. 'serverless': уровень без сервера с возможностью автомасштабирования.

Значение	Описание
free	Бесплатный уровень без гарантий обслуживания и подмножества функций, предлагаемых на платных уровнях.
basic	Оплачиваемый уровень для выделенной службы с 3 репликами.
standard	Уровень выставления счетов для выделенной службы с 12 секциями и 12 репликами.
standard2	Аналогично "стандарту", но с большей емкостью на единицу поиска.
standard3	Наибольшее предложение уровня "Стандартный" с до 12 секций и 12 реплик (или до 3 секций с большим количеством индексов, если свойство hostingMode также имеет значение highDensity).
storage_optimized_l1	Уровень выставления счетов для выделенной службы, поддерживающей 1TB на секцию, до 12 секций.
storage_optimized_l2	Уровень выставления счетов для выделенной службы, поддерживающей 2TB на секцию, до 12 секций.

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

UpgradeAvailable

Перечисление

Указывает, есть ли у специализированного поиска доступно обновление.

Значение	Описание
notAvailable	В настоящее время обновление для специализированной службы недоступно.
available	Для специализированного сервиса доступна возможность улучшения.

UserAssignedIdentity

Объект

Свойства назначаемого пользователем удостоверения

Имя	Тип	Описание
clientId	string (uuid)	Идентификатор клиента назначенного удостоверения.
principalId	string (uuid)	Основной идентификатор назначенного удостоверения.