你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Services - Create Or Update

参考

服务:: Search Management

API 版本:: 2025-05-01

在给定资源组中创建或更新搜索服务。如果搜索服务已存在，则会使用给定的值更新所有属性。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	当前订阅中的资源组的名称。可以从 Azure 资源管理器 API 或门户获取此值。
searchServiceName	path	True	string	要创建或更新的 Azure AI 搜索服务的名称。搜索服务名称只能包含小写字母、数字或短划线，不能使用短划线作为前两个字符或最后一个字符，不能包含连续短划线，长度必须介于 2 到 60 个字符之间。搜索服务名称必须唯一，因为它们是服务 URI 的一部分（https://.search.windows.net). 创建服务后，无法更改服务名称。
subscriptionId	path	True	string	Microsoft Azure 订阅的唯一标识符。可以从 Azure 资源管理器 API 或门户获取此值。
api-version	query	True	string	要用于每个请求的 API 版本。

请求头

名称	必需	类型	说明
x-ms-client-request-id		string (uuid)	一个客户端生成的 GUID 值，用于标识此请求。如果指定，响应信息中将包含此内容作为跟踪请求的一种方式。

请求正文

名称	必需	类型	说明
___location	True	string	The geo-___location where the resource lives
identity		Identity	The identity of the resource.
properties.authOptions		DataPlaneAuthOptions	定义搜索服务的数据平面 API 如何对请求进行身份验证的选项。如果“disableLocalAuth”设置为 true，则无法设置此项。
properties.computeType		ComputeType	配置此属性以支持使用默认计算或 Azure 机密计算的搜索服务。
properties.dataExfiltrationProtections		SearchDataExfiltrationProtection[]	显式禁止搜索服务的数据外泄方案列表。目前，唯一支持的值是“全部”，用于禁用所有可能的数据导出方案，并计划将来进行更精细的控制。
properties.disableLocalAuth		boolean	如果设置为 true，则不允许调用搜索服务以使用 API 密钥进行身份验证。如果定义了“dataPlaneAuthOptions”，则无法将其设置为 true。
properties.encryptionWithCmk		EncryptionWithCmk	指定有关使用搜索服务中的客户经理密钥加密资源（如索引）的任何策略。
properties.endpoint		string (uri)	Azure AI 搜索服务的终结点。
properties.hostingMode		HostingMode	仅适用于 standard3 SKU。可以将此属性设置为最多允许 3 个高密度分区，允许最多 1000 个索引，这远远高于任何其他 SKU 允许的最大索引。对于 standard3 SKU，该值为“default”或“highDensity”。对于所有其他 SKU，此值必须为“default”。
properties.networkRuleSet		NetworkRuleSet	确定如何访问 Azure AI 搜索服务的网络特定规则。
properties.partitionCount		integer (int32) minimum: 1 maximum: 12	搜索服务中的分区数;如果指定，则它可以是 1、2、3、4、6 或 12。大于 1 的值仅适用于标准 SKU。对于 hostingMode 设置为“highDensity”的“standard3”服务，允许的值介于 1 到 3 之间。
properties.publicNetworkAccess		PublicNetworkAccess	此值可以设置为“已启用”，以避免对现有客户资源和模板进行重大更改。如果设置为“disabled”，则不允许通过公共接口的流量，专用终结点连接将是独占访问方法。
properties.replicaCount		integer (int32) minimum: 1 maximum: 12	搜索服务中的副本数。如果指定，它必须是标准 SKU 的 1 到 12（含 1 到 3）之间的值，对于基本 SKU，该值必须介于 1 和 3 之间。
properties.semanticSearch		SearchSemanticSearch	设置控制语义搜索可用性的选项。此配置仅适用于特定位置的某些 Azure AI 搜索 SKU。
properties.upgradeAvailable		UpgradeAvailable	指示搜索服务是否有可用的升级。
sku		Sku	搜索服务的 SKU，用于确定价格层和容量限制。创建新搜索服务时，此属性是必需的。
tags		object	资源标记。

响应

名称	类型	说明
200 OK	SearchService	已成功更新现有服务定义。如果更改了副本或分区数，缩放操作将异步进行。可以通过 Get Service 请求的响应中返回的 provisioningState 属性检查缩放作的状态。
201 Created	SearchService	如果请求创建免费搜索服务，则服务现已预配并可供使用，但存在 DNS 传播延迟。对于其他 SKU 类型，预配以异步方式进行。可以通过 Get Service 请求的响应中返回的 provisioningState 属性检查缩放作的状态。
Other Status Codes	CloudError	HTTP 400 （错误请求）：给定的服务名称或服务定义无效。有关详细信息，请参阅响应中的错误代码和消息。 HTTP 404（找不到）：找不到订阅或资源组。 HTTP 409 （冲突）：已禁用指定的订阅。

