azure-cli icon indicating copy to clipboard operation
azure-cli copied to clipboard

GraphQL APIM Azure CLI Support

Open tylerkb2 opened this issue 3 years ago • 4 comments

Feature Request: Please add support to the Azure CLI to include the new GraphQL APIM feature.

Background: Our team uses the Azure CLI to manage our APIM resources. We would like to extend this to our GraphQL API's.

Issue Encountered: "Cannot bind parameter 'SpecificationFormat'. Cannot convert value "graphql" to type "Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiFormat". Error: "Unable to match the identifier name graphql to a valid enumerator name. Specify one of the following enumerator names and try again: Wadl, Swagger, Wsdl, OpenApi, OpenApiJson"

The above error is consistent with the Azure CLI APIM Documentation.

Note: The feature is in preview. The CLI would understandably not be updated yet.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

  • ID: 197d8382-ee16-6001-4941-768877379c0d
  • Version Independent ID: 1423fa76-977f-ad88-8129-0b52a38e68e6
  • Content: az apim
  • Content Source: latest/docs-ref-autogen/apim.yml
  • GitHub Login: @rloutlaw
  • Microsoft Alias: routlaw

tylerkb2 avatar Dec 29 '21 21:12 tylerkb2

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @miaojiang.

Issue Details

Feature Request: Please add support to the Azure CLI to include the new GraphQL APIM feature.

Background: Our team uses the Azure CLI to manage our APIM resources. We would like to extend this to our GraphQL API's.

Issue Encountered: "Cannot bind parameter 'SpecificationFormat'. Cannot convert value "graphql" to type "Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiFormat". Error: "Unable to match the identifier name graphql to a valid enumerator name. Specify one of the following enumerator names and try again: Wadl, Swagger, Wsdl, OpenApi, OpenApiJson"

The above error is consistent with the Azure CLI APIM Documentation.

Note: The feature is in preview. The CLI would understandably not be updated yet.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

  • ID: 197d8382-ee16-6001-4941-768877379c0d
  • Version Independent ID: 1423fa76-977f-ad88-8129-0b52a38e68e6
  • Content: az apim
  • Content Source: latest/docs-ref-autogen/apim.yml
  • GitHub Login: @rloutlaw
  • Microsoft Alias: routlaw
Author: tylerkb2
Assignees: -
Labels:

Service Attention, API Management

Milestone: -

ghost avatar Dec 30 '21 02:12 ghost

route to service team

yonzhan avatar Dec 30 '21 02:12 yonzhan

Graphql in APIM is now GA. I still cannot find the SpecificationFormat to import a graphql api. Please help

skillbuilderzone avatar May 31 '22 09:05 skillbuilderzone

We'll need to add the Graphql specification-format to the az apim api import cmdlet.

Perhaps as a workaround, we do support the creation of a GraphQL Api and the upload of a GraphQL Schema in cli using the example below.

az apim api create --service-name MyApim -g MyResourceGroup --api-id MyGraphqlApi --path '/mygraphqlapi' --display-name 'My GraphQL API' --api-type graphql --service-url "https://MyServiceUrl.com"

az apim api schema create --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id graphql --schema-type application/vnd.ms-azure-apim.graphql.schema --schema-path "c:\path\to\schema.gql"

wpooley avatar Jul 19 '22 22:07 wpooley