summaryrefslogtreecommitdiff
path: root/website/docs/d/serviceendpoint_github.html.markdown
blob: c6dff6d63bc4c4e15c92c0c9136c49f80ae54c89 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
---
layout: "azuredevops"
page_title: "AzureDevops: Data Source: azuredevops_serviceendpoint_github"
description: |-
  Gets information about an existing GitHub Service Endpoint.
---

# Data Source : azuredevops_serviceendpoint_github

Use this data source to access information about an existing GitHub service Endpoint.

## Example Usage

### By Service Endpoint ID

```hcl
data "azuredevops_project" "sample" {
  name = "Sample Project"
}

data "azuredevops_serviceendpoint_github" "serviceendpoint" {
  project_id          = data.azuredevops_project.sample.id
  service_endpoint_id = "00000000-0000-0000-0000-000000000000"
}

output "service_endpoint_name" {
  value = data.azuredevops_serviceendpoint_github.serviceendpoint.service_endpoint_name
}
```

### By Service Endpoint Name

```hcl
data "azuredevops_project" "sample" {
  name = "Sample Project"
}

data "azuredevops_serviceendpoint_github" "serviceendpoint" {
  project_id            = data.azuredevops_project.sample.id
  service_endpoint_name = "Example-Service-Endpoint"
}

output "service_endpoint_id" {
  value = data.azuredevops_serviceendpoint_github.serviceendpoint.id
}
```

## Arguments Reference

The following arguments are supported:

* `project_id` - (Required) The ID of the project.

* `service_endpoint_id` - (Optional) the ID of the Service Endpoint.

* `service_endpoint_name` - (Optional) the Name of the Service Endpoint.

~> **NOTE:** One of either `service_endpoint_id` or `service_endpoint_name` must be specified.
~> **NOTE:** When supplying `service_endpoint_name`, take care to ensure that this is a unique name.

## Attributes Reference

In addition to the Arguments list above - the following Attributes are exported:

* `authorization` - Specifies the Authorization Scheme Map.
* `description` - Specifies the description of the Service Endpoint.