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


Services - Update

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

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

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Имя группы ресурсов в текущей подписке. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.

searchServiceName
path True

string

Имя обновляемой службы поиска.

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

Удостоверение ресурса.

location

string

Географическое расположение ресурса. Это должен быть один из поддерживаемых и зарегистрированных географических регионов Azure (например, Западная часть США, Восточная часть США, Юго-Восточная Азия и т. д.). Это свойство является обязательным при создании нового ресурса.

properties.authOptions

DataPlaneAuthOptions

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

properties.disableLocalAuth

boolean

Если задано значение true, вызовы службы поиска не смогут использовать ключи API для проверки подлинности. Если задано значение "dataPlaneAuthOptions", значение true невозможно.

properties.encryptionWithCmk

EncryptionWithCmk

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

properties.hostingMode

HostingMode

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

properties.networkRuleSet

NetworkRuleSet

Правила, относящиеся к сети, которые определяют способ доступа к службе поиска.

properties.partitionCount

integer

Количество секций в службе поиска; Если указано, это может быть 1, 2, 3, 4, 6 или 12. Значения больше 1 допустимы только для стандартных номеров SKU. Для служб standard3 с параметром hostingMode, для которых задано значение highDensity, допустимые значения находятся в диапазоне от 1 до 3.

properties.publicNetworkAccess

PublicNetworkAccess

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

properties.replicaCount

integer

Количество реплик в службе поиска. Если этот параметр указан, он должен быть значением от 1 до 12 включительно для номеров SKU "Стандартный" или от 1 до 3 включительно для SKU "Базовый".

properties.semanticSearch

SearchSemanticSearch

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

sku

Sku

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

tags

object

Теги, помогающие классифицировать ресурс в портал Azure.

Ответы

Имя Тип Описание
200 OK

SearchService

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

Other Status Codes

CloudError

HTTP 400 (недопустимый запрос): данное определение службы является недопустимым или вы попытались изменить неизменяемое свойство; Дополнительные сведения см. в коде ошибки и сообщении в ответе. HTTP 404 (не найдено). Не удалось найти подписку или группу ресурсов. HTTP 409 (конфликт): указанная подписка отключена.

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

azure_auth

Microsoft Entra ID поток авторизации OAuth2.

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

Области

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

Примеры

SearchUpdateService
SearchUpdateServiceAuthOptions
SearchUpdateServiceDisableLocalAuth
SearchUpdateServiceToAllowAccessFromPrivateEndpoints
SearchUpdateServiceToAllowAccessFromPublicCustomIPs
SearchUpdateServiceToRemoveIdentity
SearchUpdateServiceWithCmkEnforcement
SearchUpdateServiceWithSemanticSearch

SearchUpdateService

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

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

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

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

{
  "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,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "privateEndpointConnections": []
  }
}

SearchUpdateServiceAuthOptions

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

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

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

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

{
  "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,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    }
  }
}

SearchUpdateServiceDisableLocalAuth

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

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

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

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

{
  "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,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "disableLocalAuth": true,
    "authOptions": null
  }
}

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

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

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

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

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

{
  "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,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "privateEndpointConnections": []
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

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

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

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

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

{
  "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,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "10.2.3.4"
        }
      ]
    },
    "privateEndpointConnections": []
  }
}

SearchUpdateServiceToRemoveIdentity

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

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

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

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

{
  "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,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "privateEndpointConnections": []
  },
  "identity": {
    "type": "None"
  }
}

SearchUpdateServiceWithCmkEnforcement

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

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

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

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

{
  "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,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    }
  }
}

SearchUpdateServiceWithSemanticSearch

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

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

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

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

{
  "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,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "semanticSearch": "standard"
  }
}

Определения

Имя Описание
AadAuthFailureMode

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

ApiKeyOnly

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

CloudError

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

CloudErrorBody

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

DataPlaneAadOrApiKeyAuthOption

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

DataPlaneAuthOptions

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

EncryptionWithCmk

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

HostingMode

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

Identity

Удостоверение ресурса.

IdentityType

Тип удостоверения.

IpRule

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

NetworkRuleSet

Правила, относящиеся к сети, которые определяют способ доступа к службе поиска.

PrivateEndpoint

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

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionProvisioningState

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

PrivateLinkServiceConnectionState

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

PrivateLinkServiceConnectionStatus

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

ProvisioningState

Состояние последней операции подготовки, выполненной в службе поиска. Подготовка — это промежуточное состояние, которое наступает при установке емкости службы. После настройки емкости provisioningState изменится на "успешно" или "сбой". Клиентские приложения могут опрашивать состояние подготовки (рекомендуемый интервал опроса — от 30 секунд до одной минуты), используя операцию Получения службы поиска, чтобы узнать, когда операция завершена. Если вы используете бесплатную службу, это значение, как правило, возвращается как "успешно" непосредственно в вызове create search service. Это объясняется тем, что бесплатная служба использует уже настроенную емкость.

PublicNetworkAccess

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

SearchEncryptionComplianceStatus

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

SearchEncryptionWithCmk

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

SearchSemanticSearch

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

SearchService

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

SearchServiceStatus

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

SearchServiceUpdate

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

SharedPrivateLinkResource

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

SharedPrivateLinkResourceProperties

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

SharedPrivateLinkResourceProvisioningState

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

SharedPrivateLinkResourceStatus

Состояние общего ресурса приватного канала. Допустимые значения: Pending, Approved, Rejected или Disconnected.

Sku

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

SkuName

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

AadAuthFailureMode

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

Имя Тип Описание
http401WithBearerChallenge

string

Указывает, что запросы, которые не выполнили проверку подлинности, должны быть представлены с кодом состояния HTTP 401 (не авторизовано) и представлять запрос носителя.

http403

string

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

ApiKeyOnly

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

CloudError

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

Имя Тип Описание
error

CloudErrorBody

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

CloudErrorBody

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

Имя Тип Описание
code

string

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

details

CloudErrorBody[]

Содержит вложенные ошибки, связанные с этой ошибкой.

message

string

Сообщение, подробно описывающее ошибку и предоставляющее отладочную информацию.

target

string

Целевой объект конкретной ошибки (например, имя свойства в ошибке).

DataPlaneAadOrApiKeyAuthOption

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

Имя Тип Описание
aadAuthFailureMode

AadAuthFailureMode

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

DataPlaneAuthOptions

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

Имя Тип Описание
aadOrApiKey

DataPlaneAadOrApiKeyAuthOption

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

apiKeyOnly

ApiKeyOnly

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

EncryptionWithCmk

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

Имя Тип Описание
encryptionComplianceStatus

SearchEncryptionComplianceStatus

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

enforcement

SearchEncryptionWithCmk

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

HostingMode

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

Имя Тип Описание
default

string

Ограничение на количество индексов определяется ограничениями по умолчанию для номера SKU.

highDensity

string

Только приложение для SKU "Стандартный3", где служба поиска может иметь до 1000 индексов.

Identity

Удостоверение ресурса.

Имя Тип Описание
principalId

string

Идентификатор субъекта назначаемого системой удостоверения службы поиска.

tenantId

string

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

type

IdentityType

Тип удостоверения.

IdentityType

Тип удостоверения.

Имя Тип Описание
None

string

SystemAssigned

string

IpRule

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

Имя Тип Описание
value

string

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

NetworkRuleSet

Правила, относящиеся к сети, которые определяют способ доступа к службе поиска.

Имя Тип Описание
ipRules

IpRule[]

Список правил ограничения IP-адресов, используемых для брандмауэра ip-адресов. Все IP-адреса, которые не соответствуют правилам, блокируются брандмауэром. Эти правила применяются только в том случае, если параметр publicNetworkAccess службы поиска включен.

PrivateEndpoint

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

Имя Тип Описание
id

string

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

PrivateEndpointConnection

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

Имя Тип Описание
id

string

Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Имя ресурса.

properties

PrivateEndpointConnectionProperties

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

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

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

Имя Тип Описание
groupId

string

Идентификатор группы от поставщика ресурса, для подключения к службе приватного канала.

privateEndpoint

PrivateEndpoint

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

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

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

provisioningState

PrivateLinkServiceConnectionProvisioningState

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

PrivateLinkServiceConnectionProvisioningState

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

Имя Тип Описание
Canceled

string

Запрос на подготовку для ресурса подключения службы приватного канала отменен.

Deleting

string

Подключение службы приватного канала находится в процессе удаления.

Failed

string

Не удалось подготовить или удалить подключение службы приватного канала.

Incomplete

string

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

Succeeded

string

Подготовка подключения службы приватного канала завершена и готова к утверждению.

Updating

string

Подключение службы приватного канала создается вместе с другими ресурсами, чтобы оно было полностью функциональным.

PrivateLinkServiceConnectionState

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

Имя Тип Default value Описание
actionsRequired

string

None

Описание любых дополнительных действий, которые могут потребоваться.

description

string

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

status

PrivateLinkServiceConnectionStatus

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

PrivateLinkServiceConnectionStatus

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

Имя Тип Описание
Approved

string

Подключение к частной конечной точке утверждено и готово к использованию.

Disconnected

string

Подключение к частной конечной точке удалено из службы.

Pending

string

Подключение к частной конечной точке создано и ожидает утверждения.

Rejected

string

Подключение к частной конечной точке было отклонено и не может использоваться.

ProvisioningState

