Synonym Maps - Create Or Update

Usługa:: Search Service

Wersja interfejsu API:: 2025-08-01-preview

Tworzy nową mapę synonimów lub aktualizuje mapę synonimów, jeśli już istnieje.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Adres URL punktu końcowego usługi wyszukiwania.
synonymMapName	path	True	string	Nazwa mapy synonimów, która ma zostać utworzona lub zaktualizowana.
api-version	query	True	string	Wersja interfejsu API klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string (uuid)	Identyfikator śledzenia wysłany z żądaniem, aby pomóc w debugowaniu.
If-Match		string	Definiuje warunek If-Match. Operacja zostanie wykonana tylko wtedy, gdy element ETag na serwerze jest zgodny z tą wartością.
If-None-Match		string	Definiuje warunek If-None-Match. Operacja zostanie wykonana tylko wtedy, gdy element ETag na serwerze nie jest zgodny z tą wartością.
Prefer	True	string	W przypadku żądań HTTP PUT instruuje usługę, aby zwróciła utworzony/zaktualizowany zasób w przypadku powodzenia.

Treść żądania

Nazwa	Wymagane	Typ	Opis
format	True	SynonymMapFormat	Format mapy synonimów. Obecnie obsługiwany jest tylko format 'solr'.
name	True	string	Nazwa mapy synonimów.
synonyms	True	string	Seria reguł synonimów w określonym formacie mapy synonimów. Reguły muszą być oddzielone znakami nowej linii.
@odata.etag		string	Element ETag mapy synonimów.
encryptionKey		SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz jest używany w celu zapewnienia dodatkowego poziomu szyfrowania danych magazynowanych, gdy chcesz mieć pełną pewność, że nikt, nawet firma Microsoft, nie może odszyfrować Twoich danych. Po zaszyfrowaniu danych na zawsze pozostaną one zaszyfrowane. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość zgodnie z potrzebami, jeśli chcesz obrócić klucz szyfrowania; Twoje dane pozostaną nienaruszone. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne w przypadku bezpłatnych usług wyszukiwania i jest dostępne tylko w przypadku płatnych usług utworzonych 1 stycznia 2019 r. lub później.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SynonymMap
201 Created	SynonymMap
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Przykłady

SearchServiceCreateOrUpdateSynonymMap

Przykładowe żądanie

HTTP

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





{
  "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": "<applicationSecret>"
    }
  },
  "@odata.etag": "0x1234568AE7E58A1"
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "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": "<applicationSecret>"
    }
  }
}

Kod stanu:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "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": "<applicationSecret>"
    }
  }
}

Definicje

Nazwa	Opis
AzureActiveDirectoryApplicationCredentials	Poświadczenia zarejestrowanej aplikacji utworzonej dla usługi wyszukiwania, używanej do uwierzytelnionego dostępu do kluczy szyfrowania przechowywanych w usłudze Azure Key Vault.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
SearchIndexerDataNoneIdentity	Czyści właściwość tożsamości źródła danych.
SearchIndexerDataUserAssignedIdentity	Określa tożsamość źródła danych, które ma być używane.
SearchResourceEncryptionKey	Klucz szyfrowania zarządzany przez klienta w usłudze Azure Key Vault. Klucze, które tworzysz i którymi zarządzasz, mogą służyć do szyfrowania lub odszyfrowywania danych magazynowanych, takich jak indeksy i mapy synonimów.
SynonymMap	Reprezentuje definicję mapy synonimów.
SynonymMapFormat	Format mapy synonimów. Obecnie obsługiwany jest tylko format 'solr'.

AzureActiveDirectoryApplicationCredentials

Objekt

Poświadczenia zarejestrowanej aplikacji utworzonej dla usługi wyszukiwania, używanej do uwierzytelnionego dostępu do kluczy szyfrowania przechowywanych w usłudze Azure Key Vault.

