SearchService Clase
Describe un servicio Azure Cognitive Search y su estado actual.
Las variables solo se rellenan mediante el servidor y se omitirán al enviar una solicitud.
Todos los parámetros necesarios deben rellenarse para enviarlos a Azure.
- Herencia
-
azure.mgmt.search.models._models_py3.TrackedResourceSearchService
Constructor
SearchService(*, location: str, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, identity: _models.Identity | None = None, replica_count: int = 1, partition_count: int = 1, hosting_mode: str | _models.HostingMode = 'default', public_network_access: str | _models.PublicNetworkAccess = 'enabled', network_rule_set: _models.NetworkRuleSet | None = None, encryption_with_cmk: _models.EncryptionWithCmk | None = None, disable_local_auth: bool | None = None, auth_options: _models.DataPlaneAuthOptions | None = None, **kwargs: Any)Parámetros
- location
- str
Ubicación geográfica donde reside el recurso. Necesario.
- sku
- Sku
La SKU del servicio de búsqueda, que determina los límites de nivel de precio y capacidad. Esta propiedad es necesaria al crear un nuevo servicio de búsqueda.
- identity
- Identity
Identidad del recurso.
- replica_count
- int
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.
- partition_count
- int
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.
- hosting_mode
- str o 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 'default'. Los valores conocidos son: "default" y "highDensity".
- public_network_access
- str o 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. Los valores conocidos son: "habilitado" y "deshabilitado".
- network_rule_set
- NetworkRuleSet
Reglas específicas de red que determinan cómo se puede acceder al servicio Azure Cognitive Search.
- encryption_with_cmk
- EncryptionWithCmk
Especifica cualquier directiva relativa al cifrado de recursos (como índices) mediante claves de administrador de clientes dentro de un servicio de búsqueda.
- disable_local_auth
- bool
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".
- auth_options
- DataPlaneAuthOptions
Define las opciones de cómo la API del plano de datos de un servicio de búsqueda autentica las solicitudes. No se puede establecer si "disableLocalAuth" está establecido en true.
Variables
- id
- str
Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
- name
- str
Nombre del recurso.
- type
- str
Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts".
- location
- str
Ubicación geográfica donde reside el recurso. Necesario.
- sku
- Sku
La SKU del servicio de búsqueda, que determina los límites de nivel de precio y capacidad. Esta propiedad es necesaria al crear un nuevo servicio de búsqueda.
- identity
- Identity
Identidad del recurso.
- replica_count
- int
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.
- partition_count
- int
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.
- hosting_mode
- str o 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 'default'. Los valores conocidos son: "default" y "highDensity".
- public_network_access
- str o 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. Los valores conocidos son: "habilitado" y "deshabilitado".
- status
- str o 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 vertical o verticalmente. 'eliminar': se está eliminando el servicio de búsqueda. '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 podrían quitarse. '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 estado de error. Si el servicio está en los estados degradados, deshabilitados o de error, significa que el equipo de Azure Cognitive Search está investigando activamente el problema subyacente. En estos estados, los servicios dedicados son todavía facturables en función del número de unidades de búsqueda aprovisionado. Los valores conocidos son: "running", "provisioning", "deleting", "degraded", "disabled", "error" y "stopped".
- status_details
- str
Detalles del estado del servicio de búsqueda.
- provisioning_state
- str o 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 cuando se está estableciendo la capacidad de 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 ocurre porque el servicio gratuito usa una capacidad que ya está configurada. Los valores conocidos son: "succeeded", "provisioning" y "failed".
- network_rule_set
- NetworkRuleSet
Reglas específicas de red que determinan cómo se puede acceder al servicio Azure Cognitive Search.
- encryption_with_cmk
- EncryptionWithCmk
Especifica cualquier directiva relativa al cifrado de recursos (como índices) mediante claves de administrador de clientes dentro de un servicio de búsqueda.
- disable_local_auth
- bool
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".
- auth_options
- DataPlaneAuthOptions
Define las opciones de cómo la API del plano de datos de un servicio de búsqueda autentica las solicitudes. No se puede establecer si "disableLocalAuth" está establecido en true.
- private_endpoint_connections
- list[PrivateEndpointConnection]
Lista de conexiones de punto de conexión privado al servicio Azure Cognitive Search.
- shared_private_link_resources
- list[SharedPrivateLinkResource]
Lista de recursos de vínculo privado compartido administrados por el servicio Azure Cognitive Search.