graph_ql_api_resolvers

Creates, updates, deletes, gets or lists a graph_ql_api_resolvers resource.

Overview

Name	graph_ql_api_resolvers
Type	Resource
Id	azure.api_management.graph_ql_api_resolvers

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified Resolver entity.

Name	Datatype	Description
properties	object	Properties of the Resolver Contract.

list_by_api

A collection of resolvers summary entities at the GraphQL API level.

Name	Datatype	Description
properties	object	Properties of the Resolver Contract.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, apiId, resolverId, subscriptionId		Gets the details of the GraphQL API Resolver specified by its identifier.
list_by_api	select	resourceGroupName, serviceName, apiId, subscriptionId	$filter, $top, $skip	Lists a collection of the resolvers for the specified GraphQL API.
create_or_update	insert	resourceGroupName, serviceName, apiId, resolverId, subscriptionId	If-Match	Creates a new resolver in the GraphQL API or updates an existing one.
update	update	resourceGroupName, serviceName, apiId, resolverId, If-Match, subscriptionId		Updates the details of the resolver in the GraphQL API specified by its identifier.
delete	delete	resourceGroupName, serviceName, apiId, resolverId, If-Match, subscriptionId		Deletes the specified resolver in the GraphQL API.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
If-Match	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.
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.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

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

SELECT
properties
FROM azure.api_management.graph_ql_api_resolvers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND apiId = '{{ apiId }}' -- required
AND resolverId = '{{ resolverId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_api

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

SELECT
properties
FROM azure.api_management.graph_ql_api_resolvers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND apiId = '{{ apiId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure.api_management.graph_ql_api_resolvers (
data__properties,
resourceGroupName,
serviceName,
apiId,
resolverId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ apiId }}',
'{{ resolverId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: graph_ql_api_resolvers
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the graph_ql_api_resolvers resource.
    - name: serviceName
      value: string
      description: Required parameter for the graph_ql_api_resolvers resource.
    - name: apiId
      value: string
      description: Required parameter for the graph_ql_api_resolvers resource.
    - name: resolverId
      value: string
      description: Required parameter for the graph_ql_api_resolvers resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the graph_ql_api_resolvers resource.
    - name: properties
      value: object
      description: |
        Properties of the Resolver Contract.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

UPDATE examples

update

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

UPDATE azure.api_management.graph_ql_api_resolvers
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND apiId = '{{ apiId }}' --required
AND resolverId = '{{ resolverId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes the specified resolver in the GraphQL API.

DELETE FROM azure.api_management.graph_ql_api_resolvers
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND apiId = '{{ apiId }}' --required
AND resolverId = '{{ resolverId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;