az apim backend

Administrar Azure API Management back-end.

Comandos

Nombre	Description	Tipo	Estado
az apim backend create	Cree o actualice un back-end de API Management.	Core	GA
az apim backend delete	Elimine un back-end de API Management.	Core	GA
az apim backend list	Enumeración de back-end de API Management.	Core	GA
az apim backend show	Mostrar detalles de un back-end de API Management.	Core	GA
az apim backend update	Actualice un back-end de API Management.	Core	GA

az apim backend create

Editar

Cree o actualice un back-end de API Management.

az apim backend create --backend-id
                       --protocol {http, soap}
                       --resource-group
                       --service-name
                       --url
                       [--acquire-policy-token]
                       [--change-reference]
                       [--description]
                       [--if-match]

Ejemplos

Cree un back-end.

az apim backend create --service-name MyApim -g MyResourceGroup --backend-id MyBackendId --url https://mybackend.com --protocol http

Parámetros requeridos

--backend-id

Nombre único del back-end que se va a crear o actualizar.

Debe ser único en la instancia de servicio de API Management actual.

Propiedad	Valor
Grupo de parámetros:	Backend Arguments

--protocol

Protocolo que se usa para comunicarse con el servicio back-end.

Propiedad	Valor
Valores aceptados:	http, soap

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

--url

Dirección URL del servicio back-end.

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.

--acquire-policy-token

Adquirir un token de Azure Policy automáticamente para esta operación de recursos.

Propiedad	Valor
Grupo de parámetros:	Global Policy Arguments

--change-reference

Identificador de referencia de cambio relacionado para esta operación de recurso.

Propiedad	Valor
Grupo de parámetros:	Global Policy Arguments

--description

Descripción del back-end. Puede incluir etiquetas de formato HTML.

--if-match

ETag de la Entidad.

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

Editar

Elimine un back-end de API Management.

az apim backend delete --backend-id
                       --resource-group
                       --service-name
                       [--acquire-policy-token]
                       [--change-reference]
                       [--if-match]
                       [--yes]

Ejemplos

Elimine un back-end en una instancia de APIM.

az apim backend delete --resource-group MyResourceGroup --service-name MyServiceName --backend-id MyBackendId

Parámetros requeridos

--backend-id

Identificador del back-end.

Propiedad	Valor
Grupo de parámetros:	Backend Arguments

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

--acquire-policy-token

Adquirir un token de Azure Policy automáticamente para esta operación de recursos.

Propiedad	Valor
Grupo de parámetros:	Global Policy Arguments

--change-reference

Identificador de referencia de cambio relacionado para esta operación de recurso.

Propiedad	Valor
Grupo de parámetros:	Global Policy Arguments

--if-match

ETag de la Entidad.

--yes -y

No solicitar 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 backend list

Editar

Enumeración de back-end de API Management.

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

Ejemplos

Enumere todos los back-end en una instancia de APIM.

az apim backend 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 backend show

Editar

Mostrar detalles de un back-end de API Management.

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

Ejemplos

Mostrar detalles de un back-end en una instancia de APIM.

az apim backend show --resource-group MyResourceGroup --service-name MyServiceName --backend-id MyBackendId

Parámetros requeridos

--backend-id

Identificador del back-end.

Propiedad	Valor
Grupo de parámetros:	Backend Arguments

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

Editar

Actualice un back-end de API Management.

az apim backend update --backend-id
                       --resource-group
                       --service-name
                       [--acquire-policy-token]
                       [--add]
                       [--change-reference]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--protocol {http, soap}]
                       [--remove]
                       [--set]
                       [--url]

Ejemplos

Actualizar un back-end.

az apim backend update --service-name MyApim -g MyResourceGroup --backend-id MyBackendId --url https://mynewbackend.com

Parámetros requeridos

--backend-id

Nombre único del back-end que se va a actualizar.

Debe ser único en la instancia de servicio de API Management actual.

Propiedad	Valor
Grupo de parámetros:	Backend Arguments

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

--acquire-policy-token

Adquirir un token de Azure Policy automáticamente para esta operación de recursos.

Propiedad	Valor
Grupo de parámetros:	Global Policy Arguments

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

--change-reference

Identificador de referencia de cambio relacionado para esta operación de recurso.

Propiedad	Valor
Grupo de parámetros:	Global Policy Arguments

--description

Descripción del back-end. 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. No es necesario al crear una entidad, pero sí al actualizar una entidad. El valor predeterminado es None.

--protocol

Protocolo usado para comunicarse con el servicio back-end. Entre los valores posibles se incluyen: http, soap.

Propiedad	Valor
Valores aceptados:	http, soap

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

--url

Dirección URL del servicio back-end.

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?