Aliases - Create Or Update

Service:: Search Service

Version d'API:: 2025-08-01-preview

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

PUT {endpoint}/aliases('{aliasName}')?api-version=2025-08-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
aliasName	path	True	string	La 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 client.

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 aider au débogage.
If-Match		string	Définit la condition If-Match. L’opération ne sera 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 ne sera 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 renvoyer 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	L’ETag de l’alias.

Réponses

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

Exemples

SearchServiceCreateOrUpdateAlias

Exemple de requête

HTTP

PUT https://previewexampleservice.search.windows.net/aliases('myalias')?api-version=2025-08-01-preview





{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ],
  "@odata.etag": "0x1234568AE7E58A1"
}

Exemple de réponse

Code d’état:: 200

{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ]
}

Code d’état:: 201

{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ]
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
SearchAlias	Représente un alias d’index, qui décrit un mappage entre le nom de l’alias et un index. Le nom d’alias peut être utilisé à la place du nom d’index pour les opérations prises en charge.

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

SearchAlias

Objet

Représente un alias d’index, qui décrit un mappage entre le nom de l’alias et 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	L’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.