Compartir a través de

az apim product api

  • Referencia

Administrar las API del producto de Azure API Management.

Comandos

Nombre Description Tipo Estado
az apim product api add

Agregue una API al producto especificado.

 Principal GA
az apim product api check

Comprueba que la entidad de API especificada por el identificador está asociada a la entidad Product.

 Principal GA
az apim product api delete

Elimina la API especificada del producto especificado.

 Principal GA
az apim product api list

Enumera una colección de las API asociadas a un producto.

 Principal GA

az apim product api add

Editar

Agregue una API al producto especificado.

az apim product api add --api-id
                        --product-id
                        --resource-group
                        --service-name

Ejemplos

Agregue una API al producto especificado.

az apim product api add --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

Parámetros requeridos

--api-id

Identificador de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

--product-id

Identificador del producto. Debe ser único en la instancia actual del servicio API Management.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--service-name -n

Nombre de la instancia del servicio api management.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az apim product api check

Editar

Comprueba que la entidad de API especificada por el identificador está asociada a la entidad Product.

az apim product api check --api-id
                          --product-id
                          --resource-group
                          --service-name

Ejemplos

Compruebe si la API está asociada al producto.

az apim product api check --resource-group MyResourceGroup  --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

Parámetros requeridos

--api-id

Identificador de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

--product-id

Identificador del producto. Debe ser único en la instancia actual del servicio API Management.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--service-name -n

Nombre de la instancia del servicio api management.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az apim product api delete

Editar

Elimina la API especificada del producto especificado.

az apim product api delete --api-id
                           --product-id
                           --resource-group
                           --service-name

Ejemplos

Elimina la API especificada del producto especificado.

az apim product api delete --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

Parámetros requeridos

--api-id

Identificador de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

--product-id

Identificador del producto. Debe ser único en la instancia actual del servicio API Management.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--service-name -n

Nombre de la instancia del servicio api management.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az apim product api list

Editar

Enumera una colección de las API asociadas a un producto.

az apim product api list --product-id
                         --resource-group
                         --service-name

Ejemplos

Enumera todas las API asociadas a un producto.

az apim product api list --resource-group MyResourceGroup  --service-name MyServiceName  --product-id MyProductID

Parámetros requeridos

--product-id

Identificador del producto. Debe ser único en la instancia actual del servicio API Management.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--service-name -n

Nombre de la instancia del servicio api management.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.