Compartilhar via

az synapse notebook

Gerenciar blocos de anotações do Synapse.

Comandos

Nome Description Tipo Status
az synapse notebook create

Crie um notebook.

 Core GA
az synapse notebook delete

Excluir um bloco de anotações.

 Core GA
az synapse notebook export

Exportar blocos de anotações.

 Core GA
az synapse notebook import

Importar um bloco de anotações.

 Core GA
az synapse notebook list

Listar blocos de anotações.

 Core GA
az synapse notebook set

Defina um bloco de anotações existente.

 Core GA
az synapse notebook show

Obtenha um bloco de anotações.

 Core 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 ao adicionar "@" na frente do caminho do arquivo como a melhor prática para argumentos complexos, como a 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 de um arquivo JSON usando a sintaxe @{path} ou uma cadeia de caracteres JSON.

--name -n

O nome do bloco de anotações.

--workspace-name

O nome do workspace.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--executor-count

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

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

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

A pasta na qual este bloco de anotações está. Se não for especificado, este bloco de anotações aparecerá no nível raiz. Por exemplo: pasta/subpasta1.

--no-wait

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

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

O nome do pool do Spark.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--no-wait

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

Propriedade Valor
Valor padrão: False
--yes -y

Não solicite confirmação.

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

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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

Exportar todos os notebooks em um workspace.

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

Parâmetros Exigidos

--output-folder

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

--workspace-name

O nome do workspace.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--name -n

O nome do bloco de anotações.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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 ao adicionar "@" na frente do caminho do arquivo como a melhor prática para argumentos complexos, como a 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 de um arquivo JSON usando a sintaxe @{path} ou uma cadeia de caracteres JSON.

--name -n

O nome do bloco de anotações.

--workspace-name

O nome do workspace.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--executor-count

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

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

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

A pasta na qual este bloco de anotações está. Se não for especificado, este bloco de anotações aparecerá no nível raiz. Por exemplo: pasta/subpasta1.

--no-wait

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

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

O nome do pool do Spark.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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 ao adicionar "@" na frente do caminho do arquivo como a melhor prática para argumentos complexos, como a 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 de um arquivo JSON usando a sintaxe @{path} ou uma cadeia de caracteres JSON.

--name -n

O nome do bloco de anotações.

--workspace-name

O nome do workspace.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--executor-count

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

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

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

A pasta na qual este bloco de anotações está. Se não for especificado, este bloco de anotações aparecerá no nível raiz. Por exemplo: pasta/subpasta1.

--no-wait

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

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

O nome do pool do Spark.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False