Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. GitCredential
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.GitCredential

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    Manages a Git credential in Octopus Deploy.

    Create GitCredential Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GitCredential(name: string, args: GitCredentialArgs, opts?: CustomResourceOptions);
    @overload
def GitCredential(resource_name: str,
                  args: GitCredentialArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def GitCredential(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  password: Optional[str] = None,
                  username: Optional[str] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None,
                  space_id: Optional[str] = None,
                  type: Optional[str] = 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: octopusdeploy:GitCredential
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var gitCredentialResource = new Octopusdeploy.GitCredential("gitCredentialResource", new()
{
    Password = "string",
    Username = "string",
    Description = "string",
    Name = "string",
    SpaceId = "string",
    Type = "string",
});

    example, err := octopusdeploy.NewGitCredential(ctx, "gitCredentialResource", &octopusdeploy.GitCredentialArgs{
	Password:    pulumi.String("string"),
	Username:    pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	SpaceId:     pulumi.String("string"),
	Type:        pulumi.String("string"),
})

    var gitCredentialResource = new GitCredential("gitCredentialResource", GitCredentialArgs.builder()
    .password("string")
    .username("string")
    .description("string")
    .name("string")
    .spaceId("string")
    .type("string")
    .build());

    git_credential_resource = octopusdeploy.GitCredential("gitCredentialResource",
    password="string",
    username="string",
    description="string",
    name="string",
    space_id="string",
    type="string")

    const gitCredentialResource = new octopusdeploy.GitCredential("gitCredentialResource", {
    password: "string",
    username: "string",
    description: "string",
    name: "string",
    spaceId: "string",
    type: "string",
});

    type: octopusdeploy:GitCredential
properties:
    description: string
    name: string
    password: string
    spaceId: string
    type: string
    username: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GitCredential resource accepts the following input properties:

    Password string
    The password for the Git credential.
    Username string
    The username for the Git credential.
    Description string
    The description of this Git Credential.
    Name string
    The name of this Git Credential.
    SpaceId string
    The space ID associated with this Git Credential.
    Type string
    The Git credential authentication type.
    Password string
    The password for the Git credential.
    Username string
    The username for the Git credential.
    Description string
    The description of this Git Credential.
    Name string
    The name of this Git Credential.
    SpaceId string
    The space ID associated with this Git Credential.
    Type string
    The Git credential authentication type.
    password String
    The password for the Git credential.
    username String
    The username for the Git credential.
    description String
    The description of this Git Credential.
    name String
    The name of this Git Credential.
    spaceId String
    The space ID associated with this Git Credential.
    type String
    The Git credential authentication type.
    password string
    The password for the Git credential.
    username string
    The username for the Git credential.
    description string
    The description of this Git Credential.
    name string
    The name of this Git Credential.
    spaceId string
    The space ID associated with this Git Credential.
    type string
    The Git credential authentication type.
    password str
    The password for the Git credential.
    username str
    The username for the Git credential.
    description str
    The description of this Git Credential.
    name str
    The name of this Git Credential.
    space_id str
    The space ID associated with this Git Credential.
    type str
    The Git credential authentication type.
    password String
    The password for the Git credential.
    username String
    The username for the Git credential.
    description String
    The description of this Git Credential.
    name String
    The name of this Git Credential.
    spaceId String
    The space ID associated with this Git Credential.
    type String
    The Git credential authentication type.

    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,
        description: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        space_id: Optional[str] = None,
        type: Optional[str] = None,
        username: 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)
    resources:  _:    type: octopusdeploy:GitCredential    get:      id: ${id}
    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:
    Description string
    The description of this Git Credential.
    Name string
    The name of this Git Credential.
    Password string
    The password for the Git credential.
    SpaceId string
    The space ID associated with this Git Credential.
    Type string
    The Git credential authentication type.
    Username string
    The username for the Git credential.
    Description string
    The description of this Git Credential.
    Name string
    The name of this Git Credential.
    Password string
    The password for the Git credential.
    SpaceId string
    The space ID associated with this Git Credential.
    Type string
    The Git credential authentication type.
    Username string
    The username for the Git credential.
    description String
    The description of this Git Credential.
    name String
    The name of this Git Credential.
    password String
    The password for the Git credential.
    spaceId String
    The space ID associated with this Git Credential.
    type String
    The Git credential authentication type.
    username String
    The username for the Git credential.
    description string
    The description of this Git Credential.
    name string
    The name of this Git Credential.
    password string
    The password for the Git credential.
    spaceId string
    The space ID associated with this Git Credential.
    type string
    The Git credential authentication type.
    username string
    The username for the Git credential.
    description str
    The description of this Git Credential.
    name str
    The name of this Git Credential.
    password str
    The password for the Git credential.
    space_id str
    The space ID associated with this Git Credential.
    type str
    The Git credential authentication type.
    username str
    The username for the Git credential.
    description String
    The description of this Git Credential.
    name String
    The name of this Git Credential.
    password String
    The password for the Git credential.
    spaceId String
    The space ID associated with this Git Credential.
    type String
    The Git credential authentication type.
    username String
    The username for the Git credential.

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy