Share via

az apim graphql resolver policy

  • Reference

Manage Azure API Management GraphQL API's Resolvers Policies.

Commands

Name Description Type Status
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 policy create

Edit

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

az apim graphql resolver policy create --api-id
                                       --resolver-id
                                       --resource-group
                                       --service-name
                                       --value-path
                                       [--policy-format]

Examples

Create a resolver policy.

az apim graphql resolver policy create --service-name MyApim -g MyResourceGroup --api-id MyApi --resolver-id MyResolverId --policy-format xml --value-path 'path to xml file'

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.

--value-path

Contents of the Policy as defined by the format.

Optional Parameters

--policy-format

Format of the policyContent.

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 policy delete

Edit

Delete the policy configuration at the GraphQL Api Resolver.

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

Examples

Delete policy configuration.

az apim graphql resolver policy 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 policy list

Edit

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

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

Examples

Get list of policy configuration.

az apim graphql resolver policy list --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.

az apim graphql resolver policy show

Edit

Get the policy configuration at the GraphQL API Resolver level.

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

Examples

Get policy configuration.

az apim graphql resolver policy 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.