安全性

azure_auth

指定Microsoft标识平台上支持的隐式授权流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

SearchCreateOrUpdateService

SearchCreateOrUpdateServiceAuthOptions

SearchCreateOrUpdateServiceDisableLocalAuth

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

SearchCreateOrUpdateServiceWithCmkEnforcement

SearchCreateOrUpdateServiceWithDataExfiltration

SearchCreateOrUpdateServiceWithIdentity

SearchCreateOrUpdateWithSemanticSearch

SearchCreateOrUpdateService

示例请求

HTTP

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

{
  "___location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "computeType": "default"
  }
}

示例响应

状态代码:: 200

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

状态代码:: 201

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

SearchCreateOrUpdateServiceAuthOptions

示例请求

HTTP

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

{
  "___location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "computeType": "default",
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    }
  }
}

示例响应

状态代码:: 200

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

状态代码:: 201

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

SearchCreateOrUpdateServiceDisableLocalAuth

示例请求

HTTP

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

{
  "___location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "computeType": "default",
    "disableLocalAuth": true
  }
}

示例响应

状态代码:: 200

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

状态代码:: 201

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

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

示例请求

HTTP

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

{
  "___location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "publicNetworkAccess": "disabled",
    "hostingMode": "default",
    "computeType": "default"
  }
}

示例响应

状态代码:: 200

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

状态代码:: 201

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

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

示例请求

HTTP

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

{
  "___location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "hostingMode": "default",
    "computeType": "default"
  }
}

示例响应

状态代码:: 200

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

状态代码:: 201

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

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

示例请求

HTTP

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

{
  "___location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzureServices"
    },
    "hostingMode": "default",
    "computeType": "default"
  }
}

示例响应

状态代码:: 200

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

状态代码:: 201

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

SearchCreateOrUpdateServiceWithCmkEnforcement

示例请求

HTTP

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

{
  "___location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "computeType": "default",
    "encryptionWithCmk": {
      "enforcement": "Enabled"
    }
  }
}

示例响应

状态代码:: 200

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

状态代码:: 201

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

SearchCreateOrUpdateServiceWithDataExfiltration

示例请求

HTTP

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

{
  "___location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "computeType": "default",
    "dataExfiltrationProtections": [
      "BlockAll"
    ]
  }
}

示例响应

状态代码:: 200

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

状态代码:: 201

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

SearchCreateOrUpdateServiceWithIdentity

示例请求

HTTP

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

{
  "___location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "computeType": "default"
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {}
    }
  }
}

示例响应

状态代码:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "___location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {
        "clientId": "cd1dcac8-82dd-45b5-9aed-76795d529f6b",
        "principalId": "24e07a75-1286-41e5-a15d-ded85ec3acd7"
      }
    }
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

状态代码:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "___location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {
        "clientId": "cd1dcac8-82dd-45b5-9aed-76795d529f6b",
        "principalId": "24e07a75-1286-41e5-a15d-ded85ec3acd7"
      }
    }
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchCreateOrUpdateWithSemanticSearch

示例请求

HTTP

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

{
  "___location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "computeType": "default",
    "semanticSearch": "free"
  }
}

示例响应

状态代码:: 200

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

状态代码:: 201

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

定义

