Compartir a través de

Services - Create Or Update

  • Referencia
Servicio:
Search Management
Versión de la API:
2024-03-01-preview

Crea o actualiza un servicio de búsqueda en el grupo de recursos determinado. Si el servicio de búsqueda ya existe, todas las propiedades se actualizarán con los valores especificados.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
 path True

string

Nombre del grupo de recursos dentro de la suscripción actual. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
searchServiceName
 path True

string

Nombre del servicio Azure AI Search para crear o actualizar. Los nombres del servicio de búsqueda solo deben contener letras minúsculas, dígitos o guiones, no pueden usar guiones como los dos primeros o últimos caracteres, no pueden contener guiones consecutivos y deben tener entre 2 y 60 caracteres de longitud. Los nombres de servicio de búsqueda deben ser únicos globalmente, ya que forman parte del URI del servicio (https://.search.windows.net). No se puede cambiar el nombre del servicio después de crear el servicio.
subscriptionId
 path True

string

Identificador único de una suscripción de Microsoft Azure. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
api-version
 query True

string

Versión de la API que se va a usar para cada solicitud.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-request-id

string (uuid)

Valor GUID generado por el cliente que identifica esta solicitud. Si se especifica, se incluirá en la información de respuesta como una manera de realizar un seguimiento de la solicitud.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
location True

string

Ubicación geográfica donde reside el recurso
identity

Identity

Identidad del recurso.
properties.authOptions

DataPlaneAuthOptions

Define las opciones de cómo autentica las solicitudes la API del plano de datos de un servicio de búsqueda. No se puede establecer si 'disableLocalAuth' está establecido en true.
properties.disableLocalAuth

boolean

Cuando se establece en true, no se permitirá que las llamadas al servicio de búsqueda usen claves de API para la autenticación. No se puede establecer en true si se definen "dataPlaneAuthOptions".
properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

Lista de escenarios de filtración de datos que no se permiten explícitamente para el servicio de búsqueda. Actualmente, el único valor admitido es "All" para deshabilitar todos los posibles escenarios de exportación de datos con controles más específicos planeados para el futuro.
properties.encryptionWithCmk

EncryptionWithCmk

Especifica cualquier directiva relacionada con el cifrado de recursos (como índices) mediante claves de administrador de clientes dentro de un servicio de búsqueda.
properties.hostingMode

HostingMode

Solo se aplica a la SKU estándar3. Puede establecer esta propiedad para habilitar hasta 3 particiones de alta densidad que permitan hasta 1000 índices, que es mucho mayor que los índices máximos permitidos para cualquier otra SKU. Para la SKU estándar3, el valor es "default" o "highDensity". Para todas las demás SKU, este valor debe ser "predeterminado".
properties.networkRuleSet

NetworkRuleSet

Reglas específicas de red que determinan cómo se puede acceder al servicio Azure AI Search.
properties.partitionCount

integer (int32)

minimum: 1
maximum: 12

Número de particiones en el servicio de búsqueda; si se especifica, puede ser 1, 2, 3, 4, 6 o 12. Los valores mayores que 1 solo son válidos para las SKU estándar. Para los servicios "standard3" con hostingMode establecido en "highDensity", los valores permitidos están comprendidos entre 1 y 3.
properties.publicNetworkAccess

PublicNetworkAccess

Este valor se puede establecer en "habilitado" para evitar cambios importantes en las plantillas y los recursos del cliente existentes. Si se establece en "deshabilitado", no se permite el tráfico a través de la interfaz pública y las conexiones de punto de conexión privado serían el método de acceso exclusivo.
properties.replicaCount

integer (int32)

minimum: 1
maximum: 12

Número de réplicas en el servicio de búsqueda. Si se especifica, debe ser un valor entre 1 y 12 inclusive para las SKU estándar o entre 1 y 3 inclusive para la SKU básica.
properties.semanticSearch

SearchSemanticSearch

Establece opciones que controlan la disponibilidad de la búsqueda semántica. Esta configuración solo es posible para determinadas SKU de Azure AI Search en determinadas ubicaciones.
sku

Sku

SKU del servicio de búsqueda, que determina el nivel de precio y los límites de capacidad. Esta propiedad es necesaria al crear un nuevo servicio de búsqueda.
tags

object

Etiquetas de recursos.

Respuestas

Nombre Tipo Description
200 OK

SearchService

La definición de servicio existente se actualizó correctamente. Si ha cambiado el número de réplicas o particiones, la operación de escalado se realizará de forma asincrónica. Puede comprobar el estado de una operación de escalado a través de la propiedad provisioningState de una solicitud Get Service.
201 Created

SearchService

Si solicitó la creación de un servicio de búsqueda gratuito, el servicio ahora está aprovisionado y listo para su uso, sujeto a un retraso de propagación de DNS. En el caso de otros tipos de SKU, el aprovisionamiento se produce de forma asincrónica. Puede comprobar el estado de una operación de escalado a través de la propiedad provisioningState de una solicitud Get Service.
Other Status Codes

CloudError

HTTP 400 (solicitud incorrecta): el nombre de servicio o la definición de servicio especificados no son válidos. Consulte el código de error y el mensaje en la respuesta para obtener más información. HTTP 404 (no encontrado): no se encontró la suscripción o el grupo de recursos. HTTP 409 (Conflicto): la suscripción especificada está deshabilitada.

Seguridad

azure_auth

Especifica un flujo de concesión implícito, como se admite en la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

SearchCreateOrUpdateService
SearchCreateOrUpdateServiceAuthOptions
SearchCreateOrUpdateServiceDisableLocalAuth
SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints
SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs
SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass
SearchCreateOrUpdateServiceWithCmkEnforcement
SearchCreateOrUpdateServiceWithDataExfiltration
SearchCreateOrUpdateServiceWithIdentity
SearchCreateOrUpdateWithSemanticSearch

SearchCreateOrUpdateService

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
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,
    "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": []
  }
}
status code:
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,
    "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": []
  }
}

