Dela via


credentials kommandogrupp

Note

Den här informationen gäller för Databricks CLI-versionerna 0.205 och senare. The Databricks CLI is in Public Preview.

Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.

The credentials command group within the Databricks CLI allows you to manage credentials for accessing services on your cloud tenant. Varje autentiseringsuppgift omfattas av åtkomstkontrollprinciper för Unity Catalog som styr vilka användare och grupper som kan komma åt autentiseringsuppgifterna.

En autentiseringsuppgift representerar en autentiserings- och auktoriseringsmekanism för åtkomst till tjänster i molnklientorganisationen. Om du vill skapa autentiseringsuppgifter måste du vara administratör för Databricks-kontot eller ha behörigheten CREATE SERVICE CREDENTIAL . Användaren som skapar autentiseringsuppgifterna kan delegera ägarskapet till en annan användare eller grupp för att hantera behörigheter för den.

databricks-autentiseringsuppgifter create-credential

Skapa en ny autentiseringsuppgift. Vilken typ av autentiseringsuppgifter som ska skapas bestäms av fältet purpose , som ska vara antingen SERVICE eller STORAGE.

Anroparen måste vara metaarkivadministratör eller ha metaarkivbehörighet CREATE_STORAGE_CREDENTIAL för autentiseringsuppgifter för lagring eller CREATE_SERVICE_CREDENTIAL för autentiseringsuppgifter för tjänsten.

databricks credentials create-credential NAME [flags]

Arguments

NAME

    Namnet på autentiseringsuppgifterna. Namnet måste vara unikt bland lagrings- och tjänstautentiseringsuppgifterna i metaarkivet.

Options

--comment string

    Kommentar som är associerad med autentiseringsuppgifterna

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten

--purpose CredentialPurpose

    Anger syftet med autentiseringsuppgifterna. Värden som stöds: SERVICE, STORAGE

--read-only

    Om autentiseringsuppgifterna endast kan användas för läsåtgärder

--skip-validation

    Optional

Global flags

Examples

I följande exempel skapas en tjänstautentiseringsuppgift med namnet my-service-cred:

databricks credentials create-credential my-service-cred --purpose SERVICE

I följande exempel skapas en skrivskyddad lagringsautentiseringsuppgift:

databricks credentials create-credential readonly-storage --purpose STORAGE --read-only

databricks-autentiseringsuppgifter delete-credential

Ta bort en tjänst eller lagringsautentiseringsuppgifter från metaarkivet. Anroparen måste vara ägare till autentiseringsuppgifterna.

databricks credentials delete-credential NAME_ARG [flags]

Arguments

NAME_ARG

    Autentiseringsuppgiftens namn

Options

--force

    Framtvinga en uppdatering även om det finns beroende tjänster (när syftet är SERVICE) eller beroende externa platser och externa tabeller (när syftet är STORAGE)

Global flags

Examples

I följande exempel tas en autentiseringsuppgift med namnet my-service-cred:

databricks credentials delete-credential my-service-cred

I följande exempel framtvingas borttagning av en autentiseringsuppgift med beroenden:

databricks credentials delete-credential my-storage-cred --force

databricks-autentiseringsuppgifterna generate-temporary-service-credential

Generera en tillfällig tjänstautentiseringsuppgift med hjälp av de angivna tjänstautentiseringsuppgifterna. Anroparen måste vara administratör för metaarkivet eller ha behörigheten ACCESS metaarkiv för tjänstens autentiseringsuppgifter.

databricks credentials generate-temporary-service-credential CREDENTIAL_NAME [flags]

Arguments

CREDENTIAL_NAME

    Namnet på tjänstens autentiseringsuppgifter som används för att generera en tillfällig autentiseringsuppgift

Options

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten

Global flags

Examples

I följande exempel genereras tillfälliga autentiseringsuppgifter för en tjänstautentiseringsuppgift:

databricks credentials generate-temporary-service-credential my-service-cred

databricks-autentiseringsuppgifter get-credential

Hämta en tjänst eller lagringsautentiseringsuppgifter från metaarkivet. Anroparen måste vara metaarkivadministratör, ägare till autentiseringsuppgifterna eller ha behörighet för autentiseringsuppgifterna.

databricks credentials get-credential NAME_ARG [flags]

Arguments

NAME_ARG

    Autentiseringsuppgiftens namn

Options

Global flags

Examples

I följande exempel hämtas information om en autentiseringsuppgift med namnet my-service-cred:

databricks credentials get-credential my-service-cred

databricks-autentiseringsuppgifter list-credentials

List credentials. Listan är begränsad till endast de autentiseringsuppgifter som anroparen har behörighet att komma åt. Om anroparen är metaarkivadministratör är hämtningen av autentiseringsuppgifter obegränsad. Det finns ingen garanti för en specifik ordning på elementen i matrisen.

databricks credentials list-credentials [flags]

Options

--max-results int

    Maximalt antal autentiseringsuppgifter som ska returneras

--page-token string

    Ogenomskinlig token för att hämta nästa sida med resultat

