az apim

Administración de servicios de Azure API Management.

Comandos

Nombre	Description	Tipo	Estado
az apim api	Administre las API de Azure API Management.	Core	GA
az apim api create	Cree una API de API Management.	Core	GA
az apim api delete	Elimine una API de API Management.	Core	GA
az apim api export	Exportar una API de API Management.	Core	GA
az apim api import	Importe una API de API Management.	Core	GA
az apim api list	Enumera las API de API Management.	Core	GA
az apim api operation	Administración de operaciones de api de Azure API Management.	Core	GA
az apim api operation create	Crea una nueva operación en la API.	Core	GA
az apim api operation delete	Elimina la operación especificada en la API.	Core	GA
az apim api operation list	Enumerar una colección de las operaciones de la API especificada.	Core	GA
az apim api operation show	Obtiene los detalles de la operación de API especificada por su identificador.	Core	GA
az apim api operation update	Actualiza los detalles de la operación en la API especificada por su identificador.	Core	GA
az apim api release	Administración de la versión de la API de Azure API Management.	Core	GA
az apim api release create	Crea una nueva versión para la API.	Core	GA
az apim api release delete	Elimina la versión especificada en la API.	Core	GA
az apim api release list	Enumera todas las versiones de una API.	Core	GA
az apim api release show	Devuelve los detalles de una versión de API.	Core	GA
az apim api release update	Actualiza los detalles de la versión de la API especificada por su identificador.	Core	GA
az apim api revision	Administración de la revisión de la API de Azure API Management.	Core	GA
az apim api revision create	Creación de una revisión de API.	Core	GA
az apim api revision list	Enumera todas las revisiones de una API.	Core	GA
az apim api schema	Administre los esquemas de api de Azure API Management.	Core	GA
az apim api schema create	Cree un esquema de API Management API.	Core	GA
az apim api schema delete	Elimine un esquema de API Management API.	Core	GA
az apim api schema get-etag	Obtenga etag de un esquema de API Management API.	Core	GA
az apim api schema list	Enumerar los esquemas de API Management API.	Core	GA
az apim api schema show	Mostrar detalles de un esquema de API Management API.	Core	GA
az apim api schema wait	Coloque la CLI en un estado de espera hasta que se cumpla una condición de un esquema de APIm.	Core	GA
az apim api show	Mostrar los detalles de una API de API Management.	Core	GA
az apim api update	Actualizar una API de API Management.	Core	GA
az apim api versionset	Administración del conjunto de versiones de la API de Azure API Management.	Core	GA
az apim api versionset create	Crea un conjunto de versiones de API.	Core	GA
az apim api versionset delete	Elimina un conjunto de versiones de API específico.	Core	GA
az apim api versionset list	Enumera una colección de conjuntos de versiones de API en la instancia de servicio especificada.	Core	GA
az apim api versionset show	Obtiene los detalles del conjunto de versiones de api especificado por su identificador.	Core	GA
az apim api versionset update	Actualiza los detalles del conjunto de versiones de API especificado por su identificador.	Core	GA
az apim api wait	Coloque la CLI en un estado de espera hasta que se cumpla una condición de una API de APIm.	Core	GA
az apim apply-network-updates	Actualice el recurso de API Management que se ejecuta en la red virtual para seleccionar la configuración de red actualizada.	Core	GA
az apim backup	Crea una copia de seguridad del servicio API Management en la cuenta de Azure Storage especificada. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.	Core	GA
az apim check-name	Comprueba si hay un nombre de servicio disponible para su uso.	Core	GA
az apim create	Cree una instancia del servicio API Management.	Core	GA
az apim delete	Elimina un servicio API Management.	Core	GA
az apim deletedservice	Administración de servicios de Azure API Management eliminados temporalmente.	Core	GA
az apim deletedservice list	Enumere todas las instancias de servicios api Management eliminadas temporalmente disponibles para recuperar la suscripción especificada.	Core	GA
az apim deletedservice purge	Purgar la instancia del servicio Api Management eliminada temporalmente (la elimina sin opción de recuperar).	Core	GA
az apim deletedservice show	Obtenga las instancias del servicio Api Management eliminadas temporalmente disponibles para recuperar por nombre.	Core	GA
az apim graphql	Administre las API de GraphQL api de Azure API Management.	Core	GA
az apim graphql resolver	Administre los solucionadores de GraphQL API de Azure API Management.	Core	GA
az apim graphql resolver create	Cree una nueva resolución en GraphQL API o actualice una existente.	Core	GA
az apim graphql resolver delete	Elimine el solucionador especificado en GraphQL API.	Core	GA
az apim graphql resolver list	Enumere una colección de los solucionadores de graphQL API especificados.	Core	GA
az apim graphql resolver policy	Administre las directivas de solucionadores de GraphQL API de Azure API Management.	Core	GA
az apim graphql resolver policy create	Cree o actualice la configuración de directiva para el nivel de resolución de GraphQL API.	Core	GA
az apim graphql resolver policy delete	Elimine la configuración de directiva en graphQL Api Resolver.	Core	GA
az apim graphql resolver policy list	Obtenga la lista de configuración de directivas en el nivel de resolución de GraphQL API.	Core	GA
az apim graphql resolver policy show	Obtenga la configuración de directiva en el nivel de resolución de GraphQL API.	Core	GA
az apim graphql resolver show	Obtenga los detalles del solucionador de GraphQL API especificado por su identificador.	Core	GA
az apim list	Enumera las instancias del servicio API Management.	Core	GA
az apim nv	Administrar valores con nombre de Azure API Management.	Core	GA
az apim nv create	Cree un valor con nombre de API Management.	Core	GA
az apim nv delete	Elimine un valor con nombre de API Management.	Core	GA
az apim nv list	Enumerar valores con nombre de API Management.	Core	GA
az apim nv show	Muestra los detalles de un valor con nombre de API Management.	Core	GA
az apim nv show-secret	Obtiene el secreto de un valor con nombre de API Management.	Core	GA
az apim nv update	Actualice un valor con nombre de API Management.	Core	GA
az apim nv wait	Coloque la CLI en un estado de espera hasta que se cumpla una condición de un valor con nombre apim.	Core	GA
az apim product	Administrar el producto de Azure API Management.	Core	GA
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 restore	Restaura una copia de seguridad de un servicio de API Management creado mediante la operación ApiManagementService_Backup en el servicio actual. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.	Core	GA
az apim show	Mostrar detalles de una instancia de servicio de API Management.	Core	GA
az apim update	Actualice una instancia del servicio API Management.	Core	GA
az apim wait	Coloque la CLI en un estado de espera hasta que se cumpla una condición de apim.	Core	GA

