Synonym Maps - Create

Service:
Search Service
API-versie:
2026-05-01-preview

Hiermee maakt u een nieuwe synoniemenkaart.

POST {endpoint}/synonymmaps?api-version=2026-05-01-preview

URI-parameters

Name In Vereist Type Description
endpoint
 path True

string (uri)

De eindpunt-URL van de zoekservice.
api-version
 query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name Vereist Type Description
Accept

Accept

De Accepteer kop.
x-ms-client-request-id

string (uuid)

Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Aanvraagbody

Name Vereist Type Description
format True enum:

solr

Het formaat van de synoniemenkaart. Alleen het 'solr'-formaat wordt momenteel ondersteund.
name True

string

De naam van de synoniemenkaart.
synonyms True

string

Een reeks synoniemregels in de opgegeven indeling voor synoniementoewijzing. De regels moeten worden gescheiden door nieuwe regels.
@odata.etag

string

De ETag van de synoniemenkaart.
encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra niveau van versleuteling in rust te bieden voor je data wanneer je volledige zekerheid wilt dat niemand, zelfs Microsoft niet, je data kan ontsleutelen. Zodra u uw gegevens hebt versleuteld, blijven deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. U kunt deze eigenschap indien nodig wijzigen als u uw versleutelingssleutel wilt draaien; Uw gegevens worden niet beïnvloed. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

Antwoorden

Name Type Description
201 Created

SynonymMap

De aanvraag is geslaagd en er is een nieuwe resource gemaakt.
Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Beveiliging

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

Name Description
https://search.azure.com/.default

Voorbeelden

SearchServiceCreateSynonymMap

Voorbeeldaanvraag

POST https://previewexampleservice.search.windows.net/synonymmaps?api-version=2026-05-01-preview


{
  "name": "tempsynonymmap",
  "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"
}

Voorbeeldrespons

Statuscode:
201 
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "tempsynonymmap",
  "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>"
    }
  }
}

Definities

Name Description
Accept

De Accepteer kop.
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorDetail

Het foutdetail.
ErrorResponse

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
SearchIndexerDataNoneIdentity

Hiermee wist u de identiteitseigenschap van een gegevensbron.
SearchIndexerDataUserAssignedIdentity

Hiermee geeft u de identiteit op voor een gegevensbron die moet worden gebruikt.
SearchResourceEncryptionKey

Een door de klant beheerde versleutelingssleutel in Azure Key Vault. Sleutels die u maakt en beheert, kunnen worden gebruikt om inactieve gegevens, zoals indexen en synoniementoewijzingen, te versleutelen of te ontsleutelen.
SynonymMap

Vertegenwoordigt een synoniemtoewijzingsdefinitie.

Accept

Opsomming

De Accepteer kop.

Waarde Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

De aanvullende informatie.
type

string

Het extra informatietype.

ErrorDetail

Object

Het foutdetail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

Aanvullende informatie over de fout.
code

string

De foutcode.
details

ErrorDetail[]

De foutgegevens.
message

string

Het foutbericht.
target

string

Het foutdoelwit.

ErrorResponse

Object

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name Type Description
error

ErrorDetail

Het foutobject.

SearchIndexerDataNoneIdentity

Object

Hiermee wist u de identiteitseigenschap van een gegevensbron.

Name Type Description
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

Een URI-fragment dat het type identiteit specificeert.

SearchIndexerDataUserAssignedIdentity

Object

Hiermee geeft u de identiteit op voor een gegevensbron die moet worden gebruikt.

Name Type Description
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

Een URI-fragment dat het type identiteit specificeert.
federatedIdentityClientId

string

Multi-tenant User-Assigned Managed Identity Support: De client-id van de multi-tentant app die is geconfigureerd om te federeren met de door de gebruiker toegewezen beheerde identiteit.
userAssignedIdentity

string

De volledig gekwalificeerde Azure-resource-id van een door de gebruiker toegewezen beheerde identiteit, meestal in de vorm '/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId' die aan de zoekservice moet zijn toegewezen.

SearchResourceEncryptionKey

Object

Een door de klant beheerde versleutelingssleutel in Azure Key Vault. Sleutels die u maakt en beheert, kunnen worden gebruikt om inactieve gegevens, zoals indexen en synoniementoewijzingen, te versleutelen of te ontsleutelen.

Name Type Default value Description
accessCredentials.applicationId

string

Een AAD-toepassings-id waaraan de vereiste toegangsmachtigingen zijn verleend voor de Azure Key Vault die moet worden gebruikt bij het versleutelen van uw data-at-rest. De toepassings-id mag niet worden verward met de object-id voor uw AAD-toepassing.
accessCredentials.applicationSecret

string

De verificatiesleutel van de opgegeven AAD-toepassing.
identity SearchIndexerDataIdentity:

Een expliciete beheerde identiteit die moet worden gebruikt voor deze versleutelingssleutel. Als dit niet is opgegeven en de eigenschap toegangsreferenties null is, wordt de door het systeem toegewezen beheerde identiteit gebruikt. Bij het bijwerken van de resource, als de expliciete identiteit niet is opgegeven, blijft deze ongewijzigd. Als 'geen' is opgegeven, wordt de waarde van deze eigenschap gewist.
isServiceLevelKey

boolean

False

Een optionele waarde die aangeeft of deze sleutel een serviceniveausleutel is. De standaardwaarde is vals.
keyVaultKeyName

string

De naam van uw Azure Key Vault-sleutel die moet worden gebruikt om uw data-at-rest te versleutelen.
keyVaultKeyVersion

string

De versie van uw Azure Key Vault-sleutel die moet worden gebruikt om uw data-at-rest te versleutelen.
keyVaultUri

string

De URI van uw Azure Key Vault, ook wel DNS-naam genoemd, die de sleutel bevat die moet worden gebruikt voor het versleutelen van uw data-at-rest. Een voorbeeld van een URI kan https://my-keyvault-name.vault.azure.netzijn.

SynonymMap

Object

Vertegenwoordigt een synoniemtoewijzingsdefinitie.

Name Type Description
@odata.etag

string

De ETag van de synoniemenkaart.
encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra niveau van versleuteling in rust te bieden voor je data wanneer je volledige zekerheid wilt dat niemand, zelfs Microsoft niet, je data kan ontsleutelen. Zodra u uw gegevens hebt versleuteld, blijven deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. U kunt deze eigenschap indien nodig wijzigen als u uw versleutelingssleutel wilt draaien; Uw gegevens worden niet beïnvloed. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.
format enum:

solr

Het formaat van de synoniemenkaart. Alleen het 'solr'-formaat wordt momenteel ondersteund.
name

string

De naam van de synoniemenkaart.
synonyms

string

Een reeks synoniemregels in de opgegeven indeling voor synoniementoewijzing. De regels moeten worden gescheiden door nieuwe regels.