secrets группа команд

Note

Эта информация относится к Интерфейсу командной строки Databricks версии 0.205 и выше. Интерфейс командной строки Databricks находится в общедоступной предварительной версии.

Использование интерфейса командной строки Databricks подчиняется лицензии Databricks и уведомлению о конфиденциальности Databricks, включая любые положения о данных использования.

Группа secrets команд в интерфейсе командной строки Databricks позволяет управлять секретами, областями секретов и разрешениями на доступ. Иногда доступ к данным требует проверки подлинности во внешних источниках данных через JDBC. Вместо прямого ввода учетных данных в записную книжку используйте секреты Databricks для хранения учетных данных и ссылки на них в записных книжках и заданиях. Дополнительные сведения см. в разделе Управление секретами.

databricks secrets create-scope

Создайте новую область секрета.

Имя области должно состоять из буквенно-цифровых символов, дефисов, символов подчеркивания и периодов и не может превышать 128 символов.

databricks secrets create-scope SCOPE [flags]

Arguments

SCOPE

    Имя области, запрашиваемое пользователем. Имена областей уникальны.

Options

--initial-manage-principal string

    Субъект, которому изначально предоставляется разрешение MANAGE для созданной области.

--json JSON

    Встроенная строка JSON или @path JSON-файл с текстом запроса.

--scope-backend-type ScopeBackendType

    Тип бэкенда, с использованием которого будет создана область. Поддерживаемые значения: AZURE_KEYVAULT, DATABRICKS

Глобальные флаги

databricks secrets delete-acl

Удалите заданный ACL в указанной области.

Пользователь должен иметь разрешение MANAGE для вызова этой команды. Создает исключение RESOURCE_DOES_NOT_EXIST , если такая область секрета, субъект или ACL не существует. Выдается ошибка PERMISSION_DENIED, если у пользователя нет разрешения на вызов API.

databricks secrets delete-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    Имя области, из которой нужно удалить разрешения.

PRINCIPAL

    Субъект, из которого нужно удалить существующий список управления доступом (ACL).

Options

--json JSON

    Встроенная строка JSON или @path JSON-файл с текстом запроса.

Глобальные флаги

databricks секреты delete-scope

Удалить область секретов.

Выбрасывает RESOURCE_DOES_NOT_EXIST, если область не существует. Вызывает исключение PERMISSION_DENIED, если у пользователя нет разрешения на этот вызов.

databricks secrets delete-scope SCOPE [flags]

Arguments

SCOPE

    Имя области для удаления.

Options

--json JSON

    Встроенная строка JSON или @path JSON-файл с текстом запроса.

Глобальные флаги

databricks secrets delete-secret

Удалите секрет, хранящийся в этой области секрета. Необходимо иметь WRITE или MANAGE разрешение на область секрета.

Выбрасывает RESOURCE_DOES_NOT_EXIST, если такая секретная область или секрет не существует. Вызывает исключение PERMISSION_DENIED, если у пользователя нет разрешения на этот вызов.

databricks secrets delete-secret SCOPE KEY [flags]

Arguments

SCOPE

    Имя области, содержащей секрет для удаления.

KEY

    Имя секрета для удаления.

Options

--json JSON

    Встроенная строка JSON или @path JSON-файл с текстом запроса.

Глобальные флаги

databricks secrets get-acl

Получите сведения об заданном ACL, например группе и разрешении. У пользователей MANAGE должно быть разрешение на вызов этого API.

Выбрасывается RESOURCE_DOES_NOT_EXIST, если такая область секретов не существует. Вызывает исключение PERMISSION_DENIED, если у пользователя нет разрешения на этот вызов.

databricks secrets get-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    Имя области, из которой извлекаются данные ACL.

PRINCIPAL

    Субъект, для которого запрашиваются сведения об ACL.

Options

Глобальные флаги

databricks secrets get-secret

Получите байтовое представление секретного значения для заданной области и ключа.

Пользователям требуется READ разрешение на этот вызов.

Обратите внимание, что возвращаемое значение секрета находится в байтах. Интерпретация байтов определяется вызывающим элементом в DBUtils и типом, в который декодируются данные.

Выдается ошибка PERMISSION_DENIED, если у пользователя нет разрешения на вызов API. Выдает исключение RESOURCE_DOES_NOT_EXIST , если такая область хранения секретов или секрет не существует.

databricks secrets get-secret SCOPE KEY [flags]

Arguments

SCOPE

    Имя области для получения секретных сведений.

KEY

    Ключ для получения этого секрета.

Options

Глобальные флаги

databricks secrets list-acls

Перечислите ACL для заданной области секрета. У пользователей MANAGE должно быть разрешение на вызов этого API.

Выбрасывается RESOURCE_DOES_NOT_EXIST, если такая область секретов не существует. Вызывает исключение PERMISSION_DENIED, если у пользователя нет разрешения на этот вызов.

databricks secrets list-acls SCOPE [flags]

Arguments

SCOPE

    Имя области, из которой извлекаются данные ACL.

Options

Глобальные флаги

