Partager via


models Paquet

Classes

AdminKeyResult

Réponse contenant les clés API d’administration primaire et secondaire pour un service Recherche cognitive Azure donné.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

AsyncOperationResult

Détails d’une opération de ressource de liaison privée partagée asynchrone de longue durée.

CheckNameAvailabilityInput

Entrée de l’API de disponibilité du nom de vérification.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

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

CheckNameAvailabilityOutput

Sortie de l’API de disponibilité de nom de vérification.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

CloudErrorBody

Décrit une erreur d’API particulière avec un code d’erreur et un message.

DataPlaneAadOrApiKeyAuthOption

Indique que la clé API ou un jeton d’accès d’Azure Active Directory peuvent être utilisés pour l’authentification.

DataPlaneAuthOptions

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

EncryptionWithCmk

Décrit une stratégie qui détermine comment les ressources du service de recherche doivent être chiffrées avec des clés gérées par le client.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

Identity

Identité de la ressource.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

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

IpRule

Règle de restriction IP du service Recherche cognitive Azure.

ListQueryKeysResult

Réponse contenant les clés API de requête pour un service Recherche cognitive Azure donné.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

NetworkRuleSet

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

Operation

Décrit une opération d’API REST.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

OperationDisplay

Objet qui décrit l’opération.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

OperationListResult

Résultat de la demande de liste des opérations d’API REST. Il contient une liste d’opérations et une URL pour obtenir l’ensemble de résultats suivant.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

PrivateEndpointConnection

Décrit une connexion de point de terminaison privé existante au service Recherche cognitive Azure.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

PrivateEndpointConnectionListResult

Réponse contenant une liste de connexions de point de terminaison privé.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

PrivateEndpointConnectionProperties

Décrit les propriétés d’une connexion de point de terminaison privé existante au service Recherche cognitive Azure.

PrivateEndpointConnectionPropertiesPrivateEndpoint

Ressource de point de terminaison privé du fournisseur Microsoft.Network.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Décrit l’état actuel d’une connexion de service Private Link existante au point de terminaison privé Azure.

PrivateLinkResource

Décrit une ressource de liaison privée prise en charge pour le service Recherche cognitive Azure.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

PrivateLinkResourceProperties

Décrit les propriétés d’une ressource de liaison privée prise en charge pour le service Recherche cognitive Azure. Pour une version d’API donnée, cela représente les groupIds « pris en charge » lors de la création d’une ressource de liaison privée partagée.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

PrivateLinkResourcesResult

Réponse contenant la liste des ressources Private Link prises en charge.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

QueryKey

Décrit une clé API pour un service Recherche cognitive Azure donné qui dispose d’autorisations pour les opérations de requête uniquement.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

Resource

Champs courants retournés dans la réponse pour toutes les ressources Azure Resource Manager.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

SearchManagementRequestOptions

Groupe de paramètres.

SearchService

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

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

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

SearchServiceListResult

Réponse contenant la liste des services Recherche cognitive Azure.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

SearchServiceUpdate

Paramètres utilisés pour mettre à jour un service Recherche cognitive Azure.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

ShareablePrivateLinkResourceProperties

Décrit les propriétés d’un type de ressource qui a été intégré au service de liaison privée, pris en charge par Recherche cognitive Azure.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

ShareablePrivateLinkResourceType

Décrit un type de ressource qui a été intégré au service de liaison privée, pris en charge par Recherche cognitive Azure.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

SharedPrivateLinkResource

Décrit une ressource Private Link partagée gérée par le service Recherche cognitive Azure.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

SharedPrivateLinkResourceListResult

Réponse contenant la liste des ressources Private Link partagées.

Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.

SharedPrivateLinkResourceProperties

Décrit les propriétés d’une ressource de Private Link partagée existante gérée par le service Recherche cognitive Azure.

Sku

Définit la référence SKU d’un service Recherche cognitive Azure, qui détermine le niveau de prix et les limites de capacité.

TrackedResource

La définition du modèle de ressource pour une ressource Azure Resource Manager suivi d’une ressource de niveau supérieur qui a des « balises » et un « emplacement ».

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.

Énumérations

AadAuthFailureMode

Décrit la réponse que l’API de plan de données d’un service Search enverrait pour les demandes ayant échoué à l’authentification.

AdminKeyKind

AdminKeyKind.

HostingMode

Applicable uniquement pour 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 ».

IdentityType

Type d’identité.

PrivateLinkServiceConnectionProvisioningState

État d’approvisionnement de la connexion de service de liaison privée. Il peut s’agir d’une mise à jour, d’une suppression, d’un échec, d’une réussite ou d’une erreur incomplète.

PrivateLinkServiceConnectionStatus

État de la connexion au service de liaison privée. Peut être en attente, approuvé, rejeté ou déconnecté.

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 devient « réussi » ou « échec ». Les applications clientes peuvent interroger l’état d’approvisionnement (l’intervalle d’interrogation recommandé est de 30 secondes à une minute) à l’aide de l’opération Get Search Service 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.

PublicNetworkAccess

Cette valeur peut être définie sur « enabled » pour éviter les modifications cassants sur les modèles et les ressources client existants. Si la valeur est « disabled », 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.

SearchEncryptionComplianceStatus

Indique si le service de recherche est conforme ou non en ce qui concerne les ressources chiffrées non client. Si un service a plusieurs ressources chiffrées non client et que « Application » est « activé », le service est marqué comme « non conforme ».

SearchEncryptionWithCmk

Décrit comment un service de recherche doit appliquer une ou plusieurs ressources chiffrées non client.

SearchServiceStatus

État du service de recherche. Les valeurs possibles incluent : « en cours d’exécution » : 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 mise à l’échelle vers le haut ou vers le bas. « suppression » : le service de recherche est en cours de suppression. « dégradé » : le service de recherche est dégradé. 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 les états de dégradation, 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.

SharedPrivateLinkResourceAsyncOperationResult

État actuel de l’opération de ressource de liaison privée partagée asynchrone de longue durée.

SharedPrivateLinkResourceProvisioningState

État d’approvisionnement de la ressource de liaison privée partagée. Il peut s’agir d’une mise à jour, d’une suppression, d’un échec, d’une réussite ou d’une erreur incomplète.

SharedPrivateLinkResourceStatus

État de la ressource de liaison privée partagée. Peut être en attente, approuvé, rejeté ou déconnecté.

SkuName

Référence SKU du service de recherche. Les valeurs valides sont les suivantes : « free » : service partagé. « de base » : service dédié avec jusqu’à 3 réplicas. « standard » : service dédié avec jusqu’à 12 partitions et 12 réplicas. « standard2 » : similaire à standard, mais avec plus de capacité par unité de recherche. « standard3 » : offre Standard la plus grande avec jusqu’à 12 partitions et 12 réplicas (ou jusqu’à 3 partitions avec plus d’index si vous définissez également la propriété hostingMode sur « highDensity »). « storage_optimized_l1 » : prend en charge 1 To par partition, jusqu’à 12 partitions. « storage_optimized_l2 » : prend en charge 2 To par partition, jusqu’à 12 partitions.

UnavailableNameReason

Raison pour laquelle le nom n’est pas disponible. « Non valide » indique que le nom fourni ne correspond pas aux exigences de nommage (longueur incorrecte, caractères non pris en charge, etc.). « AlreadyExists » indique que le nom est déjà utilisé et n’est donc pas disponible.