FileSharesOperations Classe
Aviso
NÃO instancie essa classe diretamente.
Em vez disso, você deve acessar as operações a seguir por meio de
Atributo <xref:file_shares>.
- Herança
-
builtins.objectFileSharesOperations
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. |
list |
Lista todos os compartilhamentos. |
restore |
Restaure um compartilhamento de arquivos dentro de dias de retenção válidos se a exclusão temporária de 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.
async create(resource_group_name: str, account_name: str, share_name: str, file_share: _models.FileShare, expand: str | _models.PutSharesExpand | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.FileShare
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
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
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.
Propriedades do compartilhamento de arquivos a ser criado. É um tipo FileShare ou um tipo de E/S. Obrigatórios.
- expand
- str ou PutSharesExpand
Opcional, usado para criar um instantâneo. "snapshots" O valor padrão é None.
- 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
Exceções
delete
Exclui o compartilhamento especificado em sua conta.
async delete(resource_group_name: str, account_name: str, share_name: str, x_ms_snapshot: str | None = None, **kwargs: Any) -> None
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
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
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.
- 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
Exceções
get
Obtém as propriedades de um compartilhamento especificado.
async get(resource_group_name: str, account_name: str, share_name: str, expand: Literal['stats'] = 'stats', x_ms_snapshot: str | None = None, **kwargs: Any) -> FileShare
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
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
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
Opcional, usado para expandir as propriedades dentro das propriedades do compartilhamento. Os valores conhecidos são "stats" e None. O valor padrão é "stats".
- x_ms_snapshot
- str
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
Exceções
list
Lista todos os compartilhamentos.
list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, expand: str | ListSharesExpand | None = None, **kwargs: Any) -> AsyncIterable[FileShareItem]
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
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
Opcional. Número máximo especificado de compartilhamentos que podem ser incluídos na lista. O valor padrão é Nenhum.
- filter
- str
Opcional. Quando especificado, somente os nomes de compartilhamento que começam com o filtro serão listados. O valor padrão é Nenhum.
- expand
- str ou ListSharesExpand
Opcional, usado para expandir as propriedades dentro das propriedades do compartilhamento. Os valores conhecidos são: "deleted" e "snapshots". 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
Exceções
restore
Restaure um compartilhamento de arquivos dentro de dias de retenção válidos se a exclusão temporária de compartilhamento estiver habilitada.
async 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
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
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
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
É 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
Exceções
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.
async 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
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
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
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 de comprimento 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.
Propriedades a serem atualizadas para o compartilhamento de arquivos. É um tipo FileShare ou um tipo de E/S. Obrigatórios.
- content_type
- str
Tipo de conteúdo do Parâmetro do Corpo. 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
Exceções
Atributos
models
models = <module 'azure.mgmt.storage.v2021_02_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2021_02_01\\models\\__init__.py'>
Azure SDK for Python