Alias maken of bijwerken (PREVIEW-REST API)

  • Artikel

Van toepassing op: 2023-07-01-Preview, 2021-04-30-Preview

Belangrijk

2023-07-01-Preview (geen wijzigingen).

2021-04-30-Preview voegt de API toe.

In Azure AI Search is een alias een secundaire naam die kan worden gebruikt om te verwijzen naar een index voor het uitvoeren van query's, indexering en andere bewerkingen.

U kunt POST of PUT gebruiken voor een maakaanvraag. Voor beide biedt het JSON-document in de aanvraagtekst de objectdefinitie.

POST https://[service name].search.windows.net/aliases?api-version=[api-version]      
  Content-Type: application/json  
  api-key: [admin key]

Voor updateaanvragen gebruikt u PUT en geeft u de aliasnaam op de URI op.

PUT https://[service name].search.windows.net/aliases/[alias name]?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]

HTTPS is vereist voor alle serviceaanvragen. In het geval van PUT, als de alias niet bestaat, wordt deze gemaakt. Als deze al bestaat, wordt deze bijgewerkt naar de nieuwe definitie.

Als u een alias maakt, wordt een toewijzing tussen een aliasnaam en een indexnaam tot stand gebracht. Als de aanvraag is geslaagd, kan de alias worden gebruikt voor indexering, query's en andere bewerkingen.

Als u een alias bijwerkt , kunt u die alias toewijzen aan een andere zoekindex. Wanneer u een bestaande alias bijwerkt, wordt de volledige definitie vervangen door de inhoud van de aanvraagbody. Over het algemeen is het beste patroon voor updates om de aliasdefinitie op te halen met een GET, deze te wijzigen en vervolgens bij te werken met PUT.

Notitie

Het kan tot 10 seconden duren voordat een update van een alias via het systeem is doorgegeven. Wacht dus ten minste 10 seconden voordat u de index verwijdert waaraan de alias eerder is toegewezen.

Notitie

Het maximum aantal aliassen dat u kunt maken, verschilt per prijscategorie. Zie Servicelimieten voor meer informatie.

URI-parameters

Parameter Beschrijving
servicenaam Vereist. Stel deze waarde in op de unieke, door de gebruiker gedefinieerde naam van uw zoekservice.
aliasnaam Vereist voor de URI als u PUT gebruikt. De naam moet uit kleine letters bestaan, beginnen met een letter of cijfer, geen schuine streepjes of punten hebben en uit minder dan 128 tekens bestaan. Nadat u de naam met een letter of cijfer hebt gestart, kan de rest van de naam een letter, cijfer en streepjes bevatten, zolang de streepjes niet opeenvolgend zijn.
api-versie Vereist. De huidige preview-versie is 2023-07-01-Preview. Zie API-versies voor meer versies.

Aanvraagheaders

In de volgende tabel worden de vereiste en optionele aanvraagheaders beschreven.

Velden Description
Content-Type Vereist. Stel deze waarde in op application/json
api-sleutel Optioneel als u Azure-rollen gebruikt en er een bearer-token wordt opgegeven voor de aanvraag, anders is een sleutel vereist. Een API-sleutel is een unieke, door het systeem gegenereerde tekenreeks die de aanvraag verifieert bij uw zoekservice. Maakaanvragen moeten een api-key header bevatten die is ingesteld op uw beheerderssleutel (in plaats van een querysleutel). Zie Verbinding maken met Azure AI Search met behulp van sleutelverificatie voor meer informatie.

Aanvraagbody

De hoofdtekst van de aanvraag bevat een aliasdefinitie, die de naam van een alias en een matrix met de naam van één index bevat.

De volgende JSON is een weergave op hoog niveau van de belangrijkste onderdelen van de definitie.

{   
    "name" : (optional on PUT; required on POST) "The name of the alias",  
    "indexes" : (required) ["The name of the index the alias is mapped to"]
}

Aanvraag bevat de volgende eigenschappen:

Eigenschap Beschrijving
naam Vereist. De naam van de alias. Een aliasnaam mag alleen kleine letters, cijfers of streepjes bevatten, mag niet beginnen of eindigen met streepjes en mag maximaal 128 tekens bevatten.
Indexen Vereist. De naam van de index waaraan de alias is toegewezen. Er kan slechts één indexnaam worden opgenomen in de matrix.

Antwoord

Voor een geslaagde aanvraag ziet u statuscode '201 Gemaakt'.

Voor een geslaagde updateaanvraag ziet u '204 Geen inhoud'.

Voorbeelden

Voorbeeld: een indexalias

{   
  "name" : "my-alias",  
  "indexes" : ["my-index"]
}

Zie ook