az apim graphql resolver
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
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 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.
Property | Value |
---|---|
Parameter group: | API Arguments |
Resolver Name.
Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the API Management service instance.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Description of the resolver. May include HTML formatting tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az apim graphql resolver delete
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 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.
Property | Value |
---|---|
Parameter group: | API Arguments |
Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the API Management service instance.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ETag of the Entity.
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az apim graphql resolver list
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 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.
Property | Value |
---|---|
Parameter group: | API Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the API Management service instance.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az apim graphql resolver show
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 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.
Property | Value |
---|---|
Parameter group: | API Arguments |
Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the API Management service instance.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |