Partager via


SearchService Classe

Décrit un service Recherche cognitive Azure et son état actuel.

Les variables sont uniquement remplies par le serveur et sont ignorées lors de l’envoi d’une demande.

Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.

Héritage
azure.mgmt.search.models._models_py3.TrackedResource
SearchService

Constructeur

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)

Paramètres

tags
dict[str, str]

Balises de ressource.

location
str

Emplacement géographique où réside la ressource. Obligatoire.

sku
Sku

Référence SKU du service de recherche, qui détermine le niveau de prix et les limites de capacité. Cette propriété est requise lors de la création d’un service de recherche.

identity
Identity

Identité de la ressource.

replica_count
int

Nombre de réplicas dans le service de recherche. Si elle est spécifiée, il doit s’agir d’une valeur comprise entre 1 et 12 inclusive pour les références SKU standard ou comprise entre 1 et 3 inclus pour la référence SKU de base.

partition_count
int

Nombre de partitions dans le service de recherche ; s’il est spécifié, il peut s’agir de 1, 2, 3, 4, 6 ou 12. Les valeurs supérieures à 1 sont uniquement valides pour les références SKU standard. Pour les services « standard3 » avec hostingMode défini sur « highDensity », les valeurs autorisées sont comprises entre 1 et 3.

hosting_mode
str ou HostingMode

Applicable uniquement à la référence SKU standard3. Vous pouvez définir cette propriété pour activer jusqu’à 3 partitions à haute densité qui autorisent jusqu’à 1 000 index, ce qui est beaucoup plus élevé que les index maximum autorisés pour toute autre référence SKU. Pour la référence SKU standard3, la valeur est « default » ou « highDensity ». Pour toutes les autres références SKU, cette valeur doit être « default ». Les valeurs connues sont : « default » et « highDensity ».

public_network_access
str ou PublicNetworkAccess

Cette valeur peut être définie sur « enabled » pour éviter les changements cassants sur les modèles et les ressources clients existants. Si la valeur est « désactivée », le trafic sur l’interface publique n’est pas autorisé et les connexions de point de terminaison privé constituent la méthode d’accès exclusif. Les valeurs connues sont « enabled » et « disabled ».

network_rule_set
NetworkRuleSet

Règles spécifiques au réseau qui déterminent la façon dont le service Recherche cognitive Azure peut être atteint.

encryption_with_cmk
EncryptionWithCmk

Spécifie toute stratégie concernant le chiffrement des ressources (comme les index) à l’aide de clés customer manager au sein d’un service de recherche.

disable_local_auth
bool

Lorsque la valeur est true, les appels au service de recherche ne sont pas autorisés à utiliser des clés API pour l’authentification. Cette valeur ne peut pas être définie sur true si « dataPlaneAuthOptions » est défini.

auth_options
DataPlaneAuthOptions

Définit les options pour la façon dont l’API de plan de données d’un service de recherche authentifie les demandes. Cette valeur ne peut pas être définie si « disableLocalAuth » a la valeur true.

Variables

id
str

ID de ressource complet pour la ressource. Ex : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

name
str

Nom de la ressource.

type
str

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts ».

tags
dict[str, str]

Balises de ressource.

location
str

Emplacement géographique où réside la ressource. Obligatoire.

sku
Sku

Référence SKU du service de recherche, qui détermine le niveau de prix et les limites de capacité. Cette propriété est requise lors de la création d’un service de recherche.

identity
Identity

Identité de la ressource.

replica_count
int

Nombre de réplicas dans le service de recherche. Si elle est spécifiée, il doit s’agir d’une valeur comprise entre 1 et 12 inclusive pour les références SKU standard ou comprise entre 1 et 3 inclus pour la référence SKU de base.

partition_count
int

Nombre de partitions dans le service de recherche ; s’il est spécifié, il peut s’agir de 1, 2, 3, 4, 6 ou 12. Les valeurs supérieures à 1 sont uniquement valides pour les références SKU standard. Pour les services « standard3 » avec hostingMode défini sur « highDensity », les valeurs autorisées sont comprises entre 1 et 3.

