az datafactory pipeline
Nota
Essa referência faz parte da extensão datafactory para a CLI do Azure (versão 2.15.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az datafactory pipeline . Saiba mais sobre extensões.
Gerencie o pipeline com o datafactory.
Comandos
Name | Description | Tipo | Estado |
---|---|---|---|
az datafactory pipeline create |
Criar um pipeline. |
Extensão | GA |
az datafactory pipeline create-run |
Cria uma execução de um pipeline. |
Extensão | GA |
az datafactory pipeline delete |
Exclui um pipeline. |
Extensão | GA |
az datafactory pipeline list |
Lista pipelines. |
Extensão | GA |
az datafactory pipeline show |
Obtém um pipeline. |
Extensão | GA |
az datafactory pipeline update |
Atualize um pipeline. |
Extensão | GA |
az datafactory pipeline create
Criar um pipeline.
az datafactory pipeline create --factory-name
--name
--pipeline
--resource-group
[--if-match]
Exemplos
Pipelines_Create
az datafactory pipeline create --factory-name "exampleFactoryName" --pipeline "{\"activities\":[{\"name\":\"ExampleForeachActivity\",\"type\":\"ForEach\",\"typeProperties\":{\"activities\":[{\"name\":\"ExampleCopyActivity\",\"type\":\"Copy\",\"inputs\":[{\"type\":\"DatasetReference\",\"parameters\":{\"MyFileName\":\"examplecontainer.csv\",\"MyFolderPath\":\"examplecontainer\"},\"referenceName\":\"exampleDataset\"}],\"outputs\":[{\"type\":\"DatasetReference\",\"parameters\":{\"MyFileName\":{\"type\":\"Expression\",\"value\":\"@item()\"},\"MyFolderPath\":\"examplecontainer\"},\"referenceName\":\"exampleDataset\"}],\"typeProperties\":{\"dataIntegrationUnits\":32,\"sink\":{\"type\":\"BlobSink\"},\"source\":{\"type\":\"BlobSource\"}}}],\"isSequential\":true,\"items\":{\"type\":\"Expression\",\"value\":\"@pipeline().parameters.OutputBlobNameList\"}}}],\"parameters\":{\"JobId\":{\"type\":\"String\"},\"OutputBlobNameList\":{\"type\":\"Array\"}},\"variables\":{\"TestVariableArray\":{\"type\":\"Array\"}},\"runDimensions\":{\"JobId\":{\"type\":\"Expression\",\"value\":\"@pipeline().parameters.JobId\"}},\"duration\":\"0.00:10:00\"}" --name "examplePipeline" --resource-group "exampleResourceGroup"
Parâmetros Obrigatórios
O nome da fábrica.
O nome do pipeline.
Definição de recursos de pipeline. Valor esperado: json-string/json-file/@json-file.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Opcionais
ETag da entidade pipeline. Deve ser especificado apenas para atualização, para o qual deve corresponder à entidade existente ou pode ser * para atualização incondicional.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az datafactory pipeline create-run
Cria uma execução de um pipeline.
az datafactory pipeline create-run --factory-name
--name
--resource-group
[--is-recovery {false, true}]
[--parameters]
[--reference-pipeline-run-id]
[--start-activity-name]
[--start-from-failure {false, true}]
Exemplos
Pipelines_CreateRun
az datafactory pipeline create-run --factory-name "exampleFactoryName" --parameters "{\"OutputBlobNameList\":[\"exampleoutput.csv\"]}" --name "examplePipeline" --resource-group "exampleResourceGroup"
Parâmetros Obrigatórios
O nome da fábrica.
O nome do pipeline.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Opcionais
Sinalizador do modo de recuperação. Se o modo de recuperação estiver definido como true, o pipeline referenciado especificado será executado e a nova execução serão agrupados sob o mesmo groupId.
Parâmetros da execução do pipeline. Esses parâmetros serão usados somente se o runId não for especificado. Valor esperado: json-string/json-file/@json-file.
O identificador de execução do pipeline. Se o ID de execução for especificado, os parâmetros da execução especificada serão usados para criar uma nova execução.
No modo de recuperação, a repetição será iniciada a partir desta atividade. Se não for especificado, todas as atividades serão executadas.
No modo de recuperação, se definido como true, a nova execução será iniciada a partir de atividades com falha. A propriedade será usada somente se startActivityName não for especificado.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az datafactory pipeline delete
Exclui um pipeline.
az datafactory pipeline delete [--factory-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
Exemplos
Pipelines_Delete
az datafactory pipeline delete --factory-name "exampleFactoryName" --name "examplePipeline" --resource-group "exampleResourceGroup"
Parâmetros Opcionais
O nome da fábrica.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
O nome do pipeline.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Não solicite confirmação.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az datafactory pipeline list
Lista pipelines.
az datafactory pipeline list --factory-name
--resource-group
Exemplos
Pipelines_ListByFactory
az datafactory pipeline list --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"
Parâmetros Obrigatórios
O nome da fábrica.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az datafactory pipeline show
Obtém um pipeline.
az datafactory pipeline show [--factory-name]
[--ids]
[--if-none-match]
[--name]
[--resource-group]
[--subscription]
Exemplos
Pipelines_Get
az datafactory pipeline show --factory-name "exampleFactoryName" --name "examplePipeline" --resource-group "exampleResourceGroup"
Parâmetros Opcionais
O nome da fábrica.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
ETag da entidade pipeline. Só deve ser especificado para get. Se a ETag corresponder à tag de entidade existente, ou se * foi fornecido, nenhum conteúdo será retornado.
O nome do pipeline.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az datafactory pipeline update
Atualize um pipeline.
az datafactory pipeline update [--activities]
[--add]
[--annotations]
[--concurrency]
[--description]
[--duration]
[--factory-name]
[--folder-name]
[--force-string]
[--ids]
[--if-match]
[--if-none-match]
[--name]
[--parameters]
[--remove]
[--resource-group]
[--run-dimensions]
[--set]
[--subscription]
[--variables]
Exemplos
Pipelines_Update
az datafactory pipeline update --factory-name "exampleFactoryName" --description "Example description" --activities "[{\"name\":\"ExampleForeachActivity\",\"type\":\"ForEach\",\"typeProperties\":{\"activities\":[{\"name\":\"ExampleCopyActivity\",\"type\":\"Copy\",\"inputs\":[{\"type\":\"DatasetReference\",\"parameters\":{\"MyFileName\":\"examplecontainer.csv\",\"MyFolderPath\":\"examplecontainer\"},\"referenceName\":\"exampleDataset\"}],\"outputs\":[{\"type\":\"DatasetReference\",\"parameters\":{\"MyFileName\":{\"type\":\"Expression\",\"value\":\"@item()\"},\"MyFolderPath\":\"examplecontainer\"},\"referenceName\":\"exampleDataset\"}],\"typeProperties\":{\"dataIntegrationUnits\":32,\"sink\":{\"type\":\"BlobSink\"},\"source\":{\"type\":\"BlobSource\"}}}],\"isSequential\":true,\"items\":{\"type\":\"Expression\",\"value\":\"@pipeline().parameters.OutputBlobNameList\"}}}]" --parameters "{\"OutputBlobNameList\":{\"type\":\"Array\"}}" --duration "0.00:10:00" --name "examplePipeline" --resource-group "exampleResourceGroup"
Parâmetros Opcionais
Lista de atividades em pipeline. Valor esperado: json-string/json-file/@json-file.
Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>
.
Lista de tags que podem ser usadas para descrever o Pipeline. Valor esperado: json-string/json-file/@json-file.
O número máximo de execuções simultâneas para o pipeline.
A descrição do gasoduto.
Valor TimeSpan, após o qual uma Métrica de Monitoramento do Azure é acionada. Valor esperado: json-string/json-file/@json-file.
O nome da fábrica.
O nome da pasta em que este Pipeline está.
Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
ETag da entidade pipeline. Deve ser especificado apenas para atualização, para o qual deve corresponder à entidade existente ou pode ser * para atualização incondicional.
ETag da entidade pipeline. Só deve ser especificado para get. Se a ETag corresponder à tag de entidade existente, ou se * foi fornecido, nenhum conteúdo será retornado. O valor padrão é Nenhum.
O nome do pipeline.
Lista de parâmetros para pipeline. Valor esperado: json-string/json-file/@json-file.
Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Dimensões emitidas pelo Pipeline. Valor esperado: json-string/json-file/@json-file.
Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>
.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Lista de variáveis para pipeline. Valor esperado: json-string/json-file/@json-file.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.