名称	说明
AadAuthFailureMode	描述搜索服务的数据平面 API 针对身份验证失败的请求发送的响应。
ApiKeyOnly	指示只能使用 API 密钥进行身份验证。
CloudError	包含有关 API 错误的信息。
CloudErrorBody	描述具有错误代码和消息的特定 API 错误。
ComputeType	配置此属性以支持使用默认计算或 Azure 机密计算的搜索服务。
createdByType	创建资源的标识的类型。
DataPlaneAadOrApiKeyAuthOption	指示 API 密钥或来自 Microsoft Entra ID 租户的访问令牌可用于身份验证。
DataPlaneAuthOptions	定义搜索服务如何对数据平面请求进行身份验证的选项。如果“disableLocalAuth”设置为 true，则无法设置此项。
EncryptionWithCmk	描述一个策略，该策略确定如何使用客户管理的密钥对搜索服务中的资源进行加密。
HostingMode	仅适用于 standard3 SKU。可以将此属性设置为最多允许 3 个高密度分区，允许最多 1000 个索引，这远远高于任何其他 SKU 允许的最大索引。对于 standard3 SKU，该值为“default”或“highDensity”。对于所有其他 SKU，此值必须为“default”。
Identity	有关搜索服务标识的详细信息。 null 值指示搜索服务未分配标识。
IdentityType	The type of identity used for the resource. 类型“SystemAssigned, UserAssigned”包含系统创建的一个标识，以及用户分配的一组标识。类型“None”将从服务中删除所有标识。
IpRule	Azure AI 搜索服务的 IP 限制规则。
NetworkRuleSet	确定如何访问 Azure AI 搜索服务的网络特定规则。
PrivateEndpoint	来自 Microsoft.Network 提供程序的专用终结点资源。
PrivateEndpointConnection	描述与 Azure AI 搜索服务的现有专用终结点连接。
PrivateEndpointConnectionProperties	描述与搜索服务的现有专用终结点连接的属性。
PrivateLinkServiceConnectionProvisioningState	专用链接服务连接的预配状态。有效值为“正在更新”、“删除”、“失败”、“成功”、“不完整”或“已取消”。
PrivateLinkServiceConnectionState	描述与专用终结点的现有 Azure 专用链接服务连接的当前状态。
PrivateLinkServiceConnectionStatus	专用链接服务连接的状态。有效值为 Pending、Approved、Rejected 或 Disconnected。
ProvisioningState	对搜索服务执行的最后一个预配操作的状态。预配是在建立服务容量时发生的中间状态。设置容量后，provisioningState 将更改为“Succeeded”或“Failed”。客户端应用程序可以使用“获取搜索服务”操作来轮询预配状态（建议的轮询间隔为 30 秒到 1 分钟），以查看操作何时完成。如果使用免费服务，此值在调用“创建搜索服务”时倾向于直接返回为“Succeeded”。这是因为免费服务使用已设置的容量。
PublicNetworkAccess	此值可以设置为“已启用”，以避免对现有客户资源和模板进行重大更改。如果设置为“disabled”，则不允许通过公共接口的流量，专用终结点连接将是独占访问方法。
SearchBypass	可以绕过“ipRules”部分中定义的规则的入站流量的可能来源。
SearchDataExfiltrationProtection	显式禁止搜索服务的数据外泄方案列表。目前，唯一支持的值是“全部”，用于禁用所有可能的数据导出方案，并计划将来进行更精细的控制。
SearchEncryptionComplianceStatus	返回与非 CMK 加密对象相关的搜索服务符合性的状态。如果某个服务具有多个未加密的对象，并且已启用强制，则服务将标记为不符合。
SearchEncryptionWithCmk	描述如果搜索服务查找未使用客户管理的密钥加密的对象，则搜索服务应如何强制实施符合性。
SearchSemanticSearch	设置控制语义搜索可用性的选项。此配置仅适用于特定位置的某些 Azure AI 搜索 SKU。
SearchService	介绍 Azure AI 搜索服务及其当前状态。
SearchServiceStatus	搜索服务的状态。可能的值包括：“running”：搜索服务正在运行，未执行任何预配操作。 “provisioning”：正在预配或纵向扩展或缩减搜索服务。 “delete”：正在删除搜索服务。 “已降级”：搜索服务已降级。当基础搜索单元不正常时，可能会发生这种情况。搜索服务最有可能正常运行，但性能可能很慢，某些请求可能会被删除。 “disabled”：已禁用搜索服务。在此状态下，服务将拒绝所有 API 请求。 “error”：搜索服务处于错误状态。 “stopped”：搜索服务位于已禁用的订阅中。如果服务处于降级、禁用或错误状态，则意味着 Azure AI 搜索团队正在积极调查根本问题。根据预配的搜索单位数，这些状态中的专用服务仍可收费。
SharedPrivateLinkResource	介绍由 Azure AI 搜索服务管理的共享专用链接资源。
SharedPrivateLinkResourceProperties	介绍由 Azure AI 搜索服务管理的现有共享专用链接资源的属性。
SharedPrivateLinkResourceProvisioningState	共享专用链接资源的预配状态。有效值为更新、删除、失败、成功或不完整。
SharedPrivateLinkResourceStatus	共享专用链接资源的状态。有效值为 Pending、Approved、Rejected 或 Disconnected。
Sku	定义搜索服务的 SKU，用于确定计费费率和容量限制。
SkuName	搜索服务的 SKU。有效值包括：“free”：共享服务。 “basic”：最多包含 3 个副本的专用服务。 “standard”：最多包含 12 个分区和 12 个副本的专用服务。 “standard2”：类似于标准，但每个搜索单位的容量更多。 “standard3”：最大标准产品/服务最多包含 12 个分区和 12 个副本（如果同时将 hostingMode 属性设置为“highDensity”，则最多具有 3 个具有更多索引的分区）。 “storage_optimized_l1”：支持每个分区 1TB，最多支持 12 个分区。 “storage_optimized_l2”：支持每个分区 2TB，最多支持 12 个分区。
systemData	与创建和上次修改资源相关的元数据。
UpgradeAvailable	指示搜索服务是否有可用的升级。
UserAssignedIdentity	用户分配的标识属性

