FileOperations Classe

Operações fileOperations.

Você não deve instanciar diretamente essa classe, mas criar uma instância do Cliente que a criará para você e a anexará como atributo.

Herança

builtins.object

FileOperations

Construtor

FileOperations(client, config, serializer, deserializer)

Parâmetros

client

Obrigatório

Cliente para solicitações de serviço.

config

Obrigatório

Configuração do cliente de serviço.

serializer

Obrigatório

Um serializador de modelo de objeto.

deserializer

Obrigatório

Um desserializador de modelo de objeto.

Variáveis

api_version

A versão da API a ser usada para a solicitação. Valor constante: "2023-05-01.17.0".

Métodos

delete_from_compute_node	Exclui o arquivo especificado do Nó de Computação.
delete_from_task	Exclui o arquivo de tarefa especificado do Nó de Computação em que a Tarefa foi executada.
get_from_compute_node	Retorna o conteúdo do arquivo de nó de computação especificado.
get_from_task	Retorna o conteúdo do arquivo task especificado.
get_properties_from_compute_node	Obtém as propriedades do arquivo de nó de computação especificado.
get_properties_from_task	Obtém as propriedades do arquivo task especificado.
list_from_compute_node	Lista todos os arquivos em Diretórios de tarefas no Nó de Computação especificado.
list_from_task	Lista os arquivos no diretório de uma Tarefa em seu Nó de Computação.

delete_from_compute_node

Exclui o arquivo especificado do Nó de Computação.