SearchCreateOrUpdateServiceAuthOptions

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
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,
    "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": []
  }
}
status code:
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,
    "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": []
  }
}

SearchCreateOrUpdateServiceDisableLocalAuth

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
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,
    "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": []
  }
}
status code:
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,
    "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": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

Solicitud de ejemplo

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

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

Respuesta de muestra

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

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

Solicitud de ejemplo

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

{
  "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"
  }
}

Respuesta de muestra

status code:
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,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "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": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
status code:
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,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "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": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Solicitud de ejemplo

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

{
  "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": "AzurePortal"
    },
    "hostingMode": "default"
  }
}

Respuesta de muestra

status code:
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,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzurePortal"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
status code:
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,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzurePortal"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceWithCmkEnforcement

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
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,
    "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": []
  }
}
status code:
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,
    "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": []
  }
}

SearchCreateOrUpdateServiceWithDataExfiltration

Solicitud de ejemplo

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}

Respuesta de muestra

status code:
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,
    "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"
    ]
  }
}
status code:
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,
    "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"
    ]
  }
}

SearchCreateOrUpdateServiceWithIdentity

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
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,
    "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": []
  },
  "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"
      }
    }
  }
}
status code:
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,
    "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": []
  },
  "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"
      }
    }
  }
}

SearchCreateOrUpdateWithSemanticSearch

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
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,
    "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": "free"
  }
}
status code:
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,
    "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": "free"
  }
}

Definiciones

Nombre Description
AadAuthFailureMode

Describe qué respuesta enviaría la API del plano de datos de un servicio de búsqueda para solicitudes con error de autenticación.
ApiKeyOnly

Indica que solo se puede usar la clave de API para la autenticación.
CloudError

Contiene información sobre un error de API.
CloudErrorBody

Describe un error de API determinado con un código de error y un mensaje.
DataPlaneAadOrApiKeyAuthOption

Indica que se puede usar la clave de API o un token de acceso de un inquilino de Id. de Microsoft Entra para la autenticación.
DataPlaneAuthOptions

Define las opciones de cómo el servicio de búsqueda autentica una solicitud de plano de datos. No se puede establecer si 'disableLocalAuth' está establecido en true.
EncryptionWithCmk

Describe una directiva que determina cómo se cifran los recursos del servicio de búsqueda con claves administradas por el cliente.
HostingMode

Solo se aplica a la SKU estándar3. Puede establecer esta propiedad para habilitar hasta 3 particiones de alta densidad que permitan hasta 1000 índices, que es mucho mayor que los índices máximos permitidos para cualquier otra SKU. Para la SKU estándar3, el valor es "default" o "highDensity". Para todas las demás SKU, este valor debe ser "predeterminado".
Identity

Detalles sobre la identidad del servicio de búsqueda. Un valor NULL indica que el servicio de búsqueda no tiene asignada ninguna identidad.
IdentityType

Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada por el sistema y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará todas las identidades del servicio.
IpRule

Regla de restricción de IP del servicio Azure AI Search.
NetworkRuleSet

Reglas específicas de red que determinan cómo se puede acceder al servicio Azure AI Search.
PrivateEndpoint

Recurso de punto de conexión privado del proveedor Microsoft.Network.
PrivateEndpointConnection

Describe una conexión de punto de conexión privado existente al servicio Azure AI Search.
PrivateEndpointConnectionProperties

Describe las propiedades de una conexión de punto de conexión privado existente al servicio de búsqueda.
PrivateLinkServiceConnectionProvisioningState

Estado de aprovisionamiento de la conexión del servicio private link. Los valores válidos son Actualización, Eliminación, Error, Correcto, Incompleto o Cancelado.
PrivateLinkServiceConnectionState

Describe el estado actual de una conexión de servicio de Azure Private Link existente al punto de conexión privado.
PrivateLinkServiceConnectionStatus

Estado de la conexión del servicio private link. Los valores válidos son Pendiente, Aprobado, Rechazado o Desconectado.
ProvisioningState

