Compartilhar via

az synapse notebook

  • Referência

Gerencie os blocos de anotações do Synapse.

Comandos

Nome Description Tipo Status
az synapse notebook create

Crie um notebook.

 Núcleo GA
az synapse notebook delete

Excluir um bloco de anotações.

 Núcleo GA
az synapse notebook export

Exportar blocos de anotações.

 Núcleo GA
az synapse notebook import

Importar um bloco de anotações.

 Núcleo GA
az synapse notebook list

Listar blocos de anotações.

 Núcleo GA
az synapse notebook set

Defina um bloco de anotações existente.

 Núcleo GA
az synapse notebook show

Obtenha um bloco de anotações.

 Núcleo GA

az synapse notebook create

Editar

Crie um notebook.

az synapse notebook create --file
                           --name
                           --workspace-name
                           [--executor-count]
                           [--executor-size {Large, Medium, Small}]
                           [--folder-path]
                           [--no-wait]
                           [--spark-pool-name]

Exemplos

Crie um notebook. 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 notebook create --workspace-name testsynapseworkspace \
  --name testnotebook --file @"path/notebook.ipynb" --folder-path 'folder/subfolder'

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 bloco de anotações.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

--executor-count

Número de executores a serem alocados no pool do Spark especificado para o trabalho.

Valor padrão: 2
--executor-size

Número de núcleo e memória a serem usados para executores alocados no pool do Spark especificado para o trabalho.

Valores aceitos: Large, Medium, Small
Valor padrão: Small
--folder-path

A pasta em que este bloco de anotações está. Se não for especificado, este bloco de anotações aparecerá no nível raiz. Ex: pasta/subpasta1.

--no-wait

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

Valor padrão: False
--spark-pool-name

O nome da piscina Spark.

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

Editar

Excluir um bloco de anotações.

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

Exemplos

Excluir um bloco de anotações.

az synapse notebook delete --workspace-name testsynapseworkspace \
  --name testnotebook

Parâmetros Exigidos

--name -n

O nome do bloco de anotações.

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

Editar

Exportar blocos de anotações.

az synapse notebook export --output-folder
                           --workspace-name
                           [--name]

Exemplos

Exportar um bloco de anotações.

az synapse notebook export --workspace-name testsynapseworkspace \
  --name testnotebook --output-folder C:/output

Exporte todos os blocos de anotações em um espaço de trabalho.

az synapse notebook export --workspace-name testsynapseworkspace \
  --output-folder C:/output

Parâmetros Exigidos

--output-folder

A pasta onde o bloco de anotações deve ser colocado.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

--name -n

O nome do bloco de anotações.

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

Editar

Importar um bloco de anotações.

az synapse notebook import --file
                           --name
                           --workspace-name
                           [--executor-count]
                           [--executor-size {Large, Medium, Small}]
                           [--folder-path]
                           [--no-wait]
                           [--spark-pool-name]

Exemplos

Importar um bloco de anotações. 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 notebook import --workspace-name testsynapseworkspace \
  --name testnotebook --file @"path/notebook.ipynb" --folder-path 'folder/subfolder'

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 bloco de anotações.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

--executor-count

Número de executores a serem alocados no pool do Spark especificado para o trabalho.

Valor padrão: 2
--executor-size

Número de núcleo e memória a serem usados para executores alocados no pool do Spark especificado para o trabalho.

Valores aceitos: Large, Medium, Small
Valor padrão: Small
--folder-path

A pasta em que este bloco de anotações está. Se não for especificado, este bloco de anotações aparecerá no nível raiz. Ex: pasta/subpasta1.

--no-wait

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

Valor padrão: False
--spark-pool-name

O nome da piscina Spark.

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

Editar

Listar blocos de anotações.

az synapse notebook list --workspace-name

Exemplos

Listar blocos de anotações.

az synapse notebook 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 notebook set

Editar

Defina um bloco de anotações existente.

az synapse notebook set --file
                        --name
                        --workspace-name
                        [--executor-count]
                        [--executor-size {Large, Medium, Small}]
                        [--folder-path]
                        [--no-wait]
                        [--spark-pool-name]

Exemplos

Defina um bloco de anotações 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 notebook set --workspace-name testsynapseworkspace \
  --name testnotebook --file @"path/notebook.ipynb" --folder-path 'folder/subfolder'

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 bloco de anotações.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

--executor-count

Número de executores a serem alocados no pool do Spark especificado para o trabalho.

Valor padrão: 2
--executor-size

Número de núcleo e memória a serem usados para executores alocados no pool do Spark especificado para o trabalho.

Valores aceitos: Large, Medium, Small
Valor padrão: Small
--folder-path

A pasta em que este bloco de anotações está. Se não for especificado, este bloco de anotações aparecerá no nível raiz. Ex: pasta/subpasta1.

--no-wait

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

Valor padrão: False
--spark-pool-name

O nome da piscina Spark.

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

Editar

Obtenha um bloco de anotações.

az synapse notebook show --name
                         --workspace-name

Exemplos

Obtenha um bloco de anotações.

az synapse notebook show --workspace-name testsynapseworkspace \
  --name testnotebook

Parâmetros Exigidos

--name -n

O nome do bloco de anotações.

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