AadAuthFailureMode

枚举

描述搜索服务的数据平面 API 针对身份验证失败的请求发送的响应。

值	说明
http401WithBearerChallenge	指示失败身份验证的请求应显示 HTTP 状态代码 401（未授权），并提出持有者质询。
http403	指示失败身份验证的请求应显示 HTTP 状态代码 403（禁止）。

ApiKeyOnly

Object

指示只能使用 API 密钥进行身份验证。

CloudError

Object

包含有关 API 错误的信息。

名称	类型	说明
error	CloudErrorBody	描述具有错误代码和消息的特定 API 错误。
message	string	提示出错的错误的简要说明（有关详细信息/调试信息，请参阅“error.message”属性）。

CloudErrorBody

Object

描述具有错误代码和消息的特定 API 错误。

名称	类型	说明
code	string	比 HTTP 状态代码更准确地描述错误条件的错误代码。可用于以编程方式处理特定错误案例。
details	CloudErrorBody[]	包含与此错误相关的嵌套错误。
message	string	详细说明错误并提供调试信息的消息。
target	string	特定错误的目标（例如，错误中属性的名称）。

ComputeType

枚举

配置此属性以支持使用默认计算或 Azure 机密计算的搜索服务。

值	说明
confidential	使用 Azure 机密计算创建服务。
default	使用默认计算创建服务。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

DataPlaneAadOrApiKeyAuthOption

Object

指示 API 密钥或来自 Microsoft Entra ID 租户的访问令牌可用于身份验证。

名称	类型	说明
aadAuthFailureMode	AadAuthFailureMode	描述搜索服务的数据平面 API 针对身份验证失败的请求发送的响应。

DataPlaneAuthOptions

Object

定义搜索服务如何对数据平面请求进行身份验证的选项。如果“disableLocalAuth”设置为 true，则无法设置此项。

名称	类型	说明
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	指示 API 密钥或来自 Microsoft Entra ID 租户的访问令牌可用于身份验证。
apiKeyOnly	ApiKeyOnly	指示只能使用 API 密钥进行身份验证。

EncryptionWithCmk

Object

描述一个策略，该策略确定如何使用客户管理的密钥对搜索服务中的资源进行加密。

名称	类型	说明
encryptionComplianceStatus	SearchEncryptionComplianceStatus	返回与非 CMK 加密对象相关的搜索服务符合性的状态。如果某个服务具有多个未加密的对象，并且已启用强制，则服务将标记为不符合。
enforcement	SearchEncryptionWithCmk	描述如果搜索服务查找未使用客户管理的密钥加密的对象，则搜索服务应如何强制实施符合性。

HostingMode

枚举

仅适用于 standard3 SKU。可以将此属性设置为最多允许 3 个高密度分区，允许最多 1000 个索引，这远远高于任何其他 SKU 允许的最大索引。对于 standard3 SKU，该值为“default”或“highDensity”。对于所有其他 SKU，此值必须为“default”。

值	说明
default	索引数限制取决于 SKU 的默认限制。
highDensity	只有 standard3 SKU 的应用程序，其中搜索服务最多可以有 1000 个索引。

Identity

Object

有关搜索服务标识的详细信息。 null 值指示搜索服务未分配标识。

名称	类型	说明
principalId	string	搜索服务的系统分配标识的主体 ID。
tenantId	string	搜索服务的系统分配标识的租户 ID。
type	IdentityType	The type of identity used for the resource. 类型“SystemAssigned, UserAssigned”包含系统创建的一个标识，以及用户分配的一组标识。类型“None”将从服务中删除所有标识。
userAssignedIdentities	<string, UserAssignedIdentity>	The list of user identities associated with the resource. 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

