Partager via


@azure/arm-search package

Classes

SearchManagementClient

Interfaces

AdminKeyResult

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

AdminKeys

Interface représentant un AdminKeys.

AdminKeysGetOptionalParams

Paramètres facultatifs.

AdminKeysRegenerateOptionalParams

Paramètres facultatifs.

AsyncOperationResult

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

CheckNameAvailabilityInput

Entrée de case activée’API de disponibilité du nom.

CheckNameAvailabilityOutput

Sortie de case activée’API de disponibilité de nom.

CloudError

Contient des informations sur une erreur d’API.

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 peut être utilisé 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.

Identity

Identité de la ressource.

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

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.

OperationDisplay

Objet qui décrit l’opération.

OperationListResult

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

Operations

Interface représentant une opération.

OperationsListOptionalParams

Paramètres facultatifs.

PrivateEndpointConnection

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

PrivateEndpointConnectionListResult

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

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 Private Link Service existante au point de terminaison privé Azure.

PrivateEndpointConnections

Interface représentant un PrivateEndpointConnections.

PrivateEndpointConnectionsDeleteOptionalParams

Paramètres facultatifs.

PrivateEndpointConnectionsGetOptionalParams

Paramètres facultatifs.

PrivateEndpointConnectionsListByServiceNextOptionalParams

Paramètres facultatifs.

PrivateEndpointConnectionsListByServiceOptionalParams

Paramètres facultatifs.

PrivateEndpointConnectionsUpdateOptionalParams

Paramètres facultatifs.

PrivateLinkResource

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

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.

PrivateLinkResources

Interface représentant un PrivateLinkResources.

PrivateLinkResourcesListSupportedOptionalParams

Paramètres facultatifs.

PrivateLinkResourcesResult

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

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.

QueryKeys

Interface représentant un QueryKeys.

QueryKeysCreateOptionalParams

Paramètres facultatifs.

QueryKeysDeleteOptionalParams

Paramètres facultatifs.

QueryKeysListBySearchServiceNextOptionalParams

Paramètres facultatifs.

QueryKeysListBySearchServiceOptionalParams

Paramètres facultatifs.

QuotaUsageResult

Décrit l’utilisation du quota pour une référence SKU particulière prise en charge par Recherche cognitive Azure.

QuotaUsageResultName

Nom de la référence SKU prise en charge par Recherche cognitive Azure.

QuotaUsagesListResult

Réponse contenant les informations d’utilisation du quota pour toutes les références SKU prises en charge de Recherche cognitive Azure service.

Resource

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

SearchManagementClientOptionalParams

Paramètres facultatifs.

SearchManagementRequestOptions

Groupe de paramètres

SearchService

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

SearchServiceListResult

Réponse contenant une liste de services Recherche cognitive Azure.

SearchServiceUpdate

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

Services

Interface représentant un service.

ServicesCheckNameAvailabilityOptionalParams

Paramètres facultatifs.

ServicesCreateOrUpdateOptionalParams

Paramètres facultatifs.

ServicesDeleteOptionalParams

Paramètres facultatifs.

ServicesGetOptionalParams

Paramètres facultatifs.

ServicesListByResourceGroupNextOptionalParams

Paramètres facultatifs.

ServicesListByResourceGroupOptionalParams

Paramètres facultatifs.

ServicesListBySubscriptionNextOptionalParams

Paramètres facultatifs.

ServicesListBySubscriptionOptionalParams

Paramètres facultatifs.

ServicesUpdateOptionalParams

Paramètres facultatifs.

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.

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.

SharedPrivateLinkResource

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

SharedPrivateLinkResourceListResult

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

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.

SharedPrivateLinkResources

Interface représentant un SharedPrivateLinkResources.

SharedPrivateLinkResourcesCreateOrUpdateOptionalParams

Paramètres facultatifs.

SharedPrivateLinkResourcesDeleteOptionalParams

Paramètres facultatifs.

SharedPrivateLinkResourcesGetOptionalParams

Paramètres facultatifs.

