Synonym Maps - Create

Referentie

Service:: Search Service

API-versie:: 2024-07-01

Hiermee maakt u een nieuwe synoniemenkaart.

POST {endpoint}/synonymmaps?api-version=2024-07-01

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	De eindpunt-URL van de zoekservice.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string uuid	De tracerings-id die is verzonden met de aanvraag om hulp te bieden bij foutopsporing.

Aanvraagbody

Name	Vereist	Type	Description
format	True	SynonymMapFormat	De indeling van de synoniemenkaart. Alleen de solr-indeling wordt momenteel ondersteund.
name	True	string	De naam van de synoniemenkaart.
synonyms	True	string	Een reeks synoniemsregels 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 versleutelings-at-rest-niveau voor uw gegevens te bieden wanneer u volledige zekerheid wilt dat niemand, zelfs Microsoft, uw gegevens kan ontsleutelen. Zodra u uw gegevens hebt versleuteld, blijven deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap in te stellen op null. 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
Other Status Codes	ErrorResponse	Foutreactie.

Voorbeelden

SearchServiceCreateSynonymMap

Voorbeeldaanvraag

HTTP

POST https://myservice.search.windows.net/synonymmaps?api-version=2024-07-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"
    }
  }
}

Voorbeeldrespons

Statuscode:: 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
    }
  }
}

Definities

Name	Description
AzureActiveDirectoryApplicationCredentials	Referenties van een geregistreerde toepassing die is gemaakt voor uw zoekservice, die wordt gebruikt voor geverifieerde toegang tot de versleutelingssleutels die zijn opgeslagen in Azure Key Vault.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
SearchResourceEncryptionKey	Een door de klant beheerde versleutelingssleutel in Azure Key Vault. Sleutels die u maakt en beheert, kunnen worden gebruikt voor het versleutelen of ontsleutelen van data-at-rest, zoals indexen en synoniemenkaarten.
SynonymMap	Vertegenwoordigt een synoniemtoewijzingsdefinitie.
SynonymMapFormat	De indeling van de synoniemenkaart. Alleen de solr-indeling wordt momenteel ondersteund.

AzureActiveDirectoryApplicationCredentials

Referenties van een geregistreerde toepassing die is gemaakt voor uw zoekservice, die wordt gebruikt voor geverifieerde toegang tot de versleutelingssleutels die zijn opgeslagen in Azure Key Vault.

Name	Type	Description
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.
applicationSecret	string	De verificatiesleutel van de opgegeven AAD-toepassing.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

SearchResourceEncryptionKey

Een door de klant beheerde versleutelingssleutel in Azure Key Vault. Sleutels die u maakt en beheert, kunnen worden gebruikt voor het versleutelen of ontsleutelen van data-at-rest, zoals indexen en synoniemenkaarten.

Name	Type	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Optionele Azure Active Directory-referenties die worden gebruikt voor toegang tot uw Azure Key Vault. Niet vereist als u in plaats daarvan beheerde identiteit gebruikt.
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.net`zijn.

SynonymMap

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 versleutelings-at-rest-niveau voor uw gegevens te bieden wanneer u volledige zekerheid wilt dat niemand, zelfs Microsoft, uw gegevens kan ontsleutelen. Zodra u uw gegevens hebt versleuteld, blijven deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap in te stellen op null. 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	SynonymMapFormat	De indeling van de synoniemenkaart. Alleen de solr-indeling wordt momenteel ondersteund.
name	string	De naam van de synoniemenkaart.
synonyms	string	Een reeks synoniemsregels in de opgegeven indeling voor synoniementoewijzing. De regels moeten worden gescheiden door nieuwe regels.

SynonymMapFormat

De indeling van de synoniemenkaart. Alleen de solr-indeling wordt momenteel ondersteund.

Name	Type	Description
solr	string	Hiermee selecteert u de SOLR-indeling voor synoniemenkaarten.

Delen via