IdentityType

枚举

The type of identity used for the resource. 类型“SystemAssigned, UserAssigned”包含系统创建的一个标识，以及用户分配的一组标识。类型“None”将从服务中删除所有标识。

值	说明
None	指示需要删除与搜索服务关联的任何标识。
SystemAssigned	指示将启用搜索服务的系统分配标识。
SystemAssigned, UserAssigned	指示将启用搜索服务的系统分配标识以及分配一个或多个用户分配的标识。
UserAssigned	指示将向搜索服务分配一个或多个用户分配的标识。

IpRule

Object

Azure AI 搜索服务的 IP 限制规则。

名称	类型	说明
value	string	与单个 IPv4 地址（例如，123.1.2.3）或 CIDR 格式（例如，允许 123.1.2.3/24）的 IP 范围对应的值。

NetworkRuleSet

Object

确定如何访问 Azure AI 搜索服务的网络特定规则。

名称	类型	说明
bypass	SearchBypass	可以绕过“ipRules”部分中定义的规则的入站流量的可能来源。
ipRules	IpRule[]	定义入站网络（s）的 IP 限制规则列表，允许访问搜索服务终结点。同时，防火墙会阻止所有其他公共 IP 网络。仅当搜索服务的“publicNetworkAccess”为“enabled”时，才应用这些限制规则;否则，即使使用任何公共 IP 规则，也不允许通过公共接口的流量，专用终结点连接将是独占访问方法。

PrivateEndpoint

Object

来自 Microsoft.Network 提供程序的专用终结点资源。

名称	类型	说明
id	string	来自 Microsoft.Network 提供程序的专用终结点资源的资源 ID。

PrivateEndpointConnection

Object

描述与 Azure AI 搜索服务的现有专用终结点连接。

名称	类型	说明
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	PrivateEndpointConnectionProperties	介绍与 Azure AI 搜索服务的现有专用终结点连接的属性。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProperties

Object

描述与搜索服务的现有专用终结点连接的属性。

名称	类型	说明
groupId	string	专用链接服务的 Azure 资源的组 ID。
privateEndpoint	PrivateEndpoint	来自 Microsoft.Network 提供程序的专用终结点资源。
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	描述与专用终结点的现有 Azure 专用链接服务连接的当前状态。
provisioningState	PrivateLinkServiceConnectionProvisioningState	专用链接服务连接的预配状态。有效值为“正在更新”、“删除”、“失败”、“成功”、“不完整”或“已取消”。

PrivateLinkServiceConnectionProvisioningState

枚举

专用链接服务连接的预配状态。有效值为“正在更新”、“删除”、“失败”、“成功”、“不完整”或“已取消”。

值	说明
Canceled	已取消专用链接服务连接资源的预配请求。
Deleting	正在删除专用链接服务连接。
Failed	无法预配或删除专用链接服务连接。
Incomplete	已接受专用链接服务连接资源的预配请求，但尚未开始创建过程。
Succeeded	专用链接服务连接已完成预配，可供审批。
Updating	专用链接服务连接正在与其他资源一起创建，以便其功能完全正常运行。

PrivateLinkServiceConnectionState

Object

描述与专用终结点的现有 Azure 专用链接服务连接的当前状态。

名称	类型	默认值	说明
actionsRequired	string	None	对可能需要执行的任何额外操作的说明。
description	string		专用链接服务连接状态的说明。
status	PrivateLinkServiceConnectionStatus		专用链接服务连接的状态。有效值为 Pending、Approved、Rejected 或 Disconnected。

PrivateLinkServiceConnectionStatus

枚举

专用链接服务连接的状态。有效值为 Pending、Approved、Rejected 或 Disconnected。

值	说明
Approved	专用终结点连接已获批准，可供使用。
Disconnected	专用终结点连接已从服务中删除。
Pending	已创建专用终结点连接，并且正在等待审批。
Rejected	专用终结点连接已被拒绝，不能使用。

ProvisioningState

枚举

对搜索服务执行的最后一个预配操作的状态。预配是在建立服务容量时发生的中间状态。设置容量后，provisioningState 将更改为“Succeeded”或“Failed”。客户端应用程序可以使用“获取搜索服务”操作来轮询预配状态（建议的轮询间隔为 30 秒到 1 分钟），以查看操作何时完成。如果使用免费服务，此值在调用“创建搜索服务”时倾向于直接返回为“Succeeded”。这是因为免费服务使用已设置的容量。