Estado de la última operación de aprovisionamiento realizada en el servicio de búsqueda. El aprovisionamiento es un estado intermedio que se produce mientras se establece la capacidad del servicio. Una vez configurada la capacidad, provisioningState cambia a "succeeded" o "failed". Las aplicaciones cliente pueden sondear el estado de aprovisionamiento (el intervalo de sondeo recomendado es de 30 segundos a un minuto) mediante la operación Obtener servicio de búsqueda para ver cuándo se completa una operación. Si usa el servicio gratuito, este valor tiende a volver como "correcto" directamente en la llamada a Crear servicio de búsqueda. Esto se debe a que el servicio gratuito usa capacidad que ya está configurada.
PublicNetworkAccess

Este valor se puede establecer en "habilitado" para evitar cambios importantes en las plantillas y los recursos del cliente existentes. Si se establece en "deshabilitado", no se permite el tráfico a través de la interfaz pública y las conexiones de punto de conexión privado serían el método de acceso exclusivo.
SearchBypass

Posibles orígenes del tráfico entrante que pueden omitir las reglas definidas en la sección "ipRules".
SearchDisabledDataExfiltrationOption

Lista de escenarios de filtración de datos que no se permiten explícitamente para el servicio de búsqueda. Actualmente, el único valor admitido es "All" para deshabilitar todos los posibles escenarios de exportación de datos con controles más específicos planeados para el futuro.
SearchEncryptionComplianceStatus

Devuelve el estado del cumplimiento del servicio de búsqueda con respecto a objetos no cifrados por CMK. Si un servicio tiene más de un objeto sin cifrar y el cumplimiento está habilitado, el servicio se marca como no conforme.
SearchEncryptionWithCmk

Describe cómo un servicio de búsqueda debe aplicar el cumplimiento si encuentra objetos que no están cifrados con la clave administrada por el cliente.
SearchSemanticSearch

Establece opciones que controlan la disponibilidad de la búsqueda semántica. Esta configuración solo es posible para determinadas SKU de Azure AI Search en determinadas ubicaciones.
SearchService

Describe un servicio azure AI Search y su estado actual.
SearchServiceStatus

Estado del servicio de búsqueda. Entre los valores posibles se incluyen: "en ejecución": el servicio de búsqueda se está ejecutando y no hay ninguna operación de aprovisionamiento en curso. "aprovisionamiento": el servicio de búsqueda se está aprovisionando o escalando verticalmente o verticalmente. 'eliminar': el servicio de búsqueda se está eliminando. 'degradado': el servicio de búsqueda está degradado. Esto puede ocurrir cuando las unidades de búsqueda subyacentes no están en buen estado. Es más probable que el servicio de búsqueda esté operativo, pero el rendimiento podría ser lento y algunas solicitudes se podrían quitar. 'disabled': el servicio de búsqueda está deshabilitado. En este estado, el servicio rechazará todas las solicitudes de API. 'error': el servicio de búsqueda está en un estado de error. 'detenido': el servicio de búsqueda está en una suscripción que está deshabilitada. Si el servicio está en los estados degradados, deshabilitados o de error, significa que el equipo de Azure AI Search está investigando activamente el problema subyacente. Los servicios dedicados de estos estados siguen siendo cobrables en función del número de unidades de búsqueda aprovisionadas.
SharedPrivateLinkResource

Describe un recurso de vínculo privado compartido administrado por el servicio Azure AI Search.
SharedPrivateLinkResourceProperties

Describe las propiedades de un recurso de vínculo privado compartido existente administrado por el servicio Azure AI Search.
SharedPrivateLinkResourceProvisioningState

Estado de aprovisionamiento del recurso de vínculo privado compartido. Los valores válidos son Actualización, Eliminación, Error, Correcto o Incompleto.
SharedPrivateLinkResourceStatus

Estado del recurso de vínculo privado compartido. Los valores válidos son Pendiente, Aprobado, Rechazado o Desconectado.
Sku

Define la SKU de un servicio de búsqueda, que determina la tasa de facturación y los límites de capacidad.
SkuName

SKU del servicio de búsqueda. Entre los valores válidos se incluyen: "gratis": servicio compartido. 'basic': servicio dedicado con hasta 3 réplicas. 'estándar': servicio dedicado con hasta 12 particiones y 12 réplicas. 'standard2': similar al estándar, pero con más capacidad por unidad de búsqueda. 'standard3': la oferta estándar más grande con hasta 12 particiones y 12 réplicas (o hasta 3 particiones con más índices si también establece la propiedad hostingMode en 'highDensity'). 'storage_optimized_l1': admite 1 TB por partición, hasta 12 particiones. "storage_optimized_l2": admite 2 TB por partición, hasta 12 particiones".
UserAssignedManagedIdentity

Detalles de la identidad administrada asignada por el usuario asignada al servicio de búsqueda.

AadAuthFailureMode

Enumeración

Describe qué respuesta enviaría la API del plano de datos de un servicio de búsqueda para solicitudes con error de autenticación.

Valor Description
http401WithBearerChallenge

Indica que las solicitudes de autenticación con error deben presentarse con un código de estado HTTP de 401 (no autorizado) y presentar un desafío de portador.
http403

Indica que las solicitudes de autenticación con error deben presentarse con un código de estado HTTP de 403 (Prohibido).

ApiKeyOnly

Object

Indica que solo se puede usar la clave de API para la autenticación.

CloudError

