Partager via


AccessPolicy Classe

Classe De stratégie d’accès utilisée par les méthodes set et get acl dans chaque service.

Une stratégie d'accès stockée peut spécifier l'heure de début, l'heure d'expiration et les autorisations pour les signatures d'accès partagé auxquelles elle est associée. Selon la façon dont vous souhaitez contrôler l’accès à votre ressource, vous pouvez spécifier tous ces paramètres dans la stratégie d’accès stockée et les omettre de l’URL de la signature d’accès partagé. De cette façon, vous pouvez modifier le comportement de la signature associée à tout moment, de même que la révoquer. Vous pouvez aussi spécifier un ou plusieurs paramètres de stratégie d'accès dans la stratégie d'accès stockée et les autres dans l'URL. Enfin, vous pouvez spécifier tous les paramètres dans l'URL. Dans ce cas, vous pouvez utiliser la stratégie d'accès stockée pour révoquer la signature et non pour modifier son comportement.

La signature d'accès partagé et la stratégie d'accès stockée doivent inclure tous les champs obligatoires pour authentifier la signature. Si les champs obligatoires sont manquants, la demande échoue. De même, si un champ est spécifié dans l'URL de signature d'accès partagé et dans la stratégie d'accès stockée, la demande échoue avec le code d'état 400 (Requête incorrecte).

Héritage
azure.storage.fileshare._generated.models._models_py3.AccessPolicy
AccessPolicy

Constructeur

AccessPolicy(permission=None, expiry=None, start=None)

Paramètres

Nom Description
permission

Autorisations associées à la signature d'accès partagé. L'utilisateur est limité aux opérations autorisées par les autorisations. Obligatoire, sauf si un ID fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée.

valeur par défaut: None
expiry

Heure à laquelle la signature d’accès partagé devient non valide. Obligatoire, sauf si un ID fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée. Azure convertit toujours les valeurs en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC.

valeur par défaut: None
start

Heure à laquelle la signature d’accès partagé devient valide. En cas d'omission, l'heure de début de cet appel est supposée être l'heure à laquelle le service de stockage reçoit la demande. Azure convertit toujours les valeurs en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC.

valeur par défaut: None

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 :

  • 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.

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

Str utilisant la structure RestAPI. JSON par défaut.

content_type
str

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
str

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