值	说明
failed	上次预配操作失败。
provisioning	正在预配或纵向扩展或缩减搜索服务。
succeeded	上次预配操作已成功完成。

PublicNetworkAccess

枚举

此值可以设置为“已启用”，以避免对现有客户资源和模板进行重大更改。如果设置为“disabled”，则不允许通过公共接口的流量，专用终结点连接将是独占访问方法。

值	说明
disabled	无法从源自公共 Internet 的流量访问搜索服务。仅允许通过批准的专用终结点连接进行访问。
enabled	可从源自公共 Internet 的流量访问搜索服务。

SearchBypass

枚举

可以绕过“ipRules”部分中定义的规则的入站流量的可能来源。

值	说明
AzureServices	指示源自 Azure 受信任服务的请求可以绕过“ipRules”部分中定义的规则。
None	指示没有源可以绕过“ipRules”部分中定义的规则。这是默认值。

SearchDataExfiltrationProtection

枚举

显式禁止搜索服务的数据外泄方案列表。目前，唯一支持的值是“全部”，用于禁用所有可能的数据导出方案，并计划将来进行更精细的控制。

值	说明
BlockAll	指示禁用所有数据外泄方案。

SearchEncryptionComplianceStatus

枚举

返回与非 CMK 加密对象相关的搜索服务符合性的状态。如果某个服务具有多个未加密的对象，并且已启用强制，则服务将标记为不符合。

值	说明
Compliant	指示搜索服务符合要求，要么是因为非 CMK 加密的对象数为零，要么禁用强制。
NonCompliant	指示搜索服务具有多个非 CMK 加密的对象。

SearchEncryptionWithCmk

枚举

描述如果搜索服务查找未使用客户管理的密钥加密的对象，则搜索服务应如何强制实施符合性。

值	说明
Disabled	不会强制实施客户管理的密钥加密。仅使用内置服务托管加密。
Enabled	如果未使用客户管理的密钥加密一个或多个对象，搜索服务将标记为不合规。
Unspecified	未显式指定强制策略，其行为与设置为“Disabled”的行为相同。

SearchSemanticSearch

枚举

设置控制语义搜索可用性的选项。此配置仅适用于特定位置的某些 Azure AI 搜索 SKU。

值	说明
disabled	指示为搜索服务禁用语义重新调用程序。这是默认值。
free	在搜索服务上启用语义重新编制器，并指示它在免费计划的限制内使用。免费计划将限制语义排名请求的数量，并免费提供。这是新预配的搜索服务的默认值。
standard	在搜索服务上启用语义重排器作为可计费功能，吞吐量和语义上重新调用的查询量更高。

SearchService

Object

介绍 Azure AI 搜索服务及其当前状态。