delete_from_compute_node(pool_id, node_id, file_path, recursive=None, file_delete_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_id

str

Obrigatório

A ID do pool que contém o nó de computação.

node_id

str

Obrigatório

A ID do Nó de Computação do qual você deseja excluir o arquivo.

file_path

str

Obrigatório

O caminho para o arquivo ou diretório que você deseja excluir.

recursive

bool

valor padrão: None

Se deseja excluir filhos de um diretório. Se o parâmetro filePath representar um diretório em vez de um arquivo, você poderá definir recursivo como true para excluir o diretório e todos os arquivos e subdiretórios nele. Se recursivo for false, o diretório deverá estar vazio ou a exclusão falhará.

file_delete_from_compute_node_options

FileDeleteFromComputeNodeOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

BatchErrorException

delete_from_task

Exclui o arquivo de tarefa especificado do Nó de Computação em que a Tarefa foi executada.

delete_from_task(job_id, task_id, file_path, recursive=None, file_delete_from_task_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

job_id

str

Obrigatório

A ID do Trabalho que contém a Tarefa.

task_id

str

Obrigatório

A ID da Tarefa cujo arquivo você deseja excluir.

file_path

str

Obrigatório

O caminho para o arquivo ou diretório task que você deseja excluir.

recursive

bool

valor padrão: None

Se deseja excluir filhos de um diretório. Se o parâmetro filePath representar um diretório em vez de um arquivo, você poderá definir recursivo como true para excluir o diretório e todos os arquivos e subdiretórios nele. Se recursivo for false, o diretório deverá estar vazio ou a exclusão falhará.

file_delete_from_task_options

FileDeleteFromTaskOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

BatchErrorException

get_from_compute_node

Retorna o conteúdo do arquivo de nó de computação especificado.

get_from_compute_node(pool_id, node_id, file_path, file_get_from_compute_node_options=None, custom_headers=None, raw=False, callback=None, **operation_config)

Parâmetros

pool_id

str

Obrigatório

A ID do pool que contém o nó de computação.

node_id

str

Obrigatório

A ID do Nó de Computação que contém o arquivo.

file_path

str

Obrigatório

O caminho para o arquivo de nó de computação do qual você deseja obter o conteúdo.

file_get_from_compute_node_options

FileGetFromComputeNodeOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

callback

Callable[<xref:Bytes>, <xref:response=None>]

valor padrão: None

Quando especificado, será chamado com cada parte dos dados que são transmitidos. O retorno de chamada deve ter dois argumentos, os bytes da parte atual dos dados e o objeto de resposta. Se os dados estiverem carregando, a resposta será Nenhum.

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

object ou ClientRawResponse se raw=true

Tipo de retorno

Generator,

ClientRawResponse

Exceções

BatchErrorException

get_from_task

Retorna o conteúdo do arquivo task especificado.

get_from_task(job_id, task_id, file_path, file_get_from_task_options=None, custom_headers=None, raw=False, callback=None, **operation_config)

Parâmetros

job_id

str

Obrigatório

A ID do Trabalho que contém a Tarefa.

task_id

str

Obrigatório

A ID da Tarefa cujo arquivo você deseja recuperar.

file_path

str

Obrigatório

O caminho para o arquivo task do qual você deseja obter o conteúdo.

file_get_from_task_options

FileGetFromTaskOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

callback

Callable[<xref:Bytes>, <xref:response=None>]

valor padrão: None

Quando especificado, será chamado com cada parte dos dados que são transmitidos. O retorno de chamada deve ter dois argumentos, os bytes da parte atual dos dados e o objeto de resposta. Se os dados estiverem carregando, a resposta será Nenhum.

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

object ou ClientRawResponse se raw=true

Tipo de retorno

Generator,

ClientRawResponse

Exceções

BatchErrorException

get_properties_from_compute_node

Obtém as propriedades do arquivo de nó de computação especificado.

get_properties_from_compute_node(pool_id, node_id, file_path, file_get_properties_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_id

str

Obrigatório

A ID do pool que contém o nó de computação.

node_id

str

Obrigatório

A ID do Nó de Computação que contém o arquivo.

file_path

str

Obrigatório

O caminho para o arquivo de nó de computação do qual você deseja obter as propriedades.

file_get_properties_from_compute_node_options

FileGetPropertiesFromComputeNodeOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

BatchErrorException

get_properties_from_task

Obtém as propriedades do arquivo task especificado.

get_properties_from_task(job_id, task_id, file_path, file_get_properties_from_task_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

job_id

str

Obrigatório

A ID do Trabalho que contém a Tarefa.

task_id

str

Obrigatório

A ID da Tarefa cujo arquivo você deseja obter as propriedades.

file_path

str

Obrigatório

O caminho para o arquivo task do qual você deseja obter as propriedades.

file_get_properties_from_task_options

FileGetPropertiesFromTaskOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

None ou ClientRawResponse se raw=true

Tipo de retorno

None,

ClientRawResponse

Exceções

BatchErrorException

list_from_compute_node

Lista todos os arquivos em Diretórios de tarefas no Nó de Computação especificado.

list_from_compute_node(pool_id, node_id, recursive=None, file_list_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

pool_id

str

Obrigatório

A ID do pool que contém o nó de computação.

node_id

str

Obrigatório

A ID do Nó de Computação cujos arquivos você deseja listar.

recursive

bool

valor padrão: None

Se deseja listar os filhos de um diretório.

file_list_from_compute_node_options

FileListFromComputeNodeOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

Um iterador como a instância de NodeFile

Tipo de retorno

NodeFilePaged[NodeFile]

Exceções

BatchErrorException

list_from_task

Lista os arquivos no diretório de uma Tarefa em seu Nó de Computação.

list_from_task(job_id, task_id, recursive=None, file_list_from_task_options=None, custom_headers=None, raw=False, **operation_config)

Parâmetros

job_id

str

Obrigatório

A ID do Trabalho que contém a Tarefa.

task_id

str

Obrigatório

A ID da Tarefa cujos arquivos você deseja listar.

recursive

bool

valor padrão: None

Se deseja listar os filhos do diretório Tarefa. Esse parâmetro pode ser usado em combinação com o parâmetro de filtro para listar tipos específicos de arquivos.

file_list_from_task_options

FileListFromTaskOptions

valor padrão: None

Parâmetros adicionais para a operação

custom_headers

dict

valor padrão: None

cabeçalhos que serão adicionados à solicitação

raw

bool

valor padrão: False

retorna a resposta direta junto com a resposta desserializada

operation_config

Obrigatório

Substituições de configuração de operação.

Retornos

Um iterador como a instância de NodeFile

Tipo de retorno

NodeFilePaged[NodeFile]

Exceções

BatchErrorException

Atributos

models

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