queue Pacote
Pacote
| aio |
Classes
| AccessPolicy |
Classe de Política de Acesso utilizada pelo conjunto e obter métodos de política de acesso. Uma política de acesso armazenado 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 armazenado e omiti-los a partir do URL da Assinatura de Acesso Partilhado. Ao fazê-lo, permite-lhe modificar o comportamento da assinatura associada em qualquer altura, bem como revogá-la. Em alternativa, pode especificar um ou mais dos parâmetros da política de acesso na política de acesso armazenado e os outros no URL. Por fim, pode especificar todos os parâmetros no URL. Neste caso, pode utilizar a política de acesso armazenado 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 um campo for especificado no URL de Assinatura de Acesso Partilhado e na política de acesso armazenado, o pedido falhará com o código de estado 400 (Pedido Incorreto). |
| AccountSasPermissions |
ResourceTypes classe a utilizar com a função generate_account_sas e para as AccessPolicies utilizadas com set_*_acl. Existem dois tipos de SAS que podem ser utilizados 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 descodificação de mensagens para mensagens codificadas de base 64 em bytes. Descodifica mensagens codificadas com base64 para bytes. Se o conteúdo de entrada não for válido na base 64, será gerado um DecodeError. |
| BinaryBase64EncodePolicy |
Política de codificação de mensagens base 64 para mensagens binárias. Codifica mensagens binárias para a base 64. Se o conteúdo de entrada não for bytes, será gerado um TypeError. |
| CorsRule |
O CORS é uma funcionalidade HTTP que permite a execução de uma aplicação Web num domínio para aceder a recursos noutro domínio. Os browsers implementam uma restrição de segurança conhecida como política de origem idêntica, que impede uma página Web de chamar APIs num domínio diferente. O CORS é uma forma segura de permitir que um domínio (o domínio de origem) chame APIs de outro domínio. Todos os parâmetros necessários têm de ser preenchidos para serem enviados para o Azure. |
| ExponentialRetry |
Repetição exponencial. Constrói um objeto de repetição exponencial. O initial_backoff é utilizado 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 a localização para a qual o pedido deve ser enviado. Este modo aplica-se apenas a contas RA-GRS que permitem o acesso de leitura secundário. Todos os outros tipos de conta têm de utilizar PRIMARY. |
| Metrics |
Um resumo das estatísticas de pedido agrupadas pela API em agregações de hora ou minuto. Todos os parâmetros necessários têm de ser preenchidos para serem enviados para o Azure. |
| QueueAnalyticsLogging |
Definições do Registo do Azure Analytics. Todos os parâmetros necessários têm de ser preenchidos para serem enviados para o Azure. |
| QueueClient |
Um cliente para interagir com uma Fila específica. Para obter uma configuração mais opcional, clique aqui. |
| QueueMessage |
Representa uma mensagem de fila. |
| QueueProperties |
Propriedades da Fila. |
| QueueSasPermissions |
QueueSasPermissions class to be used with the generate_queue_sas function and for the AccessPolicies used with set_queue_access_policy. |
| QueueServiceClient |
Um cliente para interagir com o Serviço de Fila ao nível da conta. Este cliente fornece operações para obter e configurar as propriedades da conta, bem como listar, criar e eliminar filas na conta. Para operações relacionadas com uma fila específica, um cliente para esta entidade pode ser obtido com a get_queue_client função. Para obter uma configuração mais opcional, clique aqui. |
| ResourceTypes |
Especifica os tipos de recursos que estão acessíveis com a SAS da conta. |
| RetentionPolicy |
A política de retenção que determina durante quanto tempo os dados associados devem persistir. Todos os parâmetros necessários têm de ser preenchidos para serem enviados para o Azure. |
| TextBase64DecodePolicy |
Política de descodificação de mensagens para mensagens codificadas de base 64 em texto. Descodifica mensagens codificadas com base64 para texto (unicode). Se o conteúdo de entrada não for válido na base 64, será gerado um DecodeError. Os dados da mensagem têm de suportar UTF-8. |
| TextBase64EncodePolicy |
Política de codificação de mensagens base 64 para mensagens de texto. Codifica mensagens de texto (unicode) para a base 64. Se o conteúdo de entrada não for texto, será gerado um TypeError. O texto de entrada tem de suportar UTF-8. |
Enumerações
| StorageErrorCode |
Funções
generate_account_sas
Gera uma assinatura de acesso partilhado para o serviço de fila.
Utilize a assinatura devolvida 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) -> strParâmetros
- account_name
- str
O nome da conta de armazenamento utilizado para gerar a assinatura de acesso partilhado.
- account_key
- str
A chave de conta, também denominada chave partilhada ou chave de acesso, para gerar a assinatura de acesso partilhado.
- resource_types
- ResourceTypes
Especifica os tipos de recursos que estão acessíveis com a SAS da conta.
- permission
- AccountSasPermissions ou str
As permissões associadas à assinatura de acesso partilhado. O utilizador está restrito a operações permitidas pelas permissões.
O momento em que a assinatura de acesso partilhado se torna inválida. O Azure irá sempre converter valores em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC.
O momento em que a assinatura de acesso partilhado se torna válida. Se 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 uma data for transmitida sem informações de fuso horário, assume-se que é UTC.
- ip
- str
Especifica um endereço IP ou um intervalo de endereços IP a partir dos quais aceitar pedidos. Se o endereço IP a partir do qual o pedido é originado não corresponder ao endereço IP ou intervalo de endereços especificado no token de SAS, o pedido não é autenticado. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 no SAS restringe o pedido a esses endereços IP.
- protocol
- str
Especifica o protocolo permitido para um pedido feito. O valor predefinido é https.
Devoluções
Um token de Assinatura de Acesso Partilhado (sas).
Tipo de retorno
generate_queue_sas
Gera uma assinatura de acesso partilhado para uma fila.
Utilize a assinatura devolvida 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) -> strParâmetros
- account_name
- str
O nome da conta de armazenamento utilizado para gerar a assinatura de acesso partilhado.
- account_key
- str
A chave de conta, também denominada chave partilhada ou chave de acesso, para gerar a assinatura de acesso partilhado.
- permission
- QueueSasPermissions ou str
As permissões associadas à assinatura de acesso partilhado. O utilizador está restrito a operações permitidas pelas permissões. Necessário, a menos que seja dada uma policy_id referenciar uma política de acesso armazenado que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada.
O momento em que a assinatura de acesso partilhado se torna inválida. Necessário, a menos que seja dada uma policy_id referenciar uma política de acesso armazenado 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 uma data for transmitida sem informações de fuso horário, assume-se que é UTC.
O momento em que a assinatura de acesso partilhado se torna válida. Se 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 uma data for transmitida sem informações de fuso horário, assume-se que é UTC.
- policy_id
- str
Um valor exclusivo com até 64 carateres de comprimento que se correlaciona com uma política de acesso armazenada. Para criar uma política de acesso armazenada, utilize set_queue_access_policy.
- ip
- str
Especifica um endereço IP ou um intervalo de endereços IP a partir dos quais aceitar pedidos. Se o endereço IP a partir do qual o pedido é originado não corresponder ao endereço IP ou intervalo de endereços especificado no token de SAS, o pedido não é autenticado. Por exemplo, especificar sip='168.1.5.65' ou sip='168.1.5.60-168.1.5.70' no SAS restringe o pedido a esses endereços IP.
- protocol
- str
Especifica o protocolo permitido para um pedido feito. O valor predefinido é https.
Devoluções
Um token de Assinatura de Acesso Partilhado (sas).
Tipo de retorno
Exemplos
Gerar um token de 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'
)
Azure SDK for Python
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários