Partilhar via

az synapse notebook

Gerencie os cadernos da Synapse.

Comandos

Name Description Tipo Status
az synapse notebook create

Crie um bloco de notas.

 Core disponibilidade geral
az synapse notebook delete

Excluir um bloco de anotações.

 Core disponibilidade geral
az synapse notebook export

Exportar blocos de anotações.

 Core disponibilidade geral
az synapse notebook import

Importe um bloco de notas.

 Core disponibilidade geral
az synapse notebook list

Listar blocos de anotações.

 Core disponibilidade geral
az synapse notebook set

Defina um bloco de anotações existente.

 Core disponibilidade geral
az synapse notebook show

Obtenha um bloco de notas.

 Core disponibilidade geral

az synapse notebook create

Editar

Crie um bloco de notas.

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

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

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--executor-count

Número de executores a serem alocados no pool de faíscas especificado para o trabalho.

Propriedade Valor
Default value: 2
--executor-size

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

Propriedade Valor
Default value: Small
Valores aceites: Large, Medium, Small
--folder-path

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

--no-wait

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

Propriedade Valor
Default value: False
--spark-pool-name

O nome da piscina Spark.

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

--name -n

O nome do bloco de anotações.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Editar

Exportar blocos de anotações.

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

Exemplos

Exporte um bloco de notas.

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

Exporte todos os blocos de notas numa área de trabalho.

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

Parâmetros Obrigatórios

--output-folder

A pasta onde o bloco de notas deve ser colocado.

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--name -n

O nome do bloco de anotações.

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

Editar

Importe um bloco de notas.

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

Exemplos

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

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

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--executor-count

Número de executores a serem alocados no pool de faíscas especificado para o trabalho.

Propriedade Valor
Default value: 2
--executor-size

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

Propriedade Valor
Default value: Small
Valores aceites: Large, Medium, Small
--folder-path

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

--no-wait

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

Propriedade Valor
Default value: False
--spark-pool-name

O nome da piscina Spark.

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

az synapse notebook set --workspace-name testsynapseworkspace \
  --name testnotebook --file @"path/notebook.ipynb" --folder-path 'folder/subfolder'

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

--workspace-name

O nome do espaço de trabalho.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--executor-count

Número de executores a serem alocados no pool de faíscas especificado para o trabalho.

Propriedade Valor
Default value: 2
--executor-size

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

Propriedade Valor
Default value: Small
Valores aceites: Large, Medium, Small
--folder-path

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

--no-wait

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

Propriedade Valor
Default value: False
--spark-pool-name

O nome da piscina Spark.

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

Editar

Obtenha um bloco de notas.

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

Exemplos

Obtenha um bloco de notas.

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

Parâmetros Obrigatórios

--name -n

O nome do bloco de anotações.

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