Parameters (Connect-PostgreSQL Cmdlet)
The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.
| Property | Description |
| AuthScheme | 認証で使用されるスキーム。このプロパティが空白の場合は、デフォルトの認証が使用されます。 |
| Server | サーバーのホスト名またはIP アドレス。 |
| Database | PostgreSQL データベースの名前。 |
| User | 認証するユーザーのユーザーID を指定します。 |
| Password | 認証するユーザーのパスワードを指定します。 |
| Port | PostgreSQL サーバーのポート番号。 |
| UseSSL | このプロパティは、SSL の構成を決定します。SSL が有効になっている場合、ユーザーとサーバーの間に暗号化された接続が確立され、ネットワーク上で送信されるデータが安全に保たれ、中断から保護されます。 |
| Visibility | ユーザーが許可したテーブルのメタデータを、カンマ区切りのクエリのリストとしてフィルタリングします。例えば、SELECT およびINSERT クエリの可視性を制限するには、'SELECT,INSERT' を指定します。有効な値：SELECT、INSERT、UPDATE、DELETE。 |
| Property | Description |
| AWSAccessKey | AWS アカウントのアクセスキーを指定します。この値には、AWS セキュリティ認証情報ページからアクセスできます。 |
| AWSSecretKey | AWS アカウントのシークレットキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。 |
| AWSRoleARN | 認証時に使用するロールのAmazon リソースネーム。 |
| AWSExternalId | 他のアカウントでロールを引き受ける際に必要となる一意の識別子。 |
| Property | Description |
| AzureTenant | データにアクセスするために使用されているPostgreSQL テナントを識別します。テナントのドメイン名（例： contoso.onmicrosoft.com ）またはディレクトリ（テナント）ID のいずれかを受け付けます。 |
| Property | Description |
| InitiateOAuth | OAuth アクセストークンを取得またはリフレッシュするプロセスを指定します。これにより、認証された認可ユーザーが作業している間、ユーザーアクセスを維持することができます。 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ） |
| OAuthAccessToken | データソースへのリクエストを認証するために使用されるOAuth アクセストークンを指定します。このトークンは、OAuth 交換が正常に完了した後に認可サーバーから発行されます。 |
| OAuthSettingsLocation | OAuth 値が保存される設定ファイルの場所を指定します。 |
| CallbackURL | OAuth 経由でPostgreSQL への認証を行った後にユーザーが戻るURL を指定します（カスタムOAuth アプリケーションのみ）。 |
| Scope | データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。 |
| OAuthVerifier | OAuthAuthorizationURL から返された検証コードを指定します。ブラウザを起動できないヘッドレスサーバーでOAuth 認証を行う場合に使用します。 OAuthSettingsLocation および OAuthVerifier の両方が設定される必要があります。 |
| OAuthRefreshToken | 元のアクセストークンが期限切れになった後に新しいアクセストークンを要求するために使用される、OAuth リフレッシュトークンを指定します。 |
| OAuthExpiresIn | OAuth アクセストークンの有効期間を秒単位で指定します。ユーザーが操作を続けている限り、アクセスを維持するためにトークンを再発行することができます。 |
| OAuthTokenTimestamp | 現在のアクセストークンがいつ作成されたかを示すUnix エポックタイムスタンプをミリ秒単位で表示します。 |
| Property | Description |
| OAuthJWTCert | クライアント証明書のJWT 証明書ストアの名前を指定します。 |
| OAuthJWTCertType | JWT 証明書を格納しているキーストアの種類を指定します。 |
| OAuthJWTCertPassword | パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
| OAuthJWTCertSubject | ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
| Property | Description |
| KerberosKDC | ユーザーの認証に使用されるKerberos キー配布センター（KDC）サービスを識別します。（SPNEGO またはWindows 認証のみ） |
| KerberosRealm | ユーザーの認証に使用される Kerberos レルムを識別します。 |
| KerberosSPN | Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）を指定します。 |
| KerberosUser | Kerberos ドメインコントローラーのプリンシパル名を確認します。形式はhost/user@realm です。 |
| KerberosKeytabFile | Kerberos のプリンシパルと暗号化されたキーのペアを含むKeytab ファイルを指定します。 |
| KerberosServiceRealm | サービスのKerberos レルムをを指定します。（クロスレルム認証のみ） |
| KerberosServiceKDC | サービスのKerberos Key Distribution Center（KDC）を指定します。 |
| KerberosTicketCache | MIT Kerberos 認証情報キャッシュファイルの完全ファイルパスを指定します。 |
| Property | Description |
| SSLClientCert | SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。 |
| SSLClientCertType | SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。 |
| SSLClientCertPassword | TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。 |
| SSLClientCertSubject | TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| Property | Description |
| SSHAuthMode | サービスへのSSH トンネルを確立する際に使用される認証方法。 |
| SSHClientCert | SSHUser の認証に使用する証明書。 |
| SSHClientCertPassword | SSHClientCert キーのパスワード（ある場合）。 |
| SSHClientCertSubject | SSH クライアント証明書のサブジェクト。 |
| SSHClientCertType | SSHClientCert 秘密鍵の種類。 |
| SSHServer | SSH サーバー。 |
| SSHPort | SSH ポート。 |
| SSHUser | SSH ユーザー。 |
| SSHPassword | SSH パスワード。 |
| SSHServerFingerprint | SSH サーバーのフィンガープリント。 |
| UseSSH | PostgreSQL 接続をSSH 経由でトンネリングするかどうか。 SSH を使用します。 |
| Property | Description |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| Property | Description |
| Logfile | provider が認証、クエリ実行、接続の詳細などのアクティビティを記録するログファイルのファイルパスを指定します。 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| MaxLogFileSize | 単一のログファイルの最大サイズをバイト単位で指定します。例えば、'10 MB' です。ファイルが上限に達すると、provider は日付と時刻を名前に付加した新しいログファイルを作成します。 |
| MaxLogFileCount | provider が保持するログファイルの最大数を指定します。上限に達すると、最も古いログファイルが削除され、新しいログファイルのためのスペースが作られます。 |
| Property | Description |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| IgnoredSchemas | information_schema やpg_catalog などのメタデータをクエリして取得されるリストからスキーマを非表示にするために使用される可視性制限フィルタ。スキーマ名は大文字と小文字が区別されることに注意してください。 |
| Property | Description |
| AutoCache | SELECT クエリの対象となるテーブルの内容が、指定されたキャッシュデータベースに自動的にキャッシュされるかどうかを指定します。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | 指定されたキャッシュデータベース内の失効データに対する許容時間（秒単位）を指定します。AutoCache がTrue に設定されている必要があります。 |
| Offline | ライブPostgreSQL データの代わりに、指定されたキャッシュデータベースからデータを取得します。 |
| CacheMetadata | provider がテーブルメタデータをファイルベースのキャッシュデータベースにキャッシュするかどうかを決定します。 |
| Property | Description |
| AllowPreparedStatement | クエリステートメントを実行前に準備します。 |
| BrowsePartitions | スーパーテーブルおよびそれに関連するパーティションをメタデータを通して公開するかどうかを決定します。 |
| FetchResultSetMetadata | このプロパティは、プロバイダーがサーバーから返される結果セットのカラムに関するスキーマ名およびテーブル名のメタデータを取得するかどうかを決定します。 |
| IncludeTableTypes | このプロパティがtrue に設定されている場合、プロバイダーはデータベース内で利用可能な個々のテーブルやビューのタイプをクエリします。 |
| InsertMode | バルクデータを挿入する際に使用する方法を指定します。デフォルトではDML モードが使用されます。 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対する追加の隠しプロパティを指定します。特定の問題に対処するため、サポートチームが推奨する場合にのみ使用してください。詳細は備考を参照してください。 |
| QueryPassthrough | このオプションは、クエリをPostgreSQL サーバーにas-is で渡します。 |
| Readonly | provider からPostgreSQL への読み取り専用アクセスを切り替えます。 |
| RTK | provider のライセンスを取得するためのランタイムキーを指定します。設定されていないか無効な場合、provider は標準のライセンス方法をデフォルトとして使用します。このプロパティは、標準のライセンス方法がサポートされていないか、ランタイムキーが必要な環境でのみ必要です。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| TimeZone | サーバーがdatetime / timestamp カラムを返す際に使用するタイムゾーンを設定します。値はPOSIX タイムゾーン仕様に従って指定する必要があります。 |