--purpose CredentialPurpose

    Returnera endast autentiseringsuppgifter för det angivna syftet. Värden som stöds: SERVICE, STORAGE

Global flags

Examples

I följande exempel visas alla autentiseringsuppgifter:

databricks credentials list-credentials

I följande exempel visas endast autentiseringsuppgifter för tjänsten:

databricks credentials list-credentials --purpose SERVICE

I följande exempel visas autentiseringsuppgifter med högst 10 resultat:

databricks credentials list-credentials --max-results 10

databricks-autentiseringsuppgifter update-credential

Uppdatera en tjänst eller lagringsautentiseringsuppgifter i metaarkivet.

Anroparen måste vara ägare till autentiseringsuppgifterna eller en metaarkivadministratör eller ha behörigheten MANAGE . Om anroparen är metaarkivadministratör kan endast fältet owner ändras.

databricks credentials update-credential NAME_ARG [flags]

Arguments

NAME_ARG

    Autentiseringsuppgiftens namn

Options

--comment string

    Kommentar som är associerad med autentiseringsuppgifterna

--force

    Framtvinga en uppdatering även om det finns beroende tjänster (när syftet är SERVICE) eller beroende externa platser och externa tabeller (när syftet är STORAGE)

--isolation-mode IsolationMode

    Om den aktuella skyddsbara enheten är tillgänglig från alla arbetsytor eller en specifik uppsättning arbetsytor. Värden som stöds: ISOLATION_MODE_ISOLATED, ISOLATION_MODE_OPEN

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten

--new-name string

    Nytt namn på autentiseringsuppgifter

--owner string

    Användarnamn för aktuell ägare av autentiseringsuppgifter

--read-only

    Om autentiseringsuppgifterna endast kan användas för läsåtgärder

--skip-validation

    Ange sant för det här argumentet för att hoppa över valideringen av de uppdaterade autentiseringsuppgifterna

Global flags

Examples

I följande exempel uppdateras kommentaren för en autentiseringsuppgift:

databricks credentials update-credential my-service-cred --comment "Updated service credential"

I följande exempel byts namn på en autentiseringsuppgift:

databricks credentials update-credential my-service-cred --new-name my-renamed-cred

I följande exempel ändras ägaren till en autentiseringsuppgift:

databricks credentials update-credential my-service-cred --owner someone@example.com

I följande exempel görs en skrivskyddad autentiseringsuppgift:

databricks credentials update-credential my-storage-cred --read-only

databricks-autentiseringsuppgifter valid-credential

Verifiera en autentiseringsuppgift.

För autentiseringsuppgifter för tjänsten (syftet är SERVICE) måste antingen den credential_name eller de molnspecifika autentiseringsuppgifterna anges.

För autentiseringsuppgifter för lagring (syftet är STORAGE), måste minst en av external_location_name och url anges. Om endast en av dem tillhandahålls används den för validering. Och om båda anges url används det för validering och external_location_name ignoreras när du kontrollerar överlappande URL:er. Antingen måste den credential_name eller de molnspecifika autentiseringsuppgifterna anges.

Anroparen måste vara metaarkivadministratör eller ägare av autentiseringsuppgifter eller ha den behörighet som krävs för metaarkivet och autentiseringsuppgifterna (t.ex. CREATE_EXTERNAL_LOCATION när syftet är STORAGE).

databricks credentials validate-credential [flags]

Options

--credential-name string

    Required

--external-location-name string

    Namnet på en befintlig extern plats som ska verifieras

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten

--purpose CredentialPurpose

    Syftet med autentiseringsuppgifterna. Värden som stöds: SERVICE, STORAGE

--read-only

    Om autentiseringsuppgifterna endast kan användas för läsåtgärder

--url string

    Url:en för den externa plats som ska verifieras

Global flags

Examples

I följande exempel verifieras en tjänstautentiseringsuppgift:

databricks credentials validate-credential --credential-name my-service-cred --purpose SERVICE

I följande exempel verifieras en lagringsautentiseringsuppgift med en extern plats:

databricks credentials validate-credential --credential-name my-storage-cred --purpose STORAGE --external-location-name my-external-location

Global flags

--debug

  Om felsökningsloggning ska aktiveras.

-h eller --help

    Visa hjälp för Databricks CLI eller den relaterade kommandogruppen eller det relaterade kommandot.

--log-file sträng

    En sträng som representerar filen som utdataloggarna ska skrivas till. Om den här flaggan inte anges är standardvärdet att skriva utdataloggar till stderr.

--log-format format

    Loggformattypen eller textjson. Standardvärdet är text.

--log-level sträng

    En sträng som representerar loggformatnivån. Om det inte anges inaktiveras loggformatnivån.

-o, --output typ

    Kommandots utdatatyp, text eller json. Standardvärdet är text.

-p, --profile sträng

    Namnet på profilen i filen som ~/.databrickscfg ska användas för att köra kommandot. Om den här flaggan inte anges används den namngivna DEFAULT profilen om den finns.

--progress-format format

    Formatet för att visa förloppsloggar: default, append, inplaceeller json

-t, --target sträng

    Om tillämpligt, paketmålet som ska användas