Object

Contiene información sobre un error de API.

Nombre Tipo Description
error

CloudErrorBody

Describe un error de API determinado con un código de error y un mensaje.
message

string

Una breve descripción del error que indica lo que salió mal (para obtener detalles o información de depuración, consulte la propiedad "error.message").

CloudErrorBody

Object

Describe un error de API determinado con un código de error y un mensaje.

Nombre Tipo Description
code

string

Código de error que describe la condición de error más precisamente que un código de estado HTTP. Se puede usar para controlar mediante programación casos de error específicos.
details

CloudErrorBody[]

Contiene errores anidados relacionados con este error.
message

string

Mensaje que describe el error con detalle y proporciona información de depuración.
target

string

Destino del error concreto (por ejemplo, el nombre de la propiedad en error).

DataPlaneAadOrApiKeyAuthOption

Object

Indica que se puede usar la clave de API o un token de acceso de un inquilino de Id. de Microsoft Entra para la autenticación.

Nombre Tipo Description
aadAuthFailureMode

AadAuthFailureMode

Describe qué respuesta enviaría la API del plano de datos de un servicio de búsqueda para solicitudes con error de autenticación.

DataPlaneAuthOptions

Object

Define las opciones de cómo el servicio de búsqueda autentica una solicitud de plano de datos. No se puede establecer si 'disableLocalAuth' está establecido en true.

Nombre Tipo Description
aadOrApiKey

DataPlaneAadOrApiKeyAuthOption

Indica que se puede usar la clave de API o un token de acceso de un inquilino de Id. de Microsoft Entra para la autenticación.
apiKeyOnly

ApiKeyOnly

Indica que solo se puede usar la clave de API para la autenticación.

EncryptionWithCmk

Object

Describe una directiva que determina cómo se cifran los recursos del servicio de búsqueda con claves administradas por el cliente.

Nombre Tipo Description
encryptionComplianceStatus

SearchEncryptionComplianceStatus

Devuelve el estado del cumplimiento del servicio de búsqueda con respecto a objetos no cifrados por CMK. Si un servicio tiene más de un objeto sin cifrar y el cumplimiento está habilitado, el servicio se marca como no conforme.
enforcement

SearchEncryptionWithCmk

Describe cómo un servicio de búsqueda debe aplicar el cumplimiento si encuentra objetos que no están cifrados con la clave administrada por el cliente.

HostingMode

Enumeración

Solo se aplica a la SKU estándar3. Puede establecer esta propiedad para habilitar hasta 3 particiones de alta densidad que permitan hasta 1000 índices, que es mucho mayor que los índices máximos permitidos para cualquier otra SKU. Para la SKU estándar3, el valor es "default" o "highDensity". Para todas las demás SKU, este valor debe ser "predeterminado".

Valor Description
default

El límite del número de índices viene determinado por los límites predeterminados de la SKU.
highDensity

Solo la aplicación para la SKU estándar3, donde el servicio de búsqueda puede tener hasta 1000 índices.

Identity

Object

Detalles sobre la identidad del servicio de búsqueda. Un valor NULL indica que el servicio de búsqueda no tiene asignada ninguna identidad.

Nombre Tipo Description
principalId

string

Identificador de entidad de seguridad de la identidad asignada por el sistema del servicio de búsqueda.
tenantId

string

Identificador de inquilino de la identidad asignada por el sistema del servicio de búsqueda.
type

IdentityType

Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada por el sistema y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará todas las identidades del servicio.
userAssignedIdentities

<string,  UserAssignedManagedIdentity>

Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos arm con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IdentityType

Enumeración

Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada por el sistema y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará todas las identidades del servicio.

Valor Description
None

Indica que se debe quitar cualquier identidad asociada al servicio de búsqueda.
SystemAssigned

Indica que se habilitará la identidad asignada por el sistema para el servicio de búsqueda.
SystemAssigned, UserAssigned

Indica que la identidad asignada por el sistema para el servicio de búsqueda se habilitará junto con la asignación de una o varias identidades asignadas por el usuario.
UserAssigned

Indica que se asignarán una o varias identidades asignadas por el usuario al servicio de búsqueda.

IpRule

Object

Regla de restricción de IP del servicio Azure AI Search.

Nombre Tipo Description
value

string

Valor correspondiente a una sola dirección IPv4 (por ejemplo, 123.1.2.3) o a un intervalo IP en formato CIDR (por ejemplo, 123.1.2.3/24) que se permitirá.

NetworkRuleSet

Object

Reglas específicas de red que determinan cómo se puede acceder al servicio Azure AI Search.

Nombre Tipo Description
bypass

SearchBypass

Posibles orígenes del tráfico entrante que pueden omitir las reglas definidas en la sección "ipRules".
ipRules

IpRule[]

Lista de reglas de restricción de IP que definen las redes entrantes con la posibilidad de acceder al punto de conexión de servicio de búsqueda. Mientras tanto, el firewall bloquea todas las demás redes IP públicas. Estas reglas de restricción solo se aplican cuando "publicNetworkAccess" del servicio de búsqueda está "habilitado"; De lo contrario, el tráfico a través de la interfaz pública no se permite incluso con ninguna regla de IP pública y las conexiones de punto de conexión privado serían el método de acceso exclusivo.

