az synapse notebook

Управление записными книжками Synapse.

Команды

Имя Описание Тип Состояние
az synapse notebook create

Создайте записную книжку.

 Core GA
az synapse notebook delete

Удаление записной книжки.

 Core GA
az synapse notebook export

Экспорт записных книжек.

 Core GA
az synapse notebook import

Импорт записной книжки.

 Core GA
az synapse notebook list

Вывод списка записных книжек.

 Core GA
az synapse notebook set

Установка существующей записной книжки.

 Core GA
az synapse notebook show

Получите записную книжку.

 Core GA

az synapse notebook create

Изменить

Создайте записную книжку.

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

Примеры

Создайте записную книжку. Обратите внимание, чтобы добавить "@" в передней части пути к файлу в качестве оптимальной практики для сложных аргументов, таких как строка JSON.

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

Обязательные параметры

--file

Свойства могут быть предоставлены из JSON-файла с помощью синтаксиса @{path} или строки JSON.

--name -n

Имя записной книжки.

--workspace-name

Имя рабочей области.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--executor-count

Количество исполнителей, выделенных в указанном пуле Spark для задания.

Свойство Значение
Default value: 2
--executor-size

Количество ядер и памяти, которые будут использоваться для исполнителей, выделенных в указанном пуле Spark для задания.

Свойство Значение
Default value: Small
Допустимые значения: Large, Medium, Small
--folder-path

Папка, в которую находится эта записная книжка. Если это не указано, эта записная книжка будет отображаться на корневом уровне. Например: folder/subfolder1.

--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Default value: False
--spark-pool-name

Имя пула Spark.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az synapse notebook delete

Изменить

Удаление записной книжки.

az synapse notebook delete --name
                           --workspace-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--no-wait]
                           [--yes]

Примеры

Удаление записной книжки.

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

Обязательные параметры

--name -n

Имя записной книжки.

--workspace-name

Имя рабочей области.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Default value: False
--yes -y

Не запрашивать подтверждение.

Свойство Значение
Default value: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az synapse notebook export

Изменить

Экспорт записных книжек.

az synapse notebook export --output-folder
                           --workspace-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--name]

Примеры

Экспорт записной книжки.

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

Экспортируйте все записные книжки в рабочую область.

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

Обязательные параметры

--output-folder

Папка, в которой должна размещаться записная книжка.

--workspace-name

Имя рабочей области.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--name -n

Имя записной книжки.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az synapse notebook import

Изменить

Импорт записной книжки.

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

Примеры

Импорт записной книжки. Обратите внимание, чтобы добавить "@" в передней части пути к файлу в качестве оптимальной практики для сложных аргументов, таких как строка JSON.

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

Обязательные параметры

--file

Свойства могут быть предоставлены из JSON-файла с помощью синтаксиса @{path} или строки JSON.

--name -n

Имя записной книжки.

--workspace-name

Имя рабочей области.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--executor-count

Количество исполнителей, выделенных в указанном пуле Spark для задания.

Свойство Значение
Default value: 2
--executor-size

Количество ядер и памяти, которые будут использоваться для исполнителей, выделенных в указанном пуле Spark для задания.

Свойство Значение
Default value: Small
Допустимые значения: Large, Medium, Small
--folder-path

Папка, в которую находится эта записная книжка. Если это не указано, эта записная книжка будет отображаться на корневом уровне. Например: folder/subfolder1.

--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Default value: False
--spark-pool-name

Имя пула Spark.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az synapse notebook list

Изменить

Вывод списка записных книжек.

az synapse notebook list --workspace-name

Примеры

Вывод списка записных книжек.

az synapse notebook list --workspace-name testsynapseworkspace

Обязательные параметры

--workspace-name

Имя рабочей области.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az synapse notebook set

Изменить

Установка существующей записной книжки.

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

Примеры

Установка существующей записной книжки. Обратите внимание, чтобы добавить "@" в передней части пути к файлу в качестве оптимальной практики для сложных аргументов, таких как строка JSON.

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

Обязательные параметры

--file

Свойства могут быть предоставлены из JSON-файла с помощью синтаксиса @{path} или строки JSON.

--name -n

Имя записной книжки.

--workspace-name

Имя рабочей области.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--executor-count

Количество исполнителей, выделенных в указанном пуле Spark для задания.

Свойство Значение
Default value: 2
--executor-size

Количество ядер и памяти, которые будут использоваться для исполнителей, выделенных в указанном пуле Spark для задания.

Свойство Значение
Default value: Small
Допустимые значения: Large, Medium, Small
--folder-path

Папка, в которую находится эта записная книжка. Если это не указано, эта записная книжка будет отображаться на корневом уровне. Например: folder/subfolder1.

--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Default value: False
--spark-pool-name

Имя пула Spark.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az synapse notebook show

Изменить

Получите записную книжку.

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

Примеры

Получите записную книжку.

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

Обязательные параметры

--name -n

Имя записной книжки.

--workspace-name

Имя рабочей области.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False