hosting_mode
str ou HostingMode

Applicable uniquement à la référence SKU standard3. Vous pouvez définir cette propriété pour activer jusqu’à 3 partitions à haute densité qui autorisent jusqu’à 1 000 index, ce qui est beaucoup plus élevé que les index maximum autorisés pour toute autre référence SKU. Pour la référence SKU standard3, la valeur est « default » ou « highDensity ». Pour toutes les autres références SKU, cette valeur doit être « default ». Les valeurs connues sont : « default » et « highDensity ».

public_network_access
str ou PublicNetworkAccess

Cette valeur peut être définie sur « enabled » pour éviter les changements cassants sur les modèles et les ressources clients existants. Si la valeur est « désactivée », le trafic sur l’interface publique n’est pas autorisé et les connexions de point de terminaison privé constituent la méthode d’accès exclusif. Les valeurs connues sont « enabled » et « disabled ».

status
str ou SearchServiceStatus

Status du service de recherche. Les valeurs possibles sont les suivantes : « running » : le service de recherche est en cours d’exécution et aucune opération d’approvisionnement n’est en cours. « provisionnement » : le service de recherche est en cours d’approvisionnement ou de scale-up ou de scale-down. « suppression » : le service de recherche est en cours de suppression. « détérioré » : le service de recherche est détérioré. Cela peut se produire lorsque les unités de recherche sous-jacentes ne sont pas saines. Le service de recherche est probablement opérationnel, mais les performances peuvent être lentes et certaines demandes peuvent être supprimées. « disabled » : le service de recherche est désactivé. Dans cet état, le service rejette toutes les demandes d’API. ' error' : le service de recherche est dans un état d’erreur. Si votre service est dans l’état détérioré, désactivé ou d’erreur, cela signifie que l’équipe Recherche cognitive Azure étudie activement le problème sous-jacent. Les services dédiés indiquant ces états peuvent faire l’objet d’une facturation en fonction du nombre d’unités de recherche déployées. Les valeurs connues sont les suivantes : « running », « provisioning », « deleting », « degrad », « disabled », « error » et « stopped ».

status_details
str

Détails du service de recherche status.

provisioning_state
str ou ProvisioningState

État de la dernière opération d’approvisionnement effectuée sur le service de recherche. Le déploiement désigne un état intermédiaire pendant lequel la capacité de service est établie. Une fois la capacité configurée, provisioningState passe à « succeeded » ou « failed ». Les applications clientes peuvent interroger l’approvisionnement status (l’intervalle d’interrogation recommandé est de 30 secondes à une minute) à l’aide de l’opération Obtenir le service de recherche pour voir quand une opération est terminée. Si vous utilisez le service gratuit, cette valeur a tendance à revenir comme « réussi » directement dans l’appel à Créer un service de recherche. Cela est dû au fait que le service gratuit utilise une capacité déjà configurée. Les valeurs connues sont « succeeded », « provisioning » et « failed ».

network_rule_set
NetworkRuleSet

Règles spécifiques au réseau qui déterminent la façon dont le service Recherche cognitive Azure peut être atteint.

encryption_with_cmk
EncryptionWithCmk

Spécifie toute stratégie concernant le chiffrement des ressources (comme les index) à l’aide de clés customer manager au sein d’un service de recherche.

disable_local_auth
bool

Lorsque la valeur est true, les appels au service de recherche ne sont pas autorisés à utiliser des clés API pour l’authentification. Cette valeur ne peut pas être définie sur true si « dataPlaneAuthOptions » est défini.

auth_options
DataPlaneAuthOptions

Définit les options pour la façon dont l’API de plan de données d’un service de recherche authentifie les demandes. Cette valeur ne peut pas être définie si « disableLocalAuth » a la valeur true.

private_endpoint_connections
list[PrivateEndpointConnection]

Liste des connexions de point de terminaison privé au service Recherche cognitive Azure.

shared_private_link_resources
list[SharedPrivateLinkResource]

Liste des ressources de liaison privée partagées gérées par le service Recherche cognitive Azure.