PrivateEndpoint

Object

Recurso de punto de conexión privado del proveedor Microsoft.Network.

Nombre Tipo Description
id

string

Identificador de recurso del recurso de punto de conexión privado del proveedor Microsoft.Network.

PrivateEndpointConnection

Object

Describe una conexión de punto de conexión privado existente al servicio Azure AI Search.

Nombre Tipo Description
id

string

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nombre del recurso
properties

PrivateEndpointConnectionProperties

Describe las propiedades de una conexión de punto de conexión privado existente al servicio Azure AI Search.
type

string

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Object

Describe las propiedades de una conexión de punto de conexión privado existente al servicio de búsqueda.

Nombre Tipo Description
groupId

string

Identificador de grupo del recurso de Azure para el que está el servicio private link.
privateEndpoint

PrivateEndpoint

Recurso de punto de conexión privado del proveedor Microsoft.Network.
privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Describe el estado actual de una conexión de servicio de Azure Private Link existente al punto de conexión privado.
provisioningState

PrivateLinkServiceConnectionProvisioningState

Estado de aprovisionamiento de la conexión del servicio private link. Los valores válidos son Actualización, Eliminación, Error, Correcto, Incompleto o Cancelado.

PrivateLinkServiceConnectionProvisioningState

Enumeración

Estado de aprovisionamiento de la conexión del servicio private link. Los valores válidos son Actualización, Eliminación, Error, Correcto, Incompleto o Cancelado.

Valor Description
Canceled

Se ha cancelado la solicitud de aprovisionamiento para el recurso de conexión del servicio private link.
Deleting

La conexión del servicio private link está en proceso de eliminación.
Failed

No se pudo aprovisionar o eliminar la conexión del servicio private link.
Incomplete

Se ha aceptado la solicitud de aprovisionamiento para el recurso de conexión del servicio private link, pero aún no se ha iniciado el proceso de creación.
Succeeded

La conexión del servicio private link ha finalizado el aprovisionamiento y está lista para su aprobación.
Updating

La conexión del servicio private link está en proceso de crearse junto con otros recursos para que sea totalmente funcional.

PrivateLinkServiceConnectionState

Object

Describe el estado actual de una conexión de servicio de Azure Private Link existente al punto de conexión privado.

Nombre Tipo Valor predeterminado Description
actionsRequired

string

None

Descripción de cualquier acción adicional que pueda ser necesaria.
description

string

Descripción del estado de conexión del servicio private link.
status

PrivateLinkServiceConnectionStatus

Estado de la conexión del servicio private link. Los valores válidos son Pendiente, Aprobado, Rechazado o Desconectado.

PrivateLinkServiceConnectionStatus

Enumeración

Estado de la conexión del servicio private link. Los valores válidos son Pendiente, Aprobado, Rechazado o Desconectado.

Valor Description
Approved

La conexión de punto de conexión privado está aprobada y está lista para su uso.
Disconnected

La conexión del punto de conexión privado se ha quitado del servicio.
Pending

Se ha creado la conexión del punto de conexión privado y está pendiente de aprobación.
Rejected

Se ha rechazado la conexión del punto de conexión privado y no se puede usar.

ProvisioningState

Enumeración

Estado de la última operación de aprovisionamiento realizada en el servicio de búsqueda. El aprovisionamiento es un estado intermedio que se produce mientras se establece la capacidad del servicio. Una vez configurada la capacidad, provisioningState cambia a "succeeded" o "failed". Las aplicaciones cliente pueden sondear el estado de aprovisionamiento (el intervalo de sondeo recomendado es de 30 segundos a un minuto) mediante la operación Obtener servicio de búsqueda para ver cuándo se completa una operación. Si usa el servicio gratuito, este valor tiende a volver como "correcto" directamente en la llamada a Crear servicio de búsqueda. Esto se debe a que el servicio gratuito usa capacidad que ya está configurada.

Valor Description
failed

Error en la última operación de aprovisionamiento.
provisioning

El servicio de búsqueda se está aprovisionando o escalando verticalmente o verticalmente.
succeeded

La última operación de aprovisionamiento se ha completado correctamente.

PublicNetworkAccess

Enumeración

Este valor se puede establecer en "habilitado" para evitar cambios importantes en las plantillas y los recursos del cliente existentes. Si se establece en "deshabilitado", no se permite el tráfico a través de la interfaz pública y las conexiones de punto de conexión privado serían el método de acceso exclusivo.

Valor Description
disabled

El servicio de búsqueda no es accesible desde el tráfico procedente de la red pública de Internet. El acceso solo se permite a través de conexiones de punto de conexión privado aprobadas.
enabled

El servicio de búsqueda es accesible desde el tráfico procedente de la red pública de Internet.

SearchBypass

Enumeración

Posibles orígenes del tráfico entrante que pueden omitir las reglas definidas en la sección "ipRules".

Valor Description
AzurePortal

Indica que las solicitudes que se originan en Azure Portal pueden omitir las reglas definidas en la sección "ipRules".
None

