Share via

GraphQLApiResolver interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a GraphQLApiResolver.

Methods

createOrUpdate(string, string, string, string, ResolverContract, GraphQLApiResolverCreateOrUpdateOptionalParams)

Creates a new resolver in the GraphQL API or updates an existing one.
delete(string, string, string, string, string, GraphQLApiResolverDeleteOptionalParams)

Deletes the specified resolver in the GraphQL API.
get(string, string, string, string, GraphQLApiResolverGetOptionalParams)

Gets the details of the GraphQL API Resolver specified by its identifier.
getEntityTag(string, string, string, string, GraphQLApiResolverGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the GraphQL API resolver specified by its identifier.
listByApi(string, string, string, GraphQLApiResolverListByApiOptionalParams)

Lists a collection of the resolvers for the specified GraphQL API.
update(string, string, string, string, string, ResolverUpdateContract, GraphQLApiResolverUpdateOptionalParams)

Updates the details of the resolver in the GraphQL API specified by its identifier.

Method Details

createOrUpdate(string, string, string, string, ResolverContract, GraphQLApiResolverCreateOrUpdateOptionalParams)

Creates a new resolver in the GraphQL API or updates an existing one.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, resolverId: string, parameters: ResolverContract, options?: GraphQLApiResolverCreateOrUpdateOptionalParams): Promise<GraphQLApiResolverCreateOrUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

resolverId

string

Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.

parameters
ResolverContract

Create parameters.

options
GraphQLApiResolverCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<GraphQLApiResolverCreateOrUpdateResponse>

delete(string, string, string, string, string, GraphQLApiResolverDeleteOptionalParams)

Deletes the specified resolver in the GraphQL API.

function delete(resourceGroupName: string, serviceName: string, apiId: string, resolverId: string, ifMatch: string, options?: GraphQLApiResolverDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

resolverId

string

Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

options
GraphQLApiResolverDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, GraphQLApiResolverGetOptionalParams)

Gets the details of the GraphQL API Resolver specified by its identifier.

function get(resourceGroupName: string, serviceName: string, apiId: string, resolverId: string, options?: GraphQLApiResolverGetOptionalParams): Promise<GraphQLApiResolverGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

resolverId

string

Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.

options
GraphQLApiResolverGetOptionalParams

The options parameters.

Returns

Promise<GraphQLApiResolverGetResponse>

getEntityTag(string, string, string, string, GraphQLApiResolverGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the GraphQL API resolver specified by its identifier.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, resolverId: string, options?: GraphQLApiResolverGetEntityTagOptionalParams): Promise<GraphQLApiResolverGetEntityTagHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

resolverId

string

Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.

options
GraphQLApiResolverGetEntityTagOptionalParams

The options parameters.

Returns

Promise<GraphQLApiResolverGetEntityTagHeaders>

listByApi(string, string, string, GraphQLApiResolverListByApiOptionalParams)

Lists a collection of the resolvers for the specified GraphQL API.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: GraphQLApiResolverListByApiOptionalParams): PagedAsyncIterableIterator<ResolverContract, ResolverContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

options
GraphQLApiResolverListByApiOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ResolverContract, ResolverContract[], PageSettings>

update(string, string, string, string, string, ResolverUpdateContract, GraphQLApiResolverUpdateOptionalParams)

Updates the details of the resolver in the GraphQL API specified by its identifier.

function update(resourceGroupName: string, serviceName: string, apiId: string, resolverId: string, ifMatch: string, parameters: ResolverUpdateContract, options?: GraphQLApiResolverUpdateOptionalParams): Promise<GraphQLApiResolverUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

resolverId

string

Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

parameters
ResolverUpdateContract

GraphQL API Resolver Update parameters.

options
GraphQLApiResolverUpdateOptionalParams

The options parameters.

Returns

Promise<GraphQLApiResolverUpdateResponse>