Skip to content

Latest commit

 

History

History
87 lines (58 loc) · 3.07 KB

serviceendpoint_github_enterprise.html.markdown

File metadata and controls

87 lines (58 loc) · 3.07 KB
layout page_title description
azuredevops
AzureDevops: azuredevops_serviceendpoint_github_enterprise
Manages a GitHub Enterprise Server service endpoint within Azure DevOps organization.

azuredevops_serviceendpoint_github_enterprise

Manages a GitHub Enterprise Server service endpoint within Azure DevOps.

Example Usage

resource "azuredevops_project" "example" {
  name               = "Example Project"
  visibility         = "private"
  version_control    = "Git"
  work_item_template = "Agile"
  description        = "Managed by Terraform"
}

resource "azuredevops_serviceendpoint_github_enterprise" "example" {
  project_id            = azuredevops_project.example.id
  service_endpoint_name = "Example GitHub Enterprise"
  url                   = "https://github.contoso.com"
  description           = "Managed by Terraform"

  auth_personal {
    # Also can be set with AZDO_GITHUB_ENTERPRISE_SERVICE_CONNECTION_PAT environment variable
    personal_access_token = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Argument Reference

The following arguments are supported:

  • project_id - (Required) The ID of the project.

  • service_endpoint_name - (Required) The Service Endpoint name.

  • url - (Required) GitHub Enterprise Server Url.

  • auth_personal - (Optional) An auth_personal block as documented below. Allows connecting using a personal access token.

  • description - (Optional) The Service Endpoint description. Defaults to Managed by Terraform.

~> NOTE: GitHub Apps can not be created or updated via terraform. You must install and configure the app on GitHub and then import it. You must also set the description to "" explicitly.

An auth_personal block supports the following:

  • personal_access_token - (Required) The Personal Access Token for GitHub.

Attributes Reference

The following attributes are exported:

  • id - The ID of the service endpoint.
  • project_id - The ID of the project.
  • service_endpoint_name - The Service Endpoint name.

Relevant Links

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 2 minutes) Used when creating the GitHub Enterprise Server Service Endpoint.
  • read - (Defaults to 1 minute) Used when retrieving the GitHub Enterprise Server Service Endpoint.
  • update - (Defaults to 2 minutes) Used when updating the GitHub Enterprise Server Service Endpoint.
  • delete - (Defaults to 2 minutes) Used when deleting the GitHub Enterprise Server Service Endpoint.

Import

Azure DevOps GitHub Enterprise Server Service Endpoint can be imported using projectID/serviceEndpointID or projectName/serviceEndpointID

terraform import azuredevops_serviceendpoint_github_enterprise.example 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000