Partilhar via


az synapse pipeline

Gerencie os pipelines da Synapse.

Comandos

Name Description Tipo Status
az synapse pipeline create

Crie um pipeline.

Core disponibilidade geral
az synapse pipeline create-run

Cria uma execução de um pipeline.

Core disponibilidade geral
az synapse pipeline delete

Exclua um pipeline.

Core disponibilidade geral
az synapse pipeline list

Listar pipelines.

Core disponibilidade geral
az synapse pipeline set

Atualize um pipeline existente.

Core Deprecated
az synapse pipeline show

Obtenha um pipeline.

Core disponibilidade geral
az synapse pipeline update

Atualize um pipeline existente.

Core disponibilidade geral

az synapse pipeline create

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 a cadeia de caracteres JSON.

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

Parâmetros Obrigatórios

--file

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

--name -n

O nome do pipeline.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Não espere que a operação de longa duração termine.

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.

--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 synapse pipeline create-run

Cria uma execução de um pipeline.

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

Exemplos

Pipelines_CreateRun

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

Parâmetros Obrigatórios

--name -n

O nome do pipeline.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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 para execução de pipeline. Pode ser fornecido a partir de um arquivo JSON usando a sintaxe @{path} ou uma cadeia de caracteres JSON.

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

O ID de execução do pipeline para reexecução. 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.

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

Exclua um pipeline.

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

Exemplos

Exclua um pipeline.

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

Parâmetros Obrigatórios

--name -n

O nome do pipeline.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--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.

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

Listar pipelines.

az synapse pipeline list --workspace-name

Exemplos

Listar pipelines.

az synapse pipeline list --workspace-name testsynapseworkspace

Parâmetros Obrigatórios

--workspace-name

O nome do espaço de trabalho.

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

Preterido

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

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 a cadeia de caracteres JSON.

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

Parâmetros Obrigatórios

--file

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

--name -n

O nome do pipeline.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Não espere que a operação de longa duração termine.

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.

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

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 Obrigatórios

--name -n

O nome do pipeline.

--workspace-name

O nome do espaço de trabalho.

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

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 a cadeia de caracteres JSON.

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

Parâmetros Obrigatórios

--file

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

--name -n

O nome do pipeline.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Não espere que a operação de longa duração termine.

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.

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