SearchResourceEncryptionKey Klasa

Klucz szyfrowania zarządzanego przez klienta w usłudze Azure Key Vault. Klucze tworzone i zarządzane mogą służyć do szyfrowania lub odszyfrowywania danych magazynowanych w Azure Cognitive Search, takich jak indeksy i mapy synonimów.

Aby wysyłać na platformę Azure wszystkie wymagane parametry, należy wypełnić wszystkie wymagane parametry.

Dziedziczenie

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

SearchResourceEncryptionKey

Konstruktor

SearchResourceEncryptionKey(**kwargs)

Zmienne

Nazwa	Opis
key_name	str Wymagane. Nazwa klucza usługi Azure Key Vault, który ma być używany do szyfrowania danych magazynowanych.
key_version	str Wymagane. Wersja klucza usługi Azure Key Vault używana do szyfrowania danych magazynowanych.
vault_uri	str Wymagane. Identyfikator URI Key Vault platformy Azure, nazywany również nazwą DNS, który zawiera klucz używany do szyfrowania danych magazynowanych. Przykładowy identyfikator URI może być — https://mykeyvault-name.vault.azure.net.
application_id	str Wymagane. Identyfikator aplikacji usługi AAD, który otrzymał wymagane uprawnienia dostępu do usługi Azure Key Vault, który ma być używany podczas szyfrowania danych magazynowanych. Identyfikator aplikacji nie powinien być mylony z identyfikatorem obiektu aplikacji usługi AAD.
application_secret	str Klucz uwierzytelniania określonej aplikacji usługi AAD.

Metody

as_dict	Zwróć dykt, który można serializować przy użyciu pliku json.dump. Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru: Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym w interfejsie RESTAPI. Wartość jest bieżącą wartością w tym obiekcie. Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uważane za hierarchiczne dykt wyniku. Zobacz trzy przykłady w tym pliku: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.
deserialize	Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.
enable_additional_properties_sending
from_dict	Przeanalizuj dykt przy użyciu danego wyodrębniającego klucz zwraca model. Domyślnie należy wziąć pod uwagę wyodrębniacze kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Zwróć kod JSON, który zostanie wysłany do serwera z tego modelu. Jest to alias as_dict(full_restapi_key_transformer, keep_readonly=False). Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

as_dict

Zwróć dykt, który można serializować przy użyciu pliku json.dump.

Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru:

Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym w interfejsie RESTAPI. Wartość jest bieżącą wartością w tym obiekcie.

Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uważane za hierarchiczne dykt wyniku.

Zobacz trzy przykłady w tym pliku:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Jeśli chcesz serializacji XML, możesz przekazać 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]

Parametry

Nazwa	Opis
key_transformer	<xref:function> Funkcja przekształcania klucza.
keep_readonly	wartość domyślna: True

Zwraca

Typ	Opis
dict	Obiekt zgodny z JSON w formacie JSON

deserialize

Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.

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

Parametry

Nazwa	Opis
data Wymagane	str Str używający struktury RestAPI. Domyślnie kod JSON.
content_type	str Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML. wartość domyślna: None

Zwraca

Typ	Opis
	Wystąpienie tego modelu

Wyjątki

Typ	Opis
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Przeanalizuj dykt przy użyciu danego wyodrębniającego klucz zwraca model.

Domyślnie należy wziąć pod uwagę wyodrębniacze kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i 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

Parametry

Nazwa	Opis
data Wymagane	dict Dykt używający struktury RESTAPI
content_type	str Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML. wartość domyślna: None
key_extractors	wartość domyślna: None

Zwraca

Typ	Opis
	Wystąpienie tego modelu

Wyjątki

Typ	Opis
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Zwróć kod JSON, który zostanie wysłany do serwera z tego modelu.

Jest to alias as_dict(full_restapi_key_transformer, keep_readonly=False).

Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.

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

Parametry

Nazwa	Opis
keep_readonly	bool Jeśli chcesz serializować atrybuty readonly wartość domyślna: False

Zwraca

Typ	Opis
dict	Obiekt zgodny z JSON w formacie JSON