Compartir a través de


az synapse kql-script

Administrar script con kusto.

Comandos

Nombre Description Tipo Estado
az synapse kql-script create

Crea un script KQL.

Core GA
az synapse kql-script delete

Elimina un script KQL.

Core GA
az synapse kql-script export

Exportar scripts KQL.

Core GA
az synapse kql-script import

Crea un script KQL.

Core GA
az synapse kql-script list

Enumerar scripts KQL.

Core GA
az synapse kql-script show

Obtiene un script KQL.

Core GA
az synapse kql-script wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición de un script KQL.

Core GA

az synapse kql-script create

Crea un script KQL.

az synapse kql-script create --file
                             --name
                             --resource-group
                             --workspace-name
                             [--kusto-database-name]
                             [--kusto-pool-name]
                             [--no-wait]

Ejemplos

KustoScriptsCreateOrUpdate

az synapse kql-script create --resource-group "kustorptest" --workspace-name "kustoWorkspaceName"                --kusto-pool-name kustopooltest --kusto-database-name kustodbtest --file C:\samples\KqlScript.kql                --name "kustoScript1"

Parámetros requeridos

--file -f

Ruta de acceso del archivo de consulta KQL.

--name -n

Nombre del script KQL.

--resource-group -g

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

--workspace-name

Nombre del área de trabajo.

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.

--kusto-database-name

Nombre de la base de datos de Kusto.

--kusto-pool-name

Nombre del grupo de Kusto.

--no-wait

No espere a que finalice la operación de ejecución prolongada.

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.

--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 synapse kql-script delete

Elimina un script KQL.

az synapse kql-script delete --name
                             --workspace-name
                             [--no-wait]
                             [--yes]

Ejemplos

KustoScriptsDelete

az synapse kql-script delete --workspace-name "kustoWorkspaceName" --name "kustoScript1"

Parámetros requeridos

--name -n

Nombre del script KQL.

--workspace-name

Nombre del área de trabajo.

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.

--no-wait

No espere a que finalice la operación de ejecución prolongada.

Propiedad Valor
Valor predeterminado: False
--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.

--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 synapse kql-script export

Exportar scripts KQL.

az synapse kql-script export --output-folder
                             --workspace-name
                             [--name]

Ejemplos

KustoScriptsExport

az synapse kql-script export --workspace-name "kustoWorkspaceName" --output-folder "C:\KqlScirpt"

Parámetros requeridos

--output-folder

Nombre de la carpeta de salida.

--workspace-name

Nombre del área de trabajo.

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.

--name -n

Nombre del script KQL.

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 synapse kql-script import

Crea un script KQL.

az synapse kql-script import --file
                             --name
                             --resource-group
                             --workspace-name
                             [--kusto-database-name]
                             [--kusto-pool-name]
                             [--no-wait]

Ejemplos

KustoScriptsCreateOrUpdate

az synapse kql-script import --resource-group "kustorptest" --workspace-name "kustoWorkspaceName"                --kusto-pool-name kustopooltest --kusto-database-name kustodbtest --file C:\samples\KqlScript.kql                --name "kustoScript1"

Parámetros requeridos

--file -f

Ruta de acceso del archivo de consulta KQL.

--name -n

Nombre del script KQL.

--resource-group -g

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

--workspace-name

Nombre del área de trabajo.

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.

--kusto-database-name

Nombre de la base de datos de Kusto.

--kusto-pool-name

Nombre del grupo de Kusto.

--no-wait

No espere a que finalice la operación de ejecución prolongada.

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.

--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 synapse kql-script list

Enumerar scripts KQL.

az synapse kql-script list --workspace-name

Ejemplos

KustoScriptsList

az synapse kql-script list --workspace-name "kustoWorkspaceName"

Parámetros requeridos

--workspace-name

Nombre del área de trabajo.

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 synapse kql-script show

Obtiene un script KQL.

az synapse kql-script show --name
                           --workspace-name

Ejemplos

KustoScriptsGet

az synapse kql-script show --workspace-name "kustoWorkspaceName" --name "kustoScript1"

Parámetros requeridos

--name -n

Nombre del script KQL.

--workspace-name

Nombre del área de trabajo.

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 synapse kql-script wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición de un script KQL.

az synapse kql-script wait --name
                           --workspace-name
                           [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--interval]
                           [--timeout]
                           [--updated]

Parámetros requeridos

--name -n

Nombre del script KQL.

--workspace-name

Nombre del área de trabajo.

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.

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: False
--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
--deleted

Espere hasta que se elimine.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: False
--exists

Espere hasta que exista el recurso.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: False
--interval

Intervalo de sondeo en segundos.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: 30
--timeout

Espera máxima en segundos.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: 3600
--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
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.

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