Skip to content
This repository has been archived by the owner on Jun 25, 2024. It is now read-only.

Set DatabricksSecret

Simon D'Morias edited this page Apr 19, 2020 · 4 revisions

external help file: azure.databricks.cicd.tools-help.xml Module Name: azure.databricks.cicd.tools online version: schema: 2.0.0

Set-DatabricksSecret

SYNOPSIS

Create a scope to store Databricks secret in.

SYNTAX

Set-DatabricksSecret [[-BearerToken] <String>] [[-Region] <String>] [-ScopeName] <String>
 [-SecretName] <String> [-SecretValue] <String> [-AllUserAccess] [<CommonParameters>]

DESCRIPTION

Create a scope to store Databricks secret in. Note the the Set-DatabricksSecret command creates the scope if it does not exist.

EXAMPLES

EXAMPLE 1

Set-DatabricksSecret -BearerToken $BearerToken -Region $Region -ScopeName "Test1" -SecretName 'MySecretName' -SecretValue 'P@ssword'

This example creates a scope called Test1 if it does not exist and a secret called MySecretName with a value of P@ssword.

PARAMETERS

-BearerToken

Your Databricks Bearer token to authenticate to your workspace (see User Settings in Databricks WebUI)

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Region

Azure Region - must match the URL of your Databricks workspace, example northeurope

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ScopeName

Name for the scope - do not include spaces or special characters.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SecretName

{{ Fill SecretName Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SecretValue

{{ Fill SecretValue Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AllUserAccess

By default only the user creating the scope has access to secrets. When you set this flag all users will have access. Hopefully better permissions controls will come.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Author: Simon D'Morias / Data Thirst Ltd

RELATED LINKS

Clone this wiki locally