Partager via

SearchService interface

  • Référence
Paquet:
@azure/arm-search

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

Extends
TrackedResource

Propriétés

authOptions

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.
disableLocalAuth

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.
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.
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 ».
identity

Identité de la ressource.
networkRuleSet

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

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.
privateEndpointConnections

Liste des connexions de point de terminaison privé au service Recherche cognitive Azure. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
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. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
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.
replicaCount

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.
semanticSearch

Définit les options qui contrôlent la disponibilité de la recherche sémantique. Cette configuration n’est possible que pour certaines références SKU Recherche cognitive Azure à certains emplacements.
sharedPrivateLinkResources

Liste des ressources de liaison privée partagées gérées par le service Recherche cognitive Azure. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
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.
status

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. « erreur » : 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. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
statusDetails

Détails du service de recherche status. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

Propriétés héritées

id

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
location

Emplacement géographique où réside la ressource
name

Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
tags

Balises de ressource.
type

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

Détails de la propriété

authOptions

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.

authOptions?: DataPlaneAuthOptions

Valeur de propriété

DataPlaneAuthOptions

disableLocalAuth

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.

disableLocalAuth?: boolean

Valeur de propriété

boolean

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.

encryptionWithCmk?: EncryptionWithCmk

Valeur de propriété

EncryptionWithCmk

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 ».

hostingMode?: HostingMode

Valeur de propriété

HostingMode

identity

Identité de la ressource.

identity?: Identity

Valeur de propriété

Identity

networkRuleSet

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

networkRuleSet?: NetworkRuleSet

Valeur de propriété

NetworkRuleSet

partitionCount

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.

partitionCount?: number

Valeur de propriété

number

privateEndpointConnections

Liste des connexions de point de terminaison privé au service Recherche cognitive Azure. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

privateEndpointConnections?: PrivateEndpointConnection[]

Valeur de propriété

PrivateEndpointConnection[]

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. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

provisioningState?: ProvisioningState

Valeur de propriété

ProvisioningState

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.

publicNetworkAccess?: PublicNetworkAccess

Valeur de propriété

PublicNetworkAccess

replicaCount

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.

replicaCount?: number

Valeur de propriété

number

semanticSearch

Définit les options qui contrôlent la disponibilité de la recherche sémantique. Cette configuration n’est possible que pour certaines références SKU Recherche cognitive Azure à certains emplacements.

semanticSearch?: string

Valeur de propriété

string

sharedPrivateLinkResources

Liste des ressources de liaison privée partagées gérées par le service Recherche cognitive Azure. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Valeur de propriété

SharedPrivateLinkResource[]

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.

sku?: Sku

Valeur de propriété

Sku

status

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. « erreur » : 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. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

status?: SearchServiceStatus

Valeur de propriété

SearchServiceStatus

statusDetails

Détails du service de recherche status. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

statusDetails?: string

Valeur de propriété

string

Détails de la propriété héritée

id

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

id?: string

Valeur de propriété

string

Héritée deTrackedResource.id

location

Emplacement géographique où réside la ressource

location: string

Valeur de propriété

string

Hérité deTrackedResource.location

name

Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

name?: string

Valeur de propriété

string

Hérité deTrackedResource.name

tags

Balises de ressource.

tags?: {[propertyName: string]: string}

Valeur de propriété

{[propertyName: string]: string}

Hérité deTrackedResource.tags

type

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

type?: string

Valeur de propriété

string

Hérité deTrackedResource.type