# Equinix 提供商 Equinix提供商用于与Equinix平台提供的资源进行交互。提供商需要使用适当的凭据来配置提供商,然后才能使用。 获取Equinix Fabric和Network Edge所需的API密钥和机密信息,请参阅从[Equinix开发者平台门户网站](https://docs.equinix.com/equinix-api/api-authentication/)[生成客户端ID和客户端机密钥](https://docs.equinix.com)。 Equinix Fabric还支持使用[Workload身份令牌](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/dynamic-provider-credentials/workload-identity-tokens)进行[身份](https://developer.hashicorp.com/terraform/language/providers/configuration#alias-multiple-provider-configurations)验证,该[令牌](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/dynamic-provider-credentials/workload-identity-tokens)可代替`client_id`和`client_secret`参数。需要Equinix STS信任的IDP提供的授权范围和OIDC令牌。这是一项ALPHA功能,并非对所有用户都可用。使用工作负荷身份令牌将覆盖客户端ID/ Terraform,您必须使用[提供商别名](https://developer.hashicorp.com/terraform/language/providers/configuration#alias-multiple-provider-configurations)在单个Terraform配置中管理工作负荷身份令牌和客户端ID/机密。 使用左侧导航栏了解可用资源。 ## 用法示例[​](#用法示例 "直接链接至用法示例") 包含[提供商配置](https://developer.hashicorp.com/terraform/language/providers/configuration)和[所需提供商定义的](https://developer.hashicorp.com/terraform/language/providers/requirements)HCL示例: ``` terraform { required_providers { equinix = { source = "equinix/equinix" } } } # Credentials for all Equinix resources provider "equinix" { client_id = "someEquinixAPIClientID" client_secret = "someEquinixAPIClientSecret" } ``` Workload身份令牌可用于服务授权场景,如HCP Terraform。使用此方法时,资源和数据源的其他凭据变量是可选的`equinix_fabric_*`。 ``` # Configuration for using Workload Identity Federation provider "equinix" { # Desired scope of the requested security token. Must be an Access Policy ERN or a string of the form `roleassignments:` token_exchange_scope = "roleassignments:" # The name of the environment variable containing the token exchange subject token # For example, HCP Terraform automatically sets TFC_WORKLOAD_IDENTITY_TOKEN token_exchange_subject_token_env_var = "TFC_WORKLOAD_IDENTITY_TOKEN" } ``` 提供商配置示例,使用`environment variables`: ``` export EQUINIX_API_CLIENTID=someEquinixAPIClientID export EQUINIX_API_CLIENTSECRET=someEquinixAPIClientSecret ``` ### 令牌认证[​](#令牌认证 "直接链接至令牌认证") 可以使用[OAuth2 API](https://docs.equinix.com/api-catalog/accesstokenv1#operation/GetOAuth2AccessToken)文档中所述的OAuth2令牌功能为API客户端生成令牌。 API令牌可以使用提供商参数或`EQUINIX_API_TOKEN`环境变量提供`token`。`client_id`参数存在时,和`client_secret`参数将被忽略`token`。 有关推荐测试实践的详细信息,请参阅[Equinix API测试](https://docs.equinix.com/equinix-api/testing)指南。 ``` provider "equinix" { token = "someToken" } ``` ## 论证参考[​](#论证参考 "直接链接至论证参考") Equinix提供商需要一些基本参数。身份验证参数是单独的,但`token`OR`client_id`和`client_secret`必须通过参数或环境设置定义,才能与Equinix Fabric和Network Edge服务交互。 这些参数可以在[Terraform变量文件](https://developer.hashicorp.com/terraform/language/values/variables#variable-definitions-tfvars-files)中提供,也可以作为环境变量提供。不[建议将敏感数据保存在纯文本文件中](https://developer.hashicorp.com/terraform/language/state/sensitive-data)。 ## 模式[​](#模式 "直接链接至模式") ### 可选[​](#可选 "直接链接至可选") * `client_id`(字符串) API消费者密钥在Developer Portal中的“我的应用程序”下方可用。此参数也可以使用shell环境变量指定`EQUINIX_API_CLIENTID`。 * `client_secret`(字符串) Developer Portal中“我的应用程序”下提供的API消费者机密。此参数也可以使用shell环境变量指定`EQUINIX_API_CLIENTSECRET`。 * `endpoint`(string)指明所需环境的Equinix API基本URL。此参数也可以使用shell环境变量指定`EQUINIX_API_ENDPOINT`。(默认为`https://api.equinix.com`) * `max_retries`(数量)网络故障时的最大重试次数。 * `max_retry_wait_seconds`(数字)重试请求前等待的最大秒数。 * `request_timeout`(数字) Equinix Platform API客户端在取消API请求之前应等待的时间(以秒为单位)。取消的请求仍可能导致已配置资源。(默认为`30`) * `response_max_page_size`(数量)单个响应中产生分页响应的REST查询的最大记录数。(默认为客户端特定) * `sts_endpoint`(字符串)指向所需环境的STS API基本URL。此参数也可以使用shell环境变量指定`EQUINIX_STS_ENDPOINT`。(默认为`https://sts.eqix.equinix.com`)。STS是一项ALPHA功能,并非对所有用户可用。 * `token`(string) API令牌是使用[OAuth2 API](https://docs.equinix.com/equinix-api/api-authentication/)从API消费者客户端生成的。此参数也可以使用shell环境变量指定`EQUINIX_API_TOKEN`。 * `token_exchange_scope`(string)身份验证令牌的范围。必须是访问策略ERN或表单的字符串`roleassignments:`。此参数也可以使用shell环境变量指定`EQUINIX_TOKEN_EXCHANGE_SCOPE`。令牌交换是一项ALPHA功能,并非对所有用户都可用。 * `token_exchange_subject_token`(string)用于令牌交换验证的主题令牌。OIDC ID令牌必须由Equinix STS信任的OIDC提供商签发。如果未设置,提供商将使用中指定的环境变量`token_exchange_subject_token_env_var`。令牌交换是一项ALPHA功能,并非对所有用户都可用。 * `token_exchange_subject_token_env_var`(string)环境变量的名称,其中包含用于令牌交换的主题令牌。此参数也可以使用shell环境变量指定`EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN_ENV_VAR`。(默认为`EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN`)。令牌交换是一项ALPHA功能,并非对所有用户都可用。