FileSharesOperations Classe

Aviso

NÃO instancie essa classe diretamente.

Em vez disso, você deve acessar as operações a seguir por meio de

StorageManagementClient's

Atributo <xref:file_shares>.

Herança

builtins.object

FileSharesOperations

Construtor

FileSharesOperations(*args, **kwargs)

Métodos

create	Cria um novo compartilhamento na conta especificada, conforme descrito pelo corpo da solicitação. O recurso do compartilhamento inclui os metadados e as propriedades desse compartilhamento. Ele não inclui uma lista dos arquivos presentes no compartilhamento.
delete	Exclui o compartilhamento especificado em sua conta.
get	Obtém as propriedades de um compartilhamento especificado.
lease	A operação Lease Share estabelece e gerencia um bloqueio em um compartilhamento para operações de exclusão. A duração do bloqueio pode ser de 15 a 60 segundos, ou pode ser infinita.
list	Lista todos os compartilhamentos.
restore	Restaure um compartilhamento de arquivos em dias de retenção válidos se a exclusão reversível do compartilhamento estiver habilitada.
update	Atualizações compartilhar propriedades conforme especificado no corpo da solicitação. As propriedades não mencionadas na solicitação não serão alteradas. A atualização falhará se o compartilhamento especificado ainda não existir.

create

Cria um novo compartilhamento na conta especificada, conforme descrito pelo corpo da solicitação. O recurso do compartilhamento inclui os metadados e as propriedades desse compartilhamento. Ele não inclui uma lista dos arquivos presentes no compartilhamento.