Состояние последней операции подготовки, выполненной в службе поиска. Подготовка — это промежуточное состояние, которое наступает при установке емкости службы. После настройки емкости provisioningState изменится на "успешно" или "сбой". Клиентские приложения могут опрашивать состояние подготовки (рекомендуемый интервал опроса — от 30 секунд до одной минуты), используя операцию Получения службы поиска, чтобы узнать, когда операция завершена. Если вы используете бесплатную службу, это значение, как правило, возвращается как "успешно" непосредственно в вызове create search service. Это объясняется тем, что бесплатная служба использует уже настроенную емкость.

Имя Тип Описание
failed

string

Сбой последней операции подготовки.

provisioning

string

Служба поиска подготавливается или масштабируется вверх или вниз.

succeeded

string

Последняя операция подготовки успешно завершена.

PublicNetworkAccess

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

Имя Тип Описание
disabled

string

enabled

string

SearchEncryptionComplianceStatus

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

Имя Тип Описание
Compliant

string

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

NonCompliant

string

Указывает, что служба поиска содержит несколько незашифрованных ресурсов.

SearchEncryptionWithCmk

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

Имя Тип Описание
Disabled

string

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

Enabled

string

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

Unspecified

string

Политика принудительного применения не указана явным образом, при этом поведение будет таким же, как если бы для нее было задано значение "Отключено".

SearchSemanticSearch

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

Имя Тип Описание
disabled

string

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

free

string

Включает семантическое ранжирование в службе поиска и указывает, что он должен использоваться в пределах уровня "Бесплатный". Это позволит ограничить объем запросов семантического ранжирования и будет предлагаться без дополнительной платы. Это значение по умолчанию для новых подготовленных служб поиска.

standard

string

Включает семантическое ранжирование в службе поиска в качестве оплачиваемой функции с более высокой пропускной способностью и объемом запросов семантического ранжирования.

SearchService

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

Имя Тип Default value Описание
id

string

Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Удостоверение ресурса.

location

string

Географическое расположение, в котором находится ресурс

name

string

Имя ресурса.

properties.authOptions

DataPlaneAuthOptions

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

properties.disableLocalAuth

boolean

Если задано значение true, вызовы службы поиска не смогут использовать ключи API для проверки подлинности. Если определены dataPlaneAuthOptions, это значение не может быть равно true.

properties.encryptionWithCmk

EncryptionWithCmk

Задает любую политику шифрования ресурсов (например, индексов) с помощью ключей диспетчера клиентов в службе поиска.

properties.hostingMode

HostingMode

default

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

properties.networkRuleSet

NetworkRuleSet

Правила, относящиеся к сети, которые определяют способ доступа к службе поиска.

properties.partitionCount

integer

1

Количество секций в службе поиска; Если указано значение, это может быть 1, 2, 3, 4, 6 или 12. Значения больше 1 допустимы только для стандартных номеров SKU. Для служб standard3 с параметром hostingMode, для которых задано значение highDensity, допустимые значения находятся в диапазоне от 1 до 3.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Список подключений частной конечной точки к службе поиска.

properties.provisioningState

ProvisioningState

Состояние последней операции подготовки, выполненной в службе поиска. Подготовка — это промежуточное состояние, которое наступает при установке емкости службы. После настройки емкости provisioningState изменится на "успешно" или "сбой". Клиентские приложения могут опрашивать состояние подготовки (рекомендуемый интервал опроса составляет от 30 секунд до одной минуты), используя операцию Получения службы поиска, чтобы узнать, когда операция будет завершена. Если вы используете бесплатную службу, это значение, как правило, возвращается как "успешно" непосредственно в вызове create search service. Это объясняется тем, что бесплатная служба использует уже настроенную емкость.

properties.publicNetworkAccess

PublicNetworkAccess

enabled

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

properties.replicaCount

integer

1

Количество реплик в службе поиска. Если он указан, это должно быть значение от 1 до 12 включительно для номеров SKU категории "Стандартный" или от 1 до 3 включительно для номера SKU "Базовый".

properties.semanticSearch

SearchSemanticSearch

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

properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

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

properties.status

SearchServiceStatus

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

properties.statusDetails

string

Сведения о состоянии службы поиска.

sku

Sku

Номер SKU службы поиска, который определяет тарификацию и ограничения емкости. Это свойство является обязательным при создании новой службы поиска.

tags

object

Теги ресурсов.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

SearchServiceStatus

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

Имя Тип Описание
degraded

string

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

deleting

string

Служба поиска удаляется.

disabled

string

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

error

string

Служба поиска находится в состоянии ошибки, что указывает на сбой подготовки или удаления.

provisioning

string

Служба поиска подготавливается или масштабируется вверх или вниз.

running

string

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

SearchServiceUpdate

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

Имя Тип Default value Описание
id

