queue Pacote

  • Referência

Pacotes

aio

Classes

AccessPolicy

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).
AccountSasPermissions

ResourceTypes classe a ser usada com generate_account_sas função e para o AccessPolicies usado com set_*_acl. Há dois tipos de SAS que podem ser usados para conceder acesso a recursos. Uma delas é conceder acesso a um recurso específico (específico do recurso). Outra é conceder acesso a todo o serviço para uma conta específica e permitir determinadas operações com base em perms encontrados aqui.
BinaryBase64DecodePolicy

Política de decodificação de mensagens para mensagens codificadas em base 64 em bytes.

Decodifica mensagens codificadas em base64 para bytes. Se o conteúdo de entrada não for base 64 válido, um DecodeError será gerado.
BinaryBase64EncodePolicy

Política de codificação de mensagens base 64 para mensagens binárias.

Codifica mensagens binárias na base 64. Se o conteúdo de entrada não for bytes, um TypeError será gerado.
CorsRule

O CORS é um recurso HTTP que permite que um aplicativo web em execução em um domínio acesse recursos em outro domínio. Os navegadores da Web implementam uma restrição de segurança conhecida como política de mesma origem que evita que uma página da Web chame as APIs em um domínio diferente; o CORS fornece uma maneira segura de permitir que um domínio (o domínio de origem) chame APIs em outro domínio.

Todos os parâmetros necessários devem ser preenchidos para enviar ao Azure.
ExponentialRetry

Repetição exponencial.

Constrói um objeto de repetição exponencial. O initial_backoff é usado para a primeira repetição. As repetições subsequentes são repetidas após initial_backoff + increment_power^retry_count segundos.
LinearRetry

Repetição linear.

Constrói um objeto de repetição Linear.
LocationMode

Especifica o local para o qual a solicitação deve ser enviada. Esse modo só se aplica a contas RA-GRS que permitem acesso de leitura secundário. Todos os outros tipos de conta devem usar PRIMARY.
Metrics

Um resumo das estatísticas de solicitação agrupadas pela API em agregações de hora ou minuto.

Todos os parâmetros necessários devem ser preenchidos para enviar ao Azure.
QueueAnalyticsLogging

Configurações de log do Azure Analytics.

Todos os parâmetros necessários devem ser preenchidos para enviar ao Azure.
QueueClient

Um cliente para interagir com uma Fila específica.

Para obter mais configurações opcionais, clique aqui.
QueueMessage

Representa uma mensagem de fila.
QueueProperties

Propriedades da Fila.
QueueSasPermissions

Classe QueueSasPermissions a ser usada com a generate_queue_sas função e para o AccessPolicies usado com set_queue_access_policy.
QueueServiceClient

Um cliente para interagir com o Serviço de Fila no nível da conta.

Esse cliente fornece operações para recuperar e configurar as propriedades da conta, bem como listar, criar e excluir filas dentro da conta. Para operações relacionadas a uma fila específica, um cliente para essa entidade pode ser recuperado usando a get_queue_client função .

Para obter mais configurações opcionais, clique aqui.
ResourceTypes

Especifica os tipos de recursos acessíveis com a SAS da conta.
RetentionPolicy

A política de retenção que determina por quanto tempo os dados associados devem persistir.

Todos os parâmetros necessários devem ser preenchidos para enviar ao Azure.
TextBase64DecodePolicy

Política de decodificação de mensagens para mensagens codificadas em base 64 em texto.

Decodifica mensagens codificadas em base64 para texto (unicode). Se o conteúdo de entrada não for base 64 válido, um DecodeError será gerado. Os dados da mensagem devem dar suporte a UTF-8.
TextBase64EncodePolicy

Política de codificação de mensagens base 64 para mensagens de texto.

Codifica mensagens de texto (unicode) na base 64. Se o conteúdo de entrada não for texto, um TypeError será gerado. O texto de entrada deve dar suporte a UTF-8.

Enumerações

StorageErrorCode

Funções

