SearchResourceEncryptionKey Klass

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 Azure Cognitive Search, till exempel index och synonymkartor.

Alla obligatoriska parametrar måste fyllas i för att kunna skickas till Azure.

Arv

azure.search.documents.indexes._generated._serialization.Model

SearchResourceEncryptionKey

Konstruktor

SearchResourceEncryptionKey(**kwargs)

Variabler

Name	Description
key_name	str Krävs. Namnet på din Azure-Key Vault nyckel som ska användas för att kryptera dina vilande data.
key_version	str Krävs. Versionen av din Azure-Key Vault nyckel som ska användas för att kryptera dina vilande data.
vault_uri	str Krävs. URI:n för din Azure-Key Vault, även kallad DNS-namn, som innehåller nyckeln som ska användas för att kryptera dina vilande data. Ett exempel på en URI kan vara https://my– keyvault-name.vault.azure.net.
application_id	str Krävs. Ett AAD-program-ID som har beviljats nödvändiga åtkomstbehörigheter till Azure-Key Vault som ska användas när du krypterar dina vilande data. Program-ID:t bör inte förväxlas med objekt-ID:t för ditt AAD-program.
application_secret	str Autentiseringsnyckeln för det angivna AAD-programmet.

Metoder

as_dict	Returnera en diktamen som kan serialiseras med json.dump. Avancerad användning kan också använda ett återanrop som parameter: Nyckeln är det attributnamn som används i Python. Attr_desc är en dikta av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med RestAPI-kodad nyckel. Värdet är det aktuella värdet i det här objektet. Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt. Se de tre exemplen i den här filen: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.
deserialize	Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.
enable_additional_properties_sending
from_dict	Parsa en diktamen med hjälp av en viss nyckelextraktor returnerar en modell. Som standard bör du överväga viktiga extraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Returnera den JSON som skulle skickas till servern från den här modellen. Det här är ett alias för att as_dict(full_restapi_key_transformer, keep_readonly=False). Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

as_dict

Returnera en diktamen som kan serialiseras med json.dump.

Avancerad användning kan också använda ett återanrop som parameter:

Nyckeln är det attributnamn som används i Python. Attr_desc är en dikta av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med RestAPI-kodad nyckel. Värdet är det aktuella värdet i det här objektet.

Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt.

Se de tre exemplen i den här filen:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

Parametrar

Name	Description
key_transformer	<xref:function> En nyckeltransformatorfunktion.
keep_readonly	standardvärde: True

Returer

Typ	Description
dict	Ett dict JSON-kompatibelt objekt

deserialize

Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.

deserialize(data: Any, content_type: str | None = None) -> ModelType

Parametrar

Name	Description
data Obligatorisk	str En str som använder RestAPI-struktur. JSON som standard.
content_type	str JSON som standard anger du application/xml om XML. standardvärde: None

Returer

Typ	Description
	En instans av den här modellen

Undantag

Typ	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Parsa en diktamen med hjälp av en viss nyckelextraktor returnerar en modell.

Som standard bör du överväga viktiga extraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och last_rest_key_case_insensitive_extractor)

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

Parametrar

Name	Description
data Obligatorisk	dict En dikta med Hjälp av RestAPI-struktur
content_type	str JSON som standard anger du application/xml om XML. standardvärde: None
key_extractors	standardvärde: None

Returer

Typ	Description
	En instans av den här modellen

Undantag

Typ	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Returnera den JSON som skulle skickas till servern från den här modellen.

Det här är ett alias för att as_dict(full_restapi_key_transformer, keep_readonly=False).

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Parametrar

Name	Description
keep_readonly	bool Om du vill serialisera readonly-attributen standardvärde: False

Returer

Typ	Description
dict	Ett dict JSON-kompatibelt objekt