SharedPrivateLinkResourcesListByServiceNextOptionalParams

Paramètres facultatifs.

SharedPrivateLinkResourcesListByServiceOptionalParams

Paramètres facultatifs.

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 une ressource de niveau supérieur suivie qui a des « balises » et un « emplacement »

UsageBySubscriptionSkuOptionalParams

Paramètres facultatifs.

Usages

Interface représentant un Usage.

UsagesListBySubscriptionNextOptionalParams

Paramètres facultatifs.

UsagesListBySubscriptionOptionalParams

Paramètres facultatifs.

Alias de type

AadAuthFailureMode

Définit des valeurs pour AadAuthFailureMode.

AdminKeyKind

Définit les valeurs de AdminKeyKind.

AdminKeysGetResponse

Contient des données de réponse pour l’opération get.

AdminKeysRegenerateResponse

Contient des données de réponse pour l’opération de régénération.

HostingMode

Définit des valeurs pour HostingMode.

IdentityType

Définit des valeurs pour IdentityType.

OperationsListResponse

Contient des données de réponse pour l’opération de liste.

PrivateEndpointConnectionsDeleteResponse

Contient des données de réponse pour l’opération de suppression.

PrivateEndpointConnectionsGetResponse

Contient des données de réponse pour l’opération get.

PrivateEndpointConnectionsListByServiceNextResponse

Contient des données de réponse pour l’opération listByServiceNext.

PrivateEndpointConnectionsListByServiceResponse

Contient des données de réponse pour l’opération listByService.

PrivateEndpointConnectionsUpdateResponse

Contient des données de réponse pour l’opération de mise à jour.

PrivateLinkResourcesListSupportedResponse

Contient des données de réponse pour l’opération listSupported.

PrivateLinkServiceConnectionProvisioningState

Définit des valeurs pour PrivateLinkServiceConnectionProvisioningState.
KnownPrivateLinkServiceConnectionProvisioningState peut être utilisé indifféremment avec PrivateLinkServiceConnectionProvisioningState. Cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Mise à jour : la connexion au service de liaison privée est en cours de création avec d’autres ressources pour qu’elle soit entièrement fonctionnelle.
Suppression : la connexion au service de liaison privée est en cours de suppression.
Échec : la connexion au service de liaison privée n’a pas pu être provisionnée ou supprimée.
Réussite : la connexion au service de liaison privée a terminé l’approvisionnement et est prête à être approuvée.
Incomplet : la demande d’approvisionnement pour la ressource de connexion de service private link a été acceptée, mais le processus de création n’a pas encore commencé.
Annulé : la demande d’approvisionnement pour la ressource de connexion de service private link a été annulée

PrivateLinkServiceConnectionStatus

Définit des valeurs pour PrivateLinkServiceConnectionStatus.

ProvisioningState

Définit des valeurs pour ProvisioningState.

PublicNetworkAccess

Définit des valeurs pour PublicNetworkAccess.

QueryKeysCreateResponse

Contient des données de réponse pour l’opération de création.

QueryKeysListBySearchServiceNextResponse

Contient des données de réponse pour l’opération listBySearchServiceNext.

QueryKeysListBySearchServiceResponse

Contient des données de réponse pour l’opération listBySearchService.

SearchEncryptionComplianceStatus

Définit les valeurs de SearchEncryptionComplianceStatus.

SearchEncryptionWithCmk

Définit les valeurs de SearchEncryptionWithCmk.

SearchSemanticSearch

Définit les valeurs de SearchSemanticSearch.
KnownSearchSemanticSearch peut être utilisé indifféremment avec SearchSemanticSearch. Cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

disabled : indique que la recherche sémantique est désactivée pour le service de recherche.
gratuit : active la recherche sémantique sur un service de recherche et indique qu’elle doit être utilisée dans les limites du niveau gratuit. Cela limiterait le volume de demandes de recherche sémantique et est proposé sans frais supplémentaires. Il s’agit de la valeur par défaut pour les services de recherche nouvellement provisionnés.
standard : active la recherche sémantique sur un service de recherche en tant que fonctionnalité facturable, avec un débit et un volume plus élevés de requêtes de recherche sémantique.

