Compartilhar via


FileSharedAccessSignature Classe

Fornece uma fábrica para criar tokens de assinatura de acesso de arquivo e compartilhamento com um nome de conta comum e uma chave de conta. Os usuários podem usar a fábrica ou podem construir o serviço apropriado e usar o método generate_*_shared_access_signature diretamente.

Herança
FileSharedAccessSignature

Construtor

FileSharedAccessSignature(account_name, account_key)

Parâmetros

Nome Description
account_name
Obrigatório
str

O nome da conta de armazenamento usado para gerar as assinaturas de acesso compartilhado.

account_key
Obrigatório
str

A chave de acesso para gerar as assinaturas de acesso de compartilhamentos.

Métodos

generate_account

Gera uma assinatura de acesso compartilhado para a conta. Use a assinatura retornada com o parâmetro sas_token do serviço ou para criar um novo objeto de conta.

generate_file

Gera uma assinatura de acesso compartilhado para o arquivo. Use a assinatura retornada com o parâmetro sas_token de FileService.

generate_share

Gera uma assinatura de acesso compartilhado para o compartilhamento. Use a assinatura retornada com o parâmetro sas_token de FileService.

generate_account

Gera uma assinatura de acesso compartilhado para a conta. Use a assinatura retornada com o parâmetro sas_token do serviço ou para criar um novo objeto de conta.

generate_account(services, resource_types, permission, expiry, start=None, ip=None, protocol=None)

Parâmetros

Nome Description
services
Obrigatório
<xref:Services>

Especifica os serviços acessíveis com a SAS da conta. Você pode combinar valores para fornecer acesso a mais de um serviço.

resource_types
Obrigatório
<xref:ResourceTypes>

Especifica os tipos de recursos acessíveis com a SAS da conta. Você pode combinar valores para fornecer acesso a mais de um tipo de recurso.

permission
Obrigatório
<xref:AccountPermissions>

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. Você pode combinar valores para fornecer mais de uma permissão.

expiry
Obrigatório

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.

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
ip
str

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

valor padrão: None
protocol
str

Especifica o protocolo permitido para uma solicitação feita. O valor padrão é https,http. Consulte Protocol para saber os valores possíveis.

valor padrão: None

generate_file

Gera uma assinatura de acesso compartilhado para o arquivo. Use a assinatura retornada com o parâmetro sas_token de FileService.

generate_file(share_name, directory_name=None, file_name=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)

Parâmetros

Nome Description
share_name
Obrigatório
str

Nome do compartilhamento.

directory_name
str

Nome do diretório. Os tokens SAS não podem ser criados para diretórios, portanto, esse parâmetro só deve estar presente se file_name for fornecido.

valor padrão: None
file_name
str

Nome do arquivo.

valor padrão: None
permission

As permissões associadas à assinatura de acesso compartilhado. O usuário é restrito às operações permitidas pelas permissões. As permissões devem ser ordenadas para leitura, criação, gravação, exclusão, lista. 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
id
str

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

valor padrão: None
ip
str

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

valor padrão: None
protocol
str

Especifica o protocolo permitido para uma solicitação feita. O valor padrão é https,http. Consulte Protocol para saber os valores possíveis.

valor padrão: None
cache_control
str

Valor do cabeçalho de resposta para Cache-Control quando o recurso é acessado usando essa assinatura de acesso compartilhado.

valor padrão: None
content_disposition
str

Valor do cabeçalho de resposta para Content-Disposition quando o recurso é acessado usando essa assinatura de acesso compartilhado.

valor padrão: None
content_encoding
str

Valor do cabeçalho de resposta para Codificação de Conteúdo quando o recurso é acessado usando essa assinatura de acesso compartilhado.

valor padrão: None
content_language
str

Valor do cabeçalho de resposta para Content-Language quando o recurso é acessado usando essa assinatura de acesso compartilhado.

valor padrão: None
content_type
str

Valor do cabeçalho de resposta para Content-Type quando o recurso é acessado usando essa assinatura de acesso compartilhado.

valor padrão: None

generate_share

Gera uma assinatura de acesso compartilhado para o compartilhamento. Use a assinatura retornada com o parâmetro sas_token de FileService.

generate_share(share_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)

Parâmetros

Nome Description
share_name
Obrigatório
str

Nome do compartilhamento.

permission

As permissões associadas à assinatura de acesso compartilhado. O usuário é restrito às operações permitidas pelas permissões. As permissões devem ser ordenadas para leitura, criação, gravação, exclusão, lista. 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
id
str

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

valor padrão: None
ip
str

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

valor padrão: None
protocol
str

Especifica o protocolo permitido para uma solicitação feita. O valor padrão é https,http. Consulte Protocol para saber os valores possíveis.

valor padrão: None
cache_control
str

Valor do cabeçalho de resposta para Cache-Control quando o recurso é acessado usando essa assinatura de acesso compartilhado.

valor padrão: None
content_disposition
str

Valor do cabeçalho de resposta para Content-Disposition quando o recurso é acessado usando essa assinatura de acesso compartilhado.

valor padrão: None
content_encoding
str

Valor do cabeçalho de resposta para Codificação de Conteúdo quando o recurso é acessado usando essa assinatura de acesso compartilhado.

valor padrão: None
content_language
str

Valor do cabeçalho de resposta para Content-Language quando o recurso é acessado usando essa assinatura de acesso compartilhado.

valor padrão: None
content_type
str

Valor do cabeçalho de resposta para Content-Type quando o recurso é acessado usando essa assinatura de acesso compartilhado.

valor padrão: None