Notitie
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen u aan te melden of de directory te wijzigen.
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen de mappen te wijzigen.
Een secret scope van een werkruimte is een benoemde verzameling geheimen in één werkruimte. Secret scope-permissies bepalen wie de geheimen erin kan lezen, ernaar kan schrijven en beheren. Machtigingen gelden voor de hele scope, niet voor individuele secrets, dus een gebruiker die één secret in een scope kan lezen, kan ze allemaal lezen. Om werkruimtegeheimscopes te vergelijken met Unity Catalog-geheimen, zie Kies waar een geheim moet worden opgeslagen.
Om een secret scope voor de werkruimte te gebruiken:
- Maak een geheime scope.
- Voeg secrets toe aan de scope.
- Verleen machtigingen voor de scope.
- Verwijs naar de geheimen in je code, of in een Spark-configuratie-eigenschap of omgevingsvariabele. Zie Een geheim gebruiken in een Spark-configuratie-eigenschap of omgevingsvariabele.
Warning
Workspace-beheerders, makers van geheimen en gebruikers die toestemming hebben gekregen, kunnen Azure Databricks geheimen raadplegen en lezen. Hoewel Azure Databricks probeert geheime waarden in notebook-uitvoer te redigeren, is het niet mogelijk om deze gebruikers volledig te verhinderen geheime inhoud te bekijken. Wijs altijd geheime toegangsmachtigingen zorgvuldig toe om gevoelige informatie te beveiligen.
Geheime scopes beheren
Azure Databricks raadt aan om secret scopes af te stemmen op rollen of applicaties in plaats van individuen.
Er zijn twee typen geheime reikwijdte:
- Door Azure Key Vault ondersteund: u kunt verwijzen naar geheimen die zijn opgeslagen in een Azure Key Vault met behulp van geheime bereiken met Azure Key Vault-ondersteuning. Een door Azure Key Vault ondersteunde secret-scope is een alleen-lezen interface naar de Key Vault. Je beheert de geheimen ervan in Azure.
- Databricks-ondersteund: Een Databricks-ondersteunde geheime scope wordt opgeslagen in een versleutelde database die eigendom is van en beheerd wordt door Azure Databricks.
Important
Door Azure Key Vault ondersteunde secret scopes ondersteunen alleen het machtigingsmodel Vault access policy, niet Azure role-based access control (RBAC). Nieuwe Azure Key Vault-kluizen gebruiken standaard Azure RBAC. Als je key vault Azure RBAC gebruikt, verander dan het permissiemodel naar Vault access policy voordat je een geheime scope aanmaakt die door Azure Key Vault wordt ondersteund.
Nadat u een geheim domein hebt gemaakt, kunt u machtigingen toewijzen om gebruikers toegang te verlenen tot het lezen, schrijven en beheren van geheime domeinen.
Een geheim bereik met Azure Key Vault-ondersteuning maken
Maak een secretbereik aan dat wordt ondersteund door Azure Key Vault in het Azure-portaal en de Azure Databricks-workspace-UI. Je kunt ook de Databricks CLI gebruiken.
Requirements
- U moet een Azure Key Vault-exemplaar hebben. Als u geen Key Vault-instantie heeft, volg dan de instructies in Een Key Vault maken met behulp van het Azure-portaal.
- U moet de rol Key Vault-bijdrager, Bijdrager of Eigenaar hebben voor het Azure Key Vault-exemplaar dat u wilt gebruiken om het geheime bereik te ondersteunen.
Note
Voor het maken van een geheime scope die door Azure Key Vault wordt gesteund, is de rol Bijdrager of Eigenaar van de Azure Key Vault-instance vereist, zelfs als de Azure Databricks-service eerder toegang heeft gekregen tot de sleutelkluis.
Als de sleutelkluis in een andere tenant bestaat dan de Azure Databricks-werkruimte, moet de Microsoft Entra ID-gebruiker die de geheime scope aanmaakt toestemming hebben om service-principals te maken in de tenant van de sleutelkluis. Anders treedt de volgende fout op:
Unable to grant read/list permission to Databricks service principal to KeyVault 'https://xxxxx.vault.azure.net/': Status code 403, {"odata.error":{"code":"Authorization_RequestDenied","message":{"lang":"en","value":"Insufficient privileges to complete the operation."},"requestId":"XXXXX","date":"YYYY-MM-DDTHH:MM:SS"}}
Configureer uw Azure Key Vault-instantie voor Azure Databricks
Log in op het Azure-portaal, zoek en selecteer de Azure key vault-instantie.
Onder Instellingen klikt u op het tabblad Toegangsconfiguratie.
Stel Toestemmingsmodel in op kluis toegangsbeleid. Nieuwe sleutelkluizen gebruiken standaard Azure-rolgebaseerde toegangscontrole, wat niet wordt ondersteund door Azure Key Vault-ondersteunde geheime scopes.
Note
Als u een geheim bereik met Azure Key Vault-ondersteuning maakt, verleent u de machtigingen ophalen en weergeven aan de toepassings-id voor de Azure Databricks-service met behulp van toegangsbeleid voor de kluis.
Selecteer Netwerken onder Instellingen.
In Firewalls en virtuele netwerken stel Toegang toestaan vanaf: in op Openbare toegang toestaan vanaf specifieke virtuele netwerken en IP-adressen.
Onder Uitzondering, selecteer Vertrouwde Microsoft-services toestaan om deze firewall te omzeilen.
Note
U kunt ook Toegang toestaan vanaf: instellen naar Openbare toegang toestaan vanuit alle netwerken.
Maak een door Azure Key Vault ondersteunde geheimenomvang aan
Ga naar
https://<databricks-instance>#secrets/createScope. Vervang<databricks-instance>door de werkruimte-URL van jouw Azure Databricks-implementatie. Deze URL is hoofdlettergevoelig. Bijvoorbeeld,scopeincreateScopemoet een hoofdletterSgebruiken.
Voer de naam van de geheime scope in. Namen van geheime scopnamen zijn hoofdletterongevoelig.
Selecteer in Beheer hoofdgebruikerCreator of Alle werkruimtegebruikers om op te geven welke gebruikers de machtiging BEHEREN hebben voor de geheime scope.
Met de BEHEREN-machtiging kunnen gebruikers machtigingen binnen het gegeven bereik lezen, schrijven en verlenen. Uw account moet het Premium-abonnement hebben om Maker te kunnen kiezen.
Voer de DNS-naam (bijvoorbeeld
https://databrickskv.vault.azure.net/) en de resource-id in, bijvoorbeeld:/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/databricks-rg/providers/Microsoft.KeyVault/vaults/databricksKVDeze eigenschappen zijn beschikbaar op het tabblad Instellingen > Eigenschappen van een Azure Key Vault in uw Azure-portaal.
Klik op Create.
Gebruik het Databricks CLI-commando
databricks secrets list-scopesom te verifiëren of de scope succesvol is aangemaakt.
Maak een door Databricks ondersteunde geheime scope
Maak een geheime scope aan met de Databricks CLI (versie 0.205 en hoger) of de Secrets API.
Namen van geheime bereiken:
- Moet uniek zijn binnen een werkruimte.
- Moet bestaan uit alfanumerieke tekens, streepjes, onderstrepen
@en punten, en mag niet meer dan 128 tekens zijn. - Zijn hoofdletterongevoelig.
Geheime domeinnamen worden beschouwd als niet-gevoelig en zijn leesbaar door alle gebruikers in de werkruimte.
Om een scope te maken met behulp van de Databricks CLI:
databricks secrets create-scope <scope-name>
Standaard worden scopes aangemaakt met de BEHEER machtiging voor de gebruiker die de scope heeft aangemaakt. Nadat u een door Databricks ondersteunde geheime scope heeft gecreëerd, kunt u er geheimen aan toevoegen.
Geheime bereiken weergeven
Om de bestaande scopes in een werkruimte met behulp van de CLI weer te geven:
databricks secrets list-scopes
U kunt ook geheime scopes weergeven met de Secrets-API.
Een geheim bereik verwijderen
Het verwijderen van een geheime scope verwijdert alle geheimen en ACL's die op de scope zijn toegepast. Als u een bereik wilt verwijderen met behulp van de CLI, voert u het volgende uit:
databricks secrets delete-scope <scope-name>
U kunt ook een geheim bereik verwijderen met behulp van de Geheimen-API.
Beheer geheimen
Een geheim is een sleutel-waarde paar dat gevoelige informatie opslaat met behulp van een sleutelnaam die uniek is binnen een geheime scope.
De methode voor het creëren van een geheim hangt af van of je een Azure Key Vault-ondersteunde scope of een Databricks-ondersteunde scope gebruikt.
Maak een geheim aan in een Azure Key Vault-ondersteunde scope
Als u een geheim wilt maken in Azure Key Vault, gebruikt u Azure Portal of Azure Geheim instellen REST API.
Maak een geheim aan in een door Databricks ondersteunde scope
Maak een geheim aan met de Databricks CLI (versie 0.205 en hoger), de Databricks SDK voor Python in een notebook, of de Secrets API. Geheime namen zijn niet hoofdlettergevoelig.
Databricks-CLI
Wanneer je een geheim aanmaakt in een door Databricks ondersteunde scope, kun je de geheime waarde op een van drie manieren specificeren:
- Specificeer de waarde als een string met de
--string-valuevlag. - Voer het geheim in wanneer u hierom interactief wordt gevraagd (geheimen met één regel).
- Geef het geheim door via standaardinvoer (geheimen op meerdere regels).
Voorbeeld:
databricks secrets put-secret --json '{
"scope": "<scope-name>",
"key": "<key-name>",
"string_value": "<secret>"
}'
Als u een geheim met meerdere regels maakt, kunt u het geheim doorgeven via standaardinvoer. Voorbeeld:
(cat << EOF
this
is
a
multi
line
secret
EOF
) | databricks secrets put-secret <scope-name> <key-name>
Databricks SDK voor Python
from databricks.sdk import WorkspaceClient
w = WorkspaceClient()
w.secrets.put_secret("<secret_scope>","<key-name>",string_value ="<secret>")
Lees een geheim
Lees een geheim met de Databricks CLI (versie 0.205 en hoger), of in een notebook met de Secrets-utility (dbutils.secrets).
Databricks-CLI
Om de waarde van een secret te lezen met de Databricks CLI, moet je de base64-gecodeerde waarde decoderen. Je kunt jq gebruiken om de waarde te extraheren en base64 --decode om deze te decoderen.
databricks secrets get-secret <scope-name> <key-name> | jq -r .value | base64 --decode
Secrets-hulpprogramma (dbutils.secrets)
password = dbutils.secrets.get(scope = "<scope-name>", key = "<key-name>")
Geheimen weergeven
Om geheimen in een bepaalde scope op te sommen:
databricks secrets list-secrets <scope-name>
Het antwoord toont metadata over de secrets, zoals hun sleutelnamen. Om deze metadata in een notitieboek of job te vermelden, gebruik je de Secrets-utility (dbutils.secrets). Voorbeeld:
dbutils.secrets.list('my-scope')
Een geheim verwijderen
Om een geheim uit een scope te verwijderen met de Databricks CLI:
databricks secrets delete-secret <scope-name> <key-name>
U kunt ook de Secrets API gebruiken.
Verwijder een geheim uit een scope die wordt ondersteund door Azure Key Vault door de Azure SetSecret REST API of de Azure portal gebruikersinterface te gebruiken.
Beheer geheimen scope permissies
Standaard heeft de gebruiker die een geheime scope aanmaakt de machtiging MANAGE, waarmee hij geheimen in de scope kan lezen, geheimen ernaar kan schrijven en de rechten kan beheren.
Note
Geheime ACL's bevinden zich op het scopenniveau. Als je Azure Key Vault-ondersteunde domeinen gebruikt, hebben gebruikers die toegang tot het domein krijgen, toegang tot alle geheimen in de Azure Key Vault. Om toegang te beperken, gebruik aparte Azure-sleutelhangerinstances.
Beheer geheime scope-rechten met de Databricks CLI (versie 0.205 en hoger) of de Secrets API. Voor geheime machtigingsniveaus, zie Geheime ACL's.
Verleen een gebruiker rechten op een geheime scope
Note
Het verlenen van rechten op een geheime scope vereist het Premium-abonnement.
Een gebruiker machtigingen verlenen voor een geheim bereik met behulp van de Databricks CLI:
databricks secrets put-acl <scope-name> <principal> <permission>
Een PUT-verzoek voor een hoofdgebruiker die al een toegepaste toestemming heeft, overschrijft het bestaande toestemmingsniveau.
In principal het veld wordt een bestaande Azure Databricks-principal opgegeven. Een gebruiker wordt opgegeven door het e-mailadres, een service-principal door de applicationId waarde, en een groep door de groepsnaam. Zie Principal voor meer informatie.
Om bijvoorbeeld een groep zoals datascience de geheimen in een scope te laten lezen, geef het READ:
databricks secrets put-acl <scope-name> <group> READ
Machtigingen voor geheimbereik weergeven
Om alle geheime scope-machtigingen voor een bepaalde geheime scope te bekijken:
databricks secrets list-acls <scope-name>
Om de permissies voor een geheime scope die zijn toegepast op een principal voor een gegeven geheime scope te verkrijgen:
databricks secrets get-acl <scope-name> <principal>
Als er geen ACL bestaat voor de gegeven principal en scope, mislukt dit verzoek.
Verwijder een geheime scope-machtiging
Om een geheime scope-recht te verwijderen dat is toegepast op een voor een bepaalde geheime scope:
databricks secrets delete-acl <scope-name> <principal>
Geheime redactie
Het opslaan van inloggegevens als geheimen van Azure Databricks helpt ze te beschermen wanneer je notebooks en taken uitvoert. Je kunt echter nog steeds per ongeluk een geheim afdrukken naar standaard outputbuffers of de waarde tonen tijdens variabeletoewijzing.
Om dit te voorkomen probeert Azure Databricks geheime waarden te maskeren die worden gelezen met dbutils.secrets.get() en waarnaar wordt verwezen in een Spark-configuratie-eigenschap. Wanneer deze worden weergegeven, worden de geheime waarden vervangen door [REDACTED].
Als u bijvoorbeeld een variabele instelt op een geheime waarde met behulp van dbutils.secrets.get() en die variabele vervolgens afdrukt, wordt die variabele vervangen door [REDACTED].
Warning
Redaction is alleen van toepassing op letterlijke geheime waarden. De geheimhoudingsfunctionaliteit voorkomt geen opzettelijke en willekeurige transformaties van een geheime letterlijke waarde. Om secrets te beheren, gebruik je toegangscontrolelijsten om de rechten om commando's uit te voeren te beperken. Dit voorkomt ongeautoriseerde toegang tot gedeelde notitieboekcontexten.
Geheime redaction in SQL
Azure Databricks probeert alle SQL Data query language (DQL)-commando's die de geheime functie oproepen, inclusief verwijzingsweergaven en door de gebruiker gedefinieerde functies, af te schermen. Wanneer de secret functie wordt gebruikt, wordt de uitvoer waar mogelijk vervangen door [REDACTED] . Net als bij het redigeren van notebooks is dit alleen van toepassing op letterlijke waarden, niet op getransformeerde of indirect verwezen gegevens.
Voor SQL data manipulation language (DML)-commando's staat Azure Databricks het opzoeken van secrets toe als het geheim als veilig wordt beschouwd. Een geheim is bijvoorbeeld veilig wanneer het wordt verpakt in een cryptografische functie zoals sha() of aes_encrypt(), die voorkomen dat ruwe waarden onversleuteld worden opgeslagen.
Geheime validatie in SQL
Azure Databricks past ook validatie toe om SQL DML-opdrachten te blokkeren die ertoe kunnen leiden dat niet-versleutelde geheimen worden opgeslagen in tabellen. De query analyzer probeert deze scenario's te identificeren en te voorkomen, waardoor onbedoelde opslag van gevoelige informatie in tekst zonder opmaak wordt voorkomen.
Aanvullende bronnen
| Resource | Description |
|---|---|
| Geheimenbeheer | Vergelijk geheime scopes van werkruimtes met geheimen uit de Unity Catalog en kijk waar je elk kunt gebruiken. |
| Gebruik een geheim in een Spark-configuratie-eigenschap of omgevingsvariabele | Verwijs naar geheimen in Spark-configuratie-eigenschappen en omgevingsvariabelen. |