PoolListUsageMetricsOptions Třída

  • Reference

Další parametry pro operaci list_usage_metrics

Dědičnost
Model
PoolListUsageMetricsOptions

Konstruktor

PoolListUsageMetricsOptions(*, start_time=None, end_time=None, filter: str = None, max_results: int = 1000, timeout: int = 30, client_request_id: str = None, return_client_request_id: bool = False, ocp_date=None, **kwargs)

Parametry

start_time
datetime
Vyžadováno

Nejstarší čas, od kterého se mají zahrnout metriky. Musí to být nejméně dvě a půl hodiny před aktuálním časem. Pokud není zadaný, použije se výchozí čas zahájení posledního aktuálně dostupného intervalu agregace.

end_time
datetime
Vyžadováno

Poslední čas, od kterého chcete zahrnout metriky. To musí být nejméně dvě hodiny před aktuálním časem. Pokud není zadaný, použije se výchozí koncový čas posledního aktuálně dostupného intervalu agregace.

filter
str
Vyžadováno

Klauzule $filter OData. Další informace o vytváření tohoto filtru najdete v tématu https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.

max_results
int
Vyžadováno

Maximální počet položek, které se mají vrátit v odpovědi. Vrátí se maximálně 1000 výsledků. Výchozí hodnota: 1000 .

timeout
int
Vyžadováno

Maximální čas, který může server strávit zpracováním požadavku, v sekundách. Výchozí hodnota je 30 sekund. Výchozí hodnota: 30 .

client_request_id
str
Vyžadováno

Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez ozdob, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return_client_request_id
bool
Vyžadováno

Jestli má server v odpovědi vrátit client-request-id. Výchozí hodnota: False .

ocp_date
datetime
Vyžadováno

Čas, kdy byla žádost vystavena. Klientské knihovny obvykle tuto možnost nastaví na aktuální systémový čas. pokud přímo voláte rozhraní REST API, nastavte ho explicitně.

Metody

as_dict

Vrátí dikt, který může být JSONify pomocí json.dump.

Rozšířené využití může volitelně použít zpětné volání jako parametr:

Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. V současné době obsahuje "type" s typem msrest a "key" s klíčem kódovaným restAPI. Hodnota je aktuální hodnota v tomto objektu.

Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se za hierarchický dikt výsledku.

Podívejte se na tři příklady v tomto souboru:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.
deserialize

Parsujte str pomocí syntaxe RestAPI a vraťte model.
enable_additional_properties_sending
from_dict

Analýza diktu pomocí daného extraktoru klíčů vrátí model.

Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a last_rest_key_case_insensitive_extractor).
is_xml_model
serialize

Vrátí kód JSON, který se z tohoto modelu odešle do Azure.

Toto je alias pro as_dict(full_restapi_key_transformer; keep_readonly=False).

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.
validate

Rekurzivně ověřte tento model a vraťte seznam ValidationError.

as_dict

Vrátí dikt, který může být JSONify pomocí json.dump.

Rozšířené využití může volitelně použít zpětné volání jako parametr:

Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. V současné době obsahuje "type" s typem msrest a "key" s klíčem kódovaným restAPI. Hodnota je aktuální hodnota v tomto objektu.

Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se za hierarchický dikt výsledku.

Podívejte se na tři příklady v tomto souboru:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parametry

key_transformer
<xref:function>

Funkce klíčového transformátoru.

keep_readonly
výchozí hodnota: True

Návraty

Objekt kompatibilní s diktem JSON

Návratový typ

dict

deserialize

Parsujte str pomocí syntaxe RestAPI a vraťte model.

deserialize(data, content_type=None)

Parametry

data
str
Vyžadováno

Str používající strukturu RestAPI. Ve výchozím nastavení JSON.

content_type
str
výchozí hodnota: None

Ve výchozím nastavení JSON nastavte application/xml, pokud XML.

Návraty

Instance tohoto modelu

Výjimky

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

Analýza diktu pomocí daného extraktoru klíčů vrátí model.

Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a last_rest_key_case_insensitive_extractor).

from_dict(data, key_extractors=None, content_type=None)

Parametry

data
dict
Vyžadováno

Diktování pomocí struktury RestAPI

content_type
str
výchozí hodnota: None

Ve výchozím nastavení JSON nastavte application/xml, pokud XML.

key_extractors
výchozí hodnota: None

Návraty

Instance tohoto modelu

Výjimky

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

Vrátí kód JSON, který se z tohoto modelu odešle do Azure.

Toto je alias pro as_dict(full_restapi_key_transformer; keep_readonly=False).

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parametry

keep_readonly
bool
výchozí hodnota: False

Pokud chcete serializovat atributy readonly

Návraty

Objekt kompatibilní s diktem JSON

Návratový typ

dict

validate

Rekurzivně ověřte tento model a vraťte seznam ValidationError.

validate()

Návraty

Seznam chyb ověření

Návratový typ

list