Cmdlets for GraphQL

Build 24.0.8963

Parameters (Connect-GraphQL Cmdlet)

The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.

Authentication


PropertyDescription
AuthSchemeThe type of authentication to use when connecting to remote services.
URLThe URL of the GraphQL service.
User認証で使用されるGraphQL ユーザーアカウント。
Passwordユーザーの認証で使用されるパスワード。

AWSAuthentication


PropertyDescription
CredentialsLocationMFA クレデンシャルが保存される設定ファイルの場所。
AWSCognitoRegionAWS Cognito のホスティングリージョン。
AWSUserPoolIdユーザープールのID。
AWSUserPoolClientAppIdユーザープールのアプリクライアントID。
AWSUserPoolClientAppSecretユーザープールのアプリクライアントシークレット。(オプション)

OAuth


PropertyDescription
InitiateOAuth接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。
OAuthVersion使われているOAuth のバージョン。
OAuthClientIdOAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecretOAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuthAccessTokenOAuth を使用して接続するためのアクセストークン。
OAuthAccessTokenSecretOAuth を使用して接続するためのアクセストークンのトークン シークレット。
OAuthSettingsLocationInitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。
CallbackURL認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。
OAuthGrantTypeOAuth フローのグラント種別。
OAuthIncludeCallbackURLアクセストークンリクエストにコールバックURL を含めるかどうか。
OAuthAuthorizationURLOAuth サービスの認可URL。
OAuthAccessTokenURLOAuth アクセストークンを取得するURL。
OAuthRefreshTokenURLOAuth トークンをリフレッシュするURL。
OAuthRequestTokenURLサービスがリクエストトークンを取得するために提供するURL。これは、OAuth 1.0 では必須です。
OAuthVerifierOAuth 認可URL から返された検証コード。
PKCEVerifierPKCE 認証スキームにGetOAuthAuthorizationUrl ストアドプロシージャを実行することで生成されるPKCE code verifier。
AuthTokenOAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。
AuthKeyOAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。
OAuthParamsOAuth アクセストークンのリクエストでparamname=value の形式でサブミットするその他のパラメータのカンマ区切りのリスト。
OAuthRefreshToken対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。
OAuthExpiresInOAuth アクセストークンの有効期限(秒単位)。
OAuthTokenTimestamp現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ(ミリ秒)。

JWTOAuth


PropertyDescription
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。
OAuthJWTCertSubjectOAuth JWT 証明書のサブジェクト。

SSL


PropertyDescription
SSLClientCertSSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストア。
SSLClientCertTypeTLS/SSL クライアント証明書を格納するキーストアの種類。
SSLClientCertPasswordTLS/SSL クライアント証明書のパスワード。
SSLClientCertSubjectTLS/SSL クライアント証明書のサブジェクト。
SSLServerCertTLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall


PropertyDescription
FirewallTypeプロキシベースのファイアウォールで使われるプロトコル。
FirewallServerプロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPortプロキシベースのファイアウォールのTCP ポート。
FirewallUserプロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPasswordプロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy


PropertyDescription
ProxyAutoDetectこれは、システムプロキシ設定を使用するかどうかを示します。
ProxyServerHTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPortProxyServer プロキシが起動しているTCP ポート。
ProxyAuthSchemeProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUserProxyServer プロキシへの認証に使われるユーザー名。
ProxyPasswordProxyServer プロキシへの認証に使われるパスワード。
ProxySSLTypeProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptionsProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging


PropertyDescription
Logfileログファイルの名前と場所を指定するファイルパス。
Verbosityログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。
LogModulesログファイルに含めるコアモジュール。
MaxLogFileSizeログファイルの最大バイトサイズ(例えば、10MB)を指定する文字列。
MaxLogFileCountログファイルの最大ファイル数を指定する文字列。

Schema


PropertyDescription
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemasこのプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesこのプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ExpandArgumentsDepthThis property is used to determine how far the provider should search for columns inside the arguments of type INPUT_OBJECT.
ExpandTablesDepthThis property is used to determine the depth of the child tables.
ExpandTemporaryTablesDepthThis property is used to determine the depth of the child temporary tables. Only works if ExposeDynamicProcedures is set to true.
ExpandColumnsDepthThis property is used to determine how far the provider should search for columns inside the GraphQL objects.
IncludeDeprecatedMetadataThis property is used to determine whether the provider should expose deprecated tables and columns or not.
ExposeDynamicProceduresThis property is used to determine whether the provider should expose mutations as dynamic procedures or not.

Caching


PropertyDescription
AutoCacheSELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。
CacheLocationキャッシュデータベースへのパスとファイル名を指定します。
CacheToleranceAutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。
Offlineオフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。
CacheMetadataこのプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。

Miscellaneous


PropertyDescription
CustomHeadersユーザーが決定したその他のヘッダー(オプション)。
GenerateSchemaFilesスキーマを生成して保存するユーザーの好みのタイミングを示します。
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PagesizeThe maximum number of results to return per page from GraphQL.
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RTKライセンス供与で使用されるランタイムキー。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.8963