az apim product

Administrar el producto de Azure API Management.

Comandos

Nombre	Description	Tipo	Estado
az apim product api	Administrar las API del producto de Azure API Management.	Core	GA
az apim product api add	Agregue una API al producto especificado.	Core	GA
az apim product api check	Comprueba que la entidad de API especificada por el identificador está asociada a la entidad Product.	Core	GA
az apim product api delete	Elimina la API especificada del producto especificado.	Core	GA
az apim product api list	Enumera una colección de las API asociadas a un producto.	Core	GA
az apim product create	Crea un producto.	Core	GA
az apim product delete	Eliminar producto.	Core	GA
az apim product list	Enumera una colección de productos en la instancia de servicio especificada.	Core	GA
az apim product show	Obtiene los detalles del producto especificado por su identificador.	Core	GA
az apim product update	Actualice los detalles del producto existentes.	Core	GA
az apim product wait	Coloque la CLI en un estado de espera hasta que se cumpla una condición de un producto apim.	Core	GA

az apim product create

Editar

Crea un producto.

az apim product create --product-name
                       --resource-group
                       --service-name
                       [--approval-required {false, true}]
                       [--description]
                       [--legal-terms]
                       [--no-wait]
                       [--product-id]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

Ejemplos

Crea un producto.

az apim product create --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyProductName --description MyDescription --legal-terms MyTerms --subscription-required true --approval-required true --subscriptions-limit 8 --state "published"

Parámetros requeridos

--product-name

Nombre del producto.

--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 opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--approval-required

Indica si se requiere la aprobación de la suscripción. Si es false, las nuevas suscripciones se aprobarán automáticamente, lo que permitirá a los desarrolladores llamar a las API del producto inmediatamente después de suscribirse. Si es true, los administradores deben aprobar manualmente la suscripción para que el desarrollador pueda usar cualquiera de las API del producto. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor false.

Propiedad	Valor
Valores aceptados:	false, true

--description

Descripción del producto. Puede incluir etiquetas de formato HTML.

--legal-terms

Términos de uso del producto. Los desarrolladores que intentan suscribirse al producto se mostrarán y tendrán que aceptar estos términos para poder completar el proceso de suscripción.

--no-wait

No espere a que finalice la operación de ejecución prolongada.

Propiedad	Valor
Valor predeterminado:	False

--product-id

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

--state

Indica si el producto se publica o no. Los usuarios del portal para desarrolladores pueden detectar los productos publicados. Los productos no publicados solo son visibles para los administradores. El estado predeterminado de Product no esPublished. Entre los valores posibles se incluyen: 'notPublished', 'published'.

Propiedad	Valor
Valores aceptados:	notPublished, published

--subscription-required -s

Si se requiere una suscripción de producto para acceder a las API incluidas en este producto.

Propiedad	Valor
Valores aceptados:	false, true

--subscriptions-limit

Indica si el número de suscripciones que un usuario puede tener en este producto al mismo tiempo. Establezca en NULL o omita para permitir suscripciones ilimitadas por usuario. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor false.

Parámetros globales

--debug

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

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

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

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az apim product delete

Editar

Eliminar producto.

az apim product delete --product-id
                       --resource-group
                       --service-name
                       [--delete-subscriptions]
                       [--if-match]
                       [--no-wait]
                       [--yes]

Ejemplos

Elimine el producto con todas las suscripciones a este producto.

az apim product delete --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --delete-subscriptions true

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 opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--delete-subscriptions

Elimine las suscripciones existentes asociadas al producto o no.

--if-match

ETag de la entidad.

--no-wait

No espere a que finalice la operación de ejecución prolongada.

Propiedad	Valor
Valor predeterminado:	False

--yes -y

No solicita confirmación.

Propiedad	Valor
Valor predeterminado:	False

Parámetros globales

--debug

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

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

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

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az apim product list

Editar

Enumera una colección de productos en la instancia de servicio especificada.

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

Ejemplos

Enumere todos los productos de esta instancia de APIM.

az apim product list --resource-group MyResourceGroup --service-name MyServiceName

Parámetros requeridos

--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 del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

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

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az apim product show

Editar

Obtiene los detalles del producto especificado por su identificador.

az apim product show --product-id
                     --resource-group
                     --service-name

Ejemplos

Obtiene los detalles del producto especificado por su identificador.

az apim product show --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 del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

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

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az apim product update

Editar

Actualice los detalles del producto existentes.

az apim product update --product-id
                       --resource-group
                       --service-name
                       [--add]
                       [--approval-required {false, true}]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--legal-terms]
                       [--no-wait]
                       [--product-name]
                       [--remove]
                       [--set]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

Ejemplos

Actualice los detalles del producto existentes.

az apim product update --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyNewProductName --description MyNewDescription --legal-terms MyNewTerms --subscription-required false --state "notPublished"

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 opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--add

Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string or JSON string>.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments
Valor predeterminado:	[]

--approval-required

Propiedad	Valor
Valores aceptados:	false, true

--description

Descripción del producto. Puede incluir etiquetas de formato HTML.

--force-string

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments
Valor predeterminado:	False

--if-match

ETag de la entidad.

--legal-terms

Términos de uso del producto. Los desarrolladores que intentan suscribirse al producto se mostrarán y tendrán que aceptar estos términos para poder completar el proceso de suscripción.

--no-wait

No espere a que finalice la operación de ejecución prolongada.

Propiedad	Valor
Valor predeterminado:	False

--product-name

Nombre del producto.

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments
Valor predeterminado:	[]

--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=<value>.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments
Valor predeterminado:	[]

--state

Propiedad	Valor
Valores aceptados:	notPublished, published

--subscription-required -s

Si se requiere una suscripción de producto para acceder a las API incluidas en este producto.

Propiedad	Valor
Valores aceptados:	false, true

--subscriptions-limit

Parámetros globales

--debug

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

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

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

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az apim product wait

Editar

Coloque la CLI en un estado de espera hasta que se cumpla una condición de un producto apim.

az apim product wait --product-id
                     --resource-group
                     --service-name
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--timeout]
                     [--updated]

Ejemplos

Coloque la CLI en un estado de espera hasta que se cumpla una condición de apim. (autogenerated)

az apim product wait --created --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 opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	False

--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments

--deleted

Espere hasta que se elimine.

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	False

--exists

Espere hasta que exista el recurso.

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	False

--interval

Intervalo de sondeo en segundos.

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	30

--timeout

Espera máxima en segundos.

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	3600

--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	False

Parámetros globales

--debug

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

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

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

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

Comentarios

¿Le ha resultado útil esta página?

Compartir a través de

az apim product

Comandos

az apim product create

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apim product delete

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apim product list

Ejemplos

Parámetros requeridos

az apim product show

Ejemplos

Parámetros requeridos

az apim product update

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apim product wait

Ejemplos

Parámetros requeridos

Parámetros opcionales

Comentarios