create(resource_group_name: str, account_name: str, share_name: str, file_share: _models.FileShare, expand: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.FileShare

Parâmetros

resource_group_name

str

Obrigatório

O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

account_name

str

Obrigatório

O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.

share_name

str

Obrigatório

O nome do compartilhamento de arquivos dentro da conta de armazenamento especificada. Os nomes de compartilhamento de arquivos devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.

file_share

FileShare ou IO

Obrigatório

Propriedades do compartilhamento de arquivos a ser criado. É um tipo FileShare ou um tipo de E/S. Obrigatórios.

expand

str

Obrigatório

Opcional, usado para expandir as propriedades dentro das propriedades do compartilhamento. Os valores válidos são: instantâneos. Deve ser passado como uma cadeia de caracteres com o delimitador ','. O valor padrão é Nenhum.

content_type

str

Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

FileShare ou o resultado de cls(response)

Tipo de retorno

FileShare

Exceções

HttpResponseError

delete

Exclui o compartilhamento especificado em sua conta.

delete(resource_group_name: str, account_name: str, share_name: str, x_ms_snapshot: str | None = None, include: str | None = None, **kwargs: Any) -> None

Parâmetros

resource_group_name

str

Obrigatório

O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

account_name

str

Obrigatório

O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.

share_name

str

Obrigatório

O nome do compartilhamento de arquivos dentro da conta de armazenamento especificada. Os nomes de compartilhamento de arquivos devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.

x_ms_snapshot

str

Obrigatório

Opcional, usado para excluir um instantâneo. O valor padrão é Nenhum.

include

str

Obrigatório

Opcional. Os valores válidos são: instantâneos, instantâneos concedidos, nenhum. O valor padrão são instantâneos. Para "instantâneos", o compartilhamento de arquivos é excluído, incluindo todos os instantâneos de compartilhamento de arquivos. Se o compartilhamento de arquivos contiver instantâneos concedidos, a exclusão falhará. Para 'leased-snapshots', o compartilhamento de arquivos é excluído incluindo todos os seus instantâneos de compartilhamento de arquivos (concedidos/salvos). Para 'none', o compartilhamento de arquivos será excluído se não tiver instantâneos de compartilhamento. Se o compartilhamento de arquivos contiver instantâneos (concedidos ou salvos), a exclusão falhará. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Nenhum ou o resultado de cls(response)

Tipo de retorno

None

Exceções

HttpResponseError

get

Obtém as propriedades de um compartilhamento especificado.

get(resource_group_name: str, account_name: str, share_name: str, expand: str | None = None, x_ms_snapshot: str | None = None, **kwargs: Any) -> FileShare

Parâmetros

resource_group_name

str

Obrigatório

O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

account_name

str

Obrigatório

O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.

share_name

str

Obrigatório

O nome do compartilhamento de arquivos dentro da conta de armazenamento especificada. Os nomes de compartilhamento de arquivos devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.

expand

str

Obrigatório

Opcional, usado para expandir as propriedades dentro das propriedades do compartilhamento. Os valores válidos são: estatísticas. Deve ser passado como uma cadeia de caracteres com o delimitador ','. O valor padrão é Nenhum.

x_ms_snapshot

str

Obrigatório

Opcional, usado para recuperar propriedades de um instantâneo. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

FileShare ou o resultado de cls(response)

Tipo de retorno

FileShare

Exceções

HttpResponseError

lease

A operação Lease Share estabelece e gerencia um bloqueio em um compartilhamento para operações de exclusão. A duração do bloqueio pode ser de 15 a 60 segundos, ou pode ser infinita.

lease(resource_group_name: str, account_name: str, share_name: str, x_ms_snapshot: str | None = None, parameters: _models.LeaseShareRequest | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LeaseShareResponse

Parâmetros

resource_group_name

str

Obrigatório

O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

account_name

str

Obrigatório

O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.

share_name

str

Obrigatório

O nome do compartilhamento de arquivos dentro da conta de armazenamento especificada. Os nomes de compartilhamento de arquivos devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.

x_ms_snapshot

str

Obrigatório

Opcional. Especifique o tempo instantâneo para conceder um instantâneo. O valor padrão é Nenhum.

parameters

LeaseShareRequest ou IO

Obrigatório

Corpo da solicitação do Compartilhamento de Concessão. É um tipo LeaseShareRequest ou um tipo de E/S. O valor padrão é Nenhum.

content_type

str

Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

LeaseShareResponse ou o resultado de cls(response)

Tipo de retorno

LeaseShareResponse

Exceções

HttpResponseError

list

Lista todos os compartilhamentos.

list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, expand: str | None = None, **kwargs: Any) -> Iterable[FileShareItem]

Parâmetros

resource_group_name

str

Obrigatório

O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

account_name

str

Obrigatório

O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.

maxpagesize

str

Obrigatório

Opcional. Número máximo especificado de compartilhamentos que podem ser incluídos na lista. O valor padrão é Nenhum.

filter

str

Obrigatório

Opcional. Quando especificado, somente os nomes de compartilhamento que começam com o filtro serão listados. O valor padrão é Nenhum.

expand

str

Obrigatório

Opcional, usado para expandir as propriedades dentro das propriedades do compartilhamento. Os valores válidos são: excluídos, instantâneos. Deve ser passado como uma cadeia de caracteres com o delimitador ','. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Um iterador como a instância de FileShareItem ou o resultado de cls(response)

Tipo de retorno

ItemPaged[FileShareItem]

Exceções

HttpResponseError

restore

Restaure um compartilhamento de arquivos em dias de retenção válidos se a exclusão reversível do compartilhamento estiver habilitada.

restore(resource_group_name: str, account_name: str, share_name: str, deleted_share: _models.DeletedShare, *, content_type: str = 'application/json', **kwargs: Any) -> None

Parâmetros

resource_group_name

str

Obrigatório

O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

account_name

str

Obrigatório

O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.

share_name

str

Obrigatório

O nome do compartilhamento de arquivos dentro da conta de armazenamento especificada. Os nomes de compartilhamento de arquivos devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.

deleted_share

DeletedShare ou IO

Obrigatório

É um tipo DeletedShare ou um tipo de E/S. Obrigatórios.

content_type

str

Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Nenhum ou o resultado de cls(response)

Tipo de retorno

None

Exceções

HttpResponseError

update

Atualizações compartilhar propriedades conforme especificado no corpo da solicitação. As propriedades não mencionadas na solicitação não serão alteradas. A atualização falhará se o compartilhamento especificado ainda não existir.

update(resource_group_name: str, account_name: str, share_name: str, file_share: _models.FileShare, *, content_type: str = 'application/json', **kwargs: Any) -> _models.FileShare

Parâmetros

resource_group_name

str

Obrigatório

O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.

account_name

str

Obrigatório

O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.

share_name

str

Obrigatório

O nome do compartilhamento de arquivos dentro da conta de armazenamento especificada. Os nomes de compartilhamento de arquivos devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.

file_share

FileShare ou IO

Obrigatório

Propriedades a serem atualizadas para o compartilhamento de arquivos. É um tipo FileShare ou um tipo de E/S. Obrigatórios.

content_type

str

Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

FileShare ou o resultado de cls(response)

Tipo de retorno

FileShare

Exceções

HttpResponseError

Atributos

models

models = <module 'azure.mgmt.storage.v2022_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2022_09_01\\models\\__init__.py'>