az apim apply-network-updates

Editar

Actualice el recurso de API Management que se ejecuta en la red virtual para seleccionar la configuración de red actualizada.

az apim apply-network-updates --name
                              --resource-group
                              [--location]
                              [--no-wait]

Ejemplos

Actualización de la configuración de red virtual de la instancia del servicio API Management

az apim apply-network-updates --name MyApim -g MyResourceGroup

Parámetros requeridos

--name -n

Nombre de la instancia del servicio api management.

--resource-group -g

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

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.

--location -l

Location. Los valores de: az account list-locations. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>.

--no-wait

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

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 backup

Editar

Crea una copia de seguridad del servicio API Management en la cuenta de Azure Storage especificada. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.

az apim backup --backup-name
               --container-name --storage-account-container
               --name
               --resource-group
               --storage-account-key
               --storage-account-name
               [--no-wait]

Ejemplos

Creación de una copia de seguridad de la instancia del servicio API Management

az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Parámetros requeridos

--backup-name

Nombre del archivo de copia de seguridad que se va a crear.

--container-name --storage-account-container

Nombre del contenedor de la cuenta de almacenamiento que se usa para colocar la copia de seguridad.

--name -n

Nombre de la instancia del servicio api management.

--resource-group -g

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

--storage-account-key

Clave de acceso de la cuenta de almacenamiento usada para colocar la copia de seguridad.

Propiedad	Valor
Grupo de parámetros:	Storage Arguments

--storage-account-name

Nombre de la cuenta de almacenamiento utilizada para colocar la copia de seguridad.

Propiedad	Valor
Grupo de parámetros:	Storage Arguments

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.

--no-wait

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

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 check-name

Editar

Comprueba si hay un nombre de servicio disponible para su uso.

az apim check-name --name

Parámetros requeridos

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

Editar

Cree una instancia del servicio API Management.

az apim create --name
               --publisher-email
               --publisher-name
               --resource-group
               [--disable-gateway {false, true}]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--location]
               [--no-wait]
               [--public-network-access {false, true}]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Ejemplos

Cree un servicio API Management de nivel de desarrollador.

az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft

Cree un servicio api Management de nivel de consumo.

az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
    --publisher-email email@mydomain.com --publisher-name Microsoft

Parámetros requeridos

--name -n

Nombre único de la instancia de servicio que se va a crear.

El nombre debe ser único globalmente, ya que se incluirá como nombre de host de puerta de enlace como" https://my-api-servicename.azure-api.net'. Vea ejemplos.

--publisher-email

Dirección de correo electrónico para recibir todas las notificaciones del sistema.

--publisher-name

Nombre de la organización para su uso en el portal para desarrolladores y notificaciones por correo electrónico.

--resource-group -g

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

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.

--disable-gateway

Deshabilite la puerta de enlace en la región maestra. Solo es válido para un servicio api Management implementado en varias ubicaciones.

Propiedad	Valor
Valores aceptados:	false, true

--enable-client-certificate

Exige que se presente un certificado de cliente en cada solicitud a la puerta de enlace y también permite autenticar el certificado en la directiva de la puerta de enlace.

Propiedad	Valor
Valores aceptados:	false, true

--enable-managed-identity

Cree una identidad administrada para que el servicio API Management acceda a otros recursos de Azure. Solo está pensado para usarse para el servicio de SKU de consumo.

Propiedad	Valor
Valor predeterminado:	False
Valores aceptados:	false, true

--location -l

Location. Los valores de: az account list-locations. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>.

--no-wait

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

Propiedad	Valor
Valor predeterminado:	False