Indica que ningún origen puede omitir las reglas definidas en la sección "ipRules". Este es el valor predeterminado.

SearchDisabledDataExfiltrationOption

Enumeración

Lista de escenarios de filtración de datos que no se permiten explícitamente para el servicio de búsqueda. Actualmente, el único valor admitido es "All" para deshabilitar todos los posibles escenarios de exportación de datos con controles más específicos planeados para el futuro.

Valor Description
All

Indica que todos los escenarios de filtración de datos están deshabilitados.

SearchEncryptionComplianceStatus

Enumeración

Devuelve el estado del cumplimiento del servicio de búsqueda con respecto a objetos no cifrados por CMK. Si un servicio tiene más de un objeto sin cifrar y el cumplimiento está habilitado, el servicio se marca como no conforme.

Valor Description
Compliant

Indica que el servicio de búsqueda es compatible, ya sea porque el número de objetos no cifrados con CMK es cero o el cumplimiento está deshabilitado.
NonCompliant

Indica que el servicio de búsqueda tiene más de un objeto no cifrado de CMK.

SearchEncryptionWithCmk

Enumeración

Describe cómo un servicio de búsqueda debe aplicar el cumplimiento si encuentra objetos que no están cifrados con la clave administrada por el cliente.

Valor Description
Disabled

No se realizará ninguna aplicación del cifrado de claves administradas por el cliente. Solo se usa el cifrado administrado por el servicio integrado.
Enabled

El servicio de búsqueda se marcará como no compatible si uno o varios objetos no están cifrados con una clave administrada por el cliente.
Unspecified

La directiva de cumplimiento no se especifica explícitamente, con el comportamiento que es el mismo que si se hubiera establecido en "Deshabilitado".

SearchSemanticSearch

Enumeración

Establece opciones que controlan la disponibilidad de la búsqueda semántica. Esta configuración solo es posible para determinadas SKU de Azure AI Search en determinadas ubicaciones.

Valor Description
disabled

Indica que el reranker semántico está deshabilitado para el servicio de búsqueda. Este es el valor predeterminado.
free

Habilita el reranker semántico en un servicio de búsqueda e indica que se va a usar dentro de los límites del plan gratuito. El plan gratuito limitaría el volumen de solicitudes de clasificación semántica y se ofrece sin cargo adicional. Este es el valor predeterminado para los servicios de búsqueda recién aprovisionados.
standard

Habilita el reranker semántico en un servicio de búsqueda como una característica facturable, con un mayor rendimiento y volumen de consultas semánticamente reranked.

SearchService

Object

Describe un servicio azure AI Search y su estado actual.

Nombre Tipo Valor predeterminado Description
id

string

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

Identity

Identidad del recurso.
location

string

Ubicación geográfica donde reside el recurso
name

string

Nombre del recurso
properties.authOptions

DataPlaneAuthOptions

Define las opciones de cómo autentica las solicitudes la API del plano de datos de un servicio de búsqueda. No se puede establecer si 'disableLocalAuth' está establecido en true.
properties.disableLocalAuth

boolean

Cuando se establece en true, no se permitirá que las llamadas al servicio de búsqueda usen claves de API para la autenticación. No se puede establecer en true si se definen "dataPlaneAuthOptions".
properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

Lista de escenarios de filtración de datos que no se permiten explícitamente para el servicio de búsqueda. Actualmente, el único valor admitido es "All" para deshabilitar todos los posibles escenarios de exportación de datos con controles más específicos planeados para el futuro.
properties.eTag

string

Propiedad generada por el sistema que representa la etiqueta electrónica del servicio que puede ser para el control de simultaneidad optimista durante las actualizaciones.
properties.encryptionWithCmk

EncryptionWithCmk

Especifica cualquier directiva relacionada con el cifrado de recursos (como índices) mediante claves de administrador de clientes dentro de un servicio de búsqueda.
properties.hostingMode

HostingMode

default

Solo se aplica a la SKU estándar3. Puede establecer esta propiedad para habilitar hasta 3 particiones de alta densidad que permitan hasta 1000 índices, que es mucho mayor que los índices máximos permitidos para cualquier otra SKU. Para la SKU estándar3, el valor es "default" o "highDensity". Para todas las demás SKU, este valor debe ser "predeterminado".
properties.networkRuleSet

NetworkRuleSet

Reglas específicas de red que determinan cómo se puede acceder al servicio Azure AI Search.
properties.partitionCount

integer (int32)

minimum: 1
maximum: 12 		1

Número de particiones en el servicio de búsqueda; si se especifica, puede ser 1, 2, 3, 4, 6 o 12. Los valores mayores que 1 solo son válidos para las SKU estándar. Para los servicios "standard3" con hostingMode establecido en "highDensity", los valores permitidos están comprendidos entre 1 y 3.
properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista de conexiones de punto de conexión privado al servicio Azure AI Search.
properties.provisioningState

ProvisioningState

