Services - Update

Ссылка

Служба:: Search Management

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

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов в текущей подписке. Это значение можно получить из API Azure Resource Manager или портала.
searchServiceName	path	True	string	Имя службы поиска ИИ Azure для обновления.
subscriptionId	path	True	string	Уникальный идентификатор подписки Microsoft Azure. Это значение можно получить из API Azure Resource Manager или портала.
api-version	query	True	string	Версия API, используемая для каждого запроса.

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

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

Текст запроса

Имя	Тип	Описание
identity	Identity	Сведения об удостоверении службы поиска. Значение NULL указывает, что служба поиска не назначена удостоверению.
location	string	Географическое расположение ресурса. Это должен быть один из поддерживаемых и зарегистрированных географических регионов Azure (например, западная часть США, восточная часть США, юго-восточная Азия и т. д.). Это свойство необходимо при создании нового ресурса.
properties.authOptions	DataPlaneAuthOptions	Определяет параметры того, как API плоскости данных службы поиска выполняет проверку подлинности запросов. Это невозможно задать, если параметр disableLocalAuth имеет значение true.
properties.computeType	ComputeType	Настройте это свойство для поддержки службы поиска с помощью вычислений по умолчанию или конфиденциальных вычислений Azure.
properties.dataExfiltrationProtections	SearchDataExfiltrationProtection[]	Список сценариев кражи данных, которые явно запрещены для службы поиска. В настоящее время единственным поддерживаемым значением является "Все", чтобы отключить все возможные сценарии экспорта данных с более точными элементами управления, запланированными в будущем.
properties.disableLocalAuth	boolean	Если задано значение true, вызовы службы поиска не будут разрешены использовать ключи API для проверки подлинности. Это не может быть задано значение true, если определен параметр dataPlaneAuthOptions.
properties.encryptionWithCmk	EncryptionWithCmk	Указывает любую политику шифрования ресурсов (таких как индексы) с помощью ключей диспетчера клиентов в службе поиска.
properties.endpoint	string (uri)	Конечная точка службы поиска ИИ Azure.
properties.hostingMode	HostingMode	Применимо только для номера SKU standard3. Это свойство можно настроить для включения до 3 секций высокой плотности, которые позволяют до 1000 индексов, что гораздо выше, чем максимальные индексы, разрешенные для любого другого номера SKU. Для номера SKU уровня "стандартный" значение равно "default" или "highDensity". Для всех остальных номеров SKU это значение должно иметь значение по умолчанию.
properties.networkRuleSet	NetworkRuleSet	Правила конкретной сети, определяющие, как может быть достигнута служба поиска ИИ Azure.
properties.partitionCount	integer (int32) minimum: 1 maximum: 12	Количество секций в службе поиска; Значение 1, 2, 3, 4, 6 или 12. Значения, превышающие 1, допустимы только для стандартных номеров SKU. Для служб "standard3" с параметром hostingMode задано значение highDensity, допустимые значения имеют значение от 1 до 3.
properties.publicNetworkAccess	PublicNetworkAccess	Это значение можно задать как "включено", чтобы избежать критических изменений в существующих ресурсах и шаблонах клиентов. Если задано значение "отключено", трафик через общедоступный интерфейс не разрешен, а подключения к частной конечной точке — это монопольный метод доступа.
properties.replicaCount	integer (int32) minimum: 1 maximum: 12	Количество реплик в службе поиска. Если задано, оно должно быть значением от 1 до 12 включительно для стандартных номеров SKU или от 1 до 3 включительно для базового номера SKU.
properties.semanticSearch	SearchSemanticSearch	Задает параметры, управляющие доступностью семантического поиска. Эта конфигурация возможна только для определенных номеров SKU поиска ИИ Azure в определенных расположениях.
properties.upgradeAvailable	UpgradeAvailable	Указывает, доступна ли служба поиска обновление.
sku	Sku	SKU службы поиска, которая определяет ценовую категорию и ограничения емкости. Это свойство необходимо при создании новой службы поиска.
tags	object	Теги, помогающие классифицировать ресурс на портале Azure.

Ответы

Имя	Тип	Описание
200 OK	SearchService	Существующее определение службы было успешно обновлено. Если вы изменили количество реплик или секций, операция масштабирования будет выполняться асинхронно. Вы можете проверить состояние операции масштабирования с помощью свойства provisioningState, возвращенного в ответе на запрос Get Service.
Other Status Codes	CloudError	HTTP 400 (недопустимый запрос): указанное определение службы недопустимо или вы попытаелись изменить свойство, которое является неизменяемым. Дополнительные сведения см. в коде ошибки и сообщении в ответе. HTTP 404 (не найдено): не удалось найти подписку или группу ресурсов. HTTP 409 (конфликт): указанная подписка отключена.

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

