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


Services - Update

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

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

Параметры URI

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

string

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

searchServiceName
path True

string

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

subscriptionId
path True

string

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

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.disableLocalAuth

boolean

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

properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

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

properties.encryptionWithCmk

EncryptionWithCmk

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

properties.hostingMode

HostingMode

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

properties.networkRuleSet

NetworkRuleSet

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

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 поиска ИИ Azure в определенных расположениях.

sku

Sku

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

tags

object

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

Ответы

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

SearchService

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

Other Status Codes

CloudError

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

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

azure_auth

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

Тип: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

SearchUpdateService
SearchUpdateServiceAuthOptions
SearchUpdateServiceDisableLocalAuth
SearchUpdateServiceToAllowAccessFromPrivateEndpoints
SearchUpdateServiceToAllowAccessFromPublicCustomIPs
SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass
SearchUpdateServiceToRemoveIdentity
SearchUpdateServiceWithCmkEnforcement
SearchUpdateServiceWithDataExfiltration
SearchUpdateServiceWithSemanticSearch

SearchUpdateService

Sample request

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

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

Sample response

{
  "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": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceAuthOptions

Sample request

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

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

Sample response

{
  "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": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceDisableLocalAuth

Sample request

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

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

Sample response

{
  "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": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": true,
    "authOptions": null,
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

Sample request

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

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

Sample response

{
  "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": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

Sample request

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

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

Sample response

{
  "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": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Sample request

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

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

Sample response

{
  "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"
        }
      ],
      "bypass": "AzurePortal"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceToRemoveIdentity

Sample request

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

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

Sample response

{
  "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": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceWithCmkEnforcement

Sample request

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

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

Sample response

{
  "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": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceWithDataExfiltration

Sample request

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

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

Sample response

{
  "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": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}

SearchUpdateServiceWithSemanticSearch

Sample request

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

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

Sample response

{
  "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": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "semanticSearch": "standard"
  }
}

Определения

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

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

ApiKeyOnly

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

CloudError

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

CloudErrorBody

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

DataPlaneAadOrApiKeyAuthOption

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

DataPlaneAuthOptions

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

EncryptionWithCmk

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

HostingMode

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

Identity

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

IdentityType

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

IpRule

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

NetworkRuleSet

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

PrivateEndpoint

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

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionProvisioningState

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

PrivateLinkServiceConnectionState

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

PrivateLinkServiceConnectionStatus

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

ProvisioningState

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

PublicNetworkAccess

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

SearchBypass

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

SearchDisabledDataExfiltrationOption

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

SearchEncryptionComplianceStatus

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

SearchEncryptionWithCmk

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

SearchSemanticSearch

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

SearchService

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

SearchServiceStatus

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

SearchServiceUpdate

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

SharedPrivateLinkResource

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

SharedPrivateLinkResourceProperties

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

SharedPrivateLinkResourceProvisioningState

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

SharedPrivateLinkResourceStatus

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

Sku

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

SkuName

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

UserAssignedManagedIdentity

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

AadAuthFailureMode

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

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

string

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

http403

string

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

ApiKeyOnly

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

CloudError

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

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

CloudErrorBody

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

message

string

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

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

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

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

SearchEncryptionComplianceStatus

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

enforcement

SearchEncryptionWithCmk

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

HostingMode

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

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

string

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

highDensity

string

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

Identity

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

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

string

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

tenantId

string

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

type

IdentityType

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

userAssignedIdentities

<string,  UserAssignedManagedIdentity>

Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключи словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IdentityType

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

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

string

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

SystemAssigned

string

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

SystemAssigned, UserAssigned

string

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

UserAssigned

string

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

IpRule

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

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

string

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

NetworkRuleSet

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

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

SearchBypass

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

ipRules

IpRule[]

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

PrivateEndpoint

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

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

string

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

PrivateEndpointConnection

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

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

string

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

name

string

Имя ресурса.

properties

PrivateEndpointConnectionProperties

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

type

string

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

PrivateEndpointConnectionProperties

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

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

string

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

privateEndpoint

PrivateEndpoint

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

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

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

provisioningState

PrivateLinkServiceConnectionProvisioningState

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

PrivateLinkServiceConnectionProvisioningState

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

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

string

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

Deleting

string

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

Failed

string

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

Incomplete

string

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

Succeeded

string

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

Updating

string

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

PrivateLinkServiceConnectionState

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

Имя Тип значение по умолчанию Описание
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

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

SearchBypass

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

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

string

Указывает, что запросы, исходящие с портала Azure, могут обходить правила, определенные в разделе ipRules.

AzureServices

string

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

None

string

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

SearchDisabledDataExfiltrationOption

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

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

string

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

SearchEncryptionComplianceStatus

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

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

string

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

NonCompliant

string

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

SearchEncryptionWithCmk

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

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

string

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

Enabled

string

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

Unspecified

string

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

SearchSemanticSearch

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

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

string

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

free

string

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

standard

string

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

SearchService

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

Имя Тип значение по умолчанию Описание
id

string

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

identity

Identity

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

location

string

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

name

string

Имя ресурса.

properties.authOptions

DataPlaneAuthOptions

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

properties.disableLocalAuth

boolean

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

properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

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

properties.eTag

string

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

properties.encryptionWithCmk

EncryptionWithCmk

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

properties.hostingMode

HostingMode

default

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

properties.networkRuleSet

NetworkRuleSet

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

properties.partitionCount

integer

1

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

properties.privateEndpointConnections

PrivateEndpointConnection[]

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

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 поиска ИИ Azure в определенных расположениях.

properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

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

properties.status

SearchServiceStatus

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

properties.statusDetails

string

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

sku

Sku

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

tags

object

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

type

string

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

SearchServiceStatus

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

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

string

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

deleting

string

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

disabled

string

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

error

string

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

provisioning

string

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

running

string

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

stopped

string

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

SearchServiceUpdate

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

Имя Тип значение по умолчанию Описание
id

string

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

identity

Identity

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

location

string

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

name

string

Имя ресурса.

properties.authOptions

DataPlaneAuthOptions

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

properties.disableLocalAuth

boolean

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

properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

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

properties.eTag

string

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

properties.encryptionWithCmk

EncryptionWithCmk

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

properties.hostingMode

HostingMode

default

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

properties.networkRuleSet

NetworkRuleSet

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

properties.partitionCount

integer

1

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

properties.privateEndpointConnections

PrivateEndpointConnection[]

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

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 поиска ИИ Azure в определенных расположениях.

properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

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

properties.status

SearchServiceStatus

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

properties.statusDetails

string

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

sku

Sku

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

tags

object

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

type

string

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

SharedPrivateLinkResource

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

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

string

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

name

string

Имя ресурса.

properties

SharedPrivateLinkResourceProperties

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

type

string

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

SharedPrivateLinkResourceProperties

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

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

string

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

privateLinkResourceId

string

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

provisioningState

SharedPrivateLinkResourceProvisioningState

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

requestMessage

string

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

resourceRegion

string

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

status

SharedPrivateLinkResourceStatus

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

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

string

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

free

string

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

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 секций.

UserAssignedManagedIdentity

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

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

string

Идентификатор клиента удостоверения, назначаемого пользователем.

principalId

string

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