Estado de la última operación de aprovisionamiento realizada en el servicio de búsqueda. El aprovisionamiento es un estado intermedio que se produce mientras se establece la capacidad del servicio. Una vez configurada la capacidad, provisioningState cambia a "succeeded" o "failed". Las aplicaciones cliente pueden sondear el estado de aprovisionamiento (el intervalo de sondeo recomendado es de 30 segundos a un minuto) mediante la operación Obtener servicio de búsqueda para ver cuándo se completa una operación. Si usa el servicio gratuito, este valor tiende a volver como "correcto" directamente en la llamada a Crear servicio de búsqueda. Esto se debe a que el servicio gratuito usa capacidad que ya está configurada.
properties.publicNetworkAccess

PublicNetworkAccess

enabled

Este valor se puede establecer en "habilitado" para evitar cambios importantes en las plantillas y los recursos del cliente existentes. Si se establece en "deshabilitado", no se permite el tráfico a través de la interfaz pública y las conexiones de punto de conexión privado serían el método de acceso exclusivo.
properties.replicaCount

integer (int32)

minimum: 1
maximum: 12 		1

Número de réplicas en el servicio de búsqueda. Si se especifica, debe ser un valor entre 1 y 12 inclusive para las SKU estándar o entre 1 y 3 inclusive para la SKU básica.
properties.semanticSearch

SearchSemanticSearch

Establece opciones que controlan la disponibilidad de la búsqueda semántica. Esta configuración solo es posible para determinadas SKU de Azure AI Search en determinadas ubicaciones.
properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

La lista de recursos de vínculo privado compartido administrados por el servicio Azure AI Search.
properties.status

SearchServiceStatus

Estado del servicio de búsqueda. Entre los valores posibles se incluyen: "en ejecución": el servicio de búsqueda se está ejecutando y no hay ninguna operación de aprovisionamiento en curso. "aprovisionamiento": el servicio de búsqueda se está aprovisionando o escalando verticalmente o verticalmente. 'eliminar': el servicio de búsqueda se está eliminando. 'degradado': el servicio de búsqueda está degradado. Esto puede ocurrir cuando las unidades de búsqueda subyacentes no están en buen estado. Es más probable que el servicio de búsqueda esté operativo, pero el rendimiento podría ser lento y algunas solicitudes se podrían quitar. 'disabled': el servicio de búsqueda está deshabilitado. En este estado, el servicio rechazará todas las solicitudes de API. 'error': el servicio de búsqueda está en un estado de error. 'detenido': el servicio de búsqueda está en una suscripción que está deshabilitada. Si el servicio está en los estados degradados, deshabilitados o de error, significa que el equipo de Azure AI Search está investigando activamente el problema subyacente. Los servicios dedicados de estos estados siguen siendo cobrables en función del número de unidades de búsqueda aprovisionadas.
properties.statusDetails

string

Detalles del estado del servicio de búsqueda.
sku

Sku

SKU del servicio de búsqueda, que determina el nivel de precio y los límites de capacidad. Esta propiedad es necesaria al crear un nuevo servicio de búsqueda.
tags

object

Etiquetas de recursos.
type

string

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SearchServiceStatus

Enumeración

Estado del servicio de búsqueda. Entre los valores posibles se incluyen: "en ejecución": el servicio de búsqueda se está ejecutando y no hay ninguna operación de aprovisionamiento en curso. "aprovisionamiento": el servicio de búsqueda se está aprovisionando o escalando verticalmente o verticalmente. 'eliminar': el servicio de búsqueda se está eliminando. 'degradado': el servicio de búsqueda está degradado. Esto puede ocurrir cuando las unidades de búsqueda subyacentes no están en buen estado. Es más probable que el servicio de búsqueda esté operativo, pero el rendimiento podría ser lento y algunas solicitudes se podrían quitar. 'disabled': el servicio de búsqueda está deshabilitado. En este estado, el servicio rechazará todas las solicitudes de API. 'error': el servicio de búsqueda está en un estado de error. 'detenido': el servicio de búsqueda está en una suscripción que está deshabilitada. Si el servicio está en los estados degradados, deshabilitados o de error, significa que el equipo de Azure AI Search está investigando activamente el problema subyacente. Los servicios dedicados de estos estados siguen siendo cobrables en función del número de unidades de búsqueda aprovisionadas.

Valor Description
degraded

El servicio de búsqueda se degrada porque las unidades de búsqueda subyacentes no están en buen estado.
deleting

El servicio de búsqueda se está eliminando.
disabled

El servicio de búsqueda está deshabilitado y se rechazarán todas las solicitudes de API.
error

El servicio de búsqueda está en estado de error, lo que indica un error al aprovisionar o eliminarse.
provisioning

El servicio de búsqueda se está aprovisionando o escalando verticalmente o verticalmente.
running

El servicio de búsqueda se está ejecutando y no hay ninguna operación de aprovisionamiento en curso.
stopped

El servicio de búsqueda está en una suscripción deshabilitada.

SharedPrivateLinkResource

Object

Describe un recurso de vínculo privado compartido administrado por el servicio Azure AI Search.

Nombre Tipo Description
id

string

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nombre del recurso
properties

SharedPrivateLinkResourceProperties

Describe las propiedades de un recurso de vínculo privado compartido administrado por el servicio Azure AI Search.
type

string

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Object

