Metrics Classe
Résumé des statistiques de requête regroupées par API en agrégats d’heures ou de minutes.
Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.
- Héritage
-
azure.storage.queue._generated.models._models_py3.MetricsMetrics
Constructeur
Metrics(**kwargs: Any)
Paramètres de mot clé uniquement
Nom | Description |
---|---|
version
|
La version de Storage Analytics à configurer. |
enabled
|
Obligatoire. Indique si les métriques sont activées pour le service. |
include_apis
|
Indique si les métriques doivent générer des statistiques de synthèse pour les opérations d'API appelées. |
retention_policy
|
Stratégie de rétention pour les métriques. |
Méthodes
as_dict |
Retourne un dict qui peut être sérialisé à l’aide de json.dump. L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre : La clé est le nom d’attribut utilisé dans Python. Attr_desc est une dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle de cet objet. La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il est considéré comme un dict de résultat hiérarchique. Consultez les trois exemples de ce fichier :
Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True. |
deserialize |
Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle. |
enable_additional_properties_sending | |
from_dict |
Analyser une dict à l’aide de l’extracteur de clé donné retourne un modèle. Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et last_rest_key_case_insensitive_extractor) |
is_xml_model | |
serialize |
Retourne le json qui serait envoyé à Azure à partir de ce modèle. Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False). Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True. |
as_dict
Retourne un dict qui peut être sérialisé à l’aide de json.dump.
L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre :
La clé est le nom d’attribut utilisé dans Python. Attr_desc est une dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle de cet objet.
La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il est considéré comme un dict de résultat hiérarchique.
Consultez les trois exemples de ce fichier :
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Si vous souhaitez la sérialisation XML, vous pouvez passer les 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]
Paramètres
Nom | Description |
---|---|
key_transformer
|
<xref:function>
Fonction de transformateur de clé. |
keep_readonly
|
valeur par défaut: True
|
Retours
Type | Description |
---|---|
Objet compatible JSON dict |
deserialize
Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle.
deserialize(data: Any, content_type: str | None = None) -> ModelType
Paramètres
Nom | Description |
---|---|
data
Obligatoire
|
Str utilisant la structure RestAPI. JSON par défaut. |
content_type
|
JSON par défaut, définissez application/xml si XML. valeur par défaut: None
|
Retours
Type | Description |
---|---|
Une instance de ce modèle |
Exceptions
Type | Description |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> None
from_dict
Analyser une dict à l’aide de l’extracteur de clé donné retourne un modèle.
Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et 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
Paramètres
Nom | Description |
---|---|
data
Obligatoire
|
dict utilisant la structure RestAPI |
content_type
|
JSON par défaut, définissez application/xml si XML. valeur par défaut: None
|
key_extractors
|
valeur par défaut: None
|
Retours
Type | Description |
---|---|
Une instance de ce modèle |
Exceptions
Type | Description |
---|---|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> bool
serialize
Retourne le json qui serait envoyé à Azure à partir de ce modèle.
Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False).
Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True.
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]
Paramètres
Nom | Description |
---|---|
keep_readonly
|
Si vous souhaitez sérialiser les attributs readonly valeur par défaut: False
|
Retours
Type | Description |
---|---|
Objet compatible JSON dict |
Attributs
enabled
Indique si les métriques sont activées pour le service.
enabled: bool = False
include_apis
Indique si les métriques doivent générer des statistiques de synthèse pour les opérations d'API appelées.
include_apis: bool | None
retention_policy
Stratégie de rétention pour les métriques.
retention_policy: RetentionPolicy = <azure.storage.queue._models.RetentionPolicy object>
version
La version de Storage Analytics à configurer.
version: str = '1.0'
Azure SDK for Python