Databricks v1.14.0, May 23 23

databricks.GitCredential

Explore with Pulumi AI

Import

The resource cluster can be imported using ID of Git credential that could be obtained via REST APIbash

 $ pulumi import databricks:index/gitCredential:GitCredential this <git-credential-id>

Create GitCredential Resource

new GitCredential(name: string, args: GitCredentialArgs, opts?: CustomResourceOptions);

@overload
def GitCredential(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  force: Optional[bool] = None,
                  git_provider: Optional[str] = None,
                  git_username: Optional[str] = None,
                  personal_access_token: Optional[str] = None)
@overload
def GitCredential(resource_name: str,
                  args: GitCredentialArgs,
                  opts: Optional[ResourceOptions] = None)

func NewGitCredential(ctx *Context, name string, args GitCredentialArgs, opts ...ResourceOption) (*GitCredential, error)

public GitCredential(string name, GitCredentialArgs args, CustomResourceOptions? opts = null)

public GitCredential(String name, GitCredentialArgs args)
public GitCredential(String name, GitCredentialArgs args, CustomResourceOptions options)

type: databricks:GitCredential
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GitCredentialArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args GitCredentialArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GitCredentialArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GitCredentialArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GitCredentialArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

GitCredential Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The GitCredential resource accepts the following input properties:

GitProvider string: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Git Credentials API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
Force bool: specify if settings need to be enforced - right now, Databricks allows only single Git credential, so if it's already configured, the apply operation will fail.
GitUsername string: user name at Git provider.
PersonalAccessToken string: The personal access token used to authenticate to the corresponding Git provider. If value is not provided, it's sourced from the first environment variable of GITHUB_TOKEN, that has a non-empty value.

GitProvider string: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Git Credentials API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
Force bool: specify if settings need to be enforced - right now, Databricks allows only single Git credential, so if it's already configured, the apply operation will fail.
GitUsername string: user name at Git provider.
PersonalAccessToken string: The personal access token used to authenticate to the corresponding Git provider. If value is not provided, it's sourced from the first environment variable of GITHUB_TOKEN, that has a non-empty value.

gitProvider String: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Git Credentials API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
force Boolean: specify if settings need to be enforced - right now, Databricks allows only single Git credential, so if it's already configured, the apply operation will fail.
gitUsername String: user name at Git provider.
personalAccessToken String: The personal access token used to authenticate to the corresponding Git provider. If value is not provided, it's sourced from the first environment variable of GITHUB_TOKEN, that has a non-empty value.

gitProvider string: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Git Credentials API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
force boolean: specify if settings need to be enforced - right now, Databricks allows only single Git credential, so if it's already configured, the apply operation will fail.
gitUsername string: user name at Git provider.
personalAccessToken string: The personal access token used to authenticate to the corresponding Git provider. If value is not provided, it's sourced from the first environment variable of GITHUB_TOKEN, that has a non-empty value.

git_provider str: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Git Credentials API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
force bool: specify if settings need to be enforced - right now, Databricks allows only single Git credential, so if it's already configured, the apply operation will fail.
git_username str: user name at Git provider.
personal_access_token str: The personal access token used to authenticate to the corresponding Git provider. If value is not provided, it's sourced from the first environment variable of GITHUB_TOKEN, that has a non-empty value.

gitProvider String: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Git Credentials API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
force Boolean: specify if settings need to be enforced - right now, Databricks allows only single Git credential, so if it's already configured, the apply operation will fail.
gitUsername String: user name at Git provider.
personalAccessToken String: The personal access token used to authenticate to the corresponding Git provider. If value is not provided, it's sourced from the first environment variable of GITHUB_TOKEN, that has a non-empty value.

Outputs

All input properties are implicitly available as output properties. Additionally, the GitCredential resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing GitCredential Resource

Get an existing GitCredential resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GitCredentialState, opts?: CustomResourceOptions): GitCredential

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        force: Optional[bool] = None,
        git_provider: Optional[str] = None,
        git_username: Optional[str] = None,
        personal_access_token: Optional[str] = None) -> GitCredential

func GetGitCredential(ctx *Context, name string, id IDInput, state *GitCredentialState, opts ...ResourceOption) (*GitCredential, error)

public static GitCredential Get(string name, Input<string> id, GitCredentialState? state, CustomResourceOptions? opts = null)

public static GitCredential get(String name, Output<String> id, GitCredentialState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Force bool: specify if settings need to be enforced - right now, Databricks allows only single Git credential, so if it's already configured, the apply operation will fail.
GitProvider string: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Git Credentials API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
GitUsername string: user name at Git provider.
PersonalAccessToken string: The personal access token used to authenticate to the corresponding Git provider. If value is not provided, it's sourced from the first environment variable of GITHUB_TOKEN, that has a non-empty value.

Force bool: specify if settings need to be enforced - right now, Databricks allows only single Git credential, so if it's already configured, the apply operation will fail.
GitProvider string: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Git Credentials API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
GitUsername string: user name at Git provider.
PersonalAccessToken string: The personal access token used to authenticate to the corresponding Git provider. If value is not provided, it's sourced from the first environment variable of GITHUB_TOKEN, that has a non-empty value.

force Boolean: specify if settings need to be enforced - right now, Databricks allows only single Git credential, so if it's already configured, the apply operation will fail.
gitProvider String: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Git Credentials API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
gitUsername String: user name at Git provider.
personalAccessToken String: The personal access token used to authenticate to the corresponding Git provider. If value is not provided, it's sourced from the first environment variable of GITHUB_TOKEN, that has a non-empty value.

force boolean: specify if settings need to be enforced - right now, Databricks allows only single Git credential, so if it's already configured, the apply operation will fail.
gitProvider string: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Git Credentials API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
gitUsername string: user name at Git provider.
personalAccessToken string: The personal access token used to authenticate to the corresponding Git provider. If value is not provided, it's sourced from the first environment variable of GITHUB_TOKEN, that has a non-empty value.

force bool: specify if settings need to be enforced - right now, Databricks allows only single Git credential, so if it's already configured, the apply operation will fail.
git_provider str: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Git Credentials API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
git_username str: user name at Git provider.
personal_access_token str: The personal access token used to authenticate to the corresponding Git provider. If value is not provided, it's sourced from the first environment variable of GITHUB_TOKEN, that has a non-empty value.

force Boolean: specify if settings need to be enforced - right now, Databricks allows only single Git credential, so if it's already configured, the apply operation will fail.
gitProvider String: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Git Credentials API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
gitUsername String: user name at Git provider.
personalAccessToken String: The personal access token used to authenticate to the corresponding Git provider. If value is not provided, it's sourced from the first environment variable of GITHUB_TOKEN, that has a non-empty value.

Package Details

Repository: databricks pulumi/pulumi-databricks
License: Apache-2.0
Notes: This Pulumi package is based on the databricks Terraform Provider.