azure_auth

Указывает неявный поток предоставления, как поддерживается на платформе удостоверений Майкрософт.

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

Области

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

Примеры

SearchUpdateService

SearchUpdateServiceAuthOptions

SearchUpdateServiceDisableLocalAuth

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

SearchUpdateServiceToRemoveIdentity

SearchUpdateServiceWithCmkEnforcement

SearchUpdateServiceWithDataExfiltration

SearchUpdateServiceWithSemanticSearch

SearchUpdateServiceWithSku

SearchUpdateService

Образец запроса

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2
  }
}

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

Код состояния:: 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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceAuthOptions

Образец запроса

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    }
  }
}

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

Код состояния:: 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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceDisableLocalAuth

Образец запроса

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "disableLocalAuth": true
  }
}

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

Код состояния:: 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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": true,
    "authOptions": null,
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

Образец запроса

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "publicNetworkAccess": "disabled"
  }
}

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

Код состояния:: 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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "basic"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

Образец запроса

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    }
  }
}

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

Код состояния:: 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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "10.2.3.4"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Образец запроса

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzureServices"
    }
  }
}

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

Код состояния:: 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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "10.2.3.4"
        }
      ],
      "bypass": "AzureServices"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToRemoveIdentity

Образец запроса

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "sku": {
    "name": "standard"
  },
  "identity": {
    "type": "None"
  }
}

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

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

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

SearchUpdateServiceWithCmkEnforcement

Образец запроса

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "encryptionWithCmk": {
      "enforcement": "Enabled"
    }
  }
}

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

Код состояния:: 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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceWithDataExfiltration

Образец запроса

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "dataExfiltrationProtections": [
      "BlockAll"
    ]
  }
}

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

Код состояния:: 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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [
      "BlockAll"
    ],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceWithSemanticSearch

Образец запроса

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "semanticSearch": "standard"
  }
}

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

Код состояния:: 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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "semanticSearch": "standard",
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceWithSku

Образец запроса

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-05-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard2"
  }
}

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

Код состояния:: 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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard2"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

Определения

