GraphQLApiResolver interface
GraphQLApiResolver を表すインターフェイス。
メソッド
create |
GraphQL API に新しいリゾルバーを作成するか、既存の競合回避モジュールを更新します。 |
delete(string, string, string, string, string, Graph |
GraphQL API で指定した競合回避モジュールを削除します。 |
get(string, string, string, string, Graph |
識別子で指定されたGraphQL API リゾルバーの詳細を取得します。 |
get |
識別子で指定されたGraphQL API リゾルバーのエンティティ状態 (Etag) バージョンを取得します。 |
list |
指定したGraphQL API のリゾルバーのコレクションを一覧表示します。 |
update(string, string, string, string, string, Resolver |
識別子で指定されたGraphQL API のリゾルバーの詳細を更新します。 |
メソッドの詳細
createOrUpdate(string, string, string, string, ResolverContract, GraphQLApiResolverCreateOrUpdateOptionalParams)
GraphQL API に新しいリゾルバーを作成するか、既存の競合回避モジュールを更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, resolverId: string, parameters: ResolverContract, options?: GraphQLApiResolverCreateOrUpdateOptionalParams): Promise<GraphQLApiResolverCreateOrUpdateResponse>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- resolverId
-
string
GraphQL API 内のリゾルバー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- parameters
- ResolverContract
パラメーターを作成します。
options パラメーター。
戻り値
delete(string, string, string, string, string, GraphQLApiResolverDeleteOptionalParams)
GraphQL API で指定した競合回避モジュールを削除します。
function delete(resourceGroupName: string, serviceName: string, apiId: string, resolverId: string, ifMatch: string, options?: GraphQLApiResolverDeleteOptionalParams): Promise<void>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- resolverId
-
string
GraphQL API 内のリゾルバー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
options パラメーター。
戻り値
Promise<void>
get(string, string, string, string, GraphQLApiResolverGetOptionalParams)
識別子で指定されたGraphQL API リゾルバーの詳細を取得します。
function get(resourceGroupName: string, serviceName: string, apiId: string, resolverId: string, options?: GraphQLApiResolverGetOptionalParams): Promise<GraphQLApiResolverGetResponse>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- resolverId
-
string
GraphQL API 内のリゾルバー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<GraphQLApiResolverGetResponse>
getEntityTag(string, string, string, string, GraphQLApiResolverGetEntityTagOptionalParams)
識別子で指定されたGraphQL API リゾルバーのエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, resolverId: string, options?: GraphQLApiResolverGetEntityTagOptionalParams): Promise<GraphQLApiResolverGetEntityTagHeaders>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- resolverId
-
string
GraphQL API 内のリゾルバー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
listByApi(string, string, string, GraphQLApiResolverListByApiOptionalParams)
指定したGraphQL API のリゾルバーのコレクションを一覧表示します。
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: GraphQLApiResolverListByApiOptionalParams): PagedAsyncIterableIterator<ResolverContract, ResolverContract[], PageSettings>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
options パラメーター。
戻り値
update(string, string, string, string, string, ResolverUpdateContract, GraphQLApiResolverUpdateOptionalParams)
識別子で指定されたGraphQL API のリゾルバーの詳細を更新します。
function update(resourceGroupName: string, serviceName: string, apiId: string, resolverId: string, ifMatch: string, parameters: ResolverUpdateContract, options?: GraphQLApiResolverUpdateOptionalParams): Promise<GraphQLApiResolverUpdateResponse>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- resolverId
-
string
GraphQL API 内のリゾルバー識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- ResolverUpdateContract
API リゾルバーの Update パラメーターをGraphQLします。
options パラメーター。
戻り値
Promise<GraphQLApiResolverUpdateResponse>