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

Note

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

Important

Эта функция доступна в общедоступной предварительной версии.

secrets-uc Командная группа внутри CLI Databricks управляет секретами Unity Catalog. Секрет — это защищённый объект Unity Catalog, который хранит чувствительные данные данных (такие как пароли, токены и ключи) в трёхуровневом пространстве имён (catalog_name.schema_name.secret_name). Секреты могут управляться с помощью стандартных разрешений каталога Unity и ограничены схемой внутри каталога.

databricks secrets-uc create-secret

Создаёт новый секрет в Unity Catalog. Вы должны быть владельцем родительской схемы или иметь CREATE_SECRET и USE SCHEMA привилегии на материнской схеме и USE CATALOG в родительском каталоге. Секрет хранится в указанном каталоге и схеме, а поле значения содержит конфиденциальные данные, которые необходимо безопасно хранить.

databricks secrets-uc create-secret NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]

Arguments

NAME

    Название секрета относительно её родительской схемы.

CATALOG_NAME

    Название каталога, где хранятся схема и секрет.

SCHEMA_NAME

    Название схемы, где хранится секрет.

VALUE

    Секретная ценность для хранения. Это поле является только входным и не возвращается в ответах — используйте поле effective_value (через GetSecret с include_value установленным true), чтобы прочитать секретное значение. Максимальный размер — 60 КиБ (до шифрования). Допустимый контент включает пароли, жетоны, ключи и другие чувствительные данные учетных данных.

Options

--comment string

    Пользовательское свободное текстовое описание секрета.

--expire-time string

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

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--owner string

    Владелец секрета.

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

databricks secrets-uc delete-secret

Удаляет секрет по его трёхуровневому (полностью квалифицированному) названию. Вы должны быть владельцем секрета или администратором метамагазина.

databricks secrets-uc delete-secret FULL_NAME [flags]

Arguments

FULL_NAME

    Трехуровневое (полностью квалифицированное) имя секрета (например , catalog_name.schema_name.secret_name).

Options

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

Databricks Secrets-UC Get-Secret

Получает секрет по своему трёхуровневому (полностью квалифицированному) названию. Вы должны быть администратором метамагазина, владельцем секрета или иметь право MANAGE на этот секрет. Секретное значение по умолчанию не возвращается. Чтобы получить его, у вас также должно быть привилегия READ_SECRET и include_value в запросе true.

databricks secrets-uc get-secret FULL_NAME [flags]

Arguments

FULL_NAME

    Трехуровневое (полностью квалифицированное) имя секрета (например , catalog_name.schema_name.secret_name).

Options

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

databricks secrets-UC list-secrets

Содержит секреты в каталоге Unity. Вы должны быть администратором метамагазина, владельцем секрета или иметь право MANAGE на этот секрет. И catalog_name , и schema_name должны быть заданные вместе для фильтрации секретов внутри конкретной схемы. Результаты пагинированы; Используйте поле page_token из ответа для получения следующих страниц.

databricks secrets-uc list-secrets [flags]

Options

--catalog-name string

    Название каталога, под которым можно перечислить секреты.

--limit int

    Максимальное количество возвращаемых результатов.

--page-size int

    Максимальное количество секретов для возврата.

--schema-name string

    Название схемы, под которой можно перечислять секреты.

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

Databricks Secrets-UC Update-Secret

Обновляет существующий секрет в Unity Catalog. Вы должны быть владельцем секрета или администратором метамагазина. Если вы администратор метамагазина, можно менять только поле владельца . Используйте поле update_mask , чтобы указать, какие поля обновлять. Поддерживаемые обновляемые поля включают value, comment, owner и expire_time.

databricks secrets-uc update-secret FULL_NAME UPDATE_MASK NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]

Arguments

FULL_NAME

    Трехуровневое (полностью квалифицированное) имя секрета (например , catalog_name.schema_name.secret_name).

UPDATE_MASK

    Маска поля, указывающая, какие поля секрета нужно обновить. Если update_mask равно «*», все поля, указанные в секрете , обновляются. Если update_mask указывает одно или несколько полей, обновляются только эти поля. Каждое указанное поле должно быть установлено в секрете. Поддерживаемые поля: значение, комментарий, владелецexpire_time. Чтобы изменить имя секрета, удалите и создайте его заново.

NAME

    Название секрета относительно её родительской схемы.

CATALOG_NAME

    Название каталога, где хранятся схема и секрет.

SCHEMA_NAME

    Название схемы, где хранится секрет.

VALUE

    Секретная ценность для хранения. Это поле является только входным и не возвращается в ответах — используйте поле effective_value (через GetSecret с include_value установленным true), чтобы прочитать секретное значение. Максимальный размер — 60 КиБ (до шифрования). Допустимый контент включает пароли, жетоны, ключи и другие чувствительные данные учетных данных.

Options

--comment string

    Пользовательское свободное текстовое описание секрета.

--expire-time string

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

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--owner string

    Владелец секрета.

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

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

--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 струна

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