Имя	Описание
AadAuthFailureMode	Описывает, какой ответ БУДЕТ отправлять API плоскости данных службы поиска для запросов, которые не удалось выполнить проверку подлинности.
ApiKeyOnly	Указывает, что для проверки подлинности можно использовать только ключ API.
CloudError	Содержит сведения об ошибке API.
CloudErrorBody	Описывает определенную ошибку API с кодом ошибки и сообщением.
ComputeType	Настройте это свойство для поддержки службы поиска с помощью вычислений по умолчанию или конфиденциальных вычислений Azure.
createdByType	Тип удостоверения, создавшего ресурс.
DataPlaneAadOrApiKeyAuthOption	Указывает, что для проверки подлинности можно использовать ключ API или маркер доступа из клиента идентификатора Microsoft Entra ID.
DataPlaneAuthOptions	Определяет параметры проверки подлинности запроса плоскости данных службы поиска. Это невозможно задать, если параметр disableLocalAuth имеет значение true.
EncryptionWithCmk	Описывает политику, которая определяет, как ресурсы в службе поиска должны быть зашифрованы с помощью ключей, управляемых клиентом.
HostingMode	Применимо только для номера SKU standard3. Это свойство можно настроить для включения до 3 секций высокой плотности, которые позволяют до 1000 индексов, что гораздо выше, чем максимальные индексы, разрешенные для любого другого номера SKU. Для номера SKU уровня "стандартный" значение равно "default" или "highDensity". Для всех остальных номеров SKU это значение должно иметь значение по умолчанию.
Identity	Сведения об удостоверении службы поиска. Значение NULL указывает, что служба поиска не назначена удостоверению.
IdentityType	The type of identity used for the resource. Тип SystemAssigned, UserAssigned включает как удостоверение, созданное системой, так и набор удостоверений, назначаемых пользователем. Тип "Нет" приведет к удалению всех удостоверений из службы.
IpRule	Правило ограничения IP-адресов службы поиска ИИ Azure.
NetworkRuleSet	Правила конкретной сети, определяющие, как может быть достигнута служба поиска ИИ Azure.
PrivateEndpoint	Ресурс частной конечной точки от поставщика Microsoft.Network.
PrivateEndpointConnection	Описывает существующее подключение частной конечной точки к службе поиска ИИ Azure.
PrivateEndpointConnectionProperties	Описывает свойства существующего подключения частной конечной точки к службе поиска.
PrivateLinkServiceConnectionProvisioningState	Состояние подготовки подключения службы приватного канала. Допустимые значения: "Обновление", "Удаление", "Сбой", "Успешно", "Неполный" или "Отменено".
PrivateLinkServiceConnectionState	Описывает текущее состояние существующего подключения службы Приватного канала Azure к частной конечной точке.
PrivateLinkServiceConnectionStatus	Состояние подключения службы приватного канала. Допустимые значения: ожидающие, утвержденные, отклоненные или отключенные.
ProvisioningState	Состояние последней операции подготовки, выполняемой в службе поиска. Подготовка — это промежуточное состояние, которое происходит во время установки емкости службы. После настройки емкости подготовкаstate изменится на "Успешно" или "Сбой". Клиентские приложения могут опрашивать состояние подготовки (рекомендуемый интервал опроса составляет от 30 секунд до одной минуты) с помощью операции Get Search Service, чтобы узнать, когда операция завершена. Если вы используете бесплатную службу, это значение, как правило, возвращается как "Успешно" непосредственно в вызове службы создания поиска. Это связано с тем, что бесплатная служба использует емкость, которая уже настроена.
PublicNetworkAccess	Это значение можно задать как "включено", чтобы избежать критических изменений в существующих ресурсах и шаблонах клиентов. Если задано значение "отключено", трафик через общедоступный интерфейс не разрешен, а подключения к частной конечной точке — это монопольный метод доступа.
SearchBypass	Возможные источники входящего трафика, которые могут обойти правила, определенные в разделе ipRules.
SearchDataExfiltrationProtection	Список сценариев кражи данных, которые явно запрещены для службы поиска. В настоящее время единственным поддерживаемым значением является "Все", чтобы отключить все возможные сценарии экспорта данных с более точными элементами управления, запланированными в будущем.
SearchEncryptionComplianceStatus	Возвращает состояние соответствия службы поиска требованиям к объектам без шифрования CMK. Если служба имеет несколько незашифрованных объектов и включена принудительное применение, служба помечается как несоответствующая.
SearchEncryptionWithCmk	Описывает, как служба поиска должна обеспечить соответствие требованиям, если он находит объекты, которые не шифруются с помощью ключа, управляемого клиентом.
SearchSemanticSearch	Задает параметры, управляющие доступностью семантического поиска. Эта конфигурация возможна только для определенных номеров SKU поиска ИИ Azure в определенных расположениях.
SearchService	Описывает службу поиска ИИ Azure и ее текущее состояние.
SearchServiceStatus	Состояние службы поиска. Возможные значения включают: "выполняется": служба поиска выполняется и не выполняется никаких операций подготовки. "подготовка": служба поиска подготавливается или масштабируется вверх или вниз. "удаление": служба поиска удаляется. "понижено": служба поиска снижается. Это может произойти, если базовые единицы поиска не работоспособны. Служба поиска, скорее всего, работает, но производительность может быть медленной, и некоторые запросы могут быть удалены. "отключено": служба поиска отключена. В этом состоянии служба отклонит все запросы API. "error": служба поиска находится в состоянии ошибки. "остановлено": служба поиска находится в подписке, которая отключена. Если служба находится в состояниях пониженной, отключенной или ошибки, это означает, что группа поиска ИИ Azure активно изучает основную проблему. Выделенные службы в этих состояниях по-прежнему оплачиваются на основе количества подготовленных единиц поиска.
SearchServiceUpdate	Параметры, используемые для обновления службы поиска ИИ 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": поддерживает 2TB на секцию до 12 секций.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UpgradeAvailable	Указывает, доступна ли служба поиска обновление.
UserAssignedIdentity	Свойства назначаемого пользователем удостоверения

AadAuthFailureMode

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

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

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

ApiKeyOnly

Object

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

CloudError

Object

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

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

CloudErrorBody

Object

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

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

ComputeType

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

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

Значение	Описание
confidential	Создайте службу с помощью конфиденциальных вычислений Azure.
default	Создайте службу с помощью вычислений по умолчанию.

createdByType

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

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

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

DataPlaneAadOrApiKeyAuthOption

Object

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

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

DataPlaneAuthOptions

Object

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

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

EncryptionWithCmk

Object

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

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

HostingMode

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

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

Значение	Описание
default	Ограничение на количество индексов определяется ограничениями по умолчанию для номера SKU.
highDensity	Только приложение для SKU standard3, где служба поиска может иметь до 1000 индексов.

Identity

Object

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

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

IdentityType

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

The type of identity used for the resource. Тип SystemAssigned, UserAssigned включает как удостоверение, созданное системой, так и набор удостоверений, назначаемых пользователем. Тип "Нет" приведет к удалению всех удостоверений из службы.

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

IpRule

Object

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

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

NetworkRuleSet

Object

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

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

PrivateEndpoint

Object

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

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

PrivateEndpointConnection

Object

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

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

PrivateEndpointConnectionProperties

Object

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

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

PrivateLinkServiceConnectionProvisioningState

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

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

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

PrivateLinkServiceConnectionState

Object

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

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

PrivateLinkServiceConnectionStatus

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

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

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

ProvisioningState

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

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

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

PublicNetworkAccess

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

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

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

SearchBypass

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

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

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

SearchDataExfiltrationProtection

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

Список сценариев кражи данных, которые явно запрещены для службы поиска. В настоящее время единственным поддерживаемым значением является "Все", чтобы отключить все возможные сценарии экспорта данных с более точными элементами управления, запланированными в будущем.

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

SearchEncryptionComplianceStatus

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

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

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

SearchEncryptionWithCmk

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

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

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

SearchSemanticSearch

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

Задает параметры, управляющие доступностью семантического поиска. Эта конфигурация возможна только для определенных номеров SKU поиска ИИ Azure в определенных расположениях.

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

SearchService

Object

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

Имя	Тип	Default value	Описание
id	string (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	Identity		The identity of the resource.
location	string		The geo-location where the resource lives
name	string		The name of the resource
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 уровня "стандартный" значение равно "default" или "highDensity". Для всех остальных номеров SKU это значение должно иметь значение по умолчанию.
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		Задает параметры, управляющие доступностью семантического поиска. Эта конфигурация возможна только для определенных номеров SKU поиска ИИ Azure в определенных расположениях.
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 активно изучает основную проблему. Выделенные службы в этих состояниях по-прежнему оплачиваются на основе количества подготовленных единиц поиска.

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

SearchServiceUpdate

Object

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

Имя	Тип	Default value	Описание
id	string (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	Identity		Сведения об удостоверении службы поиска. Значение NULL указывает, что служба поиска не назначена удостоверению.
location	string		Географическое расположение ресурса. Это должен быть один из поддерживаемых и зарегистрированных географических регионов Azure (например, западная часть США, восточная часть США, юго-восточная Азия и т. д.). Это свойство необходимо при создании нового ресурса.
name	string		The name of the resource
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 уровня "стандартный" значение равно "default" или "highDensity". Для всех остальных номеров SKU это значение должно иметь значение по умолчанию.
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		Задает параметры, управляющие доступностью семантического поиска. Эта конфигурация возможна только для определенных номеров SKU поиска ИИ Azure в определенных расположениях.
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		Теги, помогающие классифицировать ресурс на портале Azure.
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResource

Object

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

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

SharedPrivateLinkResourceProperties

Object

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

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

SharedPrivateLinkResourceProvisioningState

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

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

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

SharedPrivateLinkResourceStatus

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

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

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

Sku

Object

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

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

SkuName

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

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

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

systemData

Object

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

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

UpgradeAvailable

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

Указывает, доступна ли служба поиска обновление.

Значение	Описание
available	Для службы доступно обновление.
notAvailable	Обновление в настоящее время недоступно для службы.

UserAssignedIdentity

Object

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

Имя	Тип	Описание
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.

Поделиться через

Services - Update

Параметры URI

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

Текст запроса

Ответы

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

azure_auth

Области

Примеры

SearchUpdateService

Образец запроса

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

SearchUpdateServiceAuthOptions

Образец запроса

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

SearchUpdateServiceDisableLocalAuth

Образец запроса

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

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

Образец запроса

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

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

Образец запроса

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

SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Образец запроса

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

SearchUpdateServiceToRemoveIdentity

Образец запроса

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

SearchUpdateServiceWithCmkEnforcement

Образец запроса

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

SearchUpdateServiceWithDataExfiltration

Образец запроса

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

SearchUpdateServiceWithSemanticSearch

Образец запроса

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

SearchUpdateServiceWithSku

Образец запроса

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

Определения

AadAuthFailureMode

ApiKeyOnly

CloudError

CloudErrorBody

ComputeType

createdByType

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

HostingMode

Identity

IdentityType

IpRule

NetworkRuleSet

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionProvisioningState

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

SearchBypass

SearchDataExfiltrationProtection

SearchEncryptionComplianceStatus

SearchEncryptionWithCmk

SearchSemanticSearch

SearchService

SearchServiceStatus

SearchServiceUpdate

SharedPrivateLinkResource

SharedPrivateLinkResourceProperties

SharedPrivateLinkResourceProvisioningState

SharedPrivateLinkResourceStatus

Sku

SkuName