--public-network-access

Indica si se permite o no el acceso al punto de conexión público para este servicio de API Management. Si se establece en true, los puntos de conexión privados son el método de acceso exclusivo.

Propiedad	Valor
Valores aceptados:	false, true

--sku-capacity

Número de unidades implementadas de la SKU.

Propiedad	Valor
Valor predeterminado:	1

--sku-name

SKU de la instancia de API Management.

Propiedad	Valor
Valor predeterminado:	Developer
Valores aceptados:	Basic, Consumption, Developer, Isolated, Premium, Standard

--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

--virtual-network -v

Tipo de red virtual.

Propiedad	Valor
Valor predeterminado:	None
Valores aceptados:	External, Internal, None

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 delete

Editar

Elimina un servicio API Management.

az apim delete --name
               --resource-group
               [--no-wait]
               [--yes]

Ejemplos

Elimine un servicio API Management.

az apim delete -n MyApim -g MyResourceGroup

Parámetros requeridos

--name -n

Nombre de la instancia del servicio api management.

--resource-group -g

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

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.

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

Editar

Enumera las instancias del servicio API Management.

az apim list [--resource-group]

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.

--resource-group -g

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

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 restore

Editar

Restaura una copia de seguridad de un servicio de API Management creado mediante la operación ApiManagementService_Backup en el servicio actual. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.

az apim restore --backup-name
                --container-name --storage-account-container
                --name
                --resource-group
                --storage-account-key
                --storage-account-name
                [--no-wait]

Ejemplos

Restaura una copia de seguridad de la instancia del servicio API Management.

az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Parámetros requeridos

--backup-name

Nombre del archivo de copia de seguridad que se va a restaurar.

--container-name --storage-account-container

Nombre del contenedor de la cuenta de almacenamiento que se usa para recuperar la copia de seguridad.

--name -n

Nombre de la instancia del servicio api management.

--resource-group -g

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

--storage-account-key

Clave de acceso de la cuenta de almacenamiento usada para recuperar la copia de seguridad.

Propiedad	Valor
Grupo de parámetros:	Storage Arguments

--storage-account-name

Nombre de la cuenta de almacenamiento usada para recuperar la copia de seguridad.

Propiedad	Valor
Grupo de parámetros:	Storage Arguments

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.

--no-wait

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

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 show

Editar

Mostrar detalles de una instancia de servicio de API Management.

az apim show --name
             --resource-group

Parámetros requeridos

--name -n

Nombre de la instancia del servicio api management.

--resource-group -g

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

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 update

Editar

Actualice una instancia del servicio API Management.

az apim update --name
               --resource-group
               [--add]
               [--disable-gateway {false, true}]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--force-string]
               [--no-wait]
               [--public-network-access {false, true}]
               [--publisher-email]
               [--publisher-name]
               [--remove]
               [--set]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Parámetros requeridos

--name -n

Nombre de la instancia del servicio api management.

--resource-group -g

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

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:	[]

--disable-gateway

Deshabilite la puerta de enlace en la región maestra. Solo es válido para un servicio api Management implementado en varias ubicaciones.

Propiedad	Valor
Valores aceptados:	false, true

--enable-client-certificate

Exige que se presente un certificado de cliente en cada solicitud a la puerta de enlace y también permite autenticar el certificado en la directiva de la puerta de enlace.

Propiedad	Valor
Valores aceptados:	false, true

--enable-managed-identity

Cree una identidad administrada para que el servicio API Management acceda a otros recursos de Azure. Solo está pensado para usarse para el servicio de SKU de consumo.

Propiedad	Valor
Valores aceptados:	false, true

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

--no-wait

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

Propiedad	Valor
Valor predeterminado:	False

--public-network-access

Indica si se permite o no el acceso al punto de conexión público para este servicio de API Management. Si se establece en true, los puntos de conexión privados son el método de acceso exclusivo.

Propiedad	Valor
Valores aceptados:	false, true

--publisher-email

Dirección de correo electrónico para recibir todas las notificaciones del sistema.

--publisher-name

Nombre de la organización para su uso en el portal para desarrolladores y notificaciones por correo electrónico.

--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:	[]

--sku-capacity

Número de unidades implementadas de la SKU.

--sku-name

SKU de la instancia de API Management.

Propiedad	Valor
Valores aceptados:	Basic, Consumption, Developer, Isolated, Premium, Standard

--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

--virtual-network -v

Tipo de red virtual.

Propiedad	Valor
Valores aceptados:	External, Internal, None

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 wait

Editar

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

az apim wait --name
             --resource-group
             [--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 wait --created --name MyApim --resource-group MyResourceGroup

Parámetros requeridos

--name -n

Nombre de la instancia del servicio api management.

--resource-group -g

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

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

Comandos

az apim apply-network-updates

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apim backup

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apim check-name

Parámetros requeridos

az apim create

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apim delete

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apim list

Parámetros opcionales

az apim restore

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apim show

Parámetros requeridos

az apim update

Parámetros requeridos

Parámetros opcionales

az apim wait

Ejemplos

Parámetros requeridos

Parámetros opcionales

Comentarios