summaryrefslogtreecommitdiff
path: root/website/docs/d/serviceendpoint_github.html.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'website/docs/d/serviceendpoint_github.html.markdown')
-rw-r--r--website/docs/d/serviceendpoint_github.html.markdown66
1 files changed, 66 insertions, 0 deletions
diff --git a/website/docs/d/serviceendpoint_github.html.markdown b/website/docs/d/serviceendpoint_github.html.markdown
new file mode 100644
index 00000000..c6dff6d6
--- /dev/null
+++ b/website/docs/d/serviceendpoint_github.html.markdown
@@ -0,0 +1,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.