service endpoint document update

CHANGELOG.md

@@ -24,6 +24,9 @@ IMPROVEMENTS:
   - Refactor the implementation of `SecurityNamespace` and the according helper functions. [#149](https://github.com/microsoft/terraform-provider-azuredevops/pull/149)
   - All permission resources will now clear the `Id` on a `Read` operation when the connected ACLs not found. [#149](https://github.com/microsoft/terraform-provider-azuredevops/pull/149)
   
+BREAKING CHANGE
+* All service endpoint - Service endpoint `project_id` only support project ID, project name is no longer supported since v0.2.0. [#494](https://github.com/microsoft/terraform-provider-azuredevops/issues/494)
+
 ## 0.1.8 
 FEATURES:
 * **New Resource** `azuredevops_git_repository_file ` [#225](https://github.com/microsoft/terraform-provider-azuredevops/issues/225)

website/docs/r/serviceendpoint_argocd.html.markdown

@@ -54,7 +54,7 @@ resource "azuredevops_serviceendpoint_argocd" "example" {
 
 The following arguments are supported:
 
-- `project_id` - (Required) The project ID or project name.
+- `project_id` - (Required) The ID of the project.
 - `service_endpoint_name` - (Required) The Service Endpoint name.
 - `url` - (Required) URL of the ArgoCD server to connect with.
 - `description` - (Optional) The Service Endpoint description.
@@ -78,7 +78,7 @@ A `authentication_basic` block supports the following:
 The following attributes are exported:
 
 - `id` - The ID of the service endpoint.
-- `project_id` - The project ID or project name.
+- `project_id` - The ID of the project.
 - `service_endpoint_name` - The Service Endpoint name.
 
 ## Relevant Links

website/docs/r/serviceendpoint_artifactory.html.markdown

@@ -56,7 +56,7 @@ resource "azuredevops_serviceendpoint_artifactory" "example" {
 
 The following arguments are supported:
 
-* `project_id` - (Required) The project ID or project name.
+* `project_id` - (Required) The ID of the project.
 * `service_endpoint_name` - (Required) The Service Endpoint name.
 * `url` - (Required) URL of the Artifactory server to connect with.
 
@@ -74,7 +74,7 @@ The following arguments are supported:
 The following attributes are exported:
 
 * `id` - The ID of the service endpoint.
-* `project_id` - The project ID or project name.
+* `project_id` - The ID of the project.
 * `service_endpoint_name` - The Service Endpoint name.
 
 ## Relevant Links

website/docs/r/serviceendpoint_aws.html.markdown

@@ -32,7 +32,7 @@ resource "azuredevops_serviceendpoint_aws" "example" {
 
 The following arguments are supported:
 
-* `project_id` - (Required) The project ID or project name.
+* `project_id` - (Required) The ID of the project.
 * `service_endpoint_name` - (Required) The Service Endpoint name.
 * `access_key_id` - (Required) The AWS access key ID for signing programmatic requests.
 * `secret_access_key` - (Required) The AWS secret access key for signing programmatic requests.
@@ -47,7 +47,7 @@ The following arguments are supported:
 The following attributes are exported:
 
 * `id` - The ID of the service endpoint.
-* `project_id` - The project ID or project name.
+* `project_id` - The ID of the project.
 * `service_endpoint_name` - The Service Endpoint name.
 
 ## Relevant Links

website/docs/r/serviceendpoint_azurecr.html.markdown

@@ -36,7 +36,7 @@ resource "azuredevops_serviceendpoint_azurecr" "example" {
 
 The following arguments are supported:
 
-- `project_id` - (Required) The project ID or project name.
+- `project_id` - (Required) The ID of the project.
 - `service_endpoint_name` - (Required) The name you will use to refer to this service connection in task inputs.
 - `resource_group` - (Required) The resource group to which the container registry belongs.
 - `azurecr_spn_tenantid` - (Required) The tenant id of the service principal.
@@ -50,7 +50,7 @@ The following arguments are supported:
 The following attributes are exported:
 
 - `id` - The ID of the service endpoint.
-- `project_id` - The project ID or project name.
+- `project_id` - The ID of the project.
 - `service_endpoint_name` - The Service Endpoint name.
 - `service_principal_id` - The service principal ID.
 

website/docs/r/serviceendpoint_azuredevops.html.markdown

@@ -36,7 +36,7 @@ resource "azuredevops_serviceendpoint_azuredevops" "example" {
 
 The following arguments are supported:
 
-- `project_id` - (Required) The project ID or project name.
+- `project_id` - (Required) The ID of the project.
 - `service_endpoint_name` - (Required) The Service Endpoint name.
 - `org_url` - (Required) The organization URL.
 - `release_api_url` - (Required) The URL of the release API.
@@ -48,7 +48,7 @@ The following arguments are supported:
 The following attributes are exported:
 
 - `id` - The ID of the service endpoint.
-- `project_id` - The project ID or project name.
+- `project_id` - The ID of the project.
 - `service_endpoint_name` - The Service Endpoint name.
 
 ## Relevant Links

website/docs/r/serviceendpoint_azurerm.html.markdown

@@ -65,7 +65,7 @@ resource "azuredevops_serviceendpoint_azurerm" "example" {
 
 The following arguments are supported:
 
-- `project_id` - (Required) The project ID or project name.
+- `project_id` - (Required) The ID of the project.
 - `service_endpoint_name` - (Required) The Service Endpoint name.
 - `azurerm_spn_tenantid` - (Required) The tenant id if the service principal.
 - `azurerm_subscription_id` - (Required) The subscription Id of the Azure targets.
@@ -86,7 +86,7 @@ A `credentials` block supports the following:
 The following attributes are exported:
 
 - `id` - The ID of the service endpoint.
-- `project_id` - The project ID or project name.
+- `project_id` - The ID of the project.
 - `service_endpoint_name` - The Service Endpoint name.
 
 ## Relevant Links

website/docs/r/serviceendpoint_bitbucket.html.markdown

@@ -33,7 +33,7 @@ resource "azuredevops_serviceendpoint_bitbucket" "example" {
 
 The following arguments are supported:
 
-- `project_id` - (Required) The project ID or project name.
+- `project_id` - (Required) The ID of the project.
 - `service_endpoint_name` - (Required) The Service Endpoint name.
 - `username` - (Required) Bitbucket account username.
 - `password` - (Required) Bitbucket account password.
@@ -44,7 +44,7 @@ The following arguments are supported:
 The following attributes are exported:
 
 - `id` - The ID of the service endpoint.
-- `project_id` - The project ID or project name.
+- `project_id` - The ID of the project.
 - `service_endpoint_name` - The Service Endpoint name.
 
 ## Relevant Links

website/docs/r/serviceendpoint_dockerregistry.html.markdown

@@ -45,7 +45,7 @@ resource "azuredevops_serviceendpoint_dockerregistry" "example-other" {
 
 The following arguments are supported:
 
-- `project_id` - (Required) The project ID or project name.
+- `project_id` - (Required) The ID of the project.
 - `service_endpoint_name` - (Required) The name you will use to refer to this service connection in task inputs.
 - `description` - (Optional) The Service Endpoint description. Defaults to `Managed by Terraform`.
 - `docker_registry` - (Optional) The URL of the Docker registry. (Default: "https://index.docker.io/v1/")
@@ -59,7 +59,7 @@ The following arguments are supported:
 The following attributes are exported:
 
 - `id` - The ID of the service endpoint.
-- `project_id` - The project ID or project name.
+- `project_id` - The ID of the project.
 - `service_endpoint_name` - The Service Endpoint name.
 
 ## Relevant Links

website/docs/r/serviceendpoint_generic.html.markdown

@@ -36,7 +36,7 @@ resource "azuredevops_serviceendpoint_generic" "example" {
 
 The following arguments are supported:
 
-- `project_id` - (Required) The project ID or project name.
+- `project_id` - (Required) The ID of the project.
 - `service_endpoint_name` - (Required) The service endpoint name.
 - `server_url` - (Required) The URL of the server associated with the service endpoint.
 - `username` - (Optional) The username used to authenticate to the server url using basic authentication.
@@ -48,7 +48,7 @@ The following arguments are supported:
 The following attributes are exported:
 
 - `id` - The ID of the service endpoint.
-- `project_id` - The ID of the project associated with the service endpoint.
+- `project_id` - The ID of the project.
 - `service_endpoint_name` - The name of the service endpoint.
 
 ## Relevant Links

website/docs/r/serviceendpoint_generic_git.html.markdown

@@ -36,7 +36,7 @@ resource "azuredevops_serviceendpoint_generic_git" "example" {
 
 The following arguments are supported:
 
-- `project_id` - (Required) The project ID or project name to associate with the service endpoint.
+- `project_id` - (Required) The ID of the project.
 - `service_endpoint_name` - (Required) The name of the service endpoint.
 - `repository_url` - (Required) The URL of the repository associated with the service endpoint.
 - `username` - (Optional) The username used to authenticate to the git repository.
@@ -52,7 +52,7 @@ The following arguments are supported:
 The following attributes are exported:
 
 - `id` - The ID of the service endpoint.
-- `project_id` - The project ID or project name associated with the service endpoint.
+- `project_id` - The ID of the project.
 - `service_endpoint_name` - The name of the service endpoint.
 - `enable_pipelines_access` - A value indicating whether or not to attempt accessing this git server from Azure Pipelines.
 

website/docs/r/serviceendpoint_github.html.markdown

@@ -70,28 +70,28 @@ resource "azuredevops_serviceendpoint_github" "example" {
 
 The following arguments are supported:
 
-- `project_id` - (Required) The project ID or project name.
+- `project_id` - (Required) The ID of the project.
 - `service_endpoint_name` - (Required) The Service Endpoint name.
 - `description` - (Optional) The Service Endpoint description. Defaults to `Managed by Terraform`.
 - `auth_personal` - (Optional) An `auth_personal` block as documented below. Allows connecting using a personal access token.
 - `auth_oauth` - (Optional) An `auth_oauth` block as documented below. Allows connecting using an Oauth token.
 
-**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."**
+**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."**
 
 `auth_personal` block supports the following:
 
-- `personal_access_token` - (Required) The Personal Access Token for Github.
+- `personal_access_token` - (Required) The Personal Access Token for GitHub.
 
 `auth_oauth` block supports the following:
 
-- `oauth_configuration_id` - (Required) **NOTE: Github OAuth flow can not be performed via terraform. You must create this on Azure DevOps and then import it.** The OAuth Configuration ID.
+- `oauth_configuration_id` - (Required) **NOTE: GitHub OAuth flow can not be performed via terraform. You must create this on Azure DevOps and then import it.** The OAuth Configuration ID.
 
 ## Attributes Reference
 
 The following attributes are exported:
 
 - `id` - The ID of the service endpoint.
-- `project_id` - The project ID or project name.
+- `project_id` - The ID of the project.
 - `service_endpoint_name` - The Service Endpoint name.
 
 ## Relevant Links

website/docs/r/serviceendpoint_github_enterprise.html.markdown

@@ -37,24 +37,24 @@ resource "azuredevops_serviceendpoint_github_enterprise" "example" {
 
 The following arguments are supported:
 
-- `project_id` - (Required) The project ID or project name.
+- `project_id` - (Required) The ID of the project.
 - `service_endpoint_name` - (Required) The Service Endpoint name.
-- `url` - (Required) Github Enterprise Server Url.
+- `url` - (Required) GitHub Enterprise Server Url.
 - `description` - (Optional) The Service Endpoint description. Defaults to `Managed by Terraform`.
 - `auth_personal` - (Optional) An `auth_personal` block as documented below. Allows connecting using a personal access token.
 
-**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."**
+**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."**
 
 `auth_personal` block supports the following:
 
-- `personal_access_token` - (Required) The Personal Access Token for Github.
+- `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 project ID or project name.
+- `project_id` - The ID of the project.
 - `service_endpoint_name` - The Service Endpoint name.
 
 ## Relevant Links

website/docs/r/serviceendpoint_kubernetes.html.markdown

@@ -87,7 +87,7 @@ resource "azuredevops_serviceendpoint_kubernetes" "example-service-account" {
 
 The following arguments are supported:
 
-- `project_id` - (Required) The project ID or project name.
+- `project_id` - (Required) The ID of the project.
 - `service_endpoint_name` - (Required) The Service Endpoint name.
 - `apiserver_url` - (Required) The hostname (in form of URI) of the Kubernetes API.
 - `authorization_type` - (Required) The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
@@ -113,7 +113,7 @@ The following arguments are supported:
 The following attributes are exported:
 
 - `id` - The ID of the service endpoint.
-- `project_id` - The project ID or project name.
+- `project_id` - The ID of the project.
 - `service_endpoint_name` - The Service Endpoint name.
 
 ## Relevant Links

website/docs/r/serviceendpoint_npm.html.markdown

@@ -33,7 +33,7 @@ resource "azuredevops_serviceendpoint_npm" "example" {
 
 The following arguments are supported:
 
-- `project_id` - (Required) The project ID or project name.
+- `project_id` - (Required) The ID of the project.
 - `service_endpoint_name` - (Required) The Service Endpoint name.
 - `url` - (Required) URL of the npm registry to connect with.
 - `access_token` - (Required) The access token for npm registry.
@@ -44,7 +44,7 @@ The following arguments are supported:
 The following attributes are exported:
 
 - `id` - The ID of the service endpoint.
-- `project_id` - The project ID or project name.
+- `project_id` - The ID of the project.
 - `service_endpoint_name` - The Service Endpoint name.
 
 ## Relevant Links

website/docs/r/serviceendpoint_permissions.html.markdown

@@ -71,7 +71,7 @@ resource "azuredevops_serviceendpoint_permissions" "example-permissions" {
 
 The following arguments are supported:
 
-* `project_id` - (Required) The ID of the project to assign the permissions.
+* `project_id` - (Required) The ID of the project.
 * `principal` - (Required) The **group** principal to assign the permissions.
 * `permissions` - (Required) the permissions to assign. The following permissions are available.
 * `serviceendpoint_id` - (Optional) The id of the service endpoint to assign the permissions.

website/docs/r/serviceendpoint_runpipeline.html.markdown

@@ -36,7 +36,7 @@ resource "azuredevops_serviceendpoint_runpipeline" "example" {
 
 The following arguments are supported:
 
-- `project_id` - (Required) The project ID or project name.
+- `project_id` - (Required) The ID of the project.
 - `service_endpoint_name` - (Required) The Service Endpoint name.
 - `organization_name` - (Required) The organization name used for `Organization Url` and `Release API Url` fields.
 - `auth_personal` - (Required) An `auth_personal` block as documented below. Allows connecting using a personal access token.
@@ -51,7 +51,7 @@ The following arguments are supported:
 The following attributes are exported:
 
 - `id` - The ID of the service endpoint.
-- `project_id` - The project ID or project name.
+- `project_id` - The ID of the project.
 - `service_endpoint_name` - The Service Endpoint name.
 
 ## Relevant Links

website/docs/r/serviceendpoint_servicefabric.html.markdown

@@ -89,7 +89,7 @@ resource "azuredevops_serviceendpoint_servicefabric" "test" {
 
 The following arguments are supported:
 
-- `project_id` - (Required) The project ID or project name.
+- `project_id` - (Required) The ID of the project.
 - `service_endpoint_name` - (Required) The Service Endpoint name.
 - `cluster_endpoint` - (Required) Client connection endpoint for the cluster. Prefix the value with 'tcp://';. This value overrides the publish profile.
 - `description` - (Optional) The Service Endpoint description. Defaults to `Managed by Terraform`.
@@ -119,7 +119,7 @@ The following arguments are supported:
 The following attributes are exported:
 
 - `id` - The ID of the service endpoint.
-- `project_id` - The project ID or project name.
+- `project_id` - The ID of the project.
 - `service_endpoint_name` - The Service Endpoint name.
 
 ## Relevant Links

website/docs/r/serviceendpoint_sonarqube.html.markdown

@@ -32,7 +32,7 @@ resource "azuredevops_serviceendpoint_sonarqube" "example" {
 
 The following arguments are supported:
 
-* `project_id` - (Required) The project ID or project name.
+* `project_id` - (Required) The ID of the project.
 * `service_endpoint_name` - (Required) The Service Endpoint name.
 * `url` - (Required) URL of the SonarQube server to connect with.
 * `token` - (Required) Authentication Token generated through SonarQube (go to My Account > Security > Generate Tokens).
@@ -43,7 +43,7 @@ The following arguments are supported:
 The following attributes are exported:
 
 * `id` - The ID of the service endpoint.
-* `project_id` - The project ID or project name.
+* `project_id` - The ID of the project.
 * `service_endpoint_name` - The Service Endpoint name.
 
 ## Relevant Links

website/docs/r/serviceendpoint_ssh.html.markdown

@@ -33,7 +33,7 @@ resource "azuredevops_serviceendpoint_ssh" "example" {
 
 The following arguments are supported:
 
-- `project_id` - (Required) The project ID or project name.
+- `project_id` - (Required) The ID of the project.
 - `service_endpoint_name` - (Required) The Service Endpoint name.
 - `host` - (Required) The Host name or IP address of the remote machine.
 - `username` - (Required) Username for connecting to the endpoint.
@@ -47,7 +47,7 @@ The following arguments are supported:
 The following attributes are exported:
 
 - `id` - The ID of the service endpoint.
-- `project_id` - The project ID or project name.
+- `project_id` - The ID of the project.
 - `service_endpoint_name` - The Service Endpoint name.
 
 ## Relevant Links

website/docs/r/servicehook_permissions.html.markdown

@@ -46,7 +46,7 @@ resource "azuredevops_servicehook_permissions" "example-permissions" {
 
 The following arguments are supported:
 
-* `project_id` - (optional) The ID of the project to assign the permissions.
+* `project_id` - (optional) The ID of the project.
 * `principal` - (Required) The **group** principal to assign the permissions.
 * `permissions` - (Required) the permissions to assign. The following permissions are available.
 * `replace` - (Optional) Replace (`true`) or merge (`false`) the permissions. Default: `true`