Partilhar via


AccessPolicy Classe

Classe de Política de Acesso utilizada pelo conjunto e obter métodos de política de acesso.

Uma política de acesso armazenada pode especificar a hora de início, a hora de expiração e as permissões das Assinaturas de Acesso Partilhado com as quais está associada. Consoante a forma como pretende controlar o acesso ao recurso, pode especificar todos estes parâmetros na política de acesso armazenada e omiti-los a partir do URL da Assinatura de Acesso Partilhado. Ao fazê-lo, pode modificar o comportamento da assinatura associada em qualquer altura, bem como revogá-lo. Em alternativa, pode especificar um ou mais dos parâmetros da política de acesso na política de acesso armazenada e os outros no URL. Por fim, pode especificar todos os parâmetros no URL. Neste caso, pode utilizar a política de acesso armazenada para revogar a assinatura, mas não para modificar o respetivo comportamento.

Em conjunto, a Assinatura de Acesso Partilhado e a política de acesso armazenado têm de incluir todos os campos necessários para autenticar a assinatura. Se existirem campos necessários em falta, o pedido falhará. Da mesma forma, se for especificado um campo no URL da Assinatura de Acesso Partilhado e na política de acesso armazenada, o pedido falhará com o código de estado 400 (Pedido Incorreto).

Herança
azure.storage.queue._generated.models._models_py3.AccessPolicy
AccessPolicy

Construtor

AccessPolicy(permission: QueueSasPermissions | str | None = None, expiry: datetime | str | None = None, start: datetime | str | None = None)

Parâmetros

Name Description
permission

As permissões associadas à assinatura de acesso partilhado. O utilizador está restrito a operações permitidas pelas permissões. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada.

valor predefinido: None
expiry

O momento em que a assinatura de acesso partilhado se torna inválida. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC.

valor predefinido: None
start

O momento em que a assinatura de acesso partilhado se torna válida. Se for omitido, assume-se que a hora de início desta chamada é a hora em que o serviço de armazenamento recebe o pedido. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC.

valor predefinido: None

Métodos

as_dict

Devolver um ditado que pode ser serializado com json.dump.

Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro:

A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente, contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. O valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict de resultado hierárquico.

Veja os três exemplos neste ficheiro:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

deserialize

Analise um str com a sintaxe RestAPI e devolva um modelo.

enable_additional_properties_sending
from_dict

Analisar um ditado com um determinado extrator de chaves devolve um modelo.

Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

Devolver o JSON que seria enviado para o Azure a partir deste modelo.

Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso).

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

as_dict

Devolver um ditado que pode ser serializado com json.dump.

Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro:

A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente, contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. O valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict de resultado hierárquico.

Veja os três exemplos neste ficheiro:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se quiser serialização XML, pode transmitir os 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]

Parâmetros

Name Description
key_transformer
<xref:function>

Uma função de transformador de chaves.

keep_readonly
valor predefinido: True

Devoluções

Tipo Description

Um objeto compatível com JSON de ditado

deserialize

Analise um str com a sintaxe RestAPI e devolva um modelo.

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

Parâmetros

Name Description
data
Necessário
str

Um str com a estrutura RestAPI. JSON por predefinição.

content_type
str

JSON por predefinição, defina application/xml se XML.

valor predefinido: None

Devoluções

Tipo Description

Uma instância deste modelo

Exceções

Tipo Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analisar um ditado com um determinado extrator de chaves devolve um modelo.

Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e 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

Parâmetros

Name Description
data
Necessário

Um ditado com a estrutura restAPI

content_type
str

JSON por predefinição, defina application/xml se XML.

valor predefinido: None
key_extractors
valor predefinido: None

Devoluções

Tipo Description

Uma instância deste modelo

Exceções

Tipo Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Devolver o JSON que seria enviado para o Azure a partir deste modelo.

Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso).

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

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

Parâmetros

Name Description
keep_readonly

Se quiser serializar os atributos só de leitura

valor predefinido: False

Devoluções

Tipo Description

Um objeto compatível com JSON de ditado

Atributos

expiry

O momento em que a assinatura de acesso partilhado se torna inválida.

expiry: datetime | str | None

permission

As permissões associadas à assinatura de acesso partilhado. O utilizador está restrito a operações permitidas pelas permissões.

permission: QueueSasPermissions | str | None

start

O momento em que a assinatura de acesso partilhado se torna válida.

start: datetime | str | None