az datafactory pipeline

Note

Esta referencia forma parte de la extensión datafactory para la CLI de Azure (versión 2.15.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az datafactory pipeline. Obtenga más información sobre las extensiones.

Administrar la canalización con datafactory.

Comandos

Nombre	Description	Tipo	Estado
az datafactory pipeline create	Cree una canalización.	Extension	GA
az datafactory pipeline create-run	Crea una ejecución de una canalización.	Extension	GA
az datafactory pipeline delete	Elimina una canalización.	Extension	GA
az datafactory pipeline list	Enumera las canalizaciones.	Extension	GA
az datafactory pipeline show	Obtiene una canalización.	Extension	GA
az datafactory pipeline update	Actualizar una canalización.	Extension	GA

az datafactory pipeline create

Cree una canalización.

az datafactory pipeline create --factory-name
                               --name --pipeline-name
                               --pipeline
                               --resource-group
                               [--if-match]

Ejemplos

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 requeridos

--factory-name

Nombre de fábrica.

--name --pipeline-name -n

Nombre de la canalización.

--pipeline

Definición de recursos de canalización. Valor esperado: json-string/json-file/@json-file.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--if-match

ETag de la entidad de canalización. Solo se debe especificar para la actualización, para la que debe coincidir con la entidad existente o puede ser * para la actualización incondicional.

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az datafactory pipeline create-run

Crea una ejecución de una canalización.

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

Ejemplos

Pipelines_CreateRun

az datafactory pipeline create-run --factory-name "exampleFactoryName" --parameters "{\"OutputBlobNameList\":[\"exampleoutput.csv\"]}" --name "examplePipeline" --resource-group "exampleResourceGroup"

Parámetros requeridos

--factory-name

Nombre de fábrica.

--name --pipeline-name -n

Nombre de la canalización.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--is-recovery

Marca del modo de recuperación. Si el modo de recuperación se establece en true, la ejecución de canalización a la que se hace referencia y la nueva ejecución se agrupará en el mismo groupId.

Propiedad	Valor
Valores aceptados:	false, true

--parameters

Parámetros de la ejecución de la canalización. Estos parámetros solo se usarán si no se especifica runId. Valor esperado: json-string/json-file/@json-file.

--reference-pipeline-run-id

Identificador de ejecución de canalización. Si se especifica el identificador de ejecución, se usarán los parámetros de la ejecución especificada para crear una nueva ejecución.

--start-activity-name

En el modo de recuperación, la repetición se iniciará desde esta actividad. Si no se especifica, se ejecutarán todas las actividades.

--start-from-failure

En el modo de recuperación, si se establece en true, la repetición se iniciará a partir de actividades con errores. La propiedad solo se usará si no se especifica startActivityName.

Propiedad	Valor
Valores aceptados:	false, true

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az datafactory pipeline delete

Elimina una canalización.

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

Ejemplos

Pipelines_Delete

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--factory-name

Nombre de fábrica.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--name --pipeline-name -n

Nombre de la canalización.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--yes -y

No solicita confirmación.

Propiedad	Valor
Valor predeterminado:	False

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az datafactory pipeline list

Enumera las canalizaciones.

az datafactory pipeline list --factory-name
                             --resource-group

Ejemplos

Pipelines_ListByFactory

az datafactory pipeline list --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"

Parámetros requeridos

--factory-name

Nombre de fábrica.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az datafactory pipeline show

Obtiene una canalización.

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

Ejemplos

Pipelines_Get

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--factory-name

Nombre de fábrica.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--ids

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--if-none-match

ETag de la entidad de canalización. Solo se debe especificar para get. Si el ETag coincide con la etiqueta de entidad existente, o si se proporcionó *, no se devolverá ningún contenido.

--name --pipeline-name -n

Nombre de la canalización.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az datafactory pipeline update

Actualizar una canalización.

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]

Ejemplos

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 opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--activities

Lista de actividades en la canalización. Valor esperado: json-string/json-file/@json-file.

--add

Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string or JSON string>.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments
Valor predeterminado:	[]

--annotations

Lista de etiquetas que se pueden usar para describir la canalización. Valor esperado: json-string/json-file/@json-file.

--concurrency

Número máximo de ejecuciones simultáneas para la canalización.

--description

Descripción de la canalización.

--duration

Valor timeSpan, después del cual se desencadena una métrica de supervisión de Azure. Valor esperado: json-string/json-file/@json-file.

Propiedad	Valor
Grupo de parámetros:	Policy Elapsed Time Metric Arguments

--factory-name

Nombre de fábrica.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--folder-name

Nombre de la carpeta en la que se encuentra esta canalización.

Propiedad	Valor
Grupo de parámetros:	Folder Arguments

--force-string

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments
Valor predeterminado:	False

--ids

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--if-match

ETag de la entidad de canalización. Solo se debe especificar para la actualización, para la que debe coincidir con la entidad existente o puede ser * para la actualización incondicional.

--if-none-match

ETag de la entidad de canalización. Solo se debe especificar para get. Si el ETag coincide con la etiqueta de entidad existente, o si se proporcionó *, no se devolverá ningún contenido. El valor predeterminado es None.

--name --pipeline-name -n

Nombre de la canalización.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--parameters

Lista de parámetros para la canalización. Valor esperado: json-string/json-file/@json-file.

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments
Valor predeterminado:	[]

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--run-dimensions

Dimensiones emitidas por pipeline. Valor esperado: json-string/json-file/@json-file.

--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=<value>.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments
Valor predeterminado:	[]

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--variables

Lista de variables para la canalización. Valor esperado: json-string/json-file/@json-file.

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

Comentarios

¿Le ha resultado útil esta página?

Compartir a través de

az datafactory pipeline

Comandos

az datafactory pipeline create

Ejemplos

Parámetros requeridos

Parámetros opcionales

az datafactory pipeline create-run

Ejemplos

Parámetros requeridos

Parámetros opcionales

az datafactory pipeline delete

Ejemplos

Parámetros opcionales

az datafactory pipeline list

Ejemplos

Parámetros requeridos

az datafactory pipeline show

Ejemplos

Parámetros opcionales

az datafactory pipeline update

Ejemplos

Parámetros opcionales

Comentarios