Nazwa	Typ	Opis
applicationId	string	Identyfikator aplikacji usługi AAD, któremu udzielono wymaganych uprawnień dostępu do usługi Azure Key Vault, który ma być używany podczas szyfrowania danych magazynowanych. Identyfikatora aplikacji nie należy mylić z identyfikatorem obiektu aplikacji usługi AAD.
applicationSecret	string	Klucz uwierzytelniania określonej aplikacji usługi AAD.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

SearchIndexerDataNoneIdentity

Objekt

Czyści właściwość tożsamości źródła danych.

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragment identyfikatora URI określający typ tożsamości.

SearchIndexerDataUserAssignedIdentity

Objekt

Określa tożsamość źródła danych, które ma być używane.

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragment identyfikatora URI określający typ tożsamości.
userAssignedIdentity	string	W pełni kwalifikowany identyfikator zasobu platformy Azure tożsamości zarządzanej przypisanej przez użytkownika zwykle w postaci "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", który powinien zostać przypisany do usługi wyszukiwania.

SearchResourceEncryptionKey

Objekt

Klucz szyfrowania zarządzany przez klienta w usłudze Azure Key Vault. Klucze, które tworzysz i którymi zarządzasz, mogą służyć do szyfrowania lub odszyfrowywania danych magazynowanych, takich jak indeksy i mapy synonimów.

Nazwa	Typ	Opis
accessCredentials	AzureActiveDirectoryApplicationCredentials	Opcjonalne poświadczenia usługi Azure Active Directory używane do uzyskiwania dostępu do usługi Azure Key Vault. Nie jest to wymagane, jeśli zamiast tego używasz tożsamości zarządzanej.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Jawna tożsamość zarządzana do użycia dla tego klucza szyfrowania. Jeśli nie zostanie określona, a właściwość poświadczeń dostępu ma wartość null, zostanie użyta tożsamość zarządzana przypisana przez system. Podczas aktualizacji zasobu, jeśli jawna tożsamość nie jest określona, pozostaje niezmieniona. Jeśli określono wartość "none", wartość tej właściwości jest czyszczona.
keyVaultKeyName	string	Nazwa klucza usługi Azure Key Vault, który ma być używany do szyfrowania danych magazynowanych.
keyVaultKeyVersion	string	Wersja klucza usługi Azure Key Vault, która ma być używana do szyfrowania danych magazynowanych.
keyVaultUri	string	Identyfikator URI usługi Azure Key Vault, nazywany również nazwą DNS, który zawiera klucz, który ma być używany do szyfrowania danych magazynowanych. Przykładowym identyfikatorem URI może być `https://my-keyvault-name.vault.azure.net`.

SynonymMap

Objekt

Reprezentuje definicję mapy synonimów.

Nazwa	Typ	Opis
@odata.etag	string	Element ETag mapy synonimów.
encryptionKey	SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz jest używany w celu zapewnienia dodatkowego poziomu szyfrowania danych magazynowanych, gdy chcesz mieć pełną pewność, że nikt, nawet firma Microsoft, nie może odszyfrować Twoich danych. Po zaszyfrowaniu danych na zawsze pozostaną one zaszyfrowane. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość zgodnie z potrzebami, jeśli chcesz obrócić klucz szyfrowania; Twoje dane pozostaną nienaruszone. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne w przypadku bezpłatnych usług wyszukiwania i jest dostępne tylko w przypadku płatnych usług utworzonych 1 stycznia 2019 r. lub później.
format	SynonymMapFormat	Format mapy synonimów. Obecnie obsługiwany jest tylko format 'solr'.
name	string	Nazwa mapy synonimów.
synonyms	string	Seria reguł synonimów w określonym formacie mapy synonimów. Reguły muszą być oddzielone znakami nowej linii.

SynonymMapFormat

Wyliczenie

Format mapy synonimów. Obecnie obsługiwany jest tylko format 'solr'.

Wartość	Opis
solr	Wybiera format SOLR dla map synonimów.