az datafactory pipeline

Note

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	Status
az datafactory pipeline create	Crie um pipeline.	Extension	disponibilidade geral
az datafactory pipeline create-run	Cria uma execução de um pipeline.	Extension	disponibilidade geral
az datafactory pipeline delete	Exclui um pipeline.	Extension	disponibilidade geral
az datafactory pipeline list	Lista pipelines.	Extension	disponibilidade geral
az datafactory pipeline show	Obtém um pipeline.	Extension	disponibilidade geral
az datafactory pipeline update	Atualize um pipeline.	Extension	disponibilidade geral

az datafactory pipeline create

Crie um pipeline.

az datafactory pipeline create --factory-name
                               --name --pipeline-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

--factory-name

O nome da fábrica.

--name --pipeline-name -n

O nome do pipeline.

--pipeline

Definição de recursos de pipeline. Valor esperado: json-string/json-file/@json-file.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--if-match

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

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

az datafactory pipeline create-run

Cria uma execução de um pipeline.

az datafactory pipeline create-run --factory-name
                                   --name --pipeline-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

--factory-name

O nome da fábrica.

--name --pipeline-name -n

O nome do pipeline.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--is-recovery

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.

Propriedade	Valor
Valores aceites:	false, true

--parameters

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.

--reference-pipeline-run-id

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.

--start-activity-name

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.

--start-from-failure

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.

Propriedade	Valor
Valores aceites:	false, true

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

az datafactory pipeline delete

Exclui um pipeline.

az datafactory pipeline delete [--factory-name]
                               [--ids]
                               [--name --pipeline-name]
                               [--resource-group]
                               [--subscription]
                               [--yes]

Exemplos

Pipelines_Delete

az datafactory pipeline delete --factory-name "exampleFactoryName" --name "examplePipeline" --resource-group "exampleResourceGroup"

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--factory-name

O nome da fábrica.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--name --pipeline-name -n

O nome do pipeline.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--yes -y

Não solicite confirmação.

Propriedade	Valor
Default value:	False

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

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

--factory-name

O nome da fábrica.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

az datafactory pipeline show

Obtém um pipeline.

az datafactory pipeline show [--factory-name]
                             [--ids]
                             [--if-none-match]
                             [--name --pipeline-name]
                             [--resource-group]
                             [--subscription]

Exemplos

Pipelines_Get

az datafactory pipeline show --factory-name "exampleFactoryName" --name "examplePipeline" --resource-group "exampleResourceGroup"

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--factory-name

O nome da fábrica.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--ids

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--if-none-match

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.

--name --pipeline-name -n

O nome do pipeline.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

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 --pipeline-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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--activities

Lista de atividades em pipeline. Valor esperado: json-string/json-file/@json-file.

--add

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>.

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Default value:	[]

--annotations

Lista de tags que podem ser usadas para descrever o Pipeline. Valor esperado: json-string/json-file/@json-file.

--concurrency

O número máximo de execuções simultâneas para o pipeline.

--description

A descrição do gasoduto.

--duration

Valor TimeSpan, após o qual uma Métrica de Monitoramento do Azure é acionada. Valor esperado: json-string/json-file/@json-file.

Propriedade	Valor
Grupo de parâmetros:	Policy Elapsed Time Metric Arguments

--factory-name

O nome da fábrica.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--folder-name

O nome da pasta em que este Pipeline está.

Propriedade	Valor
Grupo de parâmetros:	Folder Arguments

--force-string

Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Default value:	False

--ids

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--if-match

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.

--if-none-match

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.

--name --pipeline-name -n

O nome do pipeline.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--parameters

Lista de parâmetros para pipeline. Valor esperado: json-string/json-file/@json-file.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OU --remove propertyToRemove.

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Default value:	[]

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--run-dimensions

Dimensões emitidas pelo Pipeline. Valor esperado: json-string/json-file/@json-file.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Default value:	[]

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--variables

Lista de variáveis para pipeline. Valor esperado: json-string/json-file/@json-file.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

Feedback

Esta página foi útil?

Partilhar via

az datafactory pipeline

Comandos

az datafactory pipeline create

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az datafactory pipeline create-run

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az datafactory pipeline delete

Exemplos

Parâmetros Opcionais

az datafactory pipeline list

Exemplos

Parâmetros Obrigatórios

az datafactory pipeline show

Exemplos

Parâmetros Opcionais

az datafactory pipeline update

Exemplos

Parâmetros Opcionais

Feedback