Megosztás a következőn keresztül:


Synonym Maps - Create

Új szinonimatérképet hoz létre.

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

URI-paraméterek

Name In Kötelező Típus Description
endpoint
path True

string

A keresési szolgáltatás végponti URL-címe.

api-version
query True

string

Ügyfél API-verziója.

Kérelem fejléce

Name Kötelező Típus Description
x-ms-client-request-id

string

uuid

A kéréssel együtt küldött nyomkövetési azonosító, amely segít a hibakeresésben.

Kérelem törzse

Name Kötelező Típus Description
format True

SynonymMapFormat

A szinonimatérkép formátuma. Jelenleg csak a "solr" formátum támogatott.

name True

string

A szinonimatérkép neve.

synonyms True

string

Szinonimaszabályok sorozata a megadott szinonimatérkép-formátumban. A szabályokat új vonalakkal kell elválasztani.

@odata.etag

string

A szinonimatérkép ETagje.

encryptionKey

SearchResourceEncryptionKey

Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ez a kulcs további titkosítási szintet biztosít az adatok számára, ha teljes bizonyosságot szeretne arról, hogy senki, még a Microsoft sem tudja visszafejteni az adatokat. Miután titkosította az adatokat, az mindig titkosítva marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre történő beállítására tett kísérleteket. Szükség szerint módosíthatja ezt a tulajdonságot, ha el szeretné forgatni a titkosítási kulcsot; Az adatok nem lesznek hatással. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el.

Válaszok

Name Típus Description
201 Created

SynonymMap

Other Status Codes

ErrorResponse

Hibaválasz.

Példák

SearchServiceCreateSynonymMap

Mintakérelem

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"
    }
  }
}

Mintaválasz

{
  "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
    }
  }
}

Definíciók

Name Description
AzureActiveDirectoryApplicationCredentials

A keresési szolgáltatáshoz létrehozott regisztrált alkalmazás hitelesítő adatai, amelyeket az Azure Key Vaultban tárolt titkosítási kulcsokhoz való hitelesített hozzáféréshez használnak.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

ErrorDetail

A hiba részletei.

ErrorResponse

Hibaválasz

SearchResourceEncryptionKey

Ügyfél által felügyelt titkosítási kulcs az Azure Key Vaultban. A létrehozott és kezelt kulcsokkal titkosíthatja vagy visszafejtheti az inaktív adatokat, például indexeket és szinonimatérképeket.

SynonymMap

Szinonimatérkép-definíciót jelöl.

SynonymMapFormat

A szinonimatérkép formátuma. Jelenleg csak a "solr" formátum támogatott.

AzureActiveDirectoryApplicationCredentials

A keresési szolgáltatáshoz létrehozott regisztrált alkalmazás hitelesítő adatai, amelyeket az Azure Key Vaultban tárolt titkosítási kulcsokhoz való hitelesített hozzáféréshez használnak.

Name Típus Description
applicationId

string

Egy AAD-alkalmazásazonosító, amely megkapta a szükséges hozzáférési engedélyeket az Azure Key Vaulthoz, amelyet az inaktív adatok titkosításához kell használni. Az alkalmazásazonosító nem tévesztendő össze az AAD-alkalmazás objektumazonosítójával.

applicationSecret

string

A megadott AAD-alkalmazás hitelesítési kulcsa.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name Típus Description
info

object

A további információk.

type

string

A további információtípus.

ErrorDetail

A hiba részletei.

Name Típus Description
additionalInfo

ErrorAdditionalInfo[]

A hiba további információi.

code

string

A hibakód.

details

ErrorDetail[]

A hiba részletei.

message

string

A hibaüzenet.

target

string

A hibacél.

ErrorResponse

Hibaválasz

Name Típus Description
error

ErrorDetail

A hibaobjektum.

SearchResourceEncryptionKey

Ügyfél által felügyelt titkosítási kulcs az Azure Key Vaultban. A létrehozott és kezelt kulcsokkal titkosíthatja vagy visszafejtheti az inaktív adatokat, például indexeket és szinonimatérképeket.

Name Típus Description
accessCredentials

AzureActiveDirectoryApplicationCredentials

Az Azure Key Vault eléréséhez használt opcionális Azure Active Directory-hitelesítő adatok. Nem kötelező, ha ehelyett felügyelt identitást használ.

keyVaultKeyName

string

A inaktív adatok titkosításához használandó Azure Key Vault-kulcs neve.

keyVaultKeyVersion

string

Az Azure Key Vault-kulcs inaktív adatok titkosításához használandó verziója.

keyVaultUri

string

Az Azure Key Vault URI-ja, más néven DNS-név, amely tartalmazza az inaktív adatok titkosításához használandó kulcsot. Példa URI lehet https://my-keyvault-name.vault.azure.net.

SynonymMap

Szinonimatérkép-definíciót jelöl.

Name Típus Description
@odata.etag

string

A szinonimatérkép ETagje.

encryptionKey

SearchResourceEncryptionKey

Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ez a kulcs további titkosítási szintet biztosít az adatok számára, ha teljes bizonyosságot szeretne arról, hogy senki, még a Microsoft sem tudja visszafejteni az adatokat. Miután titkosította az adatokat, az mindig titkosítva marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre történő beállítására tett kísérleteket. Szükség szerint módosíthatja ezt a tulajdonságot, ha el szeretné forgatni a titkosítási kulcsot; Az adatok nem lesznek hatással. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el.

format

SynonymMapFormat

A szinonimatérkép formátuma. Jelenleg csak a "solr" formátum támogatott.

name

string

A szinonimatérkép neve.

synonyms

string

Szinonimaszabályok sorozata a megadott szinonimatérkép-formátumban. A szabályokat új vonalakkal kell elválasztani.

SynonymMapFormat

A szinonimatérkép formátuma. Jelenleg csak a "solr" formátum támogatott.

Name Típus Description
solr

string

A szinonimatérképek SOLR formátumát választja ki.