SearchServiceStatus

Définit les valeurs de SearchServiceStatus.

ServicesCheckNameAvailabilityResponse

Contient des données de réponse pour l’opération checkNameAvailability.

ServicesCreateOrUpdateResponse

Contient des données de réponse pour l’opération createOrUpdate.

ServicesGetResponse

Contient des données de réponse pour l’opération get.

ServicesListByResourceGroupNextResponse

Contient des données de réponse pour l’opération listByResourceGroupNext.

ServicesListByResourceGroupResponse

Contient des données de réponse pour l’opération listByResourceGroup.

ServicesListBySubscriptionNextResponse

Contient des données de réponse pour l’opération listBySubscriptionNext.

ServicesListBySubscriptionResponse

Contient des données de réponse pour l’opération listBySubscription.

ServicesUpdateResponse

Contient des données de réponse pour l’opération de mise à jour.

SharedPrivateLinkResourceAsyncOperationResult

Définit des valeurs pour SharedPrivateLinkResourceAsyncOperationResult.
KnownSharedPrivateLinkResourceAsyncOperationResult peut être utilisé de manière interchangeable avec SharedPrivateLinkResourceAsyncOperationResult. Cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Exécution
Réussi
Échec

SharedPrivateLinkResourceProvisioningState

Définit des valeurs pour SharedPrivateLinkResourceProvisioningState.

SharedPrivateLinkResourceStatus

Définit des valeurs pour SharedPrivateLinkResourceStatus.

SharedPrivateLinkResourcesCreateOrUpdateResponse

Contient des données de réponse pour l’opération createOrUpdate.

SharedPrivateLinkResourcesGetResponse

Contient des données de réponse pour l’opération get.

SharedPrivateLinkResourcesListByServiceNextResponse

Contient des données de réponse pour l’opération listByServiceNext.

SharedPrivateLinkResourcesListByServiceResponse

Contient des données de réponse pour l’opération listByService.

SkuName

Définit des valeurs pour SkuName.

UnavailableNameReason

Définit des valeurs pour UnavailableNameReason.
KnownUnavailableNameReason peut être utilisé indifféremment avec UnavailableNameReason. Cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Non valide : le nom du service de recherche ne correspond pas aux exigences de nommage.
AlreadyExists : le nom du service de recherche est déjà attribué à un autre service de recherche.

UsageBySubscriptionSkuResponse

Contient des données de réponse pour l’opération usageBySubscriptionSku.

UsagesListBySubscriptionNextResponse

Contient des données de réponse pour l’opération listBySubscriptionNext.

UsagesListBySubscriptionResponse

Contient des données de réponse pour l’opération listBySubscription.

Énumérations

KnownPrivateLinkServiceConnectionProvisioningState

Valeurs connues de PrivateLinkServiceConnectionProvisioningState que le service accepte.

KnownSearchSemanticSearch

Valeurs connues de SearchSemanticSearch que le service accepte.

KnownSharedPrivateLinkResourceAsyncOperationResult

Valeurs connues de SharedPrivateLinkResourceAsyncOperationResult que le service accepte.

KnownUnavailableNameReason

Valeurs connues de UnavailableNameReason que le service accepte.

Fonctions

getContinuationToken(unknown)

Étant donné le dernier .value produit par l’itérateur byPage , retourne un jeton de continuation qui peut être utilisé pour commencer la pagination à partir de ce point ultérieurement.

Informations relatives à la fonction

getContinuationToken(unknown)

Étant donné le dernier .value produit par l’itérateur byPage , retourne un jeton de continuation qui peut être utilisé pour commencer la pagination à partir de ce point ultérieurement.

function getContinuationToken(page: unknown): string | undefined

Paramètres

page

unknown

Objet d’accès sur value IteratorResult à partir d’un byPage itérateur.

Retours

string | undefined

Jeton de continuation qui peut être transmis à byPage() lors des appels futurs.