Secrets CLI (äldre)
Viktigt!
Den här dokumentationen har dragits tillbaka och kanske inte uppdateras.
Den här informationen gäller för äldre Databricks CLI-versioner 0.18 och senare. Databricks rekommenderar att du använder nyare Databricks CLI version 0.205 eller senare i stället. Se Vad är Databricks CLI?. Kör för att hitta din version av Databricks CLI databricks -v.
Information om hur du migrerar från Databricks CLI version 0.18 eller senare till Databricks CLI version 0.205 eller senare finns i Databricks CLI-migrering.
Du kör Underkommandon för Databricks-hemligheter i CLI genom att lägga till dem i databricks secrets. Dessa underkommandon anropar API:et Hemligheter.
Mer information om hemligheter finns i Hemlig hantering.
Kommentar
Secrets CLI kräver Databricks CLI 0.7.1 eller senare.
databricks secrets --help
Usage: databricks secrets [OPTIONS] COMMAND [ARGS]...
Utility to interact with secret API.
Options:
-v, --version [VERSION]
--profile TEXT CLI connection profile to use. The default profile is
"DEFAULT".
-h, --help Show this message and exit.
Commands:
create-scope Creates a secret scope.
Options:
--scope SCOPE The name of the secret scope.
--initial-manage-principal The initial principal that can manage the created secret scope.
If specified, the initial ACL with MANAGE permission applied
to the scope is assigned to the supplied principal (user or group).
The only supported principal is the group
"users", which contains all users in the workspace. If not
specified, the initial ACL with MANAGE permission applied to
the scope is assigned to request issuer's user identity.
delete Deletes a secret.
Options:
--scope SCOPE The name of the secret scope.
--key KEY The name of secret key.
delete-acl Deletes an access control rule for a principal.
Options:
--scope SCOPE The name of the scope.
--principal PRINCIPAL The name of the principal.
delete-scope Deletes a secret scope.
Options:
--scope SCOPE The name of the secret scope.
get-acl Gets the details for an access control rule.
Options:
--scope SCOPE The name of the secret scope.
--principal PRINCIPAL The name of the principal.
--output FORMAT JSON or TABLE. Set to TABLE by default.
list Lists all the secrets in a scope.
Options:
--scope SCOPE The name of the secret scope.
--output FORMAT JSON or TABLE. Set to TABLE by default.
list-acls Lists all access control rules for a given secret scope.
Options:
--scope SCOPE The name of the secret scope.
--output FORMAT JSON or TABLE. Set to TABLE by default.
list-scopes Lists all secret scopes.
--output FORMAT JSON or TABLE. Set to TABLE by default.
put Puts a secret in a scope.
Options:
--scope SCOPE The name of the secret scope.
--key KEY The name of the secret key.
--string-value TEXT Read value from string and stored in UTF-8 (MB4) form
--binary-file PATH Read value from binary-file and stored as bytes.
put-acl Creates or overwrites an access control rule for a principal
applied to a given secret scope.
Options:
--scope SCOPE The name of the secret scope.
--principal PRINCIPAL The name of the principal.
--permission [MANAGE|WRITE|READ] The permission to apply.
write Puts a secret in a scope. "write" is an alias for "put".
Options:
--scope SCOPE The name of the secret scope.
--key KEY The name of the secret key.
--string-value TEXT Read value from string and stored in UTF-8 (MB4) form
--binary-file PATH Read value from binary-file and stored as bytes.
write-acl Creates or overwrites an access control rule for a principal
applied to a given secret scope. "write-acl" is an alias for
"put-acl".
Options:
--scope SCOPE The name of the secret scope.
--principal PRINCIPAL The name of the principal.
--permission [MANAGE|WRITE|READ] The permission to apply.
Skapa en omfattning för en hemlighet
Om du vill visa användningsdokumentationen kör du databricks secrets create-scope --help.
databricks secrets create-scope --scope my-scope
Om det lyckas visas inga utdata.
Om du vill använda Databricks CLI för att skapa ett Azure Key Vault-säkerhetskopierat hemlighetsomfång kör du databricks secrets create-scope --help för att visa information om ytterligare --scope-backend-type, --resource-idoch --dns-name alternativ. Mer information finns i Hemlig hantering.
Ta bort en hemlighet
Om du vill visa användningsdokumentationen kör du databricks secrets delete --help.
databricks secrets delete --scope my-scope --key my-key
Om det lyckas visas inga utdata.
Återkalla en ACL för ett huvudnamn
Om du vill visa användningsdokumentationen kör du databricks secrets delete-acl --help.
databricks secrets delete-acl --scope my-scope --principal someone@example.com
Om det lyckas visas inga utdata.
Ta bort en omfattning för en hemlighet
Om du vill visa användningsdokumentationen kör du databricks secrets delete-scope --help.
databricks secrets delete-scope --scope my-scope
Om det lyckas visas inga utdata.
Hämta en ACL för ett huvudnamn
Om du vill visa användningsdokumentationen kör du databricks secrets get-acl --help.
databricks secrets get-acl --scope my-scope --principal someone@example.com --output JSON
{
"principal": "sonmeone@example.com",
"permission": "MANAGE"
}
Visa en lista över de hemliga nycklar som lagras inom ett hemligt omfång
Om du vill visa användningsdokumentationen kör du databricks secrets list --help.
databricks secrets list --scope my-scope --output JSON
{
"secrets": [
{
"key": "my-key",
"last_updated_timestamp": 1621284092605
}
]
}
Kommentar
Du kan inte komma åt hemliga värden med hjälp av Databricks CLI. För att få åtkomst till hemliga värden måste du använda verktyget Databricks Utilities-hemligheter i en Databricks-notebook-fil.
Visa en lista över ACL:er för ett hemligt omfång
Om du vill visa användningsdokumentationen kör du databricks secrets list-acls --help.
databricks secrets list-acls --scope my-scope --output JSON
{
"items": [
{
"principal": "someone@example.com",
"permission": "MANAGE"
}
]
}
Visa en lista över alla tillgängliga hemliga omfång på arbetsytan
Om du vill visa användningsdokumentationen kör du databricks secrets list-scopes --help.
databricks secrets list-scopes --output JSON
{
"scopes": [
{
"name": "my-scope",
"backend_type": "DATABRICKS"
}
]
}
Skapa eller uppdatera en hemlighet
Om du vill visa användningsdokumentationen kör databricks secrets put --help du eller databricks secrets write --help.
Det finns tre sätt att lagra en hemlighet på. Det enklaste sättet är att använda --string-value alternativet. Hemligheten lagras i UTF-8-formulär (MB4). Du bör vara försiktig med det här alternativet eftersom din hemlighet kan lagras i kommandoradshistoriken i oformaterad text.
databricks secrets put --scope my-scope --key my-key --string-value my-value
Eller:
databricks secrets write --scope my-scope --key my-key --string-value my-value
Om det lyckas visas inga utdata.
Du kan också använda alternativet --binary-file för att ange en hemlighet som lagras i en fil. Filinnehållet läss som det är och lagras som byte.
databricks secrets put --scope my-scope --key my-key --binary-file my-secret.txt
Eller:
databricks secrets write --scope my-scope --key my-key --binary-file my-secret.txt
Om det lyckas visas inga utdata.
Om du inte anger något alternativ öppnas en redigerare där du kan ange din hemlighet. Följ anvisningarna i redigeraren för att ange din hemlighet.
databricks secrets put --scope my-scope --key my-key
Eller:
databricks secrets write --scope my-scope --key my-key
# ----------------------------------------------------------------------
# Do not edit the above line. Everything below it will be ignored.
# Please input your secret value above the line. Text will be stored in
# UTF-8 (MB4) form and any trailing new line will be stripped.
# Exit without saving will abort writing secret.
Bevilja eller ändra en ACL till ett hemligt omfång för ett huvudnamn
Om du vill visa användningsdokumentationen kör databricks secrets put-acl --help du eller databricks secrets write-acl --help.
databricks secrets put-acl --scope my-scope --principal someone@example.com --permission MANAGE
Eller:
databricks secrets write-acl --scope my-scope --principal someone@example.com --permission MANAGE
Om det lyckas visas inga utdata.