Partilhar via


FileOperations Classe

Operações de FileOperations.

Não deve instanciar diretamente esta classe, mas criar uma instância de Cliente que irá criá-la e anexá-la como atributo.

Herança
builtins.object
FileOperations

Construtor

FileOperations(client, config, serializer, deserializer)

Parâmetros

client
Necessário

Cliente para pedidos de serviço.

config
Necessário

Configuração do cliente de serviço.

serializer
Necessário

Um serializador de modelo de objeto.

deserializer
Necessário

Um desserializador de modelo de objeto.

Variáveis

api_version

A versão da API a utilizar para o pedido. Valor constante: "2023-05-01.17.0".

Métodos

delete_from_compute_node

Elimina o ficheiro especificado do Nó de Computação.

delete_from_task

Elimina o ficheiro de Tarefa especificado do Nó de Computação onde a Tarefa foi executada.

get_from_compute_node

Devolve o conteúdo do ficheiro de Nó de Computação especificado.

get_from_task

Devolve o conteúdo do ficheiro de Tarefa especificado.

get_properties_from_compute_node

Obtém as propriedades do ficheiro de Nó de Computação especificado.

get_properties_from_task

Obtém as propriedades do ficheiro de Tarefa especificado.

list_from_compute_node

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

list_from_task

Lista os ficheiros no diretório de uma Tarefa no respetivo Nó de Computação.

delete_from_compute_node

Elimina o ficheiro 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
Necessário

O ID do Conjunto que contém o Nó de Computação.

node_id
str
Necessário

O ID do Nó de Computação a partir do qual pretende eliminar o ficheiro.

file_path
str
Necessário

O caminho para o ficheiro ou diretório que pretende eliminar.

recursive
bool
valor predefinido: None

Se pretende eliminar crianças de um diretório. Se o parâmetro filePath representar um diretório em vez de um ficheiro, pode definir recursivo como verdadeiro para eliminar o diretório e todos os ficheiros e subdiretórios no mesmo. Se recursivo for falso, o diretório tem de estar vazio ou a eliminação falhará.

file_delete_from_compute_node_options
FileDeleteFromComputeNodeOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

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

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

delete_from_task

Elimina o ficheiro de Tarefa especificado do Nó de Computação onde 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
Necessário

O ID da Tarefa que contém a Tarefa.

task_id
str
Necessário

O ID da Tarefa cujo ficheiro pretende eliminar.

file_path
str
Necessário

O caminho para o ficheiro de tarefa ou diretório que pretende eliminar.

recursive
bool
valor predefinido: None

Se pretende eliminar crianças de um diretório. Se o parâmetro filePath representar um diretório em vez de um ficheiro, pode definir recursivo como verdadeiro para eliminar o diretório e todos os ficheiros e subdiretórios no mesmo. Se recursivo for falso, o diretório tem de estar vazio ou a eliminação falhará.

file_delete_from_task_options
FileDeleteFromTaskOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

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

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

get_from_compute_node

Devolve o conteúdo do ficheiro 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
Necessário

O ID do Conjunto que contém o Nó de Computação.

node_id
str
Necessário

O ID do Nó de Computação que contém o ficheiro.

file_path
str
Necessário

O caminho para o ficheiro de Nó de Computação do qual pretende obter o conteúdo.

file_get_from_compute_node_options
FileGetFromComputeNodeOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

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

Quando especificado, será chamado com cada segmento de dados transmitidos. A chamada de retorno deve ter dois argumentos, os bytes do segmento atual de dados e o objeto de resposta. Se os dados estiverem a ser carregados, a resposta será Nenhuma.

operation_config
Necessário

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

Devoluções

objeto ou ClientRawResponse se raw=true

Tipo de retorno

Exceções

get_from_task

Devolve o conteúdo do ficheiro de Tarefa 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
Necessário

O ID da Tarefa que contém a Tarefa.

task_id
str
Necessário

O ID da Tarefa cujo ficheiro pretende obter.

file_path
str
Necessário

O caminho para o ficheiro tarefa do qual pretende obter o conteúdo.

file_get_from_task_options
FileGetFromTaskOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

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

Quando especificado, será chamado com cada segmento de dados transmitidos. A chamada de retorno deve ter dois argumentos, os bytes do segmento atual de dados e o objeto de resposta. Se os dados estiverem a ser carregados, a resposta será Nenhuma.

operation_config
Necessário

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

Devoluções

objeto ou ClientRawResponse se raw=true

Tipo de retorno

Exceções

get_properties_from_compute_node

Obtém as propriedades do ficheiro 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
Necessário

O ID do Conjunto que contém o Nó de Computação.

node_id
str
Necessário

O ID do Nó de Computação que contém o ficheiro.

file_path
str
Necessário

O caminho para o ficheiro de Nó de Computação do qual pretende obter as propriedades.

file_get_properties_from_compute_node_options
FileGetPropertiesFromComputeNodeOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

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

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

get_properties_from_task

Obtém as propriedades do ficheiro de Tarefa 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
Necessário

O ID da Tarefa que contém a Tarefa.

task_id
str
Necessário

O ID da Tarefa cujo ficheiro pretende obter as propriedades.

file_path
str
Necessário

O caminho para o ficheiro tarefa do qual pretende obter as propriedades.

file_get_properties_from_task_options
FileGetPropertiesFromTaskOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

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

Devoluções

Nenhum ou ClientRawResponse se raw=true

Tipo de retorno

None,

Exceções

list_from_compute_node

Lista todos os ficheiros 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
Necessário

O ID do Conjunto que contém o Nó de Computação.

node_id
str
Necessário

O ID do Nó de Computação cujos ficheiros pretende listar.

recursive
bool
valor predefinido: None

Se pretende listar os menores de um diretório.

file_list_from_compute_node_options
FileListFromComputeNodeOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

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

Devoluções

Um iterador como a instância do NodeFile

Tipo de retorno

Exceções

list_from_task

Lista os ficheiros no diretório de uma Tarefa no respetivo 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
Necessário

O ID da Tarefa que contém a Tarefa.

task_id
str
Necessário

O ID da Tarefa cujos ficheiros pretende listar.

recursive
bool
valor predefinido: None

Se pretende listar os menores do diretório Tarefa. Este parâmetro pode ser utilizado em combinação com o parâmetro de filtro para listar o tipo específico de ficheiros.

file_list_from_task_options
FileListFromTaskOptions
valor predefinido: None

Parâmetros adicionais para a operação

custom_headers
dict
valor predefinido: None

cabeçalhos que serão adicionados ao pedido

raw
bool
valor predefinido: False

devolve a resposta direta juntamente com a resposta desserializada

operation_config
Necessário

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

Devoluções

Um iterador como a instância do NodeFile

Tipo de retorno

Exceções

Atributos

models

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