Describe las propiedades de un recurso de vínculo privado compartido existente administrado por el servicio Azure AI Search.

Nombre Tipo Description
groupId

string

Identificador de grupo del proveedor del recurso para el que está el recurso de vínculo privado compartido.
privateLinkResourceId

string

El identificador de recurso del recurso para el que está el recurso de vínculo privado compartido.
provisioningState

SharedPrivateLinkResourceProvisioningState

Estado de aprovisionamiento del recurso de vínculo privado compartido. Los valores válidos son Actualización, Eliminación, Error, Correcto o Incompleto.
requestMessage

string

Mensaje para solicitar la aprobación del recurso de vínculo privado compartido.
resourceRegion

string

Opcional. Se puede usar para especificar la ubicación de Azure Resource Manager del recurso para el que se crea un vínculo privado compartido. Esto solo es necesario para aquellos recursos cuya configuración dns sea regional (como Azure Kubernetes Service).
status

SharedPrivateLinkResourceStatus

Estado del recurso de vínculo privado compartido. Los valores válidos son Pendiente, Aprobado, Rechazado o Desconectado.

SharedPrivateLinkResourceProvisioningState

Enumeración

Estado de aprovisionamiento del recurso de vínculo privado compartido. Los valores válidos son Actualización, Eliminación, Error, Correcto o Incompleto.

Valor Description
Deleting

El recurso de vínculo privado compartido está en proceso de eliminación.
Failed

No se pudo aprovisionar o eliminar el recurso de vínculo privado compartido.
Incomplete

Se ha aceptado la solicitud de aprovisionamiento para el recurso de vínculo privado compartido, pero aún no se ha iniciado el proceso de creación.
Succeeded

El recurso de vínculo privado compartido ha terminado de aprovisionar y está listo para su aprobación.
Updating

El recurso de vínculo privado compartido está en proceso de creación junto con otros recursos para que sea totalmente funcional.

SharedPrivateLinkResourceStatus

Enumeración

Estado del recurso de vínculo privado compartido. Los valores válidos son Pendiente, Aprobado, Rechazado o Desconectado.

Valor Description
Approved

El recurso de vínculo privado compartido está aprobado y está listo para su uso.
Disconnected

El recurso de vínculo privado compartido se ha quitado del servicio.
Pending

Se ha creado el recurso de vínculo privado compartido y está pendiente de aprobación.
Rejected

El recurso de vínculo privado compartido se ha rechazado y no se puede usar.

Sku

Object

Define la SKU de un servicio de búsqueda, que determina la tasa de facturación y los límites de capacidad.

Nombre Tipo Description
name

SkuName

SKU del servicio de búsqueda. Entre los valores válidos se incluyen: "gratis": servicio compartido. 'basic': servicio dedicado con hasta 3 réplicas. 'estándar': servicio dedicado con hasta 12 particiones y 12 réplicas. 'standard2': similar al estándar, pero con más capacidad por unidad de búsqueda. 'standard3': la oferta estándar más grande con hasta 12 particiones y 12 réplicas (o hasta 3 particiones con más índices si también establece la propiedad hostingMode en 'highDensity'). 'storage_optimized_l1': admite 1 TB por partición, hasta 12 particiones. "storage_optimized_l2": admite 2 TB por partición, hasta 12 particiones".

SkuName

Enumeración

SKU del servicio de búsqueda. Entre los valores válidos se incluyen: "gratis": servicio compartido. 'basic': servicio dedicado con hasta 3 réplicas. 'estándar': servicio dedicado con hasta 12 particiones y 12 réplicas. 'standard2': similar al estándar, pero con más capacidad por unidad de búsqueda. 'standard3': la oferta estándar más grande con hasta 12 particiones y 12 réplicas (o hasta 3 particiones con más índices si también establece la propiedad hostingMode en 'highDensity'). 'storage_optimized_l1': admite 1 TB por partición, hasta 12 particiones. "storage_optimized_l2": admite 2 TB por partición, hasta 12 particiones".

Valor Description
basic

Nivel facturable para un servicio dedicado que tiene hasta 3 réplicas.
free

Nivel gratis, sin garantías de Acuerdo de Nivel de Servicio y un subconjunto de las características que se ofrecen en los niveles facturables.
standard

Nivel facturable para un servicio dedicado que tiene hasta 12 particiones y 12 réplicas.
standard2

Similar a "estándar", pero con más capacidad por unidad de búsqueda.
standard3

La oferta estándar más grande con hasta 12 particiones y 12 réplicas (o hasta 3 particiones con más índices si también establece la propiedad hostingMode en "highDensity").
storage_optimized_l1

Nivel facturable para un servicio dedicado que admite 1 TB por partición, hasta 12 particiones.
storage_optimized_l2

Nivel facturable para un servicio dedicado que admite 2 TB por partición, hasta 12 particiones.

UserAssignedManagedIdentity

Object

Detalles de la identidad administrada asignada por el usuario asignada al servicio de búsqueda.

Nombre Tipo Description
clientId

string

Identificador de cliente de la identidad asignada por el usuario.
principalId

string

Identificador principal de la identidad asignada por el usuario.