From 5e803b10edff3a7749f4046492c050b9ea79e6a6 Mon Sep 17 00:00:00 2001 From: Sharath Nair Date: Thu, 4 Aug 2022 15:31:28 +1000 Subject: Create datasource azuredevops_serviceendpoint_github, add common functions to create datasource schemas, fix documentation --- .../docs/d/serviceendpoint_github.html.markdown | 66 ++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 website/docs/d/serviceendpoint_github.html.markdown (limited to 'website/docs/d/serviceendpoint_github.html.markdown') diff --git a/website/docs/d/serviceendpoint_github.html.markdown b/website/docs/d/serviceendpoint_github.html.markdown new file mode 100644 index 00000000..9030c167 --- /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 AzureRM Service Endpoint. +--- + +# Data Source : azuredevops_serviceendpoint_github + +Use this data source to access information about an existing AzureRM 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 + 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. + +* `id` - (Optional) the ID of the Service Endpoint. + +* `service_endpoint_name` - (Optional) the Name of the Service Endpoint. + +~> **NOTE:** One of either `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. -- cgit v1.2.3 From 49e08bff21b443ee8653d9e7efdffbf4d8495708 Mon Sep 17 00:00:00 2001 From: Sharath Nair Date: Fri, 19 Aug 2022 17:06:39 +1000 Subject: Incorporate comments and fixes --- website/docs/d/serviceendpoint_github.html.markdown | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'website/docs/d/serviceendpoint_github.html.markdown') diff --git a/website/docs/d/serviceendpoint_github.html.markdown b/website/docs/d/serviceendpoint_github.html.markdown index 9030c167..f35d6ec2 100644 --- a/website/docs/d/serviceendpoint_github.html.markdown +++ b/website/docs/d/serviceendpoint_github.html.markdown @@ -2,12 +2,12 @@ layout: "azuredevops" page_title: "AzureDevops: Data Source: azuredevops_serviceendpoint_github" description: |- - Gets information about an existing AzureRM Service Endpoint. + Gets information about an existing GitHub Service Endpoint. --- # Data Source : azuredevops_serviceendpoint_github -Use this data source to access information about an existing AzureRM service Endpoint. +Use this data source to access information about an existing GitHub service Endpoint. ## Example Usage @@ -20,7 +20,7 @@ data "azuredevops_project" "sample" { data "azuredevops_serviceendpoint_github" "serviceendpoint" { project_id = data.azuredevops_project.sample.id - id = "00000000-0000-0000-0000-000000000000" + service_endpoint_id = "00000000-0000-0000-0000-000000000000" } output "service_endpoint_name" { @@ -51,11 +51,11 @@ The following arguments are supported: * `project_id` - (Required) The ID of the project. -* `id` - (Optional) the ID of the Service Endpoint. +* `service_endpoint_id` - (Optional) the ID of the Service Endpoint. * `service_endpoint_name` - (Optional) the Name of the Service Endpoint. -~> **NOTE:** One of either `id` or `service_endpoint_name` must be specified. +~> **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 -- cgit v1.2.3 From 488f34861ff8d6baaa682221eee972351f191f58 Mon Sep 17 00:00:00 2001 From: xuzhang3 Date: Thu, 25 Aug 2022 11:12:41 +0800 Subject: format --- website/docs/d/serviceendpoint_github.html.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'website/docs/d/serviceendpoint_github.html.markdown') diff --git a/website/docs/d/serviceendpoint_github.html.markdown b/website/docs/d/serviceendpoint_github.html.markdown index f35d6ec2..c6dff6d6 100644 --- a/website/docs/d/serviceendpoint_github.html.markdown +++ b/website/docs/d/serviceendpoint_github.html.markdown @@ -19,8 +19,8 @@ data "azuredevops_project" "sample" { } data "azuredevops_serviceendpoint_github" "serviceendpoint" { - project_id = data.azuredevops_project.sample.id - service_endpoint_id = "00000000-0000-0000-0000-000000000000" + project_id = data.azuredevops_project.sample.id + service_endpoint_id = "00000000-0000-0000-0000-000000000000" } output "service_endpoint_name" { -- cgit v1.2.3