Aliases - Create Or Update

Service:: Search Service

Version d'API:: 2023-10-01-Preview

Crée un alias de recherche ou met à jour un alias s’il existe déjà.

PUT {endpoint}/aliases('{aliasName}')?api-version=2023-10-01-Preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
aliasName	path	True	string	Définition de l’alias à créer ou à mettre à jour.
endpoint	path	True	string	URL du point de terminaison du service de recherche.
api-version	query	True	string	Version de l’API cliente.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string (uuid)	ID de suivi envoyé avec la demande pour faciliter le débogage.
If-Match		string	Définit la condition If-Match. L’opération n’est effectuée que si l’ETag sur le serveur correspond à cette valeur.
If-None-Match		string	Définit la condition If-None-Match. L’opération n’est effectuée que si l’ETag sur le serveur ne correspond pas à cette valeur.
Prefer	True	string	Pour les requêtes HTTP PUT, indique au service de retourner la ressource créée/mise à jour en cas de réussite.

Corps de la demande

Nom	Obligatoire	Type	Description
indexes	True	string[]	Nom de l’index auquel cet alias est mappé. Un seul nom d’index peut être spécifié.
name	True	string	Nom de l’alias.
@odata.etag		string	ETag de l’alias.

Réponses

Nom	Type	Description
200 OK	SearchAlias
201 Created	SearchAlias
Other Status Codes	SearchError	Réponse d’erreur.

Exemples

SearchServiceCreateOrUpdateAlias

Exemple de requête

HTTP

PUT https://myservice.search.windows.net/aliases('production')?api-version=2023-10-01-Preview


{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

Code d’état:: 201

{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

Définitions

Nom	Description
SearchAlias	Représente un alias d’index, qui décrit un mappage du nom de l’alias à un index. Le nom d’alias peut être utilisé à la place du nom d’index pour les opérations prises en charge.
SearchError	Décrit une condition d’erreur pour l’API.

SearchAlias

Objet

Représente un alias d’index, qui décrit un mappage du nom de l’alias à un index. Le nom d’alias peut être utilisé à la place du nom d’index pour les opérations prises en charge.

Nom	Type	Description
@odata.etag	string	ETag de l’alias.
indexes	string[]	Nom de l’index auquel cet alias est mappé. Un seul nom d’index peut être spécifié.
name	string	Nom de l’alias.

SearchError

Objet

Décrit une condition d’erreur pour l’API.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	SearchError[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
message	string	Représentation lisible par l’homme de l’erreur.