generate_account_sas

Gera uma assinatura de acesso compartilhado para o serviço de fila.

Use a assinatura retornada com o parâmetro de credencial de qualquer Serviço de Fila.

generate_account_sas(account_name: str, account_key: str, resource_types: ResourceTypes | str, permission: AccountSasPermissions | str, expiry: datetime | str, start: datetime | str | None = None, ip: str | None = None, **kwargs: Any) -> str

Parâmetros

account_name
str
Obrigatório

O nome da conta de armazenamento usado para gerar a assinatura de acesso compartilhado.

account_key
str
Obrigatório

A chave da conta, também chamada de chave compartilhada ou chave de acesso, para gerar a assinatura de acesso compartilhado.

resource_types
ResourceTypes
Obrigatório

Especifica os tipos de recursos acessíveis com a SAS da conta.

permission
AccountSasPermissions ou str
Obrigatório

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

expiry
datetime ou str
Obrigatório

O momento em que a assinatura de acesso compartilhado se torna inválida. O Azure sempre converterá valores em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC.

start
datetime ou str
valor padrão: None

O momento 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, supõe-se que seja UTC.

ip
str
valor padrão: None

Especifica um endereço IP ou um intervalo de endereços IP dos quais aceitar solicitações. Se o endereço IP do qual a solicitação se origina não corresponder ao endereço IP ou intervalo de endereços especificado no token SAS, a solicitação não será autenticada. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 na SAS restringe a solicitação a esses endereços IP.

protocol
str

Especifica o protocolo permitido para uma solicitação feita. O valor padrão é https.

Retornos

Um token sas (Assinatura de Acesso Compartilhado).

Tipo de retorno

str

generate_queue_sas

Gera uma assinatura de acesso compartilhado para uma fila.

Use a assinatura retornada com o parâmetro de credencial de qualquer Serviço de Fila.

generate_queue_sas(account_name: str, queue_name: str, account_key: str, permission: QueueSasPermissions | str | None = None, expiry: datetime | str | None = None, start: datetime | str | None = None, policy_id: str | None = None, ip: str | None = None, **kwargs: Any) -> str

Parâmetros

account_name
str
Obrigatório

O nome da conta de armazenamento usado para gerar a assinatura de acesso compartilhado.

queue_name
str
Obrigatório

O nome da fila.

account_key
str
Obrigatório

A chave da conta, também chamada de chave compartilhada ou chave de acesso, para gerar a assinatura de acesso compartilhado.

permission
QueueSasPermissions ou str
valor padrão: None

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

expiry
datetime ou str
valor padrão: None

O momento em que a assinatura de acesso compartilhado se torna inválida. Obrigatório, a menos que um policy_id seja dado referenciando uma política de acesso armazenada que contenha 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, supõe-se que seja UTC.

start
datetime ou str
valor padrão: None

O momento 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, supõe-se que seja UTC.

policy_id
str
valor padrão: None

Um valor exclusivo de até 64 caracteres de comprimento que se correlaciona a uma política de acesso armazenada. Para criar uma política de acesso armazenada, use set_queue_access_policy.

ip
str
valor padrão: None

Especifica um endereço IP ou um intervalo de endereços IP dos quais aceitar solicitações. Se o endereço IP do qual a solicitação se origina não corresponder ao endereço IP ou intervalo de endereços especificado no token SAS, a solicitação não será autenticada. Por exemplo, especificar sip='168.1.5.65' ou sip='168.1.5.60-168.1.5.70' na SAS restringe a solicitação a esses endereços IP.

protocol
str

Especifica o protocolo permitido para uma solicitação feita. O valor padrão é https.

Retornos

Um token sas (Assinatura de Acesso Compartilhado).

Tipo de retorno

str

Exemplos

Gere um token sas.


   from azure.storage.queue import generate_queue_sas
   sas_token = generate_queue_sas(
       queue.account_name,
       queue.queue_name,
       queue.credential.account_key,
       policy_id='my-access-policy-id'
   )