ShareClient Classe
Um cliente para interagir com um compartilhamento específico, embora esse compartilhamento ainda não exista.
Para operações relacionadas a um diretório ou arquivo específico nesse compartilhamento, os clientes dessas entidades também podem ser recuperados usando as get_directory_client funções e get_file_client .
Para obter mais configurações opcionais, clique aqui.
- Herança
-
azure.storage.fileshare._shared.base_client.StorageAccountHostsMixinShareClient
Construtor
ShareClient(account_url: str, share_name: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, *, token_intent: Literal['backup'] | None = None, **kwargs: Any)
Parâmetros
- account_url
- str
O URI para a conta de armazenamento. Para criar um cliente dado o URI completo para o compartilhamento, use o from_share_url classmethod.
- snapshot
- str
Um compartilhamento opcional instantâneo no qual operar. Pode ser a cadeia de caracteres de ID instantâneo ou a resposta retornada de create_snapshot.
- credential
As credenciais com as quais autenticar. Isso será opcional se a URL da conta já tiver um token SAS. O valor pode ser uma cadeia de caracteres de token SAS, uma instância de um AzureSasCredential ou AzureNamedKeyCredential de azure.core.credentials, uma chave de acesso compartilhado de conta ou uma instância de uma classe TokenCredentials de azure.identity. Se o URI do recurso já contiver um token SAS, isso será ignorado em favor de uma credencial explícita
- exceto no caso de AzureSasCredential, em que os tokens SAS conflitantes gerarão um ValueError. Se estiver usando uma instância de AzureNamedKeyCredential, "name" deverá ser o nome da conta de armazenamento e "key" deverá ser a chave da conta de armazenamento.
- token_intent
- Literal['backup']
Necessário ao usar TokenCredential para autenticação e ignorado para outras formas de autenticação. Especifica a intenção para todas as solicitações ao usar a autenticação TokenCredential . Os valores possíveis são:
backup – especifica que as solicitações são destinadas a operações de tipo de backup/administrador, o que significa que todas as ACLs de arquivo/diretório são ignoradas e permissões completas são concedidas. O usuário também deve ter a permissão RBAC necessária.
- allow_trailing_dot
- bool
Se for true, o ponto à direita não será cortado do URI de destino.
- allow_source_trailing_dot
- bool
Se for true, o ponto à direita não será cortado do URI de origem.
- api_version
- str
A versão da API de Armazenamento a ser usada para solicitações. O valor padrão é a versão de serviço mais recente compatível com o SDK atual. A configuração para uma versão mais antiga pode resultar em redução da compatibilidade de recursos.
Novo na versão 12.1.0.
- secondary_hostname
- str
O nome do host do ponto de extremidade secundário.
- max_range_size
- int
O tamanho máximo do intervalo usado para um upload de arquivo. O padrão é 4*1024*1024
.
Métodos
acquire_lease |
Solicita uma nova concessão. Se o compartilhamento não tiver uma concessão ativa, o Serviço de Compartilhamento criará uma concessão no compartilhamento e retornará uma nova concessão. Novo na versão 12.5.0. |
close |
Esse método é para fechar os soquetes abertos pelo cliente. Ele não precisa ser usado ao usar com um gerenciador de contexto. |
create_directory |
Cria um diretório no compartilhamento e retorna um cliente para interagir com o diretório. |
create_permission_for_share |
Crie uma permissão (um descritor de segurança) no nível do compartilhamento. Essa 'permissão' pode ser usada para os arquivos/diretórios no compartilhamento. Se já existir uma 'permissão', ela retornará a chave dela, caso contrário, criará uma nova permissão no nível do compartilhamento e retornará sua chave. |
create_share |
Cria um novo compartilhamento na conta. Se já existir um compartilhamento com o mesmo nome, a operação falhará. |
create_snapshot |
Cria uma instantâneo do compartilhamento. Um instantâneo é uma versão somente leitura de um compartilhamento que é obtido em um ponto no tempo. Ele pode ser lido, copiado ou excluído, mas não modificado. Os instantâneos fornecem uma maneira de fazer backup de um compartilhamento como ele aparece em um momento no tempo. Um instantâneo de um compartilhamento tem o mesmo nome que o compartilhamento base do qual o instantâneo é obtido, com um valor DateTime acrescentado para indicar o momento em que o instantâneo foi obtido. |
delete_directory |
Marca o diretório para exclusão. O diretório é posteriormente excluído durante a coleta de lixo. |
delete_share |
Marca o compartilhamento especificado para exclusão. O compartilhamento é posteriormente excluído durante a coleta de lixo. |
from_connection_string |
Criar ShareClient a partir de uma cadeia de conexão. |
from_share_url | |
get_directory_client |
Faça com que um cliente interaja com o diretório especificado. O diretório ainda não precisa existir. |
get_file_client |
Faça com que um cliente interaja com o arquivo especificado. O arquivo ainda não precisa existir. |
get_permission_for_share |
Obtenha uma permissão (um descritor de segurança) para uma determinada chave. Essa "permissão" pode ser usada para os arquivos/diretórios no compartilhamento. |
get_share_access_policy |
Obtém as permissões para o compartilhamento. As permissões indicam se os arquivos em um compartilhamento podem ser acessados publicamente. |
get_share_properties |
Retorna todos os metadados definidos pelo usuário e as propriedades do sistema para o compartilhamento especificado. Os dados retornados não incluem a lista de arquivos ou diretórios dos compartilhamentos. |
get_share_stats |
Obtém o tamanho aproximado dos dados armazenados no compartilhamento em bytes. Observe que esse valor pode não incluir todos os arquivos recém-criados ou redimensionados recentemente. |
list_directories_and_files |
Lista os diretórios e arquivos no compartilhamento. |
set_share_access_policy |
Define as permissões para o compartilhamento ou as políticas de acesso armazenadas que podem ser usadas com assinaturas de acesso compartilhado. As permissões indicam se os arquivos em um compartilhamento podem ser acessados publicamente. |
set_share_metadata |
Define os metadados para o compartilhamento. Cada chamada para essa operação substitui todos os metadados existentes anexados ao compartilhamento. Para remover todos os metadados do compartilhamento, chame essa operação sem um ditado de metadados. |
set_share_properties |
Define as propriedades de compartilhamento. Novo na versão 12.4.0. |
set_share_quota |
Define a cota para o compartilhamento. |
acquire_lease
Solicita uma nova concessão.
Se o compartilhamento não tiver uma concessão ativa, o Serviço de Compartilhamento criará uma concessão no compartilhamento e retornará uma nova concessão.
Novo na versão 12.5.0.
acquire_lease(**kwargs: Any) -> ShareLeaseClient
Parâmetros
- lease_duration
- int
Especifica a duração de concessão, em segundos, ou um negativo (- 1) para uma concessão que nunca expira. A duração de uma concessão não infinita pode ser entre 15 e 60 segundos. Uma duração de concessão não pode ser alterada usando renovação ou alteração. O padrão é -1 (concessão infinita).
- lease_id
- str
ID proposta da concessão, em um formato de cadeia de caracteres GUID. O Serviço de Compartilhamento retornará 400 (solicitação inválida) se a ID de concessão proposta não estiver no formato correto.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.
Retornos
Um objeto ShareLeaseClient.
Tipo de retorno
Exemplos
Adquirir uma concessão em um compartilhamento.
share.create_directory("mydir")
lease = share.acquire_lease()
share.get_share_properties(lease=lease)
share.delete_share(lease=lease)
close
Esse método é para fechar os soquetes abertos pelo cliente. Ele não precisa ser usado ao usar com um gerenciador de contexto.
close()
create_directory
Cria um diretório no compartilhamento e retorna um cliente para interagir com o diretório.
create_directory(directory_name: str, **kwargs: Any) -> ShareDirectoryClient
Parâmetros
- metadata
Pares nome-valor associados ao diretório como metadados.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.
Retornos
ShareDirectoryClient
Tipo de retorno
create_permission_for_share
Crie uma permissão (um descritor de segurança) no nível do compartilhamento.
Essa 'permissão' pode ser usada para os arquivos/diretórios no compartilhamento. Se já existir uma 'permissão', ela retornará a chave dela, caso contrário, criará uma nova permissão no nível do compartilhamento e retornará sua chave.
create_permission_for_share(file_permission: str, **kwargs: Any) -> str
Parâmetros
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.
Retornos
Uma chave de permissão de arquivo
Tipo de retorno
create_share
Cria um novo compartilhamento na conta. Se já existir um compartilhamento com o mesmo nome, a operação falhará.
create_share(**kwargs: Any) -> Dict[str, Any]
Parâmetros
- quota
- int
A cota a ser alocada.
- access_tier
Especifica a camada de acesso do compartilhamento. Valores possíveis: 'TransactionOptimized', 'Hot', 'Cool'
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.
- protocols
- str ou ShareProtocols
Protocolos a serem habilitados no compartilhamento. Somente um protocolo pode ser habilitado no compartilhamento.
- root_squash
- str ou ShareRootSquash
O combinação por squash raiz a ser definido no compartilhamento. Válido somente para compartilhamentos NFS. Os valores possíveis incluem: 'NoRootSquash', 'RootSquash', 'AllSquash'.
Retornos
Dict de propriedade atualizado por compartilhamento (Etag e última modificação).
Tipo de retorno
Exemplos
Cria um compartilhamento de arquivos.
# Create share with Access Tier set to Hot
share.create_share(access_tier=ShareAccessTier("Hot"))
create_snapshot
Cria uma instantâneo do compartilhamento.
Um instantâneo é uma versão somente leitura de um compartilhamento que é obtido em um ponto no tempo. Ele pode ser lido, copiado ou excluído, mas não modificado. Os instantâneos fornecem uma maneira de fazer backup de um compartilhamento como ele aparece em um momento no tempo.
Um instantâneo de um compartilhamento tem o mesmo nome que o compartilhamento base do qual o instantâneo é obtido, com um valor DateTime acrescentado para indicar o momento em que o instantâneo foi obtido.
create_snapshot(**kwargs: Any | None) -> Dict[str, Any]
Parâmetros
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Ditado de propriedade atualizado por compartilhamento (ID do instantâneo, Etag e última modificação).
Tipo de retorno
Exemplos
Cria um instantâneo do compartilhamento de arquivos.
share.create_snapshot()
delete_directory
Marca o diretório para exclusão. O diretório é posteriormente excluído durante a coleta de lixo.
delete_directory(directory_name: str, **kwargs: Any) -> None
Parâmetros
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Tipo de retorno
delete_share
Marca o compartilhamento especificado para exclusão. O compartilhamento é posteriormente excluído durante a coleta de lixo.
delete_share(delete_snapshots: bool | None = False, **kwargs) -> None
Parâmetros
- lease
Obrigatório se o compartilhamento tiver uma concessão ativa. O valor pode ser um objeto ShareLeaseClient ou a ID de concessão como uma cadeia de caracteres.
Novo na versão 12.5.0.
Esse argumento palavra-chave foi introduzido na versão da API '2020-08-04'.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Exemplos
Exclui o compartilhamento e todos os instantâneos.
share.delete_share(delete_snapshots=True)
from_connection_string
Criar ShareClient a partir de uma cadeia de conexão.
from_connection_string(conn_str: str, share_name: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self
Parâmetros
- snapshot
- str
O compartilhamento opcional instantâneo no qual operar. Esse pode ser o instantâneo cadeia de caracteres de ID ou a resposta retornada de create_snapshot.
- credential
As credenciais com as quais autenticar. Isso será opcional se a URL da conta já tiver um token SAS. O valor pode ser uma cadeia de caracteres de token SAS, uma instância de um AzureSasCredential ou AzureNamedKeyCredential de azure.core.credentials, uma chave de acesso compartilhado de conta ou uma instância de uma classe TokenCredentials do azure.identity. Se o URI do recurso já contiver um token SAS, isso será ignorado em favor de uma credencial explícita
- exceto no caso do AzureSasCredential, em que os tokens SAS conflitantes gerarão um ValueError. Se estiver usando uma instância do AzureNamedKeyCredential, "name" deverá ser o nome da conta de armazenamento e "key" deverá ser a chave da conta de armazenamento.
Retornos
Um cliente de compartilhamento.
Tipo de retorno
Exemplos
Obtém o cliente de compartilhamento da cadeia de conexão.
from azure.storage.fileshare import ShareClient
share = ShareClient.from_connection_string(self.connection_string, "sharesamples2")
from_share_url
from_share_url(share_url: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self
Parâmetros
- snapshot
- str
Um compartilhamento opcional instantâneo no qual operar. Esse pode ser o instantâneo cadeia de caracteres de ID ou a resposta retornada de create_snapshot.
- credential
As credenciais com as quais autenticar. Isso será opcional se a URL da conta já tiver um token SAS. O valor pode ser uma cadeia de caracteres de token SAS, uma instância de um AzureSasCredential ou AzureNamedKeyCredential de azure.core.credentials, uma chave de acesso compartilhado de conta ou uma instância de uma classe TokenCredentials do azure.identity. Se o URI do recurso já contiver um token SAS, isso será ignorado em favor de uma credencial explícita
- exceto no caso do AzureSasCredential, em que os tokens SAS conflitantes gerarão um ValueError. Se estiver usando uma instância do AzureNamedKeyCredential, "name" deverá ser o nome da conta de armazenamento e "key" deverá ser a chave da conta de armazenamento.
Retornos
Um cliente de compartilhamento.
Tipo de retorno
get_directory_client
Faça com que um cliente interaja com o diretório especificado. O diretório ainda não precisa existir.
get_directory_client(directory_path: str | None = None) -> ShareDirectoryClient
Parâmetros
Retornos
Um cliente de diretório.
Tipo de retorno
get_file_client
Faça com que um cliente interaja com o arquivo especificado. O arquivo ainda não precisa existir.
get_file_client(file_path: str) -> ShareFileClient
Parâmetros
Retornos
Um cliente de arquivo.
Tipo de retorno
get_permission_for_share
Obtenha uma permissão (um descritor de segurança) para uma determinada chave.
Essa "permissão" pode ser usada para os arquivos/diretórios no compartilhamento.
get_permission_for_share(permission_key: str, **kwargs: Any) -> str
Parâmetros
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Uma permissão de arquivo (um SDDL portátil)
Tipo de retorno
get_share_access_policy
Obtém as permissões para o compartilhamento. As permissões indicam se os arquivos em um compartilhamento podem ser acessados publicamente.
get_share_access_policy(**kwargs: Any) -> Dict[str, Any]
Parâmetros
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
- lease
Obrigatório se o compartilhamento tiver uma concessão ativa. O valor pode ser um objeto ShareLeaseClient ou a ID de concessão como uma cadeia de caracteres.
Novo na versão 12.5.0.
Esse argumento palavra-chave foi introduzido na versão da API '2020-08-04'.
Retornos
Acessar informações de política em um ditado.
Tipo de retorno
get_share_properties
Retorna todos os metadados definidos pelo usuário e as propriedades do sistema para o compartilhamento especificado. Os dados retornados não incluem a lista de arquivos ou diretórios dos compartilhamentos.
get_share_properties(**kwargs: Any) -> ShareProperties
Parâmetros
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
- lease
Obrigatório se o compartilhamento tiver uma concessão ativa. O valor pode ser um objeto ShareLeaseClient ou a ID de concessão como uma cadeia de caracteres.
Novo na versão 12.5.0.
Esse argumento palavra-chave foi introduzido na versão da API '2020-08-04'.
Retornos
As propriedades de compartilhamento.
Tipo de retorno
Exemplos
Obtém as propriedades de compartilhamento.
properties = share.get_share_properties()
get_share_stats
Obtém o tamanho aproximado dos dados armazenados no compartilhamento em bytes.
Observe que esse valor pode não incluir todos os arquivos recém-criados ou redimensionados recentemente.
get_share_stats(**kwargs: Any) -> int
Parâmetros
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
- lease
Obrigatório se o compartilhamento tiver uma concessão ativa. O valor pode ser um objeto ShareLeaseClient ou a ID de concessão como uma cadeia de caracteres.
Novo na versão 12.5.0.
Esse argumento palavra-chave foi introduzido na versão da API '2020-08-04'.
Retornos
O tamanho aproximado dos dados (em bytes) armazenados no compartilhamento.
Tipo de retorno
list_directories_and_files
Lista os diretórios e arquivos no compartilhamento.
list_directories_and_files(directory_name: str | None = None, name_starts_with: str | None = None, marker: str | None = None, **kwargs: Any) -> Iterable[Dict[str, str]]
Parâmetros
- name_starts_with
- str
Filtra os resultados para retornar apenas diretórios cujos nomes começam com o prefixo especificado.
- marker
- str
Um token de continuação opaco. Esse valor pode ser recuperado do campo next_marker de um objeto gerador anterior. Se especificado, esse gerador começará a retornar os resultados desse ponto.
Inclua esse parâmetro para especificar um ou mais conjuntos de dados a serem incluídos na resposta. Os valores str possíveis são "carimbos de data/hora", "Etag", "Atributos", "PermissionKey".
Novo na versão 12.6.0.
Esse argumento palavra-chave foi introduzido na versão da API '2020-10-02'.
- include_extended_info
- bool
Se isso for definido como true, a ID do arquivo será retornada nos resultados listados.
Novo na versão 12.6.0.
Esse argumento palavra-chave foi introduzido na versão da API '2020-10-02'.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Um iterável de paginação automática de DirectoryProperties e FileProperties semelhantes a ditados
Tipo de retorno
Exemplos
Listar diretórios e arquivos no compartilhamento.
# Create a directory in the share
dir_client = share.create_directory("mydir")
# Upload a file to the directory
with open(SOURCE_FILE, "rb") as source_file:
dir_client.upload_file(file_name="sample", data=source_file)
# List files in the directory
my_files = list(share.list_directories_and_files(directory_name="mydir"))
print(my_files)
set_share_access_policy
Define as permissões para o compartilhamento ou as políticas de acesso armazenadas que podem ser usadas com assinaturas de acesso compartilhado. As permissões indicam se os arquivos em um compartilhamento podem ser acessados publicamente.
set_share_access_policy(signed_identifiers: Dict[str, AccessPolicy], **kwargs: Any) -> Dict[str, str]
Parâmetros
- signed_identifiers
- dict(str, AccessPolicy)
Um dicionário de políticas de acesso a serem associadas ao compartilhamento. O dicionário pode conter até 5 elementos. Um dicionário vazio limpará as políticas de acesso definidas no serviço.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
- lease
Obrigatório se o compartilhamento tiver uma concessão ativa. O valor pode ser um objeto ShareLeaseClient ou a ID de concessão como uma cadeia de caracteres.
Novo na versão 12.5.0.
Esse argumento palavra-chave foi introduzido na versão da API '2020-08-04'.
Retornos
Dict de propriedade atualizado por compartilhamento (Etag e última modificação).
Tipo de retorno
set_share_metadata
Define os metadados para o compartilhamento.
Cada chamada para essa operação substitui todos os metadados existentes anexados ao compartilhamento. Para remover todos os metadados do compartilhamento, chame essa operação sem um ditado de metadados.
set_share_metadata(metadata: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]
Parâmetros
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
- lease
Obrigatório se o compartilhamento tiver uma concessão ativa. O valor pode ser um objeto ShareLeaseClient ou a ID de concessão como uma cadeia de caracteres.
Novo na versão 12.5.0.
Esse argumento palavra-chave foi introduzido na versão da API '2020-08-04'.
Retornos
Dict de propriedade atualizado por compartilhamento (Etag e última modificação).
Tipo de retorno
Exemplos
Define os metadados de compartilhamento.
data = {'category': 'test'}
share.set_share_metadata(metadata=data)
set_share_properties
Define as propriedades de compartilhamento.
Novo na versão 12.4.0.
set_share_properties(**kwargs: Any) -> Dict[str, Any]
Parâmetros
- access_tier
- str ou <xref:azure.storage.fileshare.models.ShareAccessTier>
Especifica a camada de acesso do compartilhamento. Valores possíveis: 'TransactionOptimized', 'Hot' e 'Cool'
- quota
- int
Especifica o tamanho máximo do compartilhamento em gigabytes. Deve ser maior que 0 e menor ou igual a 5 TB.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
- root_squash
- str ou ShareRootSquash
O combinação por squash raiz a ser definido no compartilhamento. Válido apenas para compartilhamentos NFS. Os valores possíveis incluem: 'NoRootSquash', 'RootSquash', 'AllSquash'.
- lease
Obrigatório se o compartilhamento tiver uma concessão ativa. O valor pode ser um objeto ShareLeaseClient ou a ID de concessão como uma cadeia de caracteres.
Retornos
Dict de propriedade atualizado por compartilhamento (Etag e última modificação).
Tipo de retorno
Exemplos
Define as propriedades de compartilhamento.
# Set the tier for the first share to Hot
share1.set_share_properties(access_tier="Hot")
# Set the quota for the first share to 3
share1.set_share_properties(quota=3)
# Set the tier for the second share to Cool and quota to 2
share2.set_share_properties(access_tier=ShareAccessTier("Cool"), quota=2)
# Get the shares' properties
print(share1.get_share_properties().access_tier)
print(share1.get_share_properties().quota)
print(share2.get_share_properties().access_tier)
print(share2.get_share_properties().quota)
set_share_quota
Define a cota para o compartilhamento.
set_share_quota(quota: int, **kwargs: Any) -> Dict[str, Any]
Parâmetros
- quota
- int
Especifica o tamanho máximo do compartilhamento em gigabytes. Deve ser maior que 0 e menor ou igual a 5 TB.
- timeout
- int
Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais informações, confira https://zcusa.951200.xyz/rest/api/storageservices/setting-timeouts-for-file-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
- lease
Obrigatório se o compartilhamento tiver uma concessão ativa. O valor pode ser um objeto ShareLeaseClient ou a ID de concessão como uma cadeia de caracteres.
Novo na versão 12.5.0.
Esse argumento palavra-chave foi introduzido na versão da API '2020-08-04'.
Retornos
Dict de propriedade atualizado por compartilhamento (Etag e última modificação).
Tipo de retorno
Exemplos
Define a cota de compartilhamento.
# Set the quota for the share to 1GB
share.set_share_quota(quota=1)
Atributos
api_version
A versão da API de Armazenamento usada para solicitações.
location_mode
O modo de localização que o cliente está usando no momento.
Por padrão, isso será "primário". As opções incluem "primário" e "secundário".
primary_endpoint
A URL completa do ponto de extremidade primário.
primary_hostname
O nome do host do ponto de extremidade primário.
secondary_endpoint
A URL completa do ponto de extremidade secundário, se configurada.
Se não estiver disponível, um ValueError será gerado. Para especificar explicitamente um nome de host secundário, use o argumento opcional secondary_hostname palavra-chave na instanciação.
Exceções
secondary_hostname
O nome do host do ponto de extremidade secundário.
Se não estiver disponível, será Nenhum. Para especificar explicitamente um nome de host secundário, use o argumento opcional secondary_hostname palavra-chave na instanciação.
url
A URL completa do ponto de extremidade para essa entidade, incluindo o token SAS, se usado.
Isso pode ser o ponto de extremidade primário ou o ponto de extremidade secundário, dependendo do atual location_mode. :returns: a URL completa do ponto de extremidade para essa entidade, incluindo o token SAS, se usado. :rtype: str
Azure SDK for Python