Synonym Maps - Create

Referens

Service:: Search Service

API Version:: 2023-11-01

Skapar en ny synonymmappning.

POST {endpoint}/synonymmaps?api-version=2023-11-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Slutpunkts-URL:en för söktjänsten.
api-version	query	True	string	Klient-API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string uuid	Spårnings-ID:t som skickas med begäran för att hjälpa till med felsökning.

Begärandetext

Name	Obligatorisk	Typ	Description
format	True	SynonymMapFormat	Formatet på synonymmappningen. Endast solr-formatet stöds för närvarande.
name	True	string	Namnet på synonymmappningen.
synonyms	True	string	En serie synonymregler i det angivna synonymmappningsformatet. Reglerna måste avgränsas med nya linjer.
@odata.etag		string	ETag för synonymkartan.
encryptionKey		SearchResourceEncryptionKey	En beskrivning av en krypteringsnyckel som du skapar i Azure Key Vault. Den här nyckeln används för att ge ytterligare kryptering i vila för dina data när du vill ha fullständig säkerhet om att ingen, inte ens Microsoft, kan dekryptera känsliga data. När du har krypterat dina data förblir de alltid krypterade. Söktjänsten ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Dina data påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare.

Svar

Name	Typ	Description
201 Created	SynonymMap
Other Status Codes	SearchError	Felsvar.

Exempel

SearchServiceCreateSynonymMap

Sample Request

HTTP

POST https://myservice.search.windows.net/synonymmaps?api-version=2023-11-01

{
  "name": "mysynonymmap",
  "format": "solr",
  "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "myApplicationSecret"
    }
  }
}

Sample Response

Status code:: 201

{
  "name": "mysynonymmap",
  "format": "solr",
  "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": null
    }
  }
}

Definitioner

Name	Description
AzureActiveDirectoryApplicationCredentials	Autentiseringsuppgifter för ett registrerat program som skapats för din söktjänst och som används för autentiserad åtkomst till krypteringsnycklarna som lagras i Azure Key Vault.
SearchError	Beskriver ett felvillkor för API:et.
SearchResourceEncryptionKey	En kundhanterad krypteringsnyckel i Azure Key Vault. Nycklar som du skapar och hanterar kan användas för att kryptera eller dekryptera vilande data i söktjänsten, till exempel index och synonymkartor.
SynonymMap	Representerar en synonymmappningsdefinition.
SynonymMapFormat	Formatet på synonymmappningen. Endast solr-formatet stöds för närvarande.

AzureActiveDirectoryApplicationCredentials

Autentiseringsuppgifter för ett registrerat program som skapats för din söktjänst och som används för autentiserad åtkomst till krypteringsnycklarna som lagras i Azure Key Vault.

Name	Typ	Description
applicationId	string	Ett AAD-program-ID som har beviljats nödvändiga åtkomstbehörigheter till Azure-Key Vault som ska användas vid kryptering av vilande data. Program-ID:t ska inte förväxlas med objekt-ID:t för ditt AAD-program.
applicationSecret	string	Autentiseringsnyckeln för det angivna AAD-programmet.

SearchError

Beskriver ett felvillkor för API:et.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	SearchError[]	En matris med information om specifika fel som ledde till det rapporterade felet.
message	string	En mänsklig läsbar representation av felet.

SearchResourceEncryptionKey

En kundhanterad krypteringsnyckel i Azure Key Vault. Nycklar som du skapar och hanterar kan användas för att kryptera eller dekryptera vilande data i söktjänsten, till exempel index och synonymkartor.

Name	Typ	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Valfria Azure Active Directory-autentiseringsuppgifter som används för att komma åt din Azure-Key Vault. Krävs inte om du använder hanterad identitet i stället.
keyVaultKeyName	string	Namnet på din Azure Key Vault nyckel som ska användas för att kryptera vilande data.
keyVaultKeyVersion	string	Versionen av din Azure Key Vault-nyckel som ska användas för att kryptera dina vilande data.
keyVaultUri	string	URI:n för din Azure-Key Vault, även kallad DNS-namn, som innehåller nyckeln som ska användas för att kryptera vilande data. Ett exempel på en URI kan vara `https://my-keyvault-name.vault.azure.net`.

SynonymMap

Representerar en synonymmappningsdefinition.

Name	Typ	Description
@odata.etag	string	ETag för synonymkartan.
encryptionKey	SearchResourceEncryptionKey	En beskrivning av en krypteringsnyckel som du skapar i Azure Key Vault. Den här nyckeln används för att ge ytterligare kryptering i vila för dina data när du vill ha fullständig säkerhet om att ingen, inte ens Microsoft, kan dekryptera känsliga data. När du har krypterat dina data förblir de alltid krypterade. Söktjänsten ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Dina data påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare.
format	SynonymMapFormat	Formatet på synonymmappningen. Endast solr-formatet stöds för närvarande.
name	string	Namnet på synonymmappningen.
synonyms	string	En serie synonymregler i det angivna synonymmappningsformatet. Reglerna måste avgränsas med nya linjer.

SynonymMapFormat

Formatet på synonymmappningen. Endast solr-formatet stöds för närvarande.

Name	Typ	Description
solr	string	Väljer SOLR-format för synonymkartor.

Dela via