databricks секреты list-scopes

Список всех областей секретов, доступных в рабочей области.

Вызывает исключение PERMISSION_DENIED, если у пользователя нет разрешения на этот вызов.

databricks secrets list-scopes [flags]

Options

Глобальные флаги

databricks секреты список-секретов

Перечислите секретные ключи, хранящиеся в этой области. Это операция только метаданных; Не удается получить секретные данные с помощью этой команды. Пользователям требуется READ разрешение на этот вызов.

Возвращенное lastUpdatedTimestamp значение указано в миллисекундах с начала эпохи. Выбрасывается RESOURCE_DOES_NOT_EXIST, если такая область секретов не существует. Вызывает исключение PERMISSION_DENIED, если у пользователя нет разрешения на этот вызов.

databricks secrets list-secrets SCOPE [flags]

Arguments

SCOPE

    Имя области для перечисления секретов внутри.

Options

Глобальные флаги

databricks secrets put-acl

Создайте или перезаписите список управления доступом (ACL), связанный с заданным субъектом (пользователем или группой) в указанной точке области.

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

• MANAGE Разрешено изменять списки контроля доступа, а также читать и записывать данные в эту область секретов.
• WRITE Разрешено читать и записывать данные в эту секретную область.
• READ Разрешено читать эту область секрета и перечислять доступные секреты.

Обратите внимание, что в целом значения секретов можно считывать только из команды в кластере (например, с помощью записной книжки). Нет API для чтения фактического значения секрета за пределами кластера. Однако разрешение пользователя будет применено в зависимости от того, кто выполняет команду, и выполняющий команду пользователь должен иметь по крайней мере разрешение на ЧТЕНИЕ.

Пользователь должен иметь разрешение MANAGE для вызова этой команды.

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

Выбрасывается RESOURCE_DOES_NOT_EXIST, если такая область секретов не существует. Создает исключение RESOURCE_ALREADY_EXISTS , если разрешение для субъекта уже существует. Генерирует INVALID_PARAMETER_VALUE, если разрешение или субъект недействительны. Вызывает исключение PERMISSION_DENIED, если у пользователя нет разрешения на этот вызов.

databricks secrets put-acl SCOPE PRINCIPAL PERMISSION [flags]

Arguments

SCOPE

    Имя области, к которой применяются разрешения.

PRINCIPAL

    Субъект, в котором применяется разрешение.

PERMISSION

    Уровень разрешений, применяемый к субъекту. Поддерживаемые значения: MANAGE, READ, WRITE

Options

--json JSON

    Встроенная строка JSON или @path JSON-файл с текстом запроса.

Глобальные флаги

секреты databricks put-secret

Вставьте секрет в пределах указанной области с заданным именем. Если секрет уже существует с тем же именем, эта команда перезаписывает значение существующего секрета. Сервер шифрует секрет с помощью параметров шифрования области секрета перед сохранением.

Необходимо иметь WRITE или MANAGE разрешение на область секрета. Секретный ключ должен состоять из буквенно-цифровых символов, дефисов, символов подчеркивания и периодов и не может превышать 128 символов. Максимальный допустимый размер значения секрета составляет 128 КБ. Максимальное количество секретов в заданной области — 1000.

Аргументы string-value или bytes-value укажите тип секрета, который определяет значение, возвращаемое при запросе значения секрета.

Можно указать значение секрета одним из трех способов:

• Укажите значение в виде строки с помощью флага --string-value .
• Введите секрет, когда будет предложено сделать это интерактивно (секреты в одну строку).
• Передайте секрет через стандартные входные данные (многострочный секрет).

databricks secrets put-secret SCOPE KEY [flags]

Arguments

SCOPE

    Имя области для хранения секретных данных.

KEY

    Имя ключа секрета.

Options

--bytes-value string

    Если задано, значение будет храниться в виде байтов.

--json JSON

    Встроенная строка JSON или @path JSON-файл с текстом запроса.

--string-value string

    Если указано, обратите внимание, что значение будет храниться в форме UTF-8 (MB4).

Глобальные флаги

Глобальные флаги

--debug

  Следует ли включить ведение журнала отладки.

-h или --help

    Отобразить справку по интерфейсу командной строки Databricks, связанной группе команд или отдельной команде.

--log-file струна

    Строка, представляющая файл для записи журналов выходных данных. Если этот флаг не указан, по умолчанию используется запись журналов выходных данных в stderr.

--log-format формат

    Тип text формата журнала или json. Значение по умолчанию — text.

--log-level струна

    Строка, представляющая уровень формата журнала. Если не указано, уровень формата журнала отключен.

типа -o, --output

    Тип text выходных данных команды или json. Значение по умолчанию — text.

-p, --profile струна

    Имя профиля в ~/.databrickscfg файле, используемого для выполнения команды. Если этот флаг не указан, то если он существует, используется DEFAULT профиль.

--progress-format формат

    Формат для отображения журналов хода выполнения: default, appendinplace, илиjson

-t, --target струна

    Если применимо, целевой объект пакета для использования