Compartilhar via

az synapse pipeline

  • Referência

Gerenciar os pipelines da Synapse.

Comandos

Nome Description Tipo Status
az synapse pipeline create

Crie um pipeline.

 Núcleo GA
az synapse pipeline create-run

Cria uma execução de um pipeline.

 Núcleo GA
az synapse pipeline delete

Excluir um pipeline.

 Núcleo GA
az synapse pipeline list

Listar pipelines.

 Núcleo GA
az synapse pipeline set

Atualize um pipeline existente.

 Núcleo Preterido
az synapse pipeline show

Obtenha um pipeline.

 Núcleo GA
az synapse pipeline update

Atualize um pipeline existente.

 Núcleo GA

az synapse pipeline create

Editar

Crie um pipeline.

az synapse pipeline create --file
                           --name
                           --workspace-name
                           [--no-wait]

Exemplos

Crie um pipeline. Preste atenção para adicionar "@" na frente do caminho do arquivo como a prática recomendada para argumentos complexos, como cadeia de caracteres JSON.

az synapse pipeline create --workspace-name testsynapseworkspace \
  --name testpipeline --file @"path/pipeline.json"

Parâmetros Exigidos

--file

As propriedades podem ser fornecidas a partir de um arquivo JSON usando a @{path} sintaxe ou uma cadeia de caracteres JSON.

--name -n

O nome do pipeline.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az synapse pipeline create-run

Editar

Cria uma execução de um pipeline.

az synapse pipeline create-run --name
                               --workspace-name
                               [--is-recovery {false, true}]
                               [--parameters]
                               [--reference-pipeline-run-id]
                               [--start-activity-name]

Exemplos

Pipelines_CreateRun

az synapse pipeline create-run --workspace-name testsynapseworkspace --name "myPipeline" \
  --parameters "{\"OutputBlobNameList\":[\"exampleoutput.csv\"]}"

Parâmetros Exigidos

--name -n

O nome do pipeline.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

--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á agrupada no mesmo groupId.

Valores aceitos: false, true
--parameters

Parâmetros para execução do pipeline. Pode ser fornecido a partir de um arquivo JSON usando a @{path} sintaxe ou uma cadeia de caracteres JSON.

--reference-pipeline-run-id --run-id

A ID de execução do pipeline para execução re. Se a ID de execução for especificada, 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 execução será iniciada a partir dessa atividade. Se não for especificado, todas as atividades serão executadas.

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az synapse pipeline delete

Editar

Excluir um pipeline.

az synapse pipeline delete --name
                           --workspace-name
                           [--no-wait]
                           [--yes]

Exemplos

Excluir um pipeline.

az synapse pipeline delete --workspace-name testsynapseworkspace \
  --name testpipeline

Parâmetros Exigidos

--name -n

O nome do pipeline.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
--yes -y

Não solicite confirmação.

Valor padrão: False
Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az synapse pipeline list

Editar

Listar pipelines.

az synapse pipeline list --workspace-name

Exemplos

Listar pipelines.

az synapse pipeline list --workspace-name testsynapseworkspace

Parâmetros Exigidos

--workspace-name

O nome do espaço de trabalho.

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az synapse pipeline set

Editar
Preterido

Esse comando foi preterido e será removido em uma versão futura. Em vez disso, use 'atualizar'.

Atualize um pipeline existente.

az synapse pipeline set --file
                        --name
                        --workspace-name
                        [--no-wait]

Exemplos

Atualize um pipeline existente. Preste atenção para adicionar "@" na frente do caminho do arquivo como a prática recomendada para argumentos complexos, como cadeia de caracteres JSON.

az synapse pipeline set --workspace-name testsynapseworkspace \
  --name testpipeline --file @"path/pipeline.json"

Parâmetros Exigidos

--file

As propriedades podem ser fornecidas a partir de um arquivo JSON usando a @{path} sintaxe ou uma cadeia de caracteres JSON.

--name -n

O nome do pipeline.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az synapse pipeline show

Editar

Obtenha um pipeline.

az synapse pipeline show --name
                         --workspace-name

Exemplos

Obtenha um pipeline.

az synapse pipeline show --workspace-name testsynapseworkspace \
  --name testpipeline

Parâmetros Exigidos

--name -n

O nome do pipeline.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az synapse pipeline update

Editar

Atualize um pipeline existente.

az synapse pipeline update --file
                           --name
                           --workspace-name
                           [--no-wait]

Exemplos

Atualize um pipeline existente. Preste atenção para adicionar "@" na frente do caminho do arquivo como a prática recomendada para argumentos complexos, como cadeia de caracteres JSON.

az synapse pipeline update --workspace-name testsynapseworkspace \
  --name testpipeline --file @"path/pipeline.json"

Parâmetros Exigidos

--file

As propriedades podem ser fornecidas a partir de um arquivo JSON usando a @{path} sintaxe ou uma cadeia de caracteres JSON.

--name -n

O nome do pipeline.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
Parâmetros Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.