AccessPolicy Classe

Classe política de acesso usada 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 para as Assinaturas de Acesso Compartilhado às quais ela está associada. Dependendo de como você deseja controlar o acesso ao recurso, você pode especificar todos esses parâmetros dentro da política de acesso armazenada e omiti-los da URL para a Assinatura de Acesso Compartilhado. Fazer isso permite modificar o comportamento da assinatura associada a qualquer momento, bem como revogá-la. Ou você pode especificar um ou mais dos parâmetros de política de acesso na política de acesso armazenada e os outros na URL. Por fim, você pode especificar todos os parâmetros na URL. Nesse caso, é possível usar a política de acesso armazenada para revogar a assinatura, mas não para modificar seu comportamento.

Juntas, a Assinatura de Acesso Compartilhado e a política de acesso armazenada devem incluir todos os campos necessários para autenticar a assinatura. Se qualquer campo obrigatório estiver ausente, a solicitação falhará. Da mesma forma, se um campo for especificado na URL da Assinatura de Acesso Compartilhado e na política de acesso armazenada, ocorrerá uma falha na solicitação com o código de status 400 (Solicitação Incorreta).

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

Nome Description
permission

As permissões associadas à assinatura de acesso compartilhado. O usuário é restrito às operações permitidas pelas permissões. Obrigatório, a menos que uma ID seja fornecida referenciando uma política de acesso armazenada que contém esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada.

valor padrão: None
expiry

A hora em que a assinatura de acesso compartilhado se torna inválida. Obrigatório, a menos que uma ID seja fornecida referenciando uma política de acesso armazenada que contém esse campo. Este campo deverá ser omitido se tiver sido especificado em uma política de acesso armazenada associada. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC.

valor padrão: None
start

A hora em que a assinatura de acesso compartilhado se torna válida. Se for omitido, a hora de início para essa chamada será presumida como a hora na qual o serviço de armazenamento recebe a solicitação. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC.

valor padrão: None

Métodos

as_dict

Retornar um dict que pode ser serializado usando json.dump.

Opcionalmente, o uso avançado pode usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um dict de metadados. Atualmente contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto .

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.

enable_additional_properties_sending
from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

Retorne o JSON que seria enviado para o azure desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

as_dict

Retornar um dict que pode ser serializado usando json.dump.

Opcionalmente, o uso avançado pode usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um dict de metadados. Atualmente contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto .

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se você quiser serialização XML, poderá passar 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

Nome Description
key_transformer
<xref:function>

Uma função de transformador de chave.

keep_readonly
valor padrão: True

Retornos

Tipo Description

Um objeto compatível com JSON de dict

deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.

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

Parâmetros

Nome Description
data
Obrigatório
str

Um str usando a estrutura RestAPI. JSON por padrão.

content_type
str

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

valor padrão: None

Retornos

Tipo Description

Uma instância desse modelo

Exceções

Tipo Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de 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

Nome Description
data
Obrigatório

Um ditado usando a estrutura RestAPI

content_type
str

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

valor padrão: None
key_extractors
valor padrão: None

Retornos

Tipo Description

Uma instância desse modelo

Exceções

Tipo Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Retorne o JSON que seria enviado para o azure desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

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

Parâmetros

Nome Description
keep_readonly

Se você quiser serializar os atributos somente leitura

valor padrão: False

Retornos

Tipo Description

Um objeto compatível com JSON de dict

Atributos

expiry

A hora em que a assinatura de acesso compartilhado se torna inválida.

expiry: datetime | str | None

permission

As permissões associadas à assinatura de acesso compartilhado. O usuário é restrito às operações permitidas pelas permissões.

permission: QueueSasPermissions | str | None

start

A hora em que a assinatura de acesso compartilhado se torna válida.

start: datetime | str | None