# Equinixプロバイダ Equinixプロバイダは、Equinixプラットフォームが提供するリソースとの対話に使用されます。プロバイダを使用する前に、適切な認証情報を使用して設定する必要があります。 Equinix FabricとNetwork Edgeに必要なAPIキーとシークレットの取得については、「[Equinix開発者プラットフォームポータル](https://docs.equinix.com/equinix-api/api-authentication/)からの[クライアントIDとクライアントシークレットキーの生成」を](https://docs.equinix.com)参照してください。 Equinix Fabricは、および`client_secret`引数の代わりに使用できる`client_id`[ワークロードIDトークンを](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/dynamic-provider-credentials/workload-identity-tokens)使用した認証もサポートしています。Equinix STSによって信頼されたIdPからの認証スコープとOIDCトークンが必要です。これはアルファ機能であり、すべてのユーザーが利用できるわけではありません。ワークロードIDトークンを使用すると、クライアントID/シークレットが上書きされるため、[プロバイダエイリアスを](https://developer.hashicorp.com/terraform/language/providers/configuration#alias-multiple-provider-configurations)使用して、単一のTerraform構成でワークロードIDトークンとクライアント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" } ``` ワークロードIDトークンは、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 ``` ### トークン認証[​](#トークン認証 "への直接リンクトークン認証") APIクライアント用のトークンは、[Oauth2 API](https://docs.equinix.com/api-catalog/accesstokenv1#operation/GetOAuth2AccessToken)ドキュメントに記載されているOauth2トークン機能を使用して生成できます。 APIトークンは、provider引数またはevironment`EQUINIX_API_TOKEN`変数を使用して提供できます。`token``client_id`引数と`client_secret`引数は、引数がある場合は無視されます。`token` 推奨されるテスト方法の詳細については、[Equinix APIテスト](https://docs.equinix.com/equinix-api/testing)ガイドを参照してください。 ``` provider "equinix" { token = "someToken" } ``` ## 引数リファレンス[​](#引数リファレンス "への直接リンク引数リファレンス") Equinixプロバイダには、いくつかの基本的なパラメータが必要です。認証引数は個別に任意であるが、 `client_secret`Equinix FabricおよびNetwork Edgeサービスと対話するには、引数または環境設定を介してまたはの`client_id`いずれかを`token`定義する必要があります。 これらのパラメータは、[Terraform変数ファイル](https://developer.hashicorp.com/terraform/language/values/variables#variable-definitions-tfvars-files)または環境変数として提供できます。[機密データをプレーンテキストファイルに保存することは推奨されません。](https://developer.hashicorp.com/terraform/language/state/sensitive-data) ## スキーマ[​](#スキーマ "への直接リンクスキーマ") ### オプション[​](#オプション "への直接リンクオプション") * `client_id`(String) Developer Portalの「マイアプリ」で利用可能なAPIコンシューマキー。この引数はシェル環境変数で指定することもできる。`EQUINIX_API_CLIENTID` * `client_secret`(String) Developer Portalの「マイアプリ」で利用可能なAPIコンシューマシークレット。この引数はシェル環境変数で指定することもできる。`EQUINIX_API_CLIENTSECRET` * `endpoint`(文字列)必要な環境を示すEquinix APIベースURL。この引数はシェル環境変数で指定することもできる。`EQUINIX_API_ENDPOINT`(デフォルトは`https://api.equinix.com`) * `max_retries`(Number)ネットワーク障害時の最大再試行回数。 * `max_retry_wait_seconds`(数値)リクエストを再試行するまでの最大待機秒数。 * `request_timeout`(数値) EquinixプラットフォームAPIクライアントがAPIリクエストをキャンセルするまで待機する時間(秒)。キャンセルされたリクエストの結果、リソースがプロビジョニングされる可能性があります。(デフォルトは`30`) * `response_max_page_size`(Number)ページ区切りの応答を生成するRESTクエリの単一の応答でのレコードの最大数。(デフォルトはクライアント固有) * `sts_endpoint`(文字列)目的の環境をポイントするSTS APIベースURL。この引数はシェル環境変数で指定することもできる。`EQUINIX_STS_ENDPOINT`(デフォルトは`https://sts.eqix.equinix.com`)。STSはアルファ機能であり、すべてのユーザーが利用できるわけではありません。 * `token`(String) APIトークンは、[API](https://docs.equinix.com/equinix-api/api-authentication/)を使用してAPIコンシューマクライアントから生成されます。この引数はシェル環境変数で指定することもできる。`EQUINIX_API_TOKEN` * `token_exchange_scope`(String)認証トークンのスコープ。アクセスポリシーERNまたは形式の文字列である必要があります。`roleassignments:`この引数はシェル環境変数で指定することもできる。`EQUINIX_TOKEN_EXCHANGE_SCOPE`トークンエクスチェンジはアルファ機能であり、すべてのユーザーが利用できるわけではありません。 * `token_exchange_subject_token`(String)トークン交換認証に使用するサブジェクトトークン。Equinix STSが信頼するOIDCプロバイダが発行したOIDC IDトークンである必要があります。設定されていない場合、プロバイダはで指定された環境変数を使用します。`token_exchange_subject_token_env_var`トークンエクスチェンジはアルファ機能であり、すべてのユーザーが利用できるわけではありません。 * `token_exchange_subject_token_env_var`(String)トークン交換用のサブジェクトトークンを含む環境変数の名前。この引数はシェル環境変数で指定することもできる。`EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN_ENV_VAR`(デフォルトは`EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN`)。トークンエクスチェンジはアルファ機能であり、すべてのユーザーが利用できるわけではありません。