az apim graphql resolver

  • Reference

Manage Azure API Management GraphQL API's Resolvers.

Commands

Name Description Type Status
az apim graphql resolver create

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

 Core GA
az apim graphql resolver delete

Delete the specified resolver in the GraphQL API.

 Core GA
az apim graphql resolver list

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

 Core GA
az apim graphql resolver policy

Manage Azure API Management GraphQL API's Resolvers Policies.

 Core GA
az apim graphql resolver policy create

Create or updates policy configuration for the GraphQL API Resolver level.

 Core GA
az apim graphql resolver policy delete

Delete the policy configuration at the GraphQL Api Resolver.

 Core GA
az apim graphql resolver policy list

Get the list of policy configuration at the GraphQL API Resolver level.

 Core GA
az apim graphql resolver policy show

Get the policy configuration at the GraphQL API Resolver level.

 Core GA
az apim graphql resolver show

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

 Core GA

az apim graphql resolver create

Edit

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

az apim graphql resolver create --api-id
                                --display-name
                                --path
                                --resolver-id
                                --resource-group
                                --service-name
                                [--description]

Examples

Create a new resolver.

az apim graphql resolver create --service-name MyApim -g MyResourceGroup --api-id MyApi --resolver-id MyResolverId --display-name "Query-allFamilies" --path "Query/allFamilies" --description "A GraphQL Resolver example"

Required Parameters

--api-id

API 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.

--display-name

Resolver Name.

--path

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

--resolver-id

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

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--service-name -n

The name of the API Management service instance.

Optional Parameters

--description

Description of the resolver. May include HTML formatting tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az apim graphql resolver delete

Edit

Delete the specified resolver in the GraphQL API.

az apim graphql resolver delete --api-id
                                --resolver-id
                                --resource-group
                                --service-name
                                [--if-match]
                                [--yes]

Examples

Delete resolver.

az apim graphql resolver delete --service-name MyApim -g MyResourceGroup --api-id MyApi --resolver-id MyResolverId

Required Parameters

--api-id

API 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.

--resolver-id

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

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--service-name -n

The name of the API Management service instance.

Optional Parameters

--if-match

ETag of the Entity.

--yes -y

Do not prompt for confirmation.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az apim graphql resolver list

Edit

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

az apim graphql resolver list --api-id
                              --resource-group
                              --service-name

Examples

Get list of resolvers of an API.

az apim graphql resolver list --service-name MyApim -g MyResourceGroup --api-id MyApi

Required Parameters

--api-id

API 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.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--service-name -n

The name of the API Management service instance.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az apim graphql resolver show

Edit

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

az apim graphql resolver show --api-id
                              --resolver-id
                              --resource-group
                              --service-name

Examples

Get details of resolver.

az apim graphql resolver show --service-name MyApim -g MyResourceGroup --api-id MyApi --resolver-id MyResolverId

Required Parameters

--api-id

API 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.

--resolver-id

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

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--service-name -n

The name of the API Management service instance.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.