名称	类型	默认值	说明
id	string (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	Identity		The identity of the resource.
___location	string		The geo-___location where the resource lives
name	string		The name of the resource
properties.authOptions	DataPlaneAuthOptions		定义搜索服务的数据平面 API 如何对请求进行身份验证的选项。如果“disableLocalAuth”设置为 true，则无法设置此项。
properties.computeType	ComputeType		配置此属性以支持使用默认计算或 Azure 机密计算的搜索服务。
properties.dataExfiltrationProtections	SearchDataExfiltrationProtection[]		显式禁止搜索服务的数据外泄方案列表。目前，唯一支持的值是“全部”，用于禁用所有可能的数据导出方案，并计划将来进行更精细的控制。
properties.disableLocalAuth	boolean		如果设置为 true，则不允许调用搜索服务以使用 API 密钥进行身份验证。如果定义了“dataPlaneAuthOptions”，则无法将其设置为 true。
properties.eTag	string		一个系统生成的属性，表示服务 etag，可用于在更新期间进行乐观并发控制。
properties.encryptionWithCmk	EncryptionWithCmk		指定有关使用搜索服务中的客户经理密钥加密资源（如索引）的任何策略。
properties.endpoint	string (uri)		Azure AI 搜索服务的终结点。
properties.hostingMode	HostingMode	default	仅适用于 standard3 SKU。可以将此属性设置为最多允许 3 个高密度分区，允许最多 1000 个索引，这远远高于任何其他 SKU 允许的最大索引。对于 standard3 SKU，该值为“default”或“highDensity”。对于所有其他 SKU，此值必须为“default”。
properties.networkRuleSet	NetworkRuleSet		确定如何访问 Azure AI 搜索服务的网络特定规则。
properties.partitionCount	integer (int32) minimum: 1 maximum: 12	1	搜索服务中的分区数;如果指定，则它可以是 1、2、3、4、6 或 12。大于 1 的值仅适用于标准 SKU。对于 hostingMode 设置为“highDensity”的“standard3”服务，允许的值介于 1 到 3 之间。
properties.privateEndpointConnections	PrivateEndpointConnection[]		与 Azure AI 搜索服务的专用终结点连接列表。
properties.provisioningState	ProvisioningState		对搜索服务执行的最后一个预配操作的状态。预配是在建立服务容量时发生的中间状态。设置容量后，provisioningState 将更改为“Succeeded”或“Failed”。客户端应用程序可以使用“获取搜索服务”操作来轮询预配状态（建议的轮询间隔为 30 秒到 1 分钟），以查看操作何时完成。如果使用免费服务，此值在调用“创建搜索服务”时倾向于直接返回为“Succeeded”。这是因为免费服务使用已设置的容量。
properties.publicNetworkAccess	PublicNetworkAccess	enabled	此值可以设置为“已启用”，以避免对现有客户资源和模板进行重大更改。如果设置为“disabled”，则不允许通过公共接口的流量，专用终结点连接将是独占访问方法。
properties.replicaCount	integer (int32) minimum: 1 maximum: 12	1	搜索服务中的副本数。如果指定，它必须是标准 SKU 的 1 到 12（含 1 到 3）之间的值，对于基本 SKU，该值必须介于 1 和 3 之间。
properties.semanticSearch	SearchSemanticSearch		设置控制语义搜索可用性的选项。此配置仅适用于特定位置的某些 Azure AI 搜索 SKU。
properties.serviceUpgradedAt	string (date-time)		上次升级搜索服务的日期和时间。此字段将为 null，直到服务首次升级。
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		由 Azure AI 搜索服务管理的共享专用链接资源列表。
properties.status	SearchServiceStatus		搜索服务的状态。可能的值包括：“running”：搜索服务正在运行，未执行任何预配操作。 “provisioning”：正在预配或纵向扩展或缩减搜索服务。 “delete”：正在删除搜索服务。 “已降级”：搜索服务已降级。当基础搜索单元不正常时，可能会发生这种情况。搜索服务最有可能正常运行，但性能可能很慢，某些请求可能会被删除。 “disabled”：已禁用搜索服务。在此状态下，服务将拒绝所有 API 请求。 “error”：搜索服务处于错误状态。 “stopped”：搜索服务位于已禁用的订阅中。如果服务处于降级、禁用或错误状态，则意味着 Azure AI 搜索团队正在积极调查根本问题。根据预配的搜索单位数，这些状态中的专用服务仍可收费。
properties.statusDetails	string		搜索服务状态的详细信息。
properties.upgradeAvailable	UpgradeAvailable		指示搜索服务是否有可用的升级。
sku	Sku		搜索服务的 SKU，用于确定价格层和容量限制。创建新搜索服务时，此属性是必需的。
systemData	systemData		包含 createdBy 和 modifiedBy 信息的搜索服务的 Azure 资源管理器元数据。
tags	object		资源标记。
type	string		资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

SearchServiceStatus

枚举

搜索服务的状态。可能的值包括：“running”：搜索服务正在运行，未执行任何预配操作。 “provisioning”：正在预配或纵向扩展或缩减搜索服务。 “delete”：正在删除搜索服务。 “已降级”：搜索服务已降级。当基础搜索单元不正常时，可能会发生这种情况。搜索服务最有可能正常运行，但性能可能很慢，某些请求可能会被删除。 “disabled”：已禁用搜索服务。在此状态下，服务将拒绝所有 API 请求。 “error”：搜索服务处于错误状态。 “stopped”：搜索服务位于已禁用的订阅中。如果服务处于降级、禁用或错误状态，则意味着 Azure AI 搜索团队正在积极调查根本问题。根据预配的搜索单位数，这些状态中的专用服务仍可收费。

值	说明
degraded	搜索服务已降级，因为基础搜索单元不正常。
deleting	正在删除搜索服务。
disabled	搜索服务已禁用，所有 API 请求都将被拒绝。
error	搜索服务处于错误状态，指示预配失败或被删除。
provisioning	正在预配或纵向扩展或缩减搜索服务。
running	搜索服务正在运行，并且未执行任何预配操作。
stopped	搜索服务位于禁用的订阅中。

SharedPrivateLinkResource

Object

介绍由 Azure AI 搜索服务管理的共享专用链接资源。

名称	类型	说明
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	SharedPrivateLinkResourceProperties	介绍由 Azure AI 搜索服务管理的共享专用链接资源的属性。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

SharedPrivateLinkResourceProperties

Object

介绍由 Azure AI 搜索服务管理的现有共享专用链接资源的属性。

名称	类型	说明
groupId	string	共享专用链接资源的提供程序中的组 ID。
privateLinkResourceId	string	共享专用链接资源的资源的资源 ID。
provisioningState	SharedPrivateLinkResourceProvisioningState	共享专用链接资源的预配状态。有效值为更新、删除、失败、成功或不完整。
requestMessage	string	请求批准共享专用链接资源的消息。
resourceRegion	string	可选。可用于指定要为其创建共享专用链接的资源的 Azure 资源管理器位置。只有 DNS 配置是区域（例如 Azure Kubernetes 服务）的资源才需要这样做。
status	SharedPrivateLinkResourceStatus	共享专用链接资源的状态。有效值为 Pending、Approved、Rejected 或 Disconnected。

SharedPrivateLinkResourceProvisioningState

枚举

共享专用链接资源的预配状态。有效值为更新、删除、失败、成功或不完整。

值	说明
Deleting	共享专用链接资源正在删除。
Failed	共享专用链接资源预配或删除失败。
Incomplete	已接受共享专用链接资源的预配请求，但尚未开始创建过程。
Succeeded	共享专用链接资源已完成预配，可供审批。
Updating	共享专用链接资源正在与其他资源一起创建，以便其功能完全正常运行。

SharedPrivateLinkResourceStatus

枚举

共享专用链接资源的状态。有效值为 Pending、Approved、Rejected 或 Disconnected。

值	说明
Approved	共享专用链接资源已获批准，可供使用。
Disconnected	共享专用链接资源已从服务中删除。
Pending	已创建共享专用链接资源，并等待审批。
Rejected	共享专用链接资源已被拒绝，不能使用。

Sku

Object

定义搜索服务的 SKU，用于确定计费费率和容量限制。

名称	类型	说明
name	SkuName	搜索服务的 SKU。有效值包括：“free”：共享服务。 “basic”：最多包含 3 个副本的专用服务。 “standard”：最多包含 12 个分区和 12 个副本的专用服务。 “standard2”：类似于标准，但每个搜索单位的容量更多。 “standard3”：最大标准产品/服务最多包含 12 个分区和 12 个副本（如果同时将 hostingMode 属性设置为“highDensity”，则最多具有 3 个具有更多索引的分区）。 “storage_optimized_l1”：支持每个分区 1TB，最多支持 12 个分区。 “storage_optimized_l2”：支持每个分区 2TB，最多支持 12 个分区。

SkuName

枚举

搜索服务的 SKU。有效值包括：“free”：共享服务。 “basic”：最多包含 3 个副本的专用服务。 “standard”：最多包含 12 个分区和 12 个副本的专用服务。 “standard2”：类似于标准，但每个搜索单位的容量更多。 “standard3”：最大标准产品/服务最多包含 12 个分区和 12 个副本（如果同时将 hostingMode 属性设置为“highDensity”，则最多具有 3 个具有更多索引的分区）。 “storage_optimized_l1”：支持每个分区 1TB，最多支持 12 个分区。 “storage_optimized_l2”：支持每个分区 2TB，最多支持 12 个分区。

值	说明
basic	专用服务的计费层最多包含 3 个副本。
free	免费层，没有 SLA 保证，以及可计费层上提供的功能子集。
standard	专用服务的计费层最多包含 12 个分区和 12 个副本。
standard2	类似于“标准”，但每个搜索单位的容量更多。
standard3	最大标准产品/服务最多包含 12 个分区和 12 个副本（如果同时将 hostingMode 属性设置为“highDensity”，则最多包含 3 个具有更多索引的分区）。
storage_optimized_l1	专用服务的计费层支持每个分区 1TB，最多支持 12 个分区。
storage_optimized_l2	专用服务的计费层支持每个分区 2TB，最多支持 12 个分区。

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

UpgradeAvailable

枚举

指示搜索服务是否有可用的升级。

值	说明
available	有一个升级可用于该服务。
notAvailable	升级目前不适用于该服务。

UserAssignedIdentity

Object

用户分配的标识属性

名称	类型	说明
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.