string

Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Удостоверение ресурса.

location

string

Географическое расположение ресурса. Это должен быть один из поддерживаемых и зарегистрированных географических регионов Azure (например, Западная часть США, Восточная часть США, Юго-Восточная Азия и т. д.). Это свойство является обязательным при создании нового ресурса.

name

string

Имя ресурса.

properties.authOptions

DataPlaneAuthOptions

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

properties.disableLocalAuth

boolean

Если задано значение true, вызовы службы поиска не смогут использовать ключи API для проверки подлинности. Если задано значение "dataPlaneAuthOptions", значение true невозможно.

properties.encryptionWithCmk

EncryptionWithCmk

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

properties.hostingMode

HostingMode

default

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

properties.networkRuleSet

NetworkRuleSet

Правила, относящиеся к сети, которые определяют способ доступа к службе поиска.

properties.partitionCount

integer

1

Количество секций в службе поиска; Если указано, это может быть 1, 2, 3, 4, 6 или 12. Значения больше 1 допустимы только для стандартных номеров SKU. Для служб standard3 с параметром hostingMode, для которых задано значение highDensity, допустимые значения находятся в диапазоне от 1 до 3.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Список подключений к частной конечной точке к службе поиска.

properties.provisioningState

ProvisioningState

Состояние последней операции подготовки, выполненной в службе поиска. Подготовка — это промежуточное состояние, которое наступает при установке емкости службы. После настройки емкости provisioningState изменится на "успешно" или "сбой". Клиентские приложения могут опрашивать состояние подготовки (рекомендуемый интервал опроса — от 30 секунд до одной минуты), используя операцию Получения службы поиска, чтобы узнать, когда операция завершена. Если вы используете бесплатную службу, это значение, как правило, возвращается как "успешно" непосредственно в вызове create search service. Это объясняется тем, что бесплатная служба использует уже настроенную емкость.

properties.publicNetworkAccess

PublicNetworkAccess

enabled

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

properties.replicaCount

integer

1

Количество реплик в службе поиска. Если этот параметр указан, он должен быть значением от 1 до 12 включительно для номеров SKU "Стандартный" или от 1 до 3 включительно для SKU "Базовый".

properties.semanticSearch

SearchSemanticSearch

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

properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

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

properties.status

SearchServiceStatus

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

properties.statusDetails

string

Сведения о состоянии службы поиска.

sku

Sku

Номер SKU службы поиска, который определяет тарификацию и ограничения емкости. Это свойство является обязательным при создании новой службы поиска.

tags

object

Теги, помогающие классифицировать ресурс в портал Azure.

type

string

Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

SharedPrivateLinkResource

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

Имя Тип Описание
id

string

Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Имя ресурса.

properties

SharedPrivateLinkResourceProperties

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

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

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

Имя Тип Описание
groupId

string

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

privateLinkResourceId

string

Идентификатор ресурса, для который используется общий ресурс приватного канала.

provisioningState

SharedPrivateLinkResourceProvisioningState

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

requestMessage

string

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

resourceRegion

string

Необязательный элемент. Можно использовать для указания azure Resource Manager расположения ресурса, к которому будет создан общий приватный канал. Это необходимо только для тех ресурсов, конфигурация DNS которых является региональной (например, Служба Azure Kubernetes).

status

SharedPrivateLinkResourceStatus

Состояние общего ресурса приватного канала. Допустимые значения: Pending, Approved, Rejected или Disconnected.

SharedPrivateLinkResourceProvisioningState

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

Имя Тип Описание
Deleting

string

Failed

string

Incomplete

string

Succeeded

string

Updating

string

SharedPrivateLinkResourceStatus

Состояние общего ресурса приватного канала. Допустимые значения: Pending, Approved, Rejected или Disconnected.

Имя Тип Описание
Approved

string

Disconnected

string

Pending

string

Rejected

string

Sku

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

Имя Тип Описание
name

SkuName

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

SkuName

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

Имя Тип Описание
basic

string

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

free

string

Уровень "Бесплатный" без гарантий SLA и подмножества функций, предлагаемых на оплачиваемых уровнях.

standard

string

Оплачиваемый уровень для выделенной службы, имеющей до 12 секций и 12 реплик.

standard2

string

Похож на "стандартный", но с большей емкостью на единицу поиска.

standard3

string

Самое крупное стандартное предложение с 12 секциями и 12 репликами (или до 3 секций с большим количеством индексов, если свойство hostingMode также задано как highDensity).

storage_optimized_l1

string

Оплачиваемый уровень для выделенной службы, поддерживающей 1 Тбайт на секцию, до 12 секций.

storage_optimized_l2

string

Оплачиваемый уровень для выделенной службы, поддерживающей